square

package

v0.0.0-...-91acee8 Latest Latest Go to latest Published: Aug 17, 2024 License: MIT Imports: 21 Imported by: 0

README ¶

Go API client for Square.Connect

Client library for accessing the Square Connect APIs

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

API version: 2.0
Package version: 2.20180712.0
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://squareup.com/developers

Installation

Put the package under your project folder and add the following in import:

import "./Square.Connect"

Documentation for API Endpoints

All URIs are relative to https://connect.squareup.com/

Class	Method	HTTP request	Description
ApplePayApi	RegisterDomain	Post /v2/apple-pay/domains	RegisterDomain
BankAccountsApi	GetBankAccount	Get /v2/bank-accounts/{bank_account_id}	GetBankAccount
BankAccountsApi	GetBankAccountByV1Id	Get /v2/bank-accounts/by-v1-id/{v1_bank_account_id}	GetBankAccountByV1Id
BankAccountsApi	ListBankAccounts	Get /v2/bank-accounts	ListBankAccounts
BookingCustomAttributesApi	BulkDeleteBookingCustomAttributes	Post /v2/bookings/custom-attributes/bulk-delete	BulkDeleteBookingCustomAttributes
BookingCustomAttributesApi	BulkUpsertBookingCustomAttributes	Post /v2/bookings/custom-attributes/bulk-upsert	BulkUpsertBookingCustomAttributes
BookingCustomAttributesApi	CreateBookingCustomAttributeDefinition	Post /v2/bookings/custom-attribute-definitions	CreateBookingCustomAttributeDefinition
BookingCustomAttributesApi	DeleteBookingCustomAttribute	Delete /v2/bookings/{booking_id}/custom-attributes/{key}	DeleteBookingCustomAttribute
BookingCustomAttributesApi	DeleteBookingCustomAttributeDefinition	Delete /v2/bookings/custom-attribute-definitions/{key}	DeleteBookingCustomAttributeDefinition
BookingCustomAttributesApi	ListBookingCustomAttributeDefinitions	Get /v2/bookings/custom-attribute-definitions	ListBookingCustomAttributeDefinitions
BookingCustomAttributesApi	ListBookingCustomAttributes	Get /v2/bookings/{booking_id}/custom-attributes	ListBookingCustomAttributes
BookingCustomAttributesApi	RetrieveBookingCustomAttribute	Get /v2/bookings/{booking_id}/custom-attributes/{key}	RetrieveBookingCustomAttribute
BookingCustomAttributesApi	RetrieveBookingCustomAttributeDefinition	Get /v2/bookings/custom-attribute-definitions/{key}	RetrieveBookingCustomAttributeDefinition
BookingCustomAttributesApi	UpdateBookingCustomAttributeDefinition	Put /v2/bookings/custom-attribute-definitions/{key}	UpdateBookingCustomAttributeDefinition
BookingCustomAttributesApi	UpsertBookingCustomAttribute	Put /v2/bookings/{booking_id}/custom-attributes/{key}	UpsertBookingCustomAttribute
BookingsApi	BulkRetrieveBookings	Post /v2/bookings/bulk-retrieve	BulkRetrieveBookings
BookingsApi	BulkRetrieveTeamMemberBookingProfiles	Post /v2/bookings/team-member-booking-profiles/bulk-retrieve	BulkRetrieveTeamMemberBookingProfiles
BookingsApi	CancelBooking	Post /v2/bookings/{booking_id}/cancel	CancelBooking
BookingsApi	CreateBooking	Post /v2/bookings	CreateBooking
BookingsApi	ListBookings	Get /v2/bookings	ListBookings
BookingsApi	ListLocationBookingProfiles	Get /v2/bookings/location-booking-profiles	ListLocationBookingProfiles
BookingsApi	ListTeamMemberBookingProfiles	Get /v2/bookings/team-member-booking-profiles	ListTeamMemberBookingProfiles
BookingsApi	RetrieveBooking	Get /v2/bookings/{booking_id}	RetrieveBooking
BookingsApi	RetrieveBusinessBookingProfile	Get /v2/bookings/business-booking-profile	RetrieveBusinessBookingProfile
BookingsApi	RetrieveLocationBookingProfile	Get /v2/bookings/location-booking-profiles/{location_id}	RetrieveLocationBookingProfile
BookingsApi	RetrieveTeamMemberBookingProfile	Get /v2/bookings/team-member-booking-profiles/{team_member_id}	RetrieveTeamMemberBookingProfile
BookingsApi	SearchAvailability	Post /v2/bookings/availability/search	SearchAvailability
BookingsApi	UpdateBooking	Put /v2/bookings/{booking_id}	UpdateBooking
CardsApi	CreateCard	Post /v2/cards	CreateCard
CardsApi	DisableCard	Post /v2/cards/{card_id}/disable	DisableCard
CardsApi	ListCards	Get /v2/cards	ListCards
CardsApi	RetrieveCard	Get /v2/cards/{card_id}	RetrieveCard
CashDrawersApi	ListCashDrawerShiftEvents	Get /v2/cash-drawers/shifts/{shift_id}/events	ListCashDrawerShiftEvents
CashDrawersApi	ListCashDrawerShifts	Get /v2/cash-drawers/shifts	ListCashDrawerShifts
CashDrawersApi	RetrieveCashDrawerShift	Get /v2/cash-drawers/shifts/{shift_id}	RetrieveCashDrawerShift
CatalogApi	BatchDeleteCatalogObjects	Post /v2/catalog/batch-delete	BatchDeleteCatalogObjects
CatalogApi	BatchRetrieveCatalogObjects	Post /v2/catalog/batch-retrieve	BatchRetrieveCatalogObjects
CatalogApi	BatchUpsertCatalogObjects	Post /v2/catalog/batch-upsert	BatchUpsertCatalogObjects
CatalogApi	CatalogInfo	Get /v2/catalog/info	CatalogInfo
CatalogApi	DeleteCatalogObject	Delete /v2/catalog/object/{object_id}	DeleteCatalogObject
CatalogApi	ListCatalog	Get /v2/catalog/list	ListCatalog
CatalogApi	RetrieveCatalogObject	Get /v2/catalog/object/{object_id}	RetrieveCatalogObject
CatalogApi	SearchCatalogItems	Post /v2/catalog/search-catalog-items	SearchCatalogItems
CatalogApi	SearchCatalogObjects	Post /v2/catalog/search	SearchCatalogObjects
CatalogApi	UpdateItemModifierLists	Post /v2/catalog/update-item-modifier-lists	UpdateItemModifierLists
CatalogApi	UpdateItemTaxes	Post /v2/catalog/update-item-taxes	UpdateItemTaxes
CatalogApi	UpsertCatalogObject	Post /v2/catalog/object	UpsertCatalogObject
CheckoutApi	CreateCheckout	Post /v2/locations/{location_id}/checkouts	CreateCheckout
CheckoutApi	CreatePaymentLink	Post /v2/online-checkout/payment-links	CreatePaymentLink
CheckoutApi	DeletePaymentLink	Delete /v2/online-checkout/payment-links/{id}	DeletePaymentLink
CheckoutApi	ListPaymentLinks	Get /v2/online-checkout/payment-links	ListPaymentLinks
CheckoutApi	RetrieveLocationSettings	Get /v2/online-checkout/location-settings/{location_id}	RetrieveLocationSettings
CheckoutApi	RetrieveMerchantSettings	Get /v2/online-checkout/merchant-settings	RetrieveMerchantSettings
CheckoutApi	RetrievePaymentLink	Get /v2/online-checkout/payment-links/{id}	RetrievePaymentLink
CheckoutApi	UpdateLocationSettings	Put /v2/online-checkout/location-settings/{location_id}	UpdateLocationSettings
CheckoutApi	UpdateMerchantSettings	Put /v2/online-checkout/merchant-settings	UpdateMerchantSettings
CheckoutApi	UpdatePaymentLink	Put /v2/online-checkout/payment-links/{id}	UpdatePaymentLink
CustomerCustomAttributesApi	BulkUpsertCustomerCustomAttributes	Post /v2/customers/custom-attributes/bulk-upsert	BulkUpsertCustomerCustomAttributes
CustomerCustomAttributesApi	CreateCustomerCustomAttributeDefinition	Post /v2/customers/custom-attribute-definitions	CreateCustomerCustomAttributeDefinition
CustomerCustomAttributesApi	DeleteCustomerCustomAttribute	Delete /v2/customers/{customer_id}/custom-attributes/{key}	DeleteCustomerCustomAttribute
CustomerCustomAttributesApi	DeleteCustomerCustomAttributeDefinition	Delete /v2/customers/custom-attribute-definitions/{key}	DeleteCustomerCustomAttributeDefinition
CustomerCustomAttributesApi	ListCustomerCustomAttributeDefinitions	Get /v2/customers/custom-attribute-definitions	ListCustomerCustomAttributeDefinitions
CustomerCustomAttributesApi	ListCustomerCustomAttributes	Get /v2/customers/{customer_id}/custom-attributes	ListCustomerCustomAttributes
CustomerCustomAttributesApi	RetrieveCustomerCustomAttribute	Get /v2/customers/{customer_id}/custom-attributes/{key}	RetrieveCustomerCustomAttribute
CustomerCustomAttributesApi	RetrieveCustomerCustomAttributeDefinition	Get /v2/customers/custom-attribute-definitions/{key}	RetrieveCustomerCustomAttributeDefinition
CustomerCustomAttributesApi	UpdateCustomerCustomAttributeDefinition	Put /v2/customers/custom-attribute-definitions/{key}	UpdateCustomerCustomAttributeDefinition
CustomerCustomAttributesApi	UpsertCustomerCustomAttribute	Post /v2/customers/{customer_id}/custom-attributes/{key}	UpsertCustomerCustomAttribute
CustomerGroupsApi	CreateCustomerGroup	Post /v2/customers/groups	CreateCustomerGroup
CustomerGroupsApi	DeleteCustomerGroup	Delete /v2/customers/groups/{group_id}	DeleteCustomerGroup
CustomerGroupsApi	ListCustomerGroups	Get /v2/customers/groups	ListCustomerGroups
CustomerGroupsApi	RetrieveCustomerGroup	Get /v2/customers/groups/{group_id}	RetrieveCustomerGroup
CustomerGroupsApi	UpdateCustomerGroup	Put /v2/customers/groups/{group_id}	UpdateCustomerGroup
CustomerSegmentsApi	ListCustomerSegments	Get /v2/customers/segments	ListCustomerSegments
CustomerSegmentsApi	RetrieveCustomerSegment	Get /v2/customers/segments/{segment_id}	RetrieveCustomerSegment
CustomersApi	AddGroupToCustomer	Put /v2/customers/{customer_id}/groups/{group_id}	AddGroupToCustomer
CustomersApi	BulkCreateCustomers	Post /v2/customers/bulk-create	BulkCreateCustomers
CustomersApi	BulkDeleteCustomers	Post /v2/customers/bulk-delete	BulkDeleteCustomers
CustomersApi	BulkRetrieveCustomers	Post /v2/customers/bulk-retrieve	BulkRetrieveCustomers
CustomersApi	BulkUpdateCustomers	Post /v2/customers/bulk-update	BulkUpdateCustomers
CustomersApi	CreateCustomer	Post /v2/customers	CreateCustomer
CustomersApi	CreateCustomerCard	Post /v2/customers/{customer_id}/cards	CreateCustomerCard
CustomersApi	DeleteCustomer	Delete /v2/customers/{customer_id}	DeleteCustomer
CustomersApi	DeleteCustomerCard	Delete /v2/customers/{customer_id}/cards/{card_id}	DeleteCustomerCard
CustomersApi	ListCustomers	Get /v2/customers	ListCustomers
CustomersApi	RemoveGroupFromCustomer	Delete /v2/customers/{customer_id}/groups/{group_id}	RemoveGroupFromCustomer
CustomersApi	RetrieveCustomer	Get /v2/customers/{customer_id}	RetrieveCustomer
CustomersApi	SearchCustomers	Post /v2/customers/search	SearchCustomers
CustomersApi	UpdateCustomer	Put /v2/customers/{customer_id}	UpdateCustomer
DevicesApi	CreateDeviceCode	Post /v2/devices/codes	CreateDeviceCode
DevicesApi	GetDevice	Get /v2/devices/{device_id}	GetDevice
DevicesApi	GetDeviceCode	Get /v2/devices/codes/{id}	GetDeviceCode
DevicesApi	ListDeviceCodes	Get /v2/devices/codes	ListDeviceCodes
DevicesApi	ListDevices	Get /v2/devices	ListDevices
DisputesApi	AcceptDispute	Post /v2/disputes/{dispute_id}/accept	AcceptDispute
DisputesApi	CreateDisputeEvidenceText	Post /v2/disputes/{dispute_id}/evidence-text	CreateDisputeEvidenceText
DisputesApi	DeleteDisputeEvidence	Delete /v2/disputes/{dispute_id}/evidence/{evidence_id}	DeleteDisputeEvidence
DisputesApi	ListDisputeEvidence	Get /v2/disputes/{dispute_id}/evidence	ListDisputeEvidence
DisputesApi	ListDisputes	Get /v2/disputes	ListDisputes
DisputesApi	RetrieveDispute	Get /v2/disputes/{dispute_id}	RetrieveDispute
DisputesApi	RetrieveDisputeEvidence	Get /v2/disputes/{dispute_id}/evidence/{evidence_id}	RetrieveDisputeEvidence
DisputesApi	SubmitEvidence	Post /v2/disputes/{dispute_id}/submit-evidence	SubmitEvidence
EmployeesApi	ListEmployees	Get /v2/employees	ListEmployees
EmployeesApi	RetrieveEmployee	Get /v2/employees/{id}	RetrieveEmployee
EventsApi	DisableEvents	Put /v2/events/disable	DisableEvents
EventsApi	EnableEvents	Put /v2/events/enable	EnableEvents
EventsApi	ListEventTypes	Get /v2/events/types	ListEventTypes
EventsApi	SearchEvents	Post /v2/events	SearchEvents
GiftCardActivitiesApi	CreateGiftCardActivity	Post /v2/gift-cards/activities	CreateGiftCardActivity
GiftCardActivitiesApi	ListGiftCardActivities	Get /v2/gift-cards/activities	ListGiftCardActivities
GiftCardsApi	CreateGiftCard	Post /v2/gift-cards	CreateGiftCard
GiftCardsApi	LinkCustomerToGiftCard	Post /v2/gift-cards/{gift_card_id}/link-customer	LinkCustomerToGiftCard
GiftCardsApi	ListGiftCards	Get /v2/gift-cards	ListGiftCards
GiftCardsApi	RetrieveGiftCard	Get /v2/gift-cards/{id}	RetrieveGiftCard
GiftCardsApi	RetrieveGiftCardFromGAN	Post /v2/gift-cards/from-gan	RetrieveGiftCardFromGAN
GiftCardsApi	RetrieveGiftCardFromNonce	Post /v2/gift-cards/from-nonce	RetrieveGiftCardFromNonce
GiftCardsApi	UnlinkCustomerFromGiftCard	Post /v2/gift-cards/{gift_card_id}/unlink-customer	UnlinkCustomerFromGiftCard
InventoryApi	BatchChangeInventory	Post /v2/inventory/changes/batch-create	BatchChangeInventory
InventoryApi	BatchRetrieveInventoryChanges	Post /v2/inventory/changes/batch-retrieve	BatchRetrieveInventoryChanges
InventoryApi	BatchRetrieveInventoryCounts	Post /v2/inventory/counts/batch-retrieve	BatchRetrieveInventoryCounts
InventoryApi	DeprecatedBatchChangeInventory	Post /v2/inventory/batch-change	DeprecatedBatchChangeInventory
InventoryApi	DeprecatedBatchRetrieveInventoryChanges	Post /v2/inventory/batch-retrieve-changes	DeprecatedBatchRetrieveInventoryChanges
InventoryApi	DeprecatedBatchRetrieveInventoryCounts	Post /v2/inventory/batch-retrieve-counts	DeprecatedBatchRetrieveInventoryCounts
InventoryApi	DeprecatedRetrieveInventoryAdjustment	Get /v2/inventory/adjustment/{adjustment_id}	DeprecatedRetrieveInventoryAdjustment
InventoryApi	DeprecatedRetrieveInventoryPhysicalCount	Get /v2/inventory/physical-count/{physical_count_id}	DeprecatedRetrieveInventoryPhysicalCount
InventoryApi	RetrieveInventoryAdjustment	Get /v2/inventory/adjustments/{adjustment_id}	RetrieveInventoryAdjustment
InventoryApi	RetrieveInventoryChanges	Get /v2/inventory/{catalog_object_id}/changes	RetrieveInventoryChanges
InventoryApi	RetrieveInventoryCount	Get /v2/inventory/{catalog_object_id}	RetrieveInventoryCount
InventoryApi	RetrieveInventoryPhysicalCount	Get /v2/inventory/physical-counts/{physical_count_id}	RetrieveInventoryPhysicalCount
InventoryApi	RetrieveInventoryTransfer	Get /v2/inventory/transfers/{transfer_id}	RetrieveInventoryTransfer
InvoicesApi	CancelInvoice	Post /v2/invoices/{invoice_id}/cancel	CancelInvoice
InvoicesApi	CreateInvoice	Post /v2/invoices	CreateInvoice
InvoicesApi	DeleteInvoice	Delete /v2/invoices/{invoice_id}	DeleteInvoice
InvoicesApi	DeleteInvoiceAttachment	Delete /v2/invoices/{invoice_id}/attachments/{attachment_id}	DeleteInvoiceAttachment
InvoicesApi	GetInvoice	Get /v2/invoices/{invoice_id}	GetInvoice
InvoicesApi	ListInvoices	Get /v2/invoices	ListInvoices
InvoicesApi	PublishInvoice	Post /v2/invoices/{invoice_id}/publish	PublishInvoice
InvoicesApi	SearchInvoices	Post /v2/invoices/search	SearchInvoices
InvoicesApi	UpdateInvoice	Put /v2/invoices/{invoice_id}	UpdateInvoice
LaborApi	CreateBreakType	Post /v2/labor/break-types	CreateBreakType
LaborApi	CreateShift	Post /v2/labor/shifts	CreateShift
LaborApi	DeleteBreakType	Delete /v2/labor/break-types/{id}	DeleteBreakType
LaborApi	DeleteShift	Delete /v2/labor/shifts/{id}	DeleteShift
LaborApi	GetBreakType	Get /v2/labor/break-types/{id}	GetBreakType
LaborApi	GetEmployeeWage	Get /v2/labor/employee-wages/{id}	GetEmployeeWage
LaborApi	GetShift	Get /v2/labor/shifts/{id}	GetShift
LaborApi	GetTeamMemberWage	Get /v2/labor/team-member-wages/{id}	GetTeamMemberWage
LaborApi	ListBreakTypes	Get /v2/labor/break-types	ListBreakTypes
LaborApi	ListEmployeeWages	Get /v2/labor/employee-wages	ListEmployeeWages
LaborApi	ListTeamMemberWages	Get /v2/labor/team-member-wages	ListTeamMemberWages
LaborApi	ListWorkweekConfigs	Get /v2/labor/workweek-configs	ListWorkweekConfigs
LaborApi	SearchShifts	Post /v2/labor/shifts/search	SearchShifts
LaborApi	UpdateBreakType	Put /v2/labor/break-types/{id}	UpdateBreakType
LaborApi	UpdateShift	Put /v2/labor/shifts/{id}	UpdateShift
LaborApi	UpdateWorkweekConfig	Put /v2/labor/workweek-configs/{id}	UpdateWorkweekConfig
LocationCustomAttributesApi	BulkDeleteLocationCustomAttributes	Post /v2/locations/custom-attributes/bulk-delete	BulkDeleteLocationCustomAttributes
LocationCustomAttributesApi	BulkUpsertLocationCustomAttributes	Post /v2/locations/custom-attributes/bulk-upsert	BulkUpsertLocationCustomAttributes
LocationCustomAttributesApi	CreateLocationCustomAttributeDefinition	Post /v2/locations/custom-attribute-definitions	CreateLocationCustomAttributeDefinition
LocationCustomAttributesApi	DeleteLocationCustomAttribute	Delete /v2/locations/{location_id}/custom-attributes/{key}	DeleteLocationCustomAttribute
LocationCustomAttributesApi	DeleteLocationCustomAttributeDefinition	Delete /v2/locations/custom-attribute-definitions/{key}	DeleteLocationCustomAttributeDefinition
LocationCustomAttributesApi	ListLocationCustomAttributeDefinitions	Get /v2/locations/custom-attribute-definitions	ListLocationCustomAttributeDefinitions
LocationCustomAttributesApi	ListLocationCustomAttributes	Get /v2/locations/{location_id}/custom-attributes	ListLocationCustomAttributes
LocationCustomAttributesApi	RetrieveLocationCustomAttribute	Get /v2/locations/{location_id}/custom-attributes/{key}	RetrieveLocationCustomAttribute
LocationCustomAttributesApi	RetrieveLocationCustomAttributeDefinition	Get /v2/locations/custom-attribute-definitions/{key}	RetrieveLocationCustomAttributeDefinition
LocationCustomAttributesApi	UpdateLocationCustomAttributeDefinition	Put /v2/locations/custom-attribute-definitions/{key}	UpdateLocationCustomAttributeDefinition
LocationCustomAttributesApi	UpsertLocationCustomAttribute	Post /v2/locations/{location_id}/custom-attributes/{key}	UpsertLocationCustomAttribute
LocationsApi	CreateLocation	Post /v2/locations	CreateLocation
LocationsApi	ListLocations	Get /v2/locations	ListLocations
LocationsApi	RetrieveLocation	Get /v2/locations/{location_id}	RetrieveLocation
LocationsApi	UpdateLocation	Put /v2/locations/{location_id}	UpdateLocation
LoyaltyApi	AccumulateLoyaltyPoints	Post /v2/loyalty/accounts/{account_id}/accumulate	AccumulateLoyaltyPoints
LoyaltyApi	AdjustLoyaltyPoints	Post /v2/loyalty/accounts/{account_id}/adjust	AdjustLoyaltyPoints
LoyaltyApi	CalculateLoyaltyPoints	Post /v2/loyalty/programs/{program_id}/calculate	CalculateLoyaltyPoints
LoyaltyApi	CancelLoyaltyPromotion	Post /v2/loyalty/programs/{program_id}/promotions/{promotion_id}/cancel	CancelLoyaltyPromotion
LoyaltyApi	CreateLoyaltyAccount	Post /v2/loyalty/accounts	CreateLoyaltyAccount
LoyaltyApi	CreateLoyaltyPromotion	Post /v2/loyalty/programs/{program_id}/promotions	CreateLoyaltyPromotion
LoyaltyApi	CreateLoyaltyReward	Post /v2/loyalty/rewards	CreateLoyaltyReward
LoyaltyApi	DeleteLoyaltyReward	Delete /v2/loyalty/rewards/{reward_id}	DeleteLoyaltyReward
LoyaltyApi	ListLoyaltyPrograms	Get /v2/loyalty/programs	ListLoyaltyPrograms
LoyaltyApi	ListLoyaltyPromotions	Get /v2/loyalty/programs/{program_id}/promotions	ListLoyaltyPromotions
LoyaltyApi	RedeemLoyaltyReward	Post /v2/loyalty/rewards/{reward_id}/redeem	RedeemLoyaltyReward
LoyaltyApi	RetrieveLoyaltyAccount	Get /v2/loyalty/accounts/{account_id}	RetrieveLoyaltyAccount
LoyaltyApi	RetrieveLoyaltyProgram	Get /v2/loyalty/programs/{program_id}	RetrieveLoyaltyProgram
LoyaltyApi	RetrieveLoyaltyPromotion	Get /v2/loyalty/programs/{program_id}/promotions/{promotion_id}	RetrieveLoyaltyPromotion
LoyaltyApi	RetrieveLoyaltyReward	Get /v2/loyalty/rewards/{reward_id}	RetrieveLoyaltyReward
LoyaltyApi	SearchLoyaltyAccounts	Post /v2/loyalty/accounts/search	SearchLoyaltyAccounts
LoyaltyApi	SearchLoyaltyEvents	Post /v2/loyalty/events/search	SearchLoyaltyEvents
LoyaltyApi	SearchLoyaltyRewards	Post /v2/loyalty/rewards/search	SearchLoyaltyRewards
MerchantCustomAttributesApi	BulkDeleteMerchantCustomAttributes	Post /v2/merchants/custom-attributes/bulk-delete	BulkDeleteMerchantCustomAttributes
MerchantCustomAttributesApi	BulkUpsertMerchantCustomAttributes	Post /v2/merchants/custom-attributes/bulk-upsert	BulkUpsertMerchantCustomAttributes
MerchantCustomAttributesApi	CreateMerchantCustomAttributeDefinition	Post /v2/merchants/custom-attribute-definitions	CreateMerchantCustomAttributeDefinition
MerchantCustomAttributesApi	DeleteMerchantCustomAttribute	Delete /v2/merchants/{merchant_id}/custom-attributes/{key}	DeleteMerchantCustomAttribute
MerchantCustomAttributesApi	DeleteMerchantCustomAttributeDefinition	Delete /v2/merchants/custom-attribute-definitions/{key}	DeleteMerchantCustomAttributeDefinition
MerchantCustomAttributesApi	ListMerchantCustomAttributeDefinitions	Get /v2/merchants/custom-attribute-definitions	ListMerchantCustomAttributeDefinitions
MerchantCustomAttributesApi	ListMerchantCustomAttributes	Get /v2/merchants/{merchant_id}/custom-attributes	ListMerchantCustomAttributes
MerchantCustomAttributesApi	RetrieveMerchantCustomAttribute	Get /v2/merchants/{merchant_id}/custom-attributes/{key}	RetrieveMerchantCustomAttribute
MerchantCustomAttributesApi	RetrieveMerchantCustomAttributeDefinition	Get /v2/merchants/custom-attribute-definitions/{key}	RetrieveMerchantCustomAttributeDefinition
MerchantCustomAttributesApi	UpdateMerchantCustomAttributeDefinition	Put /v2/merchants/custom-attribute-definitions/{key}	UpdateMerchantCustomAttributeDefinition
MerchantCustomAttributesApi	UpsertMerchantCustomAttribute	Post /v2/merchants/{merchant_id}/custom-attributes/{key}	UpsertMerchantCustomAttribute
MerchantsApi	ListMerchants	Get /v2/merchants	ListMerchants
MerchantsApi	RetrieveMerchant	Get /v2/merchants/{merchant_id}	RetrieveMerchant
MobileAuthorizationApi	CreateMobileAuthorizationCode	Post /mobile/authorization-code	CreateMobileAuthorizationCode
OAuthApi	ObtainToken	Post /oauth2/token	ObtainToken
OAuthApi	RetrieveTokenStatus	Post /oauth2/token/status	RetrieveTokenStatus
OAuthApi	RevokeToken	Post /oauth2/revoke	RevokeToken
OrderCustomAttributesApi	BulkDeleteOrderCustomAttributes	Post /v2/orders/custom-attributes/bulk-delete	BulkDeleteOrderCustomAttributes
OrderCustomAttributesApi	BulkUpsertOrderCustomAttributes	Post /v2/orders/custom-attributes/bulk-upsert	BulkUpsertOrderCustomAttributes
OrderCustomAttributesApi	CreateOrderCustomAttributeDefinition	Post /v2/orders/custom-attribute-definitions	CreateOrderCustomAttributeDefinition
OrderCustomAttributesApi	DeleteOrderCustomAttribute	Delete /v2/orders/{order_id}/custom-attributes/{custom_attribute_key}	DeleteOrderCustomAttribute
OrderCustomAttributesApi	DeleteOrderCustomAttributeDefinition	Delete /v2/orders/custom-attribute-definitions/{key}	DeleteOrderCustomAttributeDefinition
OrderCustomAttributesApi	ListOrderCustomAttributeDefinitions	Get /v2/orders/custom-attribute-definitions	ListOrderCustomAttributeDefinitions
OrderCustomAttributesApi	ListOrderCustomAttributes	Get /v2/orders/{order_id}/custom-attributes	ListOrderCustomAttributes
OrderCustomAttributesApi	RetrieveOrderCustomAttribute	Get /v2/orders/{order_id}/custom-attributes/{custom_attribute_key}	RetrieveOrderCustomAttribute
OrderCustomAttributesApi	RetrieveOrderCustomAttributeDefinition	Get /v2/orders/custom-attribute-definitions/{key}	RetrieveOrderCustomAttributeDefinition
OrderCustomAttributesApi	UpdateOrderCustomAttributeDefinition	Put /v2/orders/custom-attribute-definitions/{key}	UpdateOrderCustomAttributeDefinition
OrderCustomAttributesApi	UpsertOrderCustomAttribute	Post /v2/orders/{order_id}/custom-attributes/{custom_attribute_key}	UpsertOrderCustomAttribute
OrdersApi	BatchRetrieveOrders	Post /v2/orders/batch-retrieve	BatchRetrieveOrders
OrdersApi	CalculateOrder	Post /v2/orders/calculate	CalculateOrder
OrdersApi	CloneOrder	Post /v2/orders/clone	CloneOrder
OrdersApi	CreateOrder	Post /v2/orders	CreateOrder
OrdersApi	PayOrder	Post /v2/orders/{order_id}/pay	PayOrder
OrdersApi	RetrieveOrder	Get /v2/orders/{order_id}	RetrieveOrder
OrdersApi	SearchOrders	Post /v2/orders/search	SearchOrders
OrdersApi	UpdateOrder	Put /v2/orders/{order_id}	UpdateOrder
PaymentsApi	CancelPayment	Post /v2/payments/{payment_id}/cancel	CancelPayment
PaymentsApi	CancelPaymentByIdempotencyKey	Post /v2/payments/cancel	CancelPaymentByIdempotencyKey
PaymentsApi	CompletePayment	Post /v2/payments/{payment_id}/complete	CompletePayment
PaymentsApi	CreatePayment	Post /v2/payments	CreatePayment
PaymentsApi	GetPayment	Get /v2/payments/{payment_id}	GetPayment
PaymentsApi	ListPayments	Get /v2/payments	ListPayments
PaymentsApi	UpdatePayment	Put /v2/payments/{payment_id}	UpdatePayment
PayoutsApi	GetPayout	Get /v2/payouts/{payout_id}	GetPayout
PayoutsApi	ListPayoutEntries	Get /v2/payouts/{payout_id}/payout-entries	ListPayoutEntries
PayoutsApi	ListPayouts	Get /v2/payouts	ListPayouts
RefundsApi	GetPaymentRefund	Get /v2/refunds/{refund_id}	GetPaymentRefund
RefundsApi	ListPaymentRefunds	Get /v2/refunds	ListPaymentRefunds
RefundsApi	RefundPayment	Post /v2/refunds	RefundPayment
SitesApi	ListSites	Get /v2/sites	ListSites
SnippetsApi	DeleteSnippet	Delete /v2/sites/{site_id}/snippet	DeleteSnippet
SnippetsApi	RetrieveSnippet	Get /v2/sites/{site_id}/snippet	RetrieveSnippet
SnippetsApi	UpsertSnippet	Post /v2/sites/{site_id}/snippet	UpsertSnippet
SubscriptionsApi	BulkSwapPlan	Post /v2/subscriptions/bulk-swap-plan	BulkSwapPlan
SubscriptionsApi	CancelSubscription	Post /v2/subscriptions/{subscription_id}/cancel	CancelSubscription
SubscriptionsApi	ChangeBillingAnchorDate	Post /v2/subscriptions/{subscription_id}/billing-anchor	ChangeBillingAnchorDate
SubscriptionsApi	CreateSubscription	Post /v2/subscriptions	CreateSubscription
SubscriptionsApi	DeleteSubscriptionAction	Delete /v2/subscriptions/{subscription_id}/actions/{action_id}	DeleteSubscriptionAction
SubscriptionsApi	ListSubscriptionEvents	Get /v2/subscriptions/{subscription_id}/events	ListSubscriptionEvents
SubscriptionsApi	PauseSubscription	Post /v2/subscriptions/{subscription_id}/pause	PauseSubscription
SubscriptionsApi	ResumeSubscription	Post /v2/subscriptions/{subscription_id}/resume	ResumeSubscription
SubscriptionsApi	RetrieveSubscription	Get /v2/subscriptions/{subscription_id}	RetrieveSubscription
SubscriptionsApi	SearchSubscriptions	Post /v2/subscriptions/search	SearchSubscriptions
SubscriptionsApi	SwapPlan	Post /v2/subscriptions/{subscription_id}/swap-plan	SwapPlan
SubscriptionsApi	UpdateSubscription	Put /v2/subscriptions/{subscription_id}	UpdateSubscription
TeamApi	BulkCreateTeamMembers	Post /v2/team-members/bulk-create	BulkCreateTeamMembers
TeamApi	BulkUpdateTeamMembers	Post /v2/team-members/bulk-update	BulkUpdateTeamMembers
TeamApi	CreateTeamMember	Post /v2/team-members	CreateTeamMember
TeamApi	RetrieveTeamMember	Get /v2/team-members/{team_member_id}	RetrieveTeamMember
TeamApi	RetrieveWageSetting	Get /v2/team-members/{team_member_id}/wage-setting	RetrieveWageSetting
TeamApi	SearchTeamMembers	Post /v2/team-members/search	SearchTeamMembers
TeamApi	UpdateTeamMember	Put /v2/team-members/{team_member_id}	UpdateTeamMember
TeamApi	UpdateWageSetting	Put /v2/team-members/{team_member_id}/wage-setting	UpdateWageSetting
TerminalApi	CancelTerminalAction	Post /v2/terminals/actions/{action_id}/cancel	CancelTerminalAction
TerminalApi	CancelTerminalCheckout	Post /v2/terminals/checkouts/{checkout_id}/cancel	CancelTerminalCheckout
TerminalApi	CancelTerminalRefund	Post /v2/terminals/refunds/{terminal_refund_id}/cancel	CancelTerminalRefund
TerminalApi	CreateTerminalAction	Post /v2/terminals/actions	CreateTerminalAction
TerminalApi	CreateTerminalCheckout	Post /v2/terminals/checkouts	CreateTerminalCheckout
TerminalApi	CreateTerminalRefund	Post /v2/terminals/refunds	CreateTerminalRefund
TerminalApi	DismissTerminalAction	Post /v2/terminals/actions/{action_id}/dismiss	DismissTerminalAction
TerminalApi	DismissTerminalCheckout	Post /v2/terminals/checkouts/{checkout_id}/dismiss	DismissTerminalCheckout
TerminalApi	DismissTerminalRefund	Post /v2/terminals/refunds/{terminal_refund_id}/dismiss	DismissTerminalRefund
TerminalApi	GetTerminalAction	Get /v2/terminals/actions/{action_id}	GetTerminalAction
TerminalApi	GetTerminalCheckout	Get /v2/terminals/checkouts/{checkout_id}	GetTerminalCheckout
TerminalApi	GetTerminalRefund	Get /v2/terminals/refunds/{terminal_refund_id}	GetTerminalRefund
TerminalApi	SearchTerminalActions	Post /v2/terminals/actions/search	SearchTerminalActions
TerminalApi	SearchTerminalCheckouts	Post /v2/terminals/checkouts/search	SearchTerminalCheckouts
TerminalApi	SearchTerminalRefunds	Post /v2/terminals/refunds/search	SearchTerminalRefunds
TransactionsApi	CaptureTransaction	Post /v2/locations/{location_id}/transactions/{transaction_id}/capture	CaptureTransaction
TransactionsApi	ListTransactions	Get /v2/locations/{location_id}/transactions	ListTransactions
TransactionsApi	RetrieveTransaction	Get /v2/locations/{location_id}/transactions/{transaction_id}	RetrieveTransaction
TransactionsApi	VoidTransaction	Post /v2/locations/{location_id}/transactions/{transaction_id}/void	VoidTransaction
V1TransactionsApi	V1ListOrders	Get /v1/{location_id}/orders	V1ListOrders
V1TransactionsApi	V1RetrieveOrder	Get /v1/{location_id}/orders/{order_id}	V1RetrieveOrder
V1TransactionsApi	V1UpdateOrder	Put /v1/{location_id}/orders/{order_id}	V1UpdateOrder
VendorsApi	BulkCreateVendors	Post /v2/vendors/bulk-create	BulkCreateVendors
VendorsApi	BulkRetrieveVendors	Post /v2/vendors/bulk-retrieve	BulkRetrieveVendors
VendorsApi	BulkUpdateVendors	Put /v2/vendors/bulk-update	BulkUpdateVendors
VendorsApi	CreateVendor	Post /v2/vendors/create	CreateVendor
VendorsApi	RetrieveVendor	Get /v2/vendors/{vendor_id}	RetrieveVendor
VendorsApi	SearchVendors	Post /v2/vendors/search	SearchVendors
VendorsApi	UpdateVendor	Put /v2/vendors/{vendor_id}	UpdateVendor
WebhookSubscriptionsApi	CreateWebhookSubscription	Post /v2/webhooks/subscriptions	CreateWebhookSubscription
WebhookSubscriptionsApi	DeleteWebhookSubscription	Delete /v2/webhooks/subscriptions/{subscription_id}	DeleteWebhookSubscription
WebhookSubscriptionsApi	ListWebhookEventTypes	Get /v2/webhooks/event-types	ListWebhookEventTypes
WebhookSubscriptionsApi	ListWebhookSubscriptions	Get /v2/webhooks/subscriptions	ListWebhookSubscriptions
WebhookSubscriptionsApi	RetrieveWebhookSubscription	Get /v2/webhooks/subscriptions/{subscription_id}	RetrieveWebhookSubscription
WebhookSubscriptionsApi	TestWebhookSubscription	Post /v2/webhooks/subscriptions/{subscription_id}/test	TestWebhookSubscription
WebhookSubscriptionsApi	UpdateWebhookSubscription	Put /v2/webhooks/subscriptions/{subscription_id}	UpdateWebhookSubscription
WebhookSubscriptionsApi	UpdateWebhookSubscriptionSignatureKey	Post /v2/webhooks/subscriptions/{subscription_id}/signature-key	UpdateWebhookSubscriptionSignatureKey

Documentation For Models

Documentation For Authorization

oauth2

Type: OAuth
Flow: accessCode
Authorization URL: https://connect.squareup.com/oauth2/authorize
Scopes:
BANK_ACCOUNTS_READ: HTTP Method: `GET`

Grants read access to bank account information associated with the targeted Square account. For example, to call the Connect v1 ListBankAccounts endpoint.

CASH_DRAWER_READ: HTTP Method: `GET`

Grants read access to cash drawer shift information. For example, to call the ListCashDrawerShifts endpoint.

CUSTOMERS_READ: HTTP Method: `GET`

Grants read access to customer information. For example, to call the ListCustomers endpoint.

CUSTOMERS_WRITE: HTTP Method: `POST`, `PUT`, `DELETE`

Grants write access to customer information. For example, to create and update customer profiles.

DEVICE_CREDENTIAL_MANAGEMENT: HTTP Method: `POST`, `GET`

Grants read/write access to device credentials information. For example, to call the CreateDeviceCode endpoint.

EMPLOYEES_READ: HTTP Method: `GET`

Grants read access to employee profile information. For example, to call the Connect v1 Employees API.

EMPLOYEES_WRITE: HTTP Method: `POST`, `PUT`, `DELETE`

Grants write access to employee profile information. For example, to create and modify employee profiles.

INVENTORY_READ: HTTP Method: `GET`

Grants read access to inventory information. For example, to call the RetrieveInventoryCount endpoint.

INVENTORY_WRITE: HTTP Method: `POST`, `PUT`, `DELETE`

Grants write access to inventory information. For example, to call the BatchChangeInventory endpoint.

ITEMS_READ: HTTP Method: `GET`

Grants read access to product catalog information. For example, to obtain objects in a product catalog.

ITEMS_WRITE: HTTP Method: `POST`, `PUT`, `DELETE`

Grants write access to product catalog information. For example, to modify or add to a product catalog.

LOYALTY_READ: HTTP Method: `GET`

Grants read access to loyalty information. For example, to call the ListLoyaltyPrograms endpoint.

LOYALTY_WRITE: HTTP Method: `POST`, `PUT`, `DELETE`

Grants write access to loyalty information. For example, to call the CreateLoyaltyAccount endpoint.

MERCHANT_PROFILE_READ: HTTP Method: `GET`

Grants read access to business and location information. For example, to obtain a location ID for subsequent activity.

ORDERS_READ: HTTP Method: `GET`

Grants read access to order information. For example, to call the BatchRetrieveOrders endpoint.

ORDERS_WRITE: HTTP Method: `POST`, `PUT`, `DELETE`

Grants write access to order information. For example, to call the CreateCheckout endpoint.

PAYMENTS_READ: HTTP Method: `GET`

Grants read access to transaction and refund information. For example, to call the RetrieveTransaction endpoint.

PAYMENTS_WRITE: HTTP Method: `POST`, `PUT`, `DELETE`

Grants write access to transaction and refunds information. For example, to process payments with the Payments or Checkout API.

PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS: HTTP Method: `POST`, `PUT`, `DELETE`

Allow third party applications to deduct a portion of each transaction amount. Required to use multiparty transaction functionality with the Payments API.

PAYMENTS_WRITE_IN_PERSON: HTTP Method: `POST`, `PUT`, `DELETE`

Grants write access to payments and refunds information. For example, to process in-person payments.

SETTLEMENTS_READ: HTTP Method: `GET`

Grants read access to settlement (deposit) information. For example, to call the Connect v1 ListSettlements endpoint.

TIMECARDS_READ: HTTP Method: `GET`

Grants read access to employee timecard information. For example, to call the Connect v2 SearchShifts endpoint.

TIMECARDS_WRITE: HTTP Method: `POST`, `PUT`, `DELETE`

Grants write access to employee shift information. For example, to create and modify employee shifts.

TIMECARDS_SETTINGS_READ: HTTP Method: `GET`

Grants read access to employee timecard settings information. For example, to call the GetBreakType endpoint.

TIMECARDS_SETTINGS_WRITE: HTTP Method: `POST`, `PUT`, `DELETE`

Grants write access to employee timecard settings information. For example, to call the UpdateBreakType endpoint.

APPOINTMENTS_READ: HTTP Method: `GET`, `POST`

Grants read access to booking information. For example, to call the RetrieveBooking endpoint.

APPOINTMENTS_WRITE: HTTP Method: `POST`, `PUT`, `DELETE`

Grants write access to booking information. For example, to call the CreateBooking endpoint.

APPOINTMENTS_BUSINESS_SETTINGS_READ: HTTP Method: `GET`

Grants read access to booking business settings. For example, to call the ListTeamMemberBookingProfiles endpoint.

INVOICES_READ: HTTP Method: `GET`, `POST`

Grants read access to invoice information. For example, to call the ListInvoices endpoint.

INVOICES_WRITE: HTTP Method: `POST`, `PUT`, `DELETE`

Grants write access to invoice information. For example, to call the CreateInvoice endpoint.

SUBSCRIPTIONS_READ: HTTP Method: `GET`, `POST`

Grants read access to subscription information. For example, to call the RetrieveSubscription endpoint.

SUBSCRIPTIONS_WRITE: HTTP Method: `POST`, `PUT`, `DELETE`

Grants write access to subscription information. For example, to call the CreateSubscription endpoint.

DISPUTES_READ: HTTP Method: `GET`

Grants read access to dispute information. For example, to call the RetrieveDispute endpoint.

DISPUTES_WRITE: HTTP Method: `POST`, `PUT`, `DELETE`

Grants write access to dispute information. For example, to call the SubmitEvidence endpoint.

GIFTCARDS_READ: HTTP Method: `GET`, `POST`

Grants read access to gift card information. For example, to call the RetrieveGiftCard endpoint.

GIFTCARDS_WRITE: HTTP Method: `POST`, `PUT`, `DELETE`

Grants write access to gift card information. For example, to call the CreateGiftCard endpoint.

ONLINE_STORE_SNIPPETS_WRITE: HTTP Method: `POST`, `PUT`, `DELETE`

Write access to ECOM online store snippets on published websites.

ONLINE_STORE_SNIPPETS_READ: HTTP Method: `GET`, `POST`

Read access to ECOM online store snippets on published websites.

ONLINE_STORE_SITE_READ: HTTP Method: `GET`, `POST`

Read access to ECOM online store site details.

PAYMENTS_WRITE_SHARED_ONFILE: HTTP Method: `POST`, `PUT`, `DELETE`

Allows the developer to process payments on behalf of a seller using a shared on file payment method.

APPOINTMENTS_ALL_READ: HTTP Method: `GET`, `POST`

Grants read access to all of a seller's booking information, calendar, and business details. This permission must be accompanied by the `APPOINTMENTS_READ` permission.

APPOINTMENTS_ALL_WRITE: HTTP Method: `POST`, `PUT`, `DELETE`

Grants write access to all booking details, including double-booking a seller. This permission must be accompanied by the `APPOINTMENTS_WRITE` permission.

MERCHANT_PROFILE_WRITE: HTTP Method: `POST`, `PUT`

Grants write access to business and location information. For example, to create a new location or update the business hours at an existing location.

VENDOR_READ: HTTP Method: `GET`, `POST`

Grants read access to vendor information, for example, when calling the `RetrieveVendor` endpoint.

VENDOR_WRITE: HTTP Method: `POST`, `PUT`, `DELETE`

Grants write access to vendor information, for example, when calling the `BulkUpdateVendors` endpoint.

PAYOUTS_READ: HTTP Method: `GET`

Grants read access to payouts and payout entries information. For example, to call the Connect v2 `ListPayouts` endpoint.

RESERVATIONS_READ: HTTP Method: `GET`

Grants read access to reservation information, for example, when calling the `RetrieveReservation` endpoint.

RESERVATIONS_WRITE: HTTP Method: `POST`, `PUT`, `DELETE`

Grants write access to reservation information, for example, when calling the `CreateReservation` endpoint.

RESTAURANT_CHECKS_READ: HTTP Method: `GET`

Grants read access to check information, for example, when calling the `RetrieveCheck` endpoint.

DEVICES_READ: HTTP Method: `GET`

Grants read access to device information. For example, to call the `GetDevice` and `ListDevices` endpoints.

CHANNELS_READ: HTTP Method: `GET`

Grants read access to view channels, for example, when calling the `RetrieveChannel` endpoint.

CHANNELS_CREATE: HTTP Method: `POST`

Grants write access to create channels, for example, when calling the `CreateChannel` endpoint.

CHANNELS_UPDATE: HTTP Method: `PUT`

Grants write access to update channels, for example, when calling the `UpdateChannel` endpoint.

ADDON_CONFIGURATIONS_READ: HTTP Method: `GET`

Grants write access for third-party Add-ons to read configurations of their Add-ons, for example, when calling `RetrieveConfiguration` endpoint.

ADDON_CONFIGURATIONS_WRITE: HTTP Method: `POST`, `PUT`, `DELETE`

Grants write access for third-party Add-ons to store configurations of their Add-ons, for example, when calling `CreateConfiguration` endpoint.

PERMISSION_SETS_READ: HTTP Method: `GET`

Grants read access to Permission Sets. For example, to call the `ListPermissionSets` and `RetrievePermissionSet` endpoints.

PERMISSION_SETS_WRITE: HTTP Method: `PUT`

Grants write access to Permission Sets.

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

oauth2ClientSecret

Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author

developers@squareup.com

Documentation ¶

Overview ¶

* Square Connect API * * Client library for accessing the Square Connect APIs * * API version: 2.0 * Contact: developers@squareup.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type AcceptDisputeRequest
type AcceptDisputeResponse
type AcceptedPaymentMethods
type AccumulateLoyaltyPointsRequest
type AccumulateLoyaltyPointsResponse
type AchDetails
type ActionCancelReason
type ActivityType
type AddGroupToCustomerRequest
type AddGroupToCustomerResponse
type AdditionalRecipient
type Address
type AdjustLoyaltyPointsRequest
type AdjustLoyaltyPointsResponse
type AfterpayDetails
type ApplePayApiService
- func (a *ApplePayApiService) RegisterDomain(ctx context.Context, body RegisterDomainRequest) (RegisterDomainResponse, *http.Response, error)
type ApplicationDetails
type ApplicationDetailsExternalSquareProduct
type ApplicationType
type AppointmentSegment
type ArchivedState
type Availability
type BankAccount
type BankAccountPaymentDetails
type BankAccountStatus
type BankAccountType
type BankAccountsApiListBankAccountsOpts
type BankAccountsApiService
- func (a *BankAccountsApiService) GetBankAccount(ctx context.Context, bankAccountId string) (GetBankAccountResponse, *http.Response, error)
- func (a *BankAccountsApiService) GetBankAccountByV1Id(ctx context.Context, v1BankAccountId string) (GetBankAccountByV1IdResponse, *http.Response, error)
- func (a *BankAccountsApiService) ListBankAccounts(ctx context.Context, localVarOptionals *BankAccountsApiListBankAccountsOpts) (ListBankAccountsResponse, *http.Response, error)
type BasicAuth
type BatchChangeInventoryRequest
type BatchChangeInventoryResponse
type BatchDeleteCatalogObjectsRequest
type BatchDeleteCatalogObjectsResponse
type BatchRetrieveCatalogObjectsRequest
type BatchRetrieveCatalogObjectsResponse
type BatchRetrieveInventoryChangesRequest
type BatchRetrieveInventoryChangesResponse
type BatchRetrieveInventoryCountsRequest
type BatchRetrieveInventoryCountsResponse
type BatchRetrieveOrdersRequest
type BatchRetrieveOrdersResponse
type BatchUpsertCatalogObjectsRequest
type BatchUpsertCatalogObjectsResponse
type Booking
type BookingBookingSource
type BookingCreatorDetails
type BookingCreatorDetailsCreatorType
type BookingCustomAttributeDeleteRequest
type BookingCustomAttributeDeleteResponse
type BookingCustomAttributeUpsertRequest
type BookingCustomAttributeUpsertResponse
type BookingCustomAttributesApiListBookingCustomAttributeDefinitionsOpts
type BookingCustomAttributesApiListBookingCustomAttributesOpts
type BookingCustomAttributesApiRetrieveBookingCustomAttributeDefinitionOpts
type BookingCustomAttributesApiRetrieveBookingCustomAttributeOpts
type BookingCustomAttributesApiService
- func (a *BookingCustomAttributesApiService) BulkDeleteBookingCustomAttributes(ctx context.Context, body BulkDeleteBookingCustomAttributesRequest) (BulkDeleteBookingCustomAttributesResponse, *http.Response, error)
- func (a *BookingCustomAttributesApiService) BulkUpsertBookingCustomAttributes(ctx context.Context, body BulkUpsertBookingCustomAttributesRequest) (BulkUpsertBookingCustomAttributesResponse, *http.Response, error)
- func (a *BookingCustomAttributesApiService) CreateBookingCustomAttributeDefinition(ctx context.Context, body CreateBookingCustomAttributeDefinitionRequest) (CreateBookingCustomAttributeDefinitionResponse, *http.Response, error)
- func (a *BookingCustomAttributesApiService) DeleteBookingCustomAttribute(ctx context.Context, bookingId string, key string) (DeleteBookingCustomAttributeResponse, *http.Response, error)
- func (a *BookingCustomAttributesApiService) DeleteBookingCustomAttributeDefinition(ctx context.Context, key string) (DeleteBookingCustomAttributeDefinitionResponse, *http.Response, error)
- func (a *BookingCustomAttributesApiService) ListBookingCustomAttributeDefinitions(ctx context.Context, ...) (ListBookingCustomAttributeDefinitionsResponse, *http.Response, error)
- func (a *BookingCustomAttributesApiService) ListBookingCustomAttributes(ctx context.Context, bookingId string, ...) (ListBookingCustomAttributesResponse, *http.Response, error)
- func (a *BookingCustomAttributesApiService) RetrieveBookingCustomAttribute(ctx context.Context, bookingId string, key string, ...) (RetrieveBookingCustomAttributeResponse, *http.Response, error)
- func (a *BookingCustomAttributesApiService) RetrieveBookingCustomAttributeDefinition(ctx context.Context, key string, ...) (RetrieveBookingCustomAttributeDefinitionResponse, *http.Response, error)
- func (a *BookingCustomAttributesApiService) UpdateBookingCustomAttributeDefinition(ctx context.Context, body UpdateBookingCustomAttributeDefinitionRequest, ...) (UpdateBookingCustomAttributeDefinitionResponse, *http.Response, error)
- func (a *BookingCustomAttributesApiService) UpsertBookingCustomAttribute(ctx context.Context, body UpsertBookingCustomAttributeRequest, ...) (UpsertBookingCustomAttributeResponse, *http.Response, error)
type BookingStatus
type BookingsApiListBookingsOpts
type BookingsApiListLocationBookingProfilesOpts
type BookingsApiListTeamMemberBookingProfilesOpts
type BookingsApiService
- func (a *BookingsApiService) BulkRetrieveBookings(ctx context.Context, body BulkRetrieveBookingsRequest) (BulkRetrieveBookingsResponse, *http.Response, error)
- func (a *BookingsApiService) BulkRetrieveTeamMemberBookingProfiles(ctx context.Context, body BulkRetrieveTeamMemberBookingProfilesRequest) (BulkRetrieveTeamMemberBookingProfilesResponse, *http.Response, error)
- func (a *BookingsApiService) CancelBooking(ctx context.Context, body CancelBookingRequest, bookingId string) (CancelBookingResponse, *http.Response, error)
- func (a *BookingsApiService) CreateBooking(ctx context.Context, body CreateBookingRequest) (CreateBookingResponse, *http.Response, error)
- func (a *BookingsApiService) ListBookings(ctx context.Context, localVarOptionals *BookingsApiListBookingsOpts) (ListBookingsResponse, *http.Response, error)
- func (a *BookingsApiService) ListLocationBookingProfiles(ctx context.Context, ...) (ListLocationBookingProfilesResponse, *http.Response, error)
- func (a *BookingsApiService) ListTeamMemberBookingProfiles(ctx context.Context, ...) (ListTeamMemberBookingProfilesResponse, *http.Response, error)
- func (a *BookingsApiService) RetrieveBooking(ctx context.Context, bookingId string) (RetrieveBookingResponse, *http.Response, error)
- func (a *BookingsApiService) RetrieveBusinessBookingProfile(ctx context.Context) (RetrieveBusinessBookingProfileResponse, *http.Response, error)
- func (a *BookingsApiService) RetrieveLocationBookingProfile(ctx context.Context, locationId string) (RetrieveLocationBookingProfileResponse, *http.Response, error)
- func (a *BookingsApiService) RetrieveTeamMemberBookingProfile(ctx context.Context, teamMemberId string) (RetrieveTeamMemberBookingProfileResponse, *http.Response, error)
- func (a *BookingsApiService) SearchAvailability(ctx context.Context, body SearchAvailabilityRequest) (SearchAvailabilityResponse, *http.Response, error)
- func (a *BookingsApiService) UpdateBooking(ctx context.Context, body UpdateBookingRequest, bookingId string) (UpdateBookingResponse, *http.Response, error)
type BreakType
type BulkCreateCustomerData
type BulkCreateCustomersRequest
type BulkCreateCustomersResponse
type BulkCreateTeamMembersRequest
type BulkCreateTeamMembersResponse
type BulkCreateVendorsRequest
type BulkCreateVendorsResponse
type BulkDeleteBookingCustomAttributesRequest
type BulkDeleteBookingCustomAttributesResponse
type BulkDeleteCustomersRequest
type BulkDeleteCustomersResponse
type BulkDeleteLocationCustomAttributesRequest
type BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest
type BulkDeleteLocationCustomAttributesResponse
type BulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponse
type BulkDeleteMerchantCustomAttributesRequest
type BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequest
type BulkDeleteMerchantCustomAttributesResponse
type BulkDeleteMerchantCustomAttributesResponseMerchantCustomAttributeDeleteResponse
type BulkDeleteOrderCustomAttributesRequest
type BulkDeleteOrderCustomAttributesRequestDeleteCustomAttribute
type BulkDeleteOrderCustomAttributesResponse
type BulkRetrieveBookingsRequest
type BulkRetrieveBookingsResponse
type BulkRetrieveCustomersRequest
type BulkRetrieveCustomersResponse
type BulkRetrieveTeamMemberBookingProfilesRequest
type BulkRetrieveTeamMemberBookingProfilesResponse
type BulkRetrieveVendorsRequest
type BulkRetrieveVendorsResponse
type BulkSwapPlanRequest
type BulkSwapPlanResponse
type BulkUpdateCustomerData
type BulkUpdateCustomersRequest
type BulkUpdateCustomersResponse
type BulkUpdateTeamMembersRequest
type BulkUpdateTeamMembersResponse
type BulkUpdateVendorsRequest
type BulkUpdateVendorsResponse
type BulkUpsertBookingCustomAttributesRequest
type BulkUpsertBookingCustomAttributesResponse
type BulkUpsertCustomerCustomAttributesRequest
type BulkUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequest
type BulkUpsertCustomerCustomAttributesResponse
type BulkUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponse
type BulkUpsertLocationCustomAttributesRequest
type BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest
type BulkUpsertLocationCustomAttributesResponse
type BulkUpsertLocationCustomAttributesResponseLocationCustomAttributeUpsertResponse
type BulkUpsertMerchantCustomAttributesRequest
type BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequest
type BulkUpsertMerchantCustomAttributesResponse
type BulkUpsertMerchantCustomAttributesResponseMerchantCustomAttributeUpsertResponse
type BulkUpsertOrderCustomAttributesRequest
type BulkUpsertOrderCustomAttributesRequestUpsertCustomAttribute
type BulkUpsertOrderCustomAttributesResponse
type BusinessAppointmentSettings
type BusinessAppointmentSettingsAlignmentTime
type BusinessAppointmentSettingsBookingLocationType
type BusinessAppointmentSettingsCancellationPolicy
type BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType
type BusinessBookingProfile
type BusinessBookingProfileBookingPolicy
type BusinessBookingProfileCustomerTimezoneChoice
type BusinessHours
type BusinessHoursPeriod
type BuyNowPayLaterDetails
type CalculateLoyaltyPointsRequest
type CalculateLoyaltyPointsResponse
type CalculateOrderRequest
type CalculateOrderResponse
type CancelBookingRequest
type CancelBookingResponse
type CancelInvoiceRequest
type CancelInvoiceResponse
type CancelLoyaltyPromotionRequest
type CancelLoyaltyPromotionResponse
type CancelPaymentByIdempotencyKeyRequest
type CancelPaymentByIdempotencyKeyResponse
type CancelPaymentRequest
type CancelPaymentResponse
type CancelSubscriptionRequest
type CancelSubscriptionResponse
type CancelTerminalActionRequest
type CancelTerminalActionResponse
type CancelTerminalCheckoutRequest
type CancelTerminalCheckoutResponse
type CancelTerminalRefundRequest
type CancelTerminalRefundResponse
type CaptureTransactionRequest
type CaptureTransactionResponse
type Card
type CardBrand
type CardCoBrand
type CardPaymentDetails
type CardPaymentTimeline
type CardPrepaidType
type CardType
type CardsApiListCardsOpts
type CardsApiService
- func (a *CardsApiService) CreateCard(ctx context.Context, body CreateCardRequest) (CreateCardResponse, *http.Response, error)
- func (a *CardsApiService) DisableCard(ctx context.Context, cardId string) (DisableCardResponse, *http.Response, error)
- func (a *CardsApiService) ListCards(ctx context.Context, localVarOptionals *CardsApiListCardsOpts) (ListCardsResponse, *http.Response, error)
- func (a *CardsApiService) RetrieveCard(ctx context.Context, cardId string) (RetrieveCardResponse, *http.Response, error)
type CashAppDetails
type CashDrawerDevice
type CashDrawerEventType
type CashDrawerShift
type CashDrawerShiftEvent
type CashDrawerShiftState
type CashDrawerShiftSummary
type CashDrawersApiListCashDrawerShiftEventsOpts
type CashDrawersApiListCashDrawerShiftsOpts
type CashDrawersApiService
- func (a *CashDrawersApiService) ListCashDrawerShiftEvents(ctx context.Context, locationId string, shiftId string, ...) (ListCashDrawerShiftEventsResponse, *http.Response, error)
- func (a *CashDrawersApiService) ListCashDrawerShifts(ctx context.Context, locationId string, ...) (ListCashDrawerShiftsResponse, *http.Response, error)
- func (a *CashDrawersApiService) RetrieveCashDrawerShift(ctx context.Context, locationId string, shiftId string) (RetrieveCashDrawerShiftResponse, *http.Response, error)
type CashPaymentDetails
type CatalogApiListCatalogOpts
type CatalogApiRetrieveCatalogObjectOpts
type CatalogApiService
- func (a *CatalogApiService) BatchDeleteCatalogObjects(ctx context.Context, body BatchDeleteCatalogObjectsRequest) (BatchDeleteCatalogObjectsResponse, *http.Response, error)
- func (a *CatalogApiService) BatchRetrieveCatalogObjects(ctx context.Context, body BatchRetrieveCatalogObjectsRequest) (BatchRetrieveCatalogObjectsResponse, *http.Response, error)
- func (a *CatalogApiService) BatchUpsertCatalogObjects(ctx context.Context, body BatchUpsertCatalogObjectsRequest) (BatchUpsertCatalogObjectsResponse, *http.Response, error)
- func (a *CatalogApiService) CatalogInfo(ctx context.Context) (CatalogInfoResponse, *http.Response, error)
- func (a *CatalogApiService) DeleteCatalogObject(ctx context.Context, objectId string) (DeleteCatalogObjectResponse, *http.Response, error)
- func (a *CatalogApiService) ListCatalog(ctx context.Context, localVarOptionals *CatalogApiListCatalogOpts) (ListCatalogResponse, *http.Response, error)
- func (a *CatalogApiService) RetrieveCatalogObject(ctx context.Context, objectId string, ...) (RetrieveCatalogObjectResponse, *http.Response, error)
- func (a *CatalogApiService) SearchCatalogItems(ctx context.Context, body SearchCatalogItemsRequest) (SearchCatalogItemsResponse, *http.Response, error)
- func (a *CatalogApiService) SearchCatalogObjects(ctx context.Context, body SearchCatalogObjectsRequest) (SearchCatalogObjectsResponse, *http.Response, error)
- func (a *CatalogApiService) UpdateItemModifierLists(ctx context.Context, body UpdateItemModifierListsRequest) (UpdateItemModifierListsResponse, *http.Response, error)
- func (a *CatalogApiService) UpdateItemTaxes(ctx context.Context, body UpdateItemTaxesRequest) (UpdateItemTaxesResponse, *http.Response, error)
- func (a *CatalogApiService) UpsertCatalogObject(ctx context.Context, body UpsertCatalogObjectRequest) (UpsertCatalogObjectResponse, *http.Response, error)
type CatalogAvailabilityPeriod
type CatalogCategory
type CatalogCategoryType
type CatalogCustomAttributeDefinition
type CatalogCustomAttributeDefinitionAppVisibility
type CatalogCustomAttributeDefinitionNumberConfig
type CatalogCustomAttributeDefinitionSelectionConfig
type CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection
type CatalogCustomAttributeDefinitionSellerVisibility
type CatalogCustomAttributeDefinitionStringConfig
type CatalogCustomAttributeDefinitionType
type CatalogCustomAttributeValue
type CatalogDiscount
type CatalogDiscountModifyTaxBasis
type CatalogDiscountType
type CatalogEcomSeoData
type CatalogIdMapping
type CatalogImage
type CatalogInfoRequest
type CatalogInfoResponse
type CatalogInfoResponseLimits
type CatalogItem
type CatalogItemFoodAndBeverageDetails
type CatalogItemFoodAndBeverageDetailsDietaryPreference
type CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference
type CatalogItemFoodAndBeverageDetailsDietaryPreferenceType
type CatalogItemFoodAndBeverageDetailsIngredient
type CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient
type CatalogItemModifierListInfo
type CatalogItemOption
type CatalogItemOptionForItem
type CatalogItemOptionValue
type CatalogItemOptionValueForItemVariation
type CatalogItemProductType
type CatalogItemVariation
type CatalogMeasurementUnit
type CatalogModifier
type CatalogModifierList
type CatalogModifierListModifierType
type CatalogModifierListSelectionType
type CatalogModifierOverride
type CatalogObject
type CatalogObjectBatch
type CatalogObjectCategory
type CatalogObjectReference
type CatalogObjectType
type CatalogPricingRule
type CatalogPricingType
type CatalogProductSet
type CatalogQuery
type CatalogQueryExact
type CatalogQueryItemVariationsForItemOptionValues
type CatalogQueryItemsForItemOptions
type CatalogQueryItemsForModifierList
type CatalogQueryItemsForTax
type CatalogQueryPrefix
type CatalogQueryRange
type CatalogQuerySet
type CatalogQuerySortedAttribute
type CatalogQueryText
type CatalogQuickAmount
type CatalogQuickAmountType
type CatalogQuickAmountsSettings
type CatalogQuickAmountsSettingsOption
type CatalogStockConversion
type CatalogSubscriptionPlan
type CatalogSubscriptionPlanVariation
type CatalogTax
type CatalogTimePeriod
type CatalogV1Id
type CategoryPathToRootNode
type ChangeBillingAnchorDateRequest
type ChangeBillingAnchorDateResponse
type ChangeTiming
type ChargeRequest
type ChargeRequestAdditionalRecipient
type ChargeResponse
type Checkout
type CheckoutApiListPaymentLinksOpts
type CheckoutApiService
- func (a *CheckoutApiService) CreateCheckout(ctx context.Context, body CreateCheckoutRequest, locationId string) (CreateCheckoutResponse, *http.Response, error)
- func (a *CheckoutApiService) CreatePaymentLink(ctx context.Context, body CreatePaymentLinkRequest) (CreatePaymentLinkResponse, *http.Response, error)
- func (a *CheckoutApiService) DeletePaymentLink(ctx context.Context, id string) (DeletePaymentLinkResponse, *http.Response, error)
- func (a *CheckoutApiService) ListPaymentLinks(ctx context.Context, localVarOptionals *CheckoutApiListPaymentLinksOpts) (ListPaymentLinksResponse, *http.Response, error)
- func (a *CheckoutApiService) RetrieveLocationSettings(ctx context.Context, locationId string) (RetrieveLocationSettingsResponse, *http.Response, error)
- func (a *CheckoutApiService) RetrieveMerchantSettings(ctx context.Context) (RetrieveMerchantSettingsResponse, *http.Response, error)
- func (a *CheckoutApiService) RetrievePaymentLink(ctx context.Context, id string) (RetrievePaymentLinkResponse, *http.Response, error)
- func (a *CheckoutApiService) UpdateLocationSettings(ctx context.Context, body UpdateLocationSettingsRequest, locationId string) (UpdateLocationSettingsResponse, *http.Response, error)
- func (a *CheckoutApiService) UpdateMerchantSettings(ctx context.Context, body UpdateMerchantSettingsRequest) (UpdateMerchantSettingsResponse, *http.Response, error)
- func (a *CheckoutApiService) UpdatePaymentLink(ctx context.Context, body UpdatePaymentLinkRequest, id string) (UpdatePaymentLinkResponse, *http.Response, error)
type CheckoutLocationSettings
type CheckoutLocationSettingsBranding
type CheckoutLocationSettingsBrandingButtonShape
type CheckoutLocationSettingsBrandingHeaderType
type CheckoutLocationSettingsCoupons
type CheckoutLocationSettingsPolicy
type CheckoutLocationSettingsTipping
type CheckoutMerchantSettings
type CheckoutMerchantSettingsPaymentMethods
type CheckoutMerchantSettingsPaymentMethodsAfterpayClearpay
type CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange
type CheckoutMerchantSettingsPaymentMethodsPaymentMethod
type CheckoutOptions
type CheckoutOptionsPaymentType
type ClearpayDetails
type CloneOrderRequest
type CloneOrderResponse
type CollectedData
type CompletePaymentRequest
type CompletePaymentResponse
type Component
type ComponentComponentType
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type ConfirmationDecision
type ConfirmationOptions
type Coordinates
type Country
type CreateBookingCustomAttributeDefinitionRequest
type CreateBookingCustomAttributeDefinitionResponse
type CreateBookingRequest
type CreateBookingResponse
type CreateBreakTypeRequest
type CreateBreakTypeResponse
type CreateCardRequest
type CreateCardResponse
type CreateCheckoutRequest
type CreateCheckoutResponse
type CreateCustomerCardRequest
type CreateCustomerCardResponse
type CreateCustomerCustomAttributeDefinitionRequest
type CreateCustomerCustomAttributeDefinitionResponse
type CreateCustomerGroupRequest
type CreateCustomerGroupResponse
type CreateCustomerRequest
type CreateCustomerResponse
type CreateDeviceCodeRequest
type CreateDeviceCodeResponse
type CreateDisputeEvidenceTextRequest
type CreateDisputeEvidenceTextResponse
type CreateGiftCardActivityRequest
type CreateGiftCardActivityResponse
type CreateGiftCardRequest
type CreateGiftCardResponse
type CreateInvoiceRequest
type CreateInvoiceResponse
type CreateLocationCustomAttributeDefinitionRequest
type CreateLocationCustomAttributeDefinitionResponse
type CreateLocationRequest
type CreateLocationResponse
type CreateLoyaltyAccountRequest
type CreateLoyaltyAccountResponse
type CreateLoyaltyPromotionRequest
type CreateLoyaltyPromotionResponse
type CreateLoyaltyRewardRequest
type CreateLoyaltyRewardResponse
type CreateMerchantCustomAttributeDefinitionRequest
type CreateMerchantCustomAttributeDefinitionResponse
type CreateMobileAuthorizationCodeRequest
type CreateMobileAuthorizationCodeResponse
type CreateOrderCustomAttributeDefinitionRequest
type CreateOrderCustomAttributeDefinitionResponse
type CreateOrderRequest
type CreateOrderResponse
type CreatePaymentLinkRequest
type CreatePaymentLinkResponse
type CreatePaymentRequest
type CreatePaymentResponse
type CreateRefundRequest
type CreateRefundResponse
type CreateShiftRequest
type CreateShiftResponse
type CreateSubscriptionRequest
type CreateSubscriptionResponse
type CreateTeamMemberRequest
type CreateTeamMemberResponse
type CreateTerminalActionRequest
type CreateTerminalActionResponse
type CreateTerminalCheckoutRequest
type CreateTerminalCheckoutResponse
type CreateTerminalRefundRequest
type CreateTerminalRefundResponse
type CreateVendorRequest
type CreateVendorResponse
type CreateWebhookSubscriptionRequest
type CreateWebhookSubscriptionResponse
type Currency
type CustomAttribute
type CustomAttributeDefinition
type CustomAttributeDefinitionVisibility
type CustomAttributeFilter
type CustomField
type Customer
type CustomerAddressFilter
type CustomerCreationSource
type CustomerCreationSourceFilter
type CustomerCustomAttributeFilter
type CustomerCustomAttributeFilterValue
type CustomerCustomAttributeFilters
type CustomerCustomAttributesApiListCustomerCustomAttributeDefinitionsOpts
type CustomerCustomAttributesApiListCustomerCustomAttributesOpts
type CustomerCustomAttributesApiRetrieveCustomerCustomAttributeDefinitionOpts
type CustomerCustomAttributesApiRetrieveCustomerCustomAttributeOpts
type CustomerCustomAttributesApiService
- func (a *CustomerCustomAttributesApiService) BulkUpsertCustomerCustomAttributes(ctx context.Context, body BulkUpsertCustomerCustomAttributesRequest) (BulkUpsertCustomerCustomAttributesResponse, *http.Response, error)
- func (a *CustomerCustomAttributesApiService) CreateCustomerCustomAttributeDefinition(ctx context.Context, body CreateCustomerCustomAttributeDefinitionRequest) (CreateCustomerCustomAttributeDefinitionResponse, *http.Response, error)
- func (a *CustomerCustomAttributesApiService) DeleteCustomerCustomAttribute(ctx context.Context, customerId string, key string) (DeleteCustomerCustomAttributeResponse, *http.Response, error)
- func (a *CustomerCustomAttributesApiService) DeleteCustomerCustomAttributeDefinition(ctx context.Context, key string) (DeleteCustomerCustomAttributeDefinitionResponse, *http.Response, error)
- func (a *CustomerCustomAttributesApiService) ListCustomerCustomAttributeDefinitions(ctx context.Context, ...) (ListCustomerCustomAttributeDefinitionsResponse, *http.Response, error)
- func (a *CustomerCustomAttributesApiService) ListCustomerCustomAttributes(ctx context.Context, customerId string, ...) (ListCustomerCustomAttributesResponse, *http.Response, error)
- func (a *CustomerCustomAttributesApiService) RetrieveCustomerCustomAttribute(ctx context.Context, customerId string, key string, ...) (RetrieveCustomerCustomAttributeResponse, *http.Response, error)
- func (a *CustomerCustomAttributesApiService) RetrieveCustomerCustomAttributeDefinition(ctx context.Context, key string, ...) (RetrieveCustomerCustomAttributeDefinitionResponse, *http.Response, error)
- func (a *CustomerCustomAttributesApiService) UpdateCustomerCustomAttributeDefinition(ctx context.Context, body UpdateCustomerCustomAttributeDefinitionRequest, ...) (UpdateCustomerCustomAttributeDefinitionResponse, *http.Response, error)
- func (a *CustomerCustomAttributesApiService) UpsertCustomerCustomAttribute(ctx context.Context, body UpsertCustomerCustomAttributeRequest, ...) (UpsertCustomerCustomAttributeResponse, *http.Response, error)
type CustomerDetails
type CustomerFilter
type CustomerGroup
type CustomerGroupsApiListCustomerGroupsOpts
type CustomerGroupsApiService
- func (a *CustomerGroupsApiService) CreateCustomerGroup(ctx context.Context, body CreateCustomerGroupRequest) (CreateCustomerGroupResponse, *http.Response, error)
- func (a *CustomerGroupsApiService) DeleteCustomerGroup(ctx context.Context, groupId string) (DeleteCustomerGroupResponse, *http.Response, error)
- func (a *CustomerGroupsApiService) ListCustomerGroups(ctx context.Context, ...) (ListCustomerGroupsResponse, *http.Response, error)
- func (a *CustomerGroupsApiService) RetrieveCustomerGroup(ctx context.Context, groupId string) (RetrieveCustomerGroupResponse, *http.Response, error)
- func (a *CustomerGroupsApiService) UpdateCustomerGroup(ctx context.Context, body UpdateCustomerGroupRequest, groupId string) (UpdateCustomerGroupResponse, *http.Response, error)
type CustomerInclusionExclusion
type CustomerPreferences
type CustomerQuery
type CustomerSegment
type CustomerSegmentsApiListCustomerSegmentsOpts
type CustomerSegmentsApiService
- func (a *CustomerSegmentsApiService) ListCustomerSegments(ctx context.Context, ...) (ListCustomerSegmentsResponse, *http.Response, error)
- func (a *CustomerSegmentsApiService) RetrieveCustomerSegment(ctx context.Context, segmentId string) (RetrieveCustomerSegmentResponse, *http.Response, error)
type CustomerSort
type CustomerSortField
type CustomerTaxIds
type CustomerTextFilter
type CustomersApiDeleteCustomerOpts
type CustomersApiListCustomersOpts
type CustomersApiService
- func (a *CustomersApiService) AddGroupToCustomer(ctx context.Context, customerId string, groupId string) (AddGroupToCustomerResponse, *http.Response, error)
- func (a *CustomersApiService) BulkCreateCustomers(ctx context.Context, body BulkCreateCustomersRequest) (BulkCreateCustomersResponse, *http.Response, error)
- func (a *CustomersApiService) BulkDeleteCustomers(ctx context.Context, body BulkDeleteCustomersRequest) (BulkDeleteCustomersResponse, *http.Response, error)
- func (a *CustomersApiService) BulkRetrieveCustomers(ctx context.Context, body BulkRetrieveCustomersRequest) (BulkRetrieveCustomersResponse, *http.Response, error)
- func (a *CustomersApiService) BulkUpdateCustomers(ctx context.Context, body BulkUpdateCustomersRequest) (BulkUpdateCustomersResponse, *http.Response, error)
- func (a *CustomersApiService) CreateCustomer(ctx context.Context, body CreateCustomerRequest) (CreateCustomerResponse, *http.Response, error)
- func (a *CustomersApiService) CreateCustomerCard(ctx context.Context, body CreateCustomerCardRequest, customerId string) (CreateCustomerCardResponse, *http.Response, error)
- func (a *CustomersApiService) DeleteCustomer(ctx context.Context, customerId string, ...) (DeleteCustomerResponse, *http.Response, error)
- func (a *CustomersApiService) DeleteCustomerCard(ctx context.Context, customerId string, cardId string) (DeleteCustomerCardResponse, *http.Response, error)
- func (a *CustomersApiService) ListCustomers(ctx context.Context, localVarOptionals *CustomersApiListCustomersOpts) (ListCustomersResponse, *http.Response, error)
- func (a *CustomersApiService) RemoveGroupFromCustomer(ctx context.Context, customerId string, groupId string) (RemoveGroupFromCustomerResponse, *http.Response, error)
- func (a *CustomersApiService) RetrieveCustomer(ctx context.Context, customerId string) (RetrieveCustomerResponse, *http.Response, error)
- func (a *CustomersApiService) SearchCustomers(ctx context.Context, body SearchCustomersRequest) (SearchCustomersResponse, *http.Response, error)
- func (a *CustomersApiService) UpdateCustomer(ctx context.Context, body UpdateCustomerRequest, customerId string) (UpdateCustomerResponse, *http.Response, error)
type DataCollectionOptions
type DataCollectionOptionsInputType
type DateRange
type DayOfWeek
type DeleteBookingCustomAttributeDefinitionRequest
type DeleteBookingCustomAttributeDefinitionResponse
type DeleteBookingCustomAttributeRequest
type DeleteBookingCustomAttributeResponse
type DeleteBreakTypeRequest
type DeleteBreakTypeResponse
type DeleteCatalogObjectRequest
type DeleteCatalogObjectResponse
type DeleteCustomerCardRequest
type DeleteCustomerCardResponse
type DeleteCustomerCustomAttributeDefinitionRequest
type DeleteCustomerCustomAttributeDefinitionResponse
type DeleteCustomerCustomAttributeRequest
type DeleteCustomerCustomAttributeResponse
type DeleteCustomerGroupRequest
type DeleteCustomerGroupResponse
type DeleteCustomerRequest
type DeleteCustomerResponse
type DeleteDisputeEvidenceRequest
type DeleteDisputeEvidenceResponse
type DeleteInvoiceAttachmentRequest
type DeleteInvoiceAttachmentResponse
type DeleteInvoiceRequest
type DeleteInvoiceResponse
type DeleteLocationCustomAttributeDefinitionRequest
type DeleteLocationCustomAttributeDefinitionResponse
type DeleteLocationCustomAttributeRequest
type DeleteLocationCustomAttributeResponse
type DeleteLoyaltyRewardRequest
type DeleteLoyaltyRewardResponse
type DeleteMerchantCustomAttributeDefinitionRequest
type DeleteMerchantCustomAttributeDefinitionResponse
type DeleteMerchantCustomAttributeRequest
type DeleteMerchantCustomAttributeResponse
type DeleteOrderCustomAttributeDefinitionRequest
type DeleteOrderCustomAttributeDefinitionResponse
type DeleteOrderCustomAttributeRequest
type DeleteOrderCustomAttributeResponse
type DeletePaymentLinkRequest
type DeletePaymentLinkResponse
type DeleteShiftRequest
type DeleteShiftResponse
type DeleteSnippetRequest
type DeleteSnippetResponse
type DeleteSubscriptionActionRequest
type DeleteSubscriptionActionResponse
type DeleteWebhookSubscriptionRequest
type DeleteWebhookSubscriptionResponse
type DeprecatedCreateDisputeEvidenceFileRequest
type DeprecatedCreateDisputeEvidenceFileResponse
type DeprecatedCreateDisputeEvidenceTextRequest
type DeprecatedCreateDisputeEvidenceTextResponse
type Destination
type DestinationDetails
type DestinationDetailsCardRefundDetails
type DestinationType
type Device
type DeviceAttributes
type DeviceAttributesDeviceType
type DeviceCheckoutOptions
type DeviceCode
type DeviceCodeStatus
type DeviceComponentDetails
type DeviceComponentDetailsApplicationDetails
type DeviceComponentDetailsBatteryDetails
type DeviceComponentDetailsCardReaderDetails
type DeviceComponentDetailsEthernetDetails
type DeviceComponentDetailsExternalPower
type DeviceComponentDetailsMeasurement
type DeviceComponentDetailsNetworkInterfaceDetails
type DeviceComponentDetailsWiFiDetails
type DeviceDetails
type DeviceMetadata
type DeviceStatus
type DeviceStatusCategory
type DevicesApiListDeviceCodesOpts
type DevicesApiListDevicesOpts
type DevicesApiService
- func (a *DevicesApiService) CreateDeviceCode(ctx context.Context, body CreateDeviceCodeRequest) (CreateDeviceCodeResponse, *http.Response, error)
- func (a *DevicesApiService) GetDevice(ctx context.Context, deviceId string) (GetDeviceResponse, *http.Response, error)
- func (a *DevicesApiService) GetDeviceCode(ctx context.Context, id string) (GetDeviceCodeResponse, *http.Response, error)
- func (a *DevicesApiService) ListDeviceCodes(ctx context.Context, localVarOptionals *DevicesApiListDeviceCodesOpts) (ListDeviceCodesResponse, *http.Response, error)
- func (a *DevicesApiService) ListDevices(ctx context.Context, localVarOptionals *DevicesApiListDevicesOpts) (ListDevicesResponse, *http.Response, error)
type DigitalWalletDetails
type DisableCardRequest
type DisableCardResponse
type DisableEventsRequest
type DisableEventsResponse
type DismissTerminalActionRequest
type DismissTerminalActionResponse
type DismissTerminalCheckoutRequest
type DismissTerminalCheckoutResponse
type DismissTerminalRefundRequest
type DismissTerminalRefundResponse
type Dispute
type DisputeEvidence
type DisputeEvidenceFile
type DisputeEvidenceType
type DisputeReason
type DisputeState
type DisputedPayment
type DisputesApiListDisputeEvidenceOpts
type DisputesApiListDisputesOpts
type DisputesApiService
- func (a *DisputesApiService) AcceptDispute(ctx context.Context, disputeId string) (AcceptDisputeResponse, *http.Response, error)
- func (a *DisputesApiService) CreateDisputeEvidenceText(ctx context.Context, body CreateDisputeEvidenceTextRequest, disputeId string) (CreateDisputeEvidenceTextResponse, *http.Response, error)
- func (a *DisputesApiService) DeleteDisputeEvidence(ctx context.Context, disputeId string, evidenceId string) (DeleteDisputeEvidenceResponse, *http.Response, error)
- func (a *DisputesApiService) ListDisputeEvidence(ctx context.Context, disputeId string, ...) (ListDisputeEvidenceResponse, *http.Response, error)
- func (a *DisputesApiService) ListDisputes(ctx context.Context, localVarOptionals *DisputesApiListDisputesOpts) (ListDisputesResponse, *http.Response, error)
- func (a *DisputesApiService) RetrieveDispute(ctx context.Context, disputeId string) (RetrieveDisputeResponse, *http.Response, error)
- func (a *DisputesApiService) RetrieveDisputeEvidence(ctx context.Context, disputeId string, evidenceId string) (RetrieveDisputeEvidenceResponse, *http.Response, error)
- func (a *DisputesApiService) SubmitEvidence(ctx context.Context, disputeId string) (SubmitEvidenceResponse, *http.Response, error)
type EcomVisibility
type Employee
type EmployeeStatus
type EmployeeWage
type EmployeesApiListEmployeesOpts
type EmployeesApiService
- func (a *EmployeesApiService) ListEmployees(ctx context.Context, localVarOptionals *EmployeesApiListEmployeesOpts) (ListEmployeesResponse, *http.Response, error)
- func (a *EmployeesApiService) RetrieveEmployee(ctx context.Context, id string) (RetrieveEmployeeResponse, *http.Response, error)
type EnableEventsRequest
type EnableEventsResponse
type ErrorCategory
type ErrorCode
type Event
type EventData
type EventMetadata
type EventTypeMetadata
type EventsApiListEventTypesOpts
type EventsApiService
- func (a *EventsApiService) DisableEvents(ctx context.Context) (DisableEventsResponse, *http.Response, error)
- func (a *EventsApiService) EnableEvents(ctx context.Context) (EnableEventsResponse, *http.Response, error)
- func (a *EventsApiService) ListEventTypes(ctx context.Context, localVarOptionals *EventsApiListEventTypesOpts) (ListEventTypesResponse, *http.Response, error)
- func (a *EventsApiService) SearchEvents(ctx context.Context, body SearchEventsRequest) (SearchEventsResponse, *http.Response, error)
type ExcludeStrategy
type ExternalPaymentDetails
type FilterValue
type FloatNumberRange
type Fulfillment
type FulfillmentDeliveryDetails
type FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType
type FulfillmentFulfillmentEntry
type FulfillmentFulfillmentLineItemApplication
type FulfillmentPickupDetails
type FulfillmentPickupDetailsCurbsidePickupDetails
type FulfillmentPickupDetailsScheduleType
type FulfillmentRecipient
type FulfillmentShipmentDetails
type FulfillmentState
type FulfillmentType
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type GetBankAccountByV1IdRequest
type GetBankAccountByV1IdResponse
type GetBankAccountRequest
type GetBankAccountResponse
type GetBreakTypeRequest
type GetBreakTypeResponse
type GetDeviceCodeRequest
type GetDeviceCodeResponse
type GetDeviceRequest
type GetDeviceResponse
type GetEmployeeWageRequest
type GetEmployeeWageResponse
type GetInvoiceRequest
type GetInvoiceResponse
type GetPaymentRefundRequest
type GetPaymentRefundResponse
type GetPaymentRequest
type GetPaymentResponse
type GetPayoutRequest
type GetPayoutResponse
type GetShiftRequest
type GetShiftResponse
type GetTeamMemberWageRequest
type GetTeamMemberWageResponse
type GetTerminalActionRequest
type GetTerminalActionResponse
type GetTerminalCheckoutRequest
type GetTerminalCheckoutResponse
type GetTerminalRefundRequest
type GetTerminalRefundResponse
type GiftCard
type GiftCardActivitiesApiListGiftCardActivitiesOpts
type GiftCardActivitiesApiService
- func (a *GiftCardActivitiesApiService) CreateGiftCardActivity(ctx context.Context, body CreateGiftCardActivityRequest) (CreateGiftCardActivityResponse, *http.Response, error)
- func (a *GiftCardActivitiesApiService) ListGiftCardActivities(ctx context.Context, ...) (ListGiftCardActivitiesResponse, *http.Response, error)
type GiftCardActivity
type GiftCardActivityActivate
type GiftCardActivityAdjustDecrement
type GiftCardActivityAdjustDecrementReason
type GiftCardActivityAdjustIncrement
type GiftCardActivityAdjustIncrementReason
type GiftCardActivityBlock
type GiftCardActivityBlockReason
type GiftCardActivityClearBalance
type GiftCardActivityClearBalanceReason
type GiftCardActivityDeactivate
type GiftCardActivityDeactivateReason
type GiftCardActivityImport
type GiftCardActivityImportReversal
type GiftCardActivityLoad
type GiftCardActivityRedeem
type GiftCardActivityRedeemStatus
type GiftCardActivityRefund
type GiftCardActivityTransferBalanceFrom
type GiftCardActivityTransferBalanceTo
type GiftCardActivityType
type GiftCardActivityUnblock
type GiftCardActivityUnblockReason
type GiftCardActivityUnlinkedActivityRefund
type GiftCardGanSource
type GiftCardStatus
type GiftCardType
type GiftCardsApiListGiftCardsOpts
type GiftCardsApiService
- func (a *GiftCardsApiService) CreateGiftCard(ctx context.Context, body CreateGiftCardRequest) (CreateGiftCardResponse, *http.Response, error)
- func (a *GiftCardsApiService) LinkCustomerToGiftCard(ctx context.Context, body LinkCustomerToGiftCardRequest, giftCardId string) (LinkCustomerToGiftCardResponse, *http.Response, error)
- func (a *GiftCardsApiService) ListGiftCards(ctx context.Context, localVarOptionals *GiftCardsApiListGiftCardsOpts) (ListGiftCardsResponse, *http.Response, error)
- func (a *GiftCardsApiService) RetrieveGiftCard(ctx context.Context, id string) (RetrieveGiftCardResponse, *http.Response, error)
- func (a *GiftCardsApiService) RetrieveGiftCardFromGAN(ctx context.Context, body RetrieveGiftCardFromGanRequest) (RetrieveGiftCardFromGanResponse, *http.Response, error)
- func (a *GiftCardsApiService) RetrieveGiftCardFromNonce(ctx context.Context, body RetrieveGiftCardFromNonceRequest) (RetrieveGiftCardFromNonceResponse, *http.Response, error)
- func (a *GiftCardsApiService) UnlinkCustomerFromGiftCard(ctx context.Context, body UnlinkCustomerFromGiftCardRequest, giftCardId string) (UnlinkCustomerFromGiftCardResponse, *http.Response, error)
type InventoryAdjustment
type InventoryAdjustmentGroup
type InventoryAlertType
type InventoryApiRetrieveInventoryChangesOpts
type InventoryApiRetrieveInventoryCountOpts
type InventoryApiService
- func (a *InventoryApiService) BatchChangeInventory(ctx context.Context, body BatchChangeInventoryRequest) (BatchChangeInventoryResponse, *http.Response, error)
- func (a *InventoryApiService) BatchRetrieveInventoryChanges(ctx context.Context, body BatchRetrieveInventoryChangesRequest) (BatchRetrieveInventoryChangesResponse, *http.Response, error)
- func (a *InventoryApiService) BatchRetrieveInventoryCounts(ctx context.Context, body BatchRetrieveInventoryCountsRequest) (BatchRetrieveInventoryCountsResponse, *http.Response, error)
- func (a *InventoryApiService) DeprecatedBatchChangeInventory(ctx context.Context, body BatchChangeInventoryRequest) (BatchChangeInventoryResponse, *http.Response, error)
- func (a *InventoryApiService) DeprecatedBatchRetrieveInventoryChanges(ctx context.Context, body BatchRetrieveInventoryChangesRequest) (BatchRetrieveInventoryChangesResponse, *http.Response, error)
- func (a *InventoryApiService) DeprecatedBatchRetrieveInventoryCounts(ctx context.Context, body BatchRetrieveInventoryCountsRequest) (BatchRetrieveInventoryCountsResponse, *http.Response, error)
- func (a *InventoryApiService) DeprecatedRetrieveInventoryAdjustment(ctx context.Context, adjustmentId string) (RetrieveInventoryAdjustmentResponse, *http.Response, error)
- func (a *InventoryApiService) DeprecatedRetrieveInventoryPhysicalCount(ctx context.Context, physicalCountId string) (RetrieveInventoryPhysicalCountResponse, *http.Response, error)
- func (a *InventoryApiService) RetrieveInventoryAdjustment(ctx context.Context, adjustmentId string) (RetrieveInventoryAdjustmentResponse, *http.Response, error)
- func (a *InventoryApiService) RetrieveInventoryChanges(ctx context.Context, catalogObjectId string, ...) (RetrieveInventoryChangesResponse, *http.Response, error)
- func (a *InventoryApiService) RetrieveInventoryCount(ctx context.Context, catalogObjectId string, ...) (RetrieveInventoryCountResponse, *http.Response, error)
- func (a *InventoryApiService) RetrieveInventoryPhysicalCount(ctx context.Context, physicalCountId string) (RetrieveInventoryPhysicalCountResponse, *http.Response, error)
- func (a *InventoryApiService) RetrieveInventoryTransfer(ctx context.Context, transferId string) (RetrieveInventoryTransferResponse, *http.Response, error)
type InventoryChange
type InventoryChangeType
type InventoryCount
type InventoryPhysicalCount
type InventoryState
type InventoryTransfer
type Invoice
type InvoiceAcceptedPaymentMethods
type InvoiceAttachment
type InvoiceAutomaticPaymentSource
type InvoiceCustomField
type InvoiceCustomFieldPlacement
type InvoiceDeliveryMethod
type InvoiceFilter
type InvoicePaymentReminder
type InvoicePaymentReminderStatus
type InvoicePaymentRequest
type InvoiceQuery
type InvoiceRecipient
type InvoiceRecipientTaxIds
type InvoiceRequestMethod
type InvoiceRequestType
type InvoiceSort
type InvoiceSortField
type InvoiceStatus
type InvoicesApiDeleteInvoiceOpts
type InvoicesApiListInvoicesOpts
type InvoicesApiService
- func (a *InvoicesApiService) CancelInvoice(ctx context.Context, body CancelInvoiceRequest, invoiceId string) (CancelInvoiceResponse, *http.Response, error)
- func (a *InvoicesApiService) CreateInvoice(ctx context.Context, body CreateInvoiceRequest) (CreateInvoiceResponse, *http.Response, error)
- func (a *InvoicesApiService) DeleteInvoice(ctx context.Context, invoiceId string, ...) (DeleteInvoiceResponse, *http.Response, error)
- func (a *InvoicesApiService) DeleteInvoiceAttachment(ctx context.Context, invoiceId string, attachmentId string) (DeleteInvoiceAttachmentResponse, *http.Response, error)
- func (a *InvoicesApiService) GetInvoice(ctx context.Context, invoiceId string) (GetInvoiceResponse, *http.Response, error)
- func (a *InvoicesApiService) ListInvoices(ctx context.Context, locationId string, ...) (ListInvoicesResponse, *http.Response, error)
- func (a *InvoicesApiService) PublishInvoice(ctx context.Context, body PublishInvoiceRequest, invoiceId string) (PublishInvoiceResponse, *http.Response, error)
- func (a *InvoicesApiService) SearchInvoices(ctx context.Context, body SearchInvoicesRequest) (SearchInvoicesResponse, *http.Response, error)
- func (a *InvoicesApiService) UpdateInvoice(ctx context.Context, body UpdateInvoiceRequest, invoiceId string) (UpdateInvoiceResponse, *http.Response, error)
type ItemVariationLocationOverrides
type JobAssignment
type JobAssignmentPayType
type LaborApiListBreakTypesOpts
type LaborApiListEmployeeWagesOpts
type LaborApiListTeamMemberWagesOpts
type LaborApiListWorkweekConfigsOpts
type LaborApiService
- func (a *LaborApiService) CreateBreakType(ctx context.Context, body CreateBreakTypeRequest) (CreateBreakTypeResponse, *http.Response, error)
- func (a *LaborApiService) CreateShift(ctx context.Context, body CreateShiftRequest) (CreateShiftResponse, *http.Response, error)
- func (a *LaborApiService) DeleteBreakType(ctx context.Context, id string) (DeleteBreakTypeResponse, *http.Response, error)
- func (a *LaborApiService) DeleteShift(ctx context.Context, id string) (DeleteShiftResponse, *http.Response, error)
- func (a *LaborApiService) GetBreakType(ctx context.Context, id string) (GetBreakTypeResponse, *http.Response, error)
- func (a *LaborApiService) GetEmployeeWage(ctx context.Context, id string) (GetEmployeeWageResponse, *http.Response, error)
- func (a *LaborApiService) GetShift(ctx context.Context, id string) (GetShiftResponse, *http.Response, error)
- func (a *LaborApiService) GetTeamMemberWage(ctx context.Context, id string) (GetTeamMemberWageResponse, *http.Response, error)
- func (a *LaborApiService) ListBreakTypes(ctx context.Context, localVarOptionals *LaborApiListBreakTypesOpts) (ListBreakTypesResponse, *http.Response, error)
- func (a *LaborApiService) ListEmployeeWages(ctx context.Context, localVarOptionals *LaborApiListEmployeeWagesOpts) (ListEmployeeWagesResponse, *http.Response, error)
- func (a *LaborApiService) ListTeamMemberWages(ctx context.Context, localVarOptionals *LaborApiListTeamMemberWagesOpts) (ListTeamMemberWagesResponse, *http.Response, error)
- func (a *LaborApiService) ListWorkweekConfigs(ctx context.Context, localVarOptionals *LaborApiListWorkweekConfigsOpts) (ListWorkweekConfigsResponse, *http.Response, error)
- func (a *LaborApiService) SearchShifts(ctx context.Context, body SearchShiftsRequest) (SearchShiftsResponse, *http.Response, error)
- func (a *LaborApiService) UpdateBreakType(ctx context.Context, body UpdateBreakTypeRequest, id string) (UpdateBreakTypeResponse, *http.Response, error)
- func (a *LaborApiService) UpdateShift(ctx context.Context, body UpdateShiftRequest, id string) (UpdateShiftResponse, *http.Response, error)
- func (a *LaborApiService) UpdateWorkweekConfig(ctx context.Context, body UpdateWorkweekConfigRequest, id string) (UpdateWorkweekConfigResponse, *http.Response, error)
type LinkCustomerToGiftCardRequest
type LinkCustomerToGiftCardResponse
type ListBankAccountsRequest
type ListBankAccountsResponse
type ListBookingCustomAttributeDefinitionsRequest
type ListBookingCustomAttributeDefinitionsResponse
type ListBookingCustomAttributesRequest
type ListBookingCustomAttributesResponse
type ListBookingsRequest
type ListBookingsResponse
type ListBreakTypesRequest
type ListBreakTypesResponse
type ListCardsRequest
type ListCardsResponse
type ListCashDrawerShiftEventsRequest
type ListCashDrawerShiftEventsResponse
type ListCashDrawerShiftsRequest
type ListCashDrawerShiftsResponse
type ListCatalogRequest
type ListCatalogResponse
type ListCustomerCustomAttributeDefinitionsRequest
type ListCustomerCustomAttributeDefinitionsResponse
type ListCustomerCustomAttributesRequest
type ListCustomerCustomAttributesResponse
type ListCustomerGroupsRequest
type ListCustomerGroupsResponse
type ListCustomerSegmentsRequest
type ListCustomerSegmentsResponse
type ListCustomersRequest
type ListCustomersResponse
type ListDeviceCodesRequest
type ListDeviceCodesResponse
type ListDevicesRequest
type ListDevicesResponse
type ListDisputeEvidenceRequest
type ListDisputeEvidenceResponse
type ListDisputesRequest
type ListDisputesResponse
type ListEmployeeWagesRequest
type ListEmployeeWagesResponse
type ListEmployeesRequest
type ListEmployeesResponse
type ListEventTypesRequest
type ListEventTypesResponse
type ListGiftCardActivitiesRequest
type ListGiftCardActivitiesResponse
type ListGiftCardsRequest
type ListGiftCardsResponse
type ListInvoicesRequest
type ListInvoicesResponse
type ListLocationBookingProfilesRequest
type ListLocationBookingProfilesResponse
type ListLocationCustomAttributeDefinitionsRequest
type ListLocationCustomAttributeDefinitionsResponse
type ListLocationCustomAttributesRequest
type ListLocationCustomAttributesResponse
type ListLocationsRequest
type ListLocationsResponse
type ListLoyaltyProgramsRequest
type ListLoyaltyProgramsResponse
type ListLoyaltyPromotionsRequest
type ListLoyaltyPromotionsResponse
type ListMerchantCustomAttributeDefinitionsRequest
type ListMerchantCustomAttributeDefinitionsResponse
type ListMerchantCustomAttributesRequest
type ListMerchantCustomAttributesResponse
type ListMerchantsRequest
type ListMerchantsResponse
type ListOrderCustomAttributeDefinitionsRequest
type ListOrderCustomAttributeDefinitionsResponse
type ListOrderCustomAttributesRequest
type ListOrderCustomAttributesResponse
type ListPaymentLinksRequest
type ListPaymentLinksResponse
type ListPaymentRefundsRequest
type ListPaymentRefundsResponse
type ListPaymentsRequest
type ListPaymentsResponse
type ListPayoutEntriesRequest
type ListPayoutEntriesResponse
type ListPayoutsRequest
type ListPayoutsResponse
type ListRefundsRequest
type ListRefundsResponse
type ListSitesRequest
type ListSitesResponse
type ListSubscriptionEventsRequest
type ListSubscriptionEventsResponse
type ListTeamMemberBookingProfilesRequest
type ListTeamMemberBookingProfilesResponse
type ListTeamMemberWagesRequest
type ListTeamMemberWagesResponse
type ListTransactionsRequest
type ListTransactionsResponse
type ListWebhookEventTypesRequest
type ListWebhookEventTypesResponse
type ListWebhookSubscriptionsRequest
type ListWebhookSubscriptionsResponse
type ListWorkweekConfigsRequest
type ListWorkweekConfigsResponse
type Location
type LocationBookingProfile
type LocationCapability
type LocationCustomAttributesApiListLocationCustomAttributeDefinitionsOpts
type LocationCustomAttributesApiListLocationCustomAttributesOpts
type LocationCustomAttributesApiRetrieveLocationCustomAttributeDefinitionOpts
type LocationCustomAttributesApiRetrieveLocationCustomAttributeOpts
type LocationCustomAttributesApiService
- func (a *LocationCustomAttributesApiService) BulkDeleteLocationCustomAttributes(ctx context.Context, body BulkDeleteLocationCustomAttributesRequest) (BulkDeleteLocationCustomAttributesResponse, *http.Response, error)
- func (a *LocationCustomAttributesApiService) BulkUpsertLocationCustomAttributes(ctx context.Context, body BulkUpsertLocationCustomAttributesRequest) (BulkUpsertLocationCustomAttributesResponse, *http.Response, error)
- func (a *LocationCustomAttributesApiService) CreateLocationCustomAttributeDefinition(ctx context.Context, body CreateLocationCustomAttributeDefinitionRequest) (CreateLocationCustomAttributeDefinitionResponse, *http.Response, error)
- func (a *LocationCustomAttributesApiService) DeleteLocationCustomAttribute(ctx context.Context, locationId string, key string) (DeleteLocationCustomAttributeResponse, *http.Response, error)
- func (a *LocationCustomAttributesApiService) DeleteLocationCustomAttributeDefinition(ctx context.Context, key string) (DeleteLocationCustomAttributeDefinitionResponse, *http.Response, error)
- func (a *LocationCustomAttributesApiService) ListLocationCustomAttributeDefinitions(ctx context.Context, ...) (ListLocationCustomAttributeDefinitionsResponse, *http.Response, error)
- func (a *LocationCustomAttributesApiService) ListLocationCustomAttributes(ctx context.Context, locationId string, ...) (ListLocationCustomAttributesResponse, *http.Response, error)
- func (a *LocationCustomAttributesApiService) RetrieveLocationCustomAttribute(ctx context.Context, locationId string, key string, ...) (RetrieveLocationCustomAttributeResponse, *http.Response, error)
- func (a *LocationCustomAttributesApiService) RetrieveLocationCustomAttributeDefinition(ctx context.Context, key string, ...) (RetrieveLocationCustomAttributeDefinitionResponse, *http.Response, error)
- func (a *LocationCustomAttributesApiService) UpdateLocationCustomAttributeDefinition(ctx context.Context, body UpdateLocationCustomAttributeDefinitionRequest, ...) (UpdateLocationCustomAttributeDefinitionResponse, *http.Response, error)
- func (a *LocationCustomAttributesApiService) UpsertLocationCustomAttribute(ctx context.Context, body UpsertLocationCustomAttributeRequest, ...) (UpsertLocationCustomAttributeResponse, *http.Response, error)
type LocationStatus
type LocationType
type LocationsApiService
- func (a *LocationsApiService) CreateLocation(ctx context.Context, body CreateLocationRequest) (CreateLocationResponse, *http.Response, error)
- func (a *LocationsApiService) ListLocations(ctx context.Context) (ListLocationsResponse, *http.Response, error)
- func (a *LocationsApiService) RetrieveLocation(ctx context.Context, locationId string) (RetrieveLocationResponse, *http.Response, error)
- func (a *LocationsApiService) UpdateLocation(ctx context.Context, body UpdateLocationRequest, locationId string) (UpdateLocationResponse, *http.Response, error)
type LoyaltyAccount
type LoyaltyAccountExpiringPointDeadline
type LoyaltyAccountMapping
type LoyaltyAccountMappingType
type LoyaltyApiListLoyaltyPromotionsOpts
type LoyaltyApiService
- func (a *LoyaltyApiService) AccumulateLoyaltyPoints(ctx context.Context, body AccumulateLoyaltyPointsRequest, accountId string) (AccumulateLoyaltyPointsResponse, *http.Response, error)
- func (a *LoyaltyApiService) AdjustLoyaltyPoints(ctx context.Context, body AdjustLoyaltyPointsRequest, accountId string) (AdjustLoyaltyPointsResponse, *http.Response, error)
- func (a *LoyaltyApiService) CalculateLoyaltyPoints(ctx context.Context, body CalculateLoyaltyPointsRequest, programId string) (CalculateLoyaltyPointsResponse, *http.Response, error)
- func (a *LoyaltyApiService) CancelLoyaltyPromotion(ctx context.Context, promotionId string, programId string) (CancelLoyaltyPromotionResponse, *http.Response, error)
- func (a *LoyaltyApiService) CreateLoyaltyAccount(ctx context.Context, body CreateLoyaltyAccountRequest) (CreateLoyaltyAccountResponse, *http.Response, error)
- func (a *LoyaltyApiService) CreateLoyaltyPromotion(ctx context.Context, body CreateLoyaltyPromotionRequest, programId string) (CreateLoyaltyPromotionResponse, *http.Response, error)
- func (a *LoyaltyApiService) CreateLoyaltyReward(ctx context.Context, body CreateLoyaltyRewardRequest) (CreateLoyaltyRewardResponse, *http.Response, error)
- func (a *LoyaltyApiService) DeleteLoyaltyReward(ctx context.Context, rewardId string) (DeleteLoyaltyRewardResponse, *http.Response, error)
- func (a *LoyaltyApiService) ListLoyaltyPrograms(ctx context.Context) (ListLoyaltyProgramsResponse, *http.Response, error)
- func (a *LoyaltyApiService) ListLoyaltyPromotions(ctx context.Context, programId string, ...) (ListLoyaltyPromotionsResponse, *http.Response, error)
- func (a *LoyaltyApiService) RedeemLoyaltyReward(ctx context.Context, body RedeemLoyaltyRewardRequest, rewardId string) (RedeemLoyaltyRewardResponse, *http.Response, error)
- func (a *LoyaltyApiService) RetrieveLoyaltyAccount(ctx context.Context, accountId string) (RetrieveLoyaltyAccountResponse, *http.Response, error)
- func (a *LoyaltyApiService) RetrieveLoyaltyProgram(ctx context.Context, programId string) (RetrieveLoyaltyProgramResponse, *http.Response, error)
- func (a *LoyaltyApiService) RetrieveLoyaltyPromotion(ctx context.Context, promotionId string, programId string) (RetrieveLoyaltyPromotionResponse, *http.Response, error)
- func (a *LoyaltyApiService) RetrieveLoyaltyReward(ctx context.Context, rewardId string) (RetrieveLoyaltyRewardResponse, *http.Response, error)
- func (a *LoyaltyApiService) SearchLoyaltyAccounts(ctx context.Context, body SearchLoyaltyAccountsRequest) (SearchLoyaltyAccountsResponse, *http.Response, error)
- func (a *LoyaltyApiService) SearchLoyaltyEvents(ctx context.Context, body SearchLoyaltyEventsRequest) (SearchLoyaltyEventsResponse, *http.Response, error)
- func (a *LoyaltyApiService) SearchLoyaltyRewards(ctx context.Context, body SearchLoyaltyRewardsRequest) (SearchLoyaltyRewardsResponse, *http.Response, error)
type LoyaltyEvent
type LoyaltyEventAccumulatePoints
type LoyaltyEventAccumulatePromotionPoints
type LoyaltyEventAdjustPoints
type LoyaltyEventCreateReward
type LoyaltyEventDateTimeFilter
type LoyaltyEventDeleteReward
type LoyaltyEventExpirePoints
type LoyaltyEventFilter
type LoyaltyEventLocationFilter
type LoyaltyEventLoyaltyAccountFilter
type LoyaltyEventOrderFilter
type LoyaltyEventOther
type LoyaltyEventQuery
type LoyaltyEventRedeemReward
type LoyaltyEventSource
type LoyaltyEventType
type LoyaltyEventTypeFilter
type LoyaltyProgram
type LoyaltyProgramAccrualRule
type LoyaltyProgramAccrualRuleCategoryData
type LoyaltyProgramAccrualRuleItemVariationData
type LoyaltyProgramAccrualRuleSpendData
type LoyaltyProgramAccrualRuleTaxMode
type LoyaltyProgramAccrualRuleType
type LoyaltyProgramAccrualRuleVisitData
type LoyaltyProgramExpirationPolicy
type LoyaltyProgramRewardDefinition
type LoyaltyProgramRewardDefinitionScope
type LoyaltyProgramRewardDefinitionType
type LoyaltyProgramRewardTier
type LoyaltyProgramStatus
type LoyaltyProgramTerminology
type LoyaltyPromotion
type LoyaltyPromotionAvailableTimeData
type LoyaltyPromotionIncentive
type LoyaltyPromotionIncentivePointsAdditionData
type LoyaltyPromotionIncentivePointsMultiplierData
type LoyaltyPromotionIncentiveType
type LoyaltyPromotionStatus
type LoyaltyPromotionTriggerLimit
type LoyaltyPromotionTriggerLimitInterval
type LoyaltyReward
type LoyaltyRewardStatus
type MeasurementUnit
type MeasurementUnitArea
type MeasurementUnitCustom
type MeasurementUnitGeneric
type MeasurementUnitLength
type MeasurementUnitTime
type MeasurementUnitUnitType
type MeasurementUnitVolume
type MeasurementUnitWeight
type Merchant
type MerchantCustomAttributesApiListMerchantCustomAttributeDefinitionsOpts
type MerchantCustomAttributesApiListMerchantCustomAttributesOpts
type MerchantCustomAttributesApiRetrieveMerchantCustomAttributeDefinitionOpts
type MerchantCustomAttributesApiRetrieveMerchantCustomAttributeOpts
type MerchantCustomAttributesApiService
- func (a *MerchantCustomAttributesApiService) BulkDeleteMerchantCustomAttributes(ctx context.Context, body BulkDeleteMerchantCustomAttributesRequest) (BulkDeleteMerchantCustomAttributesResponse, *http.Response, error)
- func (a *MerchantCustomAttributesApiService) BulkUpsertMerchantCustomAttributes(ctx context.Context, body BulkUpsertMerchantCustomAttributesRequest) (BulkUpsertMerchantCustomAttributesResponse, *http.Response, error)
- func (a *MerchantCustomAttributesApiService) CreateMerchantCustomAttributeDefinition(ctx context.Context, body CreateMerchantCustomAttributeDefinitionRequest) (CreateMerchantCustomAttributeDefinitionResponse, *http.Response, error)
- func (a *MerchantCustomAttributesApiService) DeleteMerchantCustomAttribute(ctx context.Context, merchantId string, key string) (DeleteMerchantCustomAttributeResponse, *http.Response, error)
- func (a *MerchantCustomAttributesApiService) DeleteMerchantCustomAttributeDefinition(ctx context.Context, key string) (DeleteMerchantCustomAttributeDefinitionResponse, *http.Response, error)
- func (a *MerchantCustomAttributesApiService) ListMerchantCustomAttributeDefinitions(ctx context.Context, ...) (ListMerchantCustomAttributeDefinitionsResponse, *http.Response, error)
- func (a *MerchantCustomAttributesApiService) ListMerchantCustomAttributes(ctx context.Context, merchantId string, ...) (ListMerchantCustomAttributesResponse, *http.Response, error)
- func (a *MerchantCustomAttributesApiService) RetrieveMerchantCustomAttribute(ctx context.Context, merchantId string, key string, ...) (RetrieveMerchantCustomAttributeResponse, *http.Response, error)
- func (a *MerchantCustomAttributesApiService) RetrieveMerchantCustomAttributeDefinition(ctx context.Context, key string, ...) (RetrieveMerchantCustomAttributeDefinitionResponse, *http.Response, error)
- func (a *MerchantCustomAttributesApiService) UpdateMerchantCustomAttributeDefinition(ctx context.Context, body UpdateMerchantCustomAttributeDefinitionRequest, ...) (UpdateMerchantCustomAttributeDefinitionResponse, *http.Response, error)
- func (a *MerchantCustomAttributesApiService) UpsertMerchantCustomAttribute(ctx context.Context, body UpsertMerchantCustomAttributeRequest, ...) (UpsertMerchantCustomAttributeResponse, *http.Response, error)
type MerchantStatus
type MerchantsApiListMerchantsOpts
type MerchantsApiService
- func (a *MerchantsApiService) ListMerchants(ctx context.Context, localVarOptionals *MerchantsApiListMerchantsOpts) (ListMerchantsResponse, *http.Response, error)
- func (a *MerchantsApiService) RetrieveMerchant(ctx context.Context, merchantId string) (RetrieveMerchantResponse, *http.Response, error)
type MobileAuthorizationApiService
- func (a *MobileAuthorizationApiService) CreateMobileAuthorizationCode(ctx context.Context, body CreateMobileAuthorizationCodeRequest) (CreateMobileAuthorizationCodeResponse, *http.Response, error)
type ModelBreak
type ModelError
type ModelRange
type ModifierLocationOverrides
type Money
type OAuthApiService
- func (a *OAuthApiService) ObtainToken(ctx context.Context, body ObtainTokenRequest) (ObtainTokenResponse, *http.Response, error)
- func (a *OAuthApiService) RetrieveTokenStatus(ctx context.Context) (RetrieveTokenStatusResponse, *http.Response, error)
- func (a *OAuthApiService) RevokeToken(ctx context.Context, body RevokeTokenRequest) (RevokeTokenResponse, *http.Response, error)
type ObtainTokenRequest
type ObtainTokenResponse
type Order
type OrderCreated
type OrderCreatedObject
type OrderCustomAttributesApiListOrderCustomAttributeDefinitionsOpts
type OrderCustomAttributesApiListOrderCustomAttributesOpts
type OrderCustomAttributesApiRetrieveOrderCustomAttributeDefinitionOpts
type OrderCustomAttributesApiRetrieveOrderCustomAttributeOpts
type OrderCustomAttributesApiService
- func (a *OrderCustomAttributesApiService) BulkDeleteOrderCustomAttributes(ctx context.Context, body BulkDeleteOrderCustomAttributesRequest) (BulkDeleteOrderCustomAttributesResponse, *http.Response, error)
- func (a *OrderCustomAttributesApiService) BulkUpsertOrderCustomAttributes(ctx context.Context, body BulkUpsertOrderCustomAttributesRequest) (BulkUpsertOrderCustomAttributesResponse, *http.Response, error)
- func (a *OrderCustomAttributesApiService) CreateOrderCustomAttributeDefinition(ctx context.Context, body CreateOrderCustomAttributeDefinitionRequest) (CreateOrderCustomAttributeDefinitionResponse, *http.Response, error)
- func (a *OrderCustomAttributesApiService) DeleteOrderCustomAttribute(ctx context.Context, orderId string, customAttributeKey string) (DeleteOrderCustomAttributeResponse, *http.Response, error)
- func (a *OrderCustomAttributesApiService) DeleteOrderCustomAttributeDefinition(ctx context.Context, key string) (DeleteOrderCustomAttributeDefinitionResponse, *http.Response, error)
- func (a *OrderCustomAttributesApiService) ListOrderCustomAttributeDefinitions(ctx context.Context, ...) (ListOrderCustomAttributeDefinitionsResponse, *http.Response, error)
- func (a *OrderCustomAttributesApiService) ListOrderCustomAttributes(ctx context.Context, orderId string, ...) (ListOrderCustomAttributesResponse, *http.Response, error)
- func (a *OrderCustomAttributesApiService) RetrieveOrderCustomAttribute(ctx context.Context, orderId string, customAttributeKey string, ...) (RetrieveOrderCustomAttributeResponse, *http.Response, error)
- func (a *OrderCustomAttributesApiService) RetrieveOrderCustomAttributeDefinition(ctx context.Context, key string, ...) (RetrieveOrderCustomAttributeDefinitionResponse, *http.Response, error)
- func (a *OrderCustomAttributesApiService) UpdateOrderCustomAttributeDefinition(ctx context.Context, body UpdateOrderCustomAttributeDefinitionRequest, ...) (UpdateOrderCustomAttributeDefinitionResponse, *http.Response, error)
- func (a *OrderCustomAttributesApiService) UpsertOrderCustomAttribute(ctx context.Context, body UpsertOrderCustomAttributeRequest, orderId string, ...) (UpsertOrderCustomAttributeResponse, *http.Response, error)
type OrderEntry
type OrderFulfillment
type OrderFulfillmentDeliveryDetails
type OrderFulfillmentDeliveryDetailsScheduleType
type OrderFulfillmentFulfillmentEntry
type OrderFulfillmentFulfillmentLineItemApplication
type OrderFulfillmentPickupDetails
type OrderFulfillmentPickupDetailsCurbsidePickupDetails
type OrderFulfillmentPickupDetailsScheduleType
type OrderFulfillmentRecipient
type OrderFulfillmentShipmentDetails
type OrderFulfillmentState
type OrderFulfillmentType
type OrderFulfillmentUpdated
type OrderFulfillmentUpdatedObject
type OrderFulfillmentUpdatedUpdate
type OrderLineItem
type OrderLineItemAppliedDiscount
type OrderLineItemAppliedServiceCharge
type OrderLineItemAppliedTax
type OrderLineItemDiscount
type OrderLineItemDiscountScope
type OrderLineItemDiscountType
type OrderLineItemItemType
type OrderLineItemModifier
type OrderLineItemPricingBlocklists
type OrderLineItemPricingBlocklistsBlockedDiscount
type OrderLineItemPricingBlocklistsBlockedTax
type OrderLineItemTax
type OrderLineItemTaxScope
type OrderLineItemTaxType
type OrderMoneyAmounts
type OrderPricingOptions
type OrderQuantityUnit
type OrderReturn
type OrderReturnDiscount
type OrderReturnLineItem
type OrderReturnLineItemModifier
type OrderReturnServiceCharge
type OrderReturnTax
type OrderReturnTip
type OrderReward
type OrderRoundingAdjustment
type OrderServiceCharge
type OrderServiceChargeCalculationPhase
type OrderServiceChargeScope
type OrderServiceChargeTreatmentType
type OrderServiceChargeType
type OrderSource
type OrderState
type OrderUpdated
type OrderUpdatedObject
type OrdersApiService
- func (a *OrdersApiService) BatchRetrieveOrders(ctx context.Context, body BatchRetrieveOrdersRequest) (BatchRetrieveOrdersResponse, *http.Response, error)
- func (a *OrdersApiService) CalculateOrder(ctx context.Context, body CalculateOrderRequest) (CalculateOrderResponse, *http.Response, error)
- func (a *OrdersApiService) CloneOrder(ctx context.Context, body CloneOrderRequest) (CloneOrderResponse, *http.Response, error)
- func (a *OrdersApiService) CreateOrder(ctx context.Context, body CreateOrderRequest) (CreateOrderResponse, *http.Response, error)
- func (a *OrdersApiService) PayOrder(ctx context.Context, body PayOrderRequest, orderId string) (PayOrderResponse, *http.Response, error)
- func (a *OrdersApiService) RetrieveOrder(ctx context.Context, orderId string) (RetrieveOrderResponse, *http.Response, error)
- func (a *OrdersApiService) SearchOrders(ctx context.Context, body SearchOrdersRequest) (SearchOrdersResponse, *http.Response, error)
- func (a *OrdersApiService) UpdateOrder(ctx context.Context, body UpdateOrderRequest, orderId string) (UpdateOrderResponse, *http.Response, error)
type PaginationCursor
type PauseSubscriptionRequest
type PauseSubscriptionResponse
type PayOrderRequest
type PayOrderResponse
type Payment
type PaymentBalanceActivityAppFeeRefundDetail
type PaymentBalanceActivityAppFeeRevenueDetail
type PaymentBalanceActivityAutomaticSavingsDetail
type PaymentBalanceActivityAutomaticSavingsReversedDetail
type PaymentBalanceActivityChargeDetail
type PaymentBalanceActivityDepositFeeDetail
type PaymentBalanceActivityDisputeDetail
type PaymentBalanceActivityFeeDetail
type PaymentBalanceActivityFreeProcessingDetail
type PaymentBalanceActivityHoldAdjustmentDetail
type PaymentBalanceActivityOpenDisputeDetail
type PaymentBalanceActivityOtherAdjustmentDetail
type PaymentBalanceActivityOtherDetail
type PaymentBalanceActivityRefundDetail
type PaymentBalanceActivityReleaseAdjustmentDetail
type PaymentBalanceActivityReserveHoldDetail
type PaymentBalanceActivityReserveReleaseDetail
type PaymentBalanceActivitySquareCapitalPaymentDetail
type PaymentBalanceActivitySquareCapitalReversedPaymentDetail
type PaymentBalanceActivityTaxOnFeeDetail
type PaymentBalanceActivityThirdPartyFeeDetail
type PaymentBalanceActivityThirdPartyFeeRefundDetail
type PaymentLink
type PaymentLinkRelatedResources
type PaymentOptions
type PaymentOptionsDelayAction
type PaymentRefund
type PaymentsApiListPaymentsOpts
type PaymentsApiService
- func (a *PaymentsApiService) CancelPayment(ctx context.Context, paymentId string) (CancelPaymentResponse, *http.Response, error)
- func (a *PaymentsApiService) CancelPaymentByIdempotencyKey(ctx context.Context, body CancelPaymentByIdempotencyKeyRequest) (CancelPaymentByIdempotencyKeyResponse, *http.Response, error)
- func (a *PaymentsApiService) CompletePayment(ctx context.Context, body CompletePaymentRequest, paymentId string) (CompletePaymentResponse, *http.Response, error)
- func (a *PaymentsApiService) CreatePayment(ctx context.Context, body CreatePaymentRequest) (CreatePaymentResponse, *http.Response, error)
- func (a *PaymentsApiService) GetPayment(ctx context.Context, paymentId string) (GetPaymentResponse, *http.Response, error)
- func (a *PaymentsApiService) ListPayments(ctx context.Context, localVarOptionals *PaymentsApiListPaymentsOpts) (ListPaymentsResponse, *http.Response, error)
- func (a *PaymentsApiService) UpdatePayment(ctx context.Context, body UpdatePaymentRequest, paymentId string) (UpdatePaymentResponse, *http.Response, error)
type Payout
type PayoutEntry
type PayoutFee
type PayoutFeeType
type PayoutStatus
type PayoutType
type PayoutsApiListPayoutEntriesOpts
type PayoutsApiListPayoutsOpts
type PayoutsApiService
- func (a *PayoutsApiService) GetPayout(ctx context.Context, payoutId string) (GetPayoutResponse, *http.Response, error)
- func (a *PayoutsApiService) ListPayoutEntries(ctx context.Context, payoutId string, ...) (ListPayoutEntriesResponse, *http.Response, error)
- func (a *PayoutsApiService) ListPayouts(ctx context.Context, localVarOptionals *PayoutsApiListPayoutsOpts) (ListPayoutsResponse, *http.Response, error)
type Phase
type PhaseInput
type PrePopulatedData
type ProcessingFee
type Product
type ProductType
type PublishInvoiceRequest
type PublishInvoiceResponse
type QrCodeOptions
type QuantityRatio
type QuickPay
type ReceiptOptions
type RedeemLoyaltyRewardRequest
type RedeemLoyaltyRewardResponse
type Refund
type RefundPaymentRequest
type RefundPaymentResponse
type RefundStatus
type RefundsApiListPaymentRefundsOpts
type RefundsApiService
- func (a *RefundsApiService) GetPaymentRefund(ctx context.Context, refundId string) (GetPaymentRefundResponse, *http.Response, error)
- func (a *RefundsApiService) ListPaymentRefunds(ctx context.Context, localVarOptionals *RefundsApiListPaymentRefundsOpts) (ListPaymentRefundsResponse, *http.Response, error)
- func (a *RefundsApiService) RefundPayment(ctx context.Context, body RefundPaymentRequest) (RefundPaymentResponse, *http.Response, error)
type RegisterDomainRequest
type RegisterDomainResponse
type RegisterDomainResponseStatus
type RemoveGroupFromCustomerRequest
type RemoveGroupFromCustomerResponse
type ResumeSubscriptionRequest
type ResumeSubscriptionResponse
type RetrieveBookingCustomAttributeDefinitionRequest
type RetrieveBookingCustomAttributeDefinitionResponse
type RetrieveBookingCustomAttributeRequest
type RetrieveBookingCustomAttributeResponse
type RetrieveBookingRequest
type RetrieveBookingResponse
type RetrieveBusinessBookingProfileRequest
type RetrieveBusinessBookingProfileResponse
type RetrieveCardRequest
type RetrieveCardResponse
type RetrieveCashDrawerShiftRequest
type RetrieveCashDrawerShiftResponse
type RetrieveCatalogObjectRequest
type RetrieveCatalogObjectResponse
type RetrieveCustomerCustomAttributeDefinitionRequest
type RetrieveCustomerCustomAttributeDefinitionResponse
type RetrieveCustomerCustomAttributeRequest
type RetrieveCustomerCustomAttributeResponse
type RetrieveCustomerGroupRequest
type RetrieveCustomerGroupResponse
type RetrieveCustomerRequest
type RetrieveCustomerResponse
type RetrieveCustomerSegmentRequest
type RetrieveCustomerSegmentResponse
type RetrieveDisputeEvidenceRequest
type RetrieveDisputeEvidenceResponse
type RetrieveDisputeRequest
type RetrieveDisputeResponse
type RetrieveEmployeeRequest
type RetrieveEmployeeResponse
type RetrieveGiftCardFromGanRequest
type RetrieveGiftCardFromGanResponse
type RetrieveGiftCardFromNonceRequest
type RetrieveGiftCardFromNonceResponse
type RetrieveGiftCardRequest
type RetrieveGiftCardResponse
type RetrieveInventoryAdjustmentRequest
type RetrieveInventoryAdjustmentResponse
type RetrieveInventoryChangesRequest
type RetrieveInventoryChangesResponse
type RetrieveInventoryCountRequest
type RetrieveInventoryCountResponse
type RetrieveInventoryPhysicalCountRequest
type RetrieveInventoryPhysicalCountResponse
type RetrieveInventoryTransferRequest
type RetrieveInventoryTransferResponse
type RetrieveLocationBookingProfileRequest
type RetrieveLocationBookingProfileResponse
type RetrieveLocationCustomAttributeDefinitionRequest
type RetrieveLocationCustomAttributeDefinitionResponse
type RetrieveLocationCustomAttributeRequest
type RetrieveLocationCustomAttributeResponse
type RetrieveLocationRequest
type RetrieveLocationResponse
type RetrieveLocationSettingsRequest
type RetrieveLocationSettingsResponse
type RetrieveLoyaltyAccountRequest
type RetrieveLoyaltyAccountResponse
type RetrieveLoyaltyProgramRequest
type RetrieveLoyaltyProgramResponse
type RetrieveLoyaltyPromotionRequest
type RetrieveLoyaltyPromotionResponse
type RetrieveLoyaltyRewardRequest
type RetrieveLoyaltyRewardResponse
type RetrieveMerchantCustomAttributeDefinitionRequest
type RetrieveMerchantCustomAttributeDefinitionResponse
type RetrieveMerchantCustomAttributeRequest
type RetrieveMerchantCustomAttributeResponse
type RetrieveMerchantRequest
type RetrieveMerchantResponse
type RetrieveMerchantSettingsRequest
type RetrieveMerchantSettingsResponse
type RetrieveOrderCustomAttributeDefinitionRequest
type RetrieveOrderCustomAttributeDefinitionResponse
type RetrieveOrderCustomAttributeRequest
type RetrieveOrderCustomAttributeResponse
type RetrieveOrderRequest
type RetrieveOrderResponse
type RetrievePaymentLinkRequest
type RetrievePaymentLinkResponse
type RetrieveSnippetRequest
type RetrieveSnippetResponse
type RetrieveSubscriptionRequest
type RetrieveSubscriptionResponse
type RetrieveTeamMemberBookingProfileRequest
type RetrieveTeamMemberBookingProfileResponse
type RetrieveTeamMemberRequest
type RetrieveTeamMemberResponse
type RetrieveTokenStatusRequest
type RetrieveTokenStatusResponse
type RetrieveTransactionRequest
type RetrieveTransactionResponse
type RetrieveVendorRequest
type RetrieveVendorResponse
type RetrieveWageSettingRequest
type RetrieveWageSettingResponse
type RetrieveWebhookSubscriptionRequest
type RetrieveWebhookSubscriptionResponse
type RevokeTokenRequest
type RevokeTokenResponse
type RiskEvaluation
type RiskEvaluationRiskLevel
type SaveCardOptions
type SearchAvailabilityFilter
type SearchAvailabilityQuery
type SearchAvailabilityRequest
type SearchAvailabilityResponse
type SearchCatalogItemsRequest
type SearchCatalogItemsRequestStockLevel
type SearchCatalogItemsResponse
type SearchCatalogObjectsRequest
type SearchCatalogObjectsResponse
type SearchCustomersRequest
type SearchCustomersResponse
type SearchEventsFilter
type SearchEventsQuery
type SearchEventsRequest
type SearchEventsResponse
type SearchEventsSort
type SearchEventsSortField
type SearchInvoicesRequest
type SearchInvoicesResponse
type SearchLoyaltyAccountsRequest
type SearchLoyaltyAccountsRequestLoyaltyAccountQuery
type SearchLoyaltyAccountsResponse
type SearchLoyaltyEventsRequest
type SearchLoyaltyEventsResponse
type SearchLoyaltyRewardsRequest
type SearchLoyaltyRewardsRequestLoyaltyRewardQuery
type SearchLoyaltyRewardsResponse
type SearchOrdersCustomerFilter
type SearchOrdersDateTimeFilter
type SearchOrdersFilter
type SearchOrdersFulfillmentFilter
type SearchOrdersQuery
type SearchOrdersRequest
type SearchOrdersResponse
type SearchOrdersSort
type SearchOrdersSortField
type SearchOrdersSourceFilter
type SearchOrdersStateFilter
type SearchShiftsRequest
type SearchShiftsResponse
type SearchSubscriptionsFilter
type SearchSubscriptionsQuery
type SearchSubscriptionsRequest
type SearchSubscriptionsResponse
type SearchTeamMembersFilter
type SearchTeamMembersQuery
type SearchTeamMembersRequest
type SearchTeamMembersResponse
type SearchTerminalActionsRequest
type SearchTerminalActionsResponse
type SearchTerminalCheckoutsRequest
type SearchTerminalCheckoutsResponse
type SearchTerminalRefundsRequest
type SearchTerminalRefundsResponse
type SearchVendorsRequest
type SearchVendorsRequestFilter
type SearchVendorsRequestSort
type SearchVendorsRequestSortField
type SearchVendorsResponse
type SegmentFilter
type SelectOption
type SelectOptions
type Shift
type ShiftFilter
type ShiftFilterStatus
type ShiftQuery
type ShiftSort
type ShiftSortField
type ShiftStatus
type ShiftWage
type ShiftWorkday
type ShiftWorkdayMatcher
type ShippingFee
type SignatureImage
type SignatureOptions
type Site
type SitesApiService
- func (a *SitesApiService) ListSites(ctx context.Context) (ListSitesResponse, *http.Response, error)
type Snippet
type SnippetResponse
type SnippetsApiService
- func (a *SnippetsApiService) DeleteSnippet(ctx context.Context, siteId string) (DeleteSnippetResponse, *http.Response, error)
- func (a *SnippetsApiService) RetrieveSnippet(ctx context.Context, siteId string) (RetrieveSnippetResponse, *http.Response, error)
- func (a *SnippetsApiService) UpsertSnippet(ctx context.Context, body UpsertSnippetRequest, siteId string) (UpsertSnippetResponse, *http.Response, error)
type SortOrder
type SourceApplication
type SquareAccountDetails
type StandardUnitDescription
type StandardUnitDescriptionGroup
type SubmitEvidenceRequest
type SubmitEvidenceResponse
type Subscription
type SubscriptionAction
type SubscriptionActionType
type SubscriptionCadence
type SubscriptionEvent
type SubscriptionEventInfo
type SubscriptionEventInfoCode
type SubscriptionEventSubscriptionEventType
type SubscriptionPhase
type SubscriptionPricing
type SubscriptionPricingType
type SubscriptionSource
type SubscriptionStatus
type SubscriptionTestResult
type SubscriptionsApiListSubscriptionEventsOpts
type SubscriptionsApiRetrieveSubscriptionOpts
type SubscriptionsApiService
- func (a *SubscriptionsApiService) BulkSwapPlan(ctx context.Context, body BulkSwapPlanRequest) (BulkSwapPlanResponse, *http.Response, error)
- func (a *SubscriptionsApiService) CancelSubscription(ctx context.Context, subscriptionId string) (CancelSubscriptionResponse, *http.Response, error)
- func (a *SubscriptionsApiService) ChangeBillingAnchorDate(ctx context.Context, body ChangeBillingAnchorDateRequest, ...) (ChangeBillingAnchorDateResponse, *http.Response, error)
- func (a *SubscriptionsApiService) CreateSubscription(ctx context.Context, body CreateSubscriptionRequest) (CreateSubscriptionResponse, *http.Response, error)
- func (a *SubscriptionsApiService) DeleteSubscriptionAction(ctx context.Context, subscriptionId string, actionId string) (DeleteSubscriptionActionResponse, *http.Response, error)
- func (a *SubscriptionsApiService) ListSubscriptionEvents(ctx context.Context, subscriptionId string, ...) (ListSubscriptionEventsResponse, *http.Response, error)
- func (a *SubscriptionsApiService) PauseSubscription(ctx context.Context, body PauseSubscriptionRequest, subscriptionId string) (PauseSubscriptionResponse, *http.Response, error)
- func (a *SubscriptionsApiService) ResumeSubscription(ctx context.Context, body ResumeSubscriptionRequest, subscriptionId string) (ResumeSubscriptionResponse, *http.Response, error)
- func (a *SubscriptionsApiService) RetrieveSubscription(ctx context.Context, subscriptionId string, ...) (RetrieveSubscriptionResponse, *http.Response, error)
- func (a *SubscriptionsApiService) SearchSubscriptions(ctx context.Context, body SearchSubscriptionsRequest) (SearchSubscriptionsResponse, *http.Response, error)
- func (a *SubscriptionsApiService) SwapPlan(ctx context.Context, body SwapPlanRequest, subscriptionId string) (SwapPlanResponse, *http.Response, error)
- func (a *SubscriptionsApiService) UpdateSubscription(ctx context.Context, body UpdateSubscriptionRequest, subscriptionId string) (UpdateSubscriptionResponse, *http.Response, error)
type SwapPlanRequest
type SwapPlanResponse
type TaxCalculationPhase
type TaxIds
type TaxInclusionType
type TeamApiService
- func (a *TeamApiService) BulkCreateTeamMembers(ctx context.Context, body BulkCreateTeamMembersRequest) (BulkCreateTeamMembersResponse, *http.Response, error)
- func (a *TeamApiService) BulkUpdateTeamMembers(ctx context.Context, body BulkUpdateTeamMembersRequest) (BulkUpdateTeamMembersResponse, *http.Response, error)
- func (a *TeamApiService) CreateTeamMember(ctx context.Context, body CreateTeamMemberRequest) (CreateTeamMemberResponse, *http.Response, error)
- func (a *TeamApiService) RetrieveTeamMember(ctx context.Context, teamMemberId string) (RetrieveTeamMemberResponse, *http.Response, error)
- func (a *TeamApiService) RetrieveWageSetting(ctx context.Context, teamMemberId string) (RetrieveWageSettingResponse, *http.Response, error)
- func (a *TeamApiService) SearchTeamMembers(ctx context.Context, body SearchTeamMembersRequest) (SearchTeamMembersResponse, *http.Response, error)
- func (a *TeamApiService) UpdateTeamMember(ctx context.Context, body UpdateTeamMemberRequest, teamMemberId string) (UpdateTeamMemberResponse, *http.Response, error)
- func (a *TeamApiService) UpdateWageSetting(ctx context.Context, body UpdateWageSettingRequest, teamMemberId string) (UpdateWageSettingResponse, *http.Response, error)
type TeamMember
type TeamMemberAssignedLocations
type TeamMemberAssignedLocationsAssignmentType
type TeamMemberBookingProfile
type TeamMemberInvitationStatus
type TeamMemberStatus
type TeamMemberWage
type Tender
type TenderBankAccountDetails
type TenderBankAccountDetailsStatus
type TenderBuyNowPayLaterDetails
type TenderBuyNowPayLaterDetailsBrand
type TenderBuyNowPayLaterDetailsStatus
type TenderCardDetails
type TenderCardDetailsEntryMethod
type TenderCardDetailsStatus
type TenderCashDetails
type TenderSquareAccountDetails
type TenderSquareAccountDetailsStatus
type TenderType
type TerminalAction
type TerminalActionActionType
type TerminalActionQuery
type TerminalActionQueryFilter
type TerminalActionQuerySort
type TerminalApiService
- func (a *TerminalApiService) CancelTerminalAction(ctx context.Context, actionId string) (CancelTerminalActionResponse, *http.Response, error)
- func (a *TerminalApiService) CancelTerminalCheckout(ctx context.Context, checkoutId string) (CancelTerminalCheckoutResponse, *http.Response, error)
- func (a *TerminalApiService) CancelTerminalRefund(ctx context.Context, terminalRefundId string) (CancelTerminalRefundResponse, *http.Response, error)
- func (a *TerminalApiService) CreateTerminalAction(ctx context.Context, body CreateTerminalActionRequest) (CreateTerminalActionResponse, *http.Response, error)
- func (a *TerminalApiService) CreateTerminalCheckout(ctx context.Context, body CreateTerminalCheckoutRequest) (CreateTerminalCheckoutResponse, *http.Response, error)
- func (a *TerminalApiService) CreateTerminalRefund(ctx context.Context, body CreateTerminalRefundRequest) (CreateTerminalRefundResponse, *http.Response, error)
- func (a *TerminalApiService) DismissTerminalAction(ctx context.Context, actionId string) (DismissTerminalActionResponse, *http.Response, error)
- func (a *TerminalApiService) DismissTerminalCheckout(ctx context.Context, checkoutId string) (DismissTerminalCheckoutResponse, *http.Response, error)
- func (a *TerminalApiService) DismissTerminalRefund(ctx context.Context, terminalRefundId string) (DismissTerminalRefundResponse, *http.Response, error)
- func (a *TerminalApiService) GetTerminalAction(ctx context.Context, actionId string) (GetTerminalActionResponse, *http.Response, error)
- func (a *TerminalApiService) GetTerminalCheckout(ctx context.Context, checkoutId string) (GetTerminalCheckoutResponse, *http.Response, error)
- func (a *TerminalApiService) GetTerminalRefund(ctx context.Context, terminalRefundId string) (GetTerminalRefundResponse, *http.Response, error)
- func (a *TerminalApiService) SearchTerminalActions(ctx context.Context, body SearchTerminalActionsRequest) (SearchTerminalActionsResponse, *http.Response, error)
- func (a *TerminalApiService) SearchTerminalCheckouts(ctx context.Context, body SearchTerminalCheckoutsRequest) (SearchTerminalCheckoutsResponse, *http.Response, error)
- func (a *TerminalApiService) SearchTerminalRefunds(ctx context.Context, body SearchTerminalRefundsRequest) (SearchTerminalRefundsResponse, *http.Response, error)
type TerminalCheckout
type TerminalCheckoutQuery
type TerminalCheckoutQueryFilter
type TerminalCheckoutQuerySort
type TerminalRefund
type TerminalRefundQuery
type TerminalRefundQueryFilter
type TerminalRefundQuerySort
type TestWebhookSubscriptionRequest
type TestWebhookSubscriptionResponse
type TimeRange
type TipSettings
type Transaction
type TransactionProduct
type TransactionType
type TransactionsApiListTransactionsOpts
type TransactionsApiService
- func (a *TransactionsApiService) CaptureTransaction(ctx context.Context, locationId string, transactionId string) (CaptureTransactionResponse, *http.Response, error)
- func (a *TransactionsApiService) ListTransactions(ctx context.Context, locationId string, ...) (ListTransactionsResponse, *http.Response, error)
- func (a *TransactionsApiService) RetrieveTransaction(ctx context.Context, locationId string, transactionId string) (RetrieveTransactionResponse, *http.Response, error)
- func (a *TransactionsApiService) VoidTransaction(ctx context.Context, locationId string, transactionId string) (VoidTransactionResponse, *http.Response, error)
type UnlinkCustomerFromGiftCardRequest
type UnlinkCustomerFromGiftCardResponse
type UpdateBookingCustomAttributeDefinitionRequest
type UpdateBookingCustomAttributeDefinitionResponse
type UpdateBookingRequest
type UpdateBookingResponse
type UpdateBreakTypeRequest
type UpdateBreakTypeResponse
type UpdateCustomerCustomAttributeDefinitionRequest
type UpdateCustomerCustomAttributeDefinitionResponse
type UpdateCustomerGroupRequest
type UpdateCustomerGroupResponse
type UpdateCustomerRequest
type UpdateCustomerResponse
type UpdateInvoiceRequest
type UpdateInvoiceResponse
type UpdateItemModifierListsRequest
type UpdateItemModifierListsResponse
type UpdateItemTaxesRequest
type UpdateItemTaxesResponse
type UpdateLocationCustomAttributeDefinitionRequest
type UpdateLocationCustomAttributeDefinitionResponse
type UpdateLocationRequest
type UpdateLocationResponse
type UpdateLocationSettingsRequest
type UpdateLocationSettingsResponse
type UpdateMerchantCustomAttributeDefinitionRequest
type UpdateMerchantCustomAttributeDefinitionResponse
type UpdateMerchantSettingsRequest
type UpdateMerchantSettingsResponse
type UpdateOrderCustomAttributeDefinitionRequest
type UpdateOrderCustomAttributeDefinitionResponse
type UpdateOrderRequest
type UpdateOrderResponse
type UpdatePaymentLinkRequest
type UpdatePaymentLinkResponse
type UpdatePaymentRequest
type UpdatePaymentResponse
type UpdateShiftRequest
type UpdateShiftResponse
type UpdateSubscriptionRequest
type UpdateSubscriptionResponse
type UpdateTeamMemberRequest
type UpdateTeamMemberResponse
type UpdateVendorRequest
type UpdateVendorResponse
type UpdateWageSettingRequest
type UpdateWageSettingResponse
type UpdateWebhookSubscriptionRequest
type UpdateWebhookSubscriptionResponse
type UpdateWebhookSubscriptionSignatureKeyRequest
type UpdateWebhookSubscriptionSignatureKeyResponse
type UpdateWorkweekConfigRequest
type UpdateWorkweekConfigResponse
type UpsertBookingCustomAttributeRequest
type UpsertBookingCustomAttributeResponse
type UpsertCatalogObjectRequest
type UpsertCatalogObjectResponse
type UpsertCustomerCustomAttributeRequest
type UpsertCustomerCustomAttributeResponse
type UpsertLocationCustomAttributeRequest
type UpsertLocationCustomAttributeResponse
type UpsertMerchantCustomAttributeRequest
type UpsertMerchantCustomAttributeResponse
type UpsertOrderCustomAttributeRequest
type UpsertOrderCustomAttributeResponse
type UpsertSnippetRequest
type UpsertSnippetResponse
type V1Device
type V1ListOrdersRequest
type V1ListOrdersResponse
type V1Money
type V1Order
type V1OrderHistoryEntry
type V1OrderHistoryEntryAction
type V1OrderState
type V1PhoneNumber
type V1RetrieveOrderRequest
type V1Tender
type V1TenderCardBrand
type V1TenderEntryMethod
type V1TenderType
type V1TransactionsApiService
- func (a *V1TransactionsApiService) V1ListOrders(ctx context.Context, locationId string, ...) ([]V1Order, *http.Response, error)
- func (a *V1TransactionsApiService) V1RetrieveOrder(ctx context.Context, locationId string, orderId string) (V1Order, *http.Response, error)
- func (a *V1TransactionsApiService) V1UpdateOrder(ctx context.Context, body V1UpdateOrderRequest, locationId string, ...) (V1Order, *http.Response, error)
type V1TransactionsApiV1ListOrdersOpts
type V1UpdateOrderRequest
type V1UpdateOrderRequestAction
type Vendor
type VendorContact
type VendorStatus
type VendorsApiService
- func (a *VendorsApiService) BulkCreateVendors(ctx context.Context, body BulkCreateVendorsRequest) (BulkCreateVendorsResponse, *http.Response, error)
- func (a *VendorsApiService) BulkRetrieveVendors(ctx context.Context, body BulkRetrieveVendorsRequest) (BulkRetrieveVendorsResponse, *http.Response, error)
- func (a *VendorsApiService) BulkUpdateVendors(ctx context.Context, body BulkUpdateVendorsRequest) (BulkUpdateVendorsResponse, *http.Response, error)
- func (a *VendorsApiService) CreateVendor(ctx context.Context, body CreateVendorRequest) (CreateVendorResponse, *http.Response, error)
- func (a *VendorsApiService) RetrieveVendor(ctx context.Context, vendorId string) (RetrieveVendorResponse, *http.Response, error)
- func (a *VendorsApiService) SearchVendors(ctx context.Context, body SearchVendorsRequest) (SearchVendorsResponse, *http.Response, error)
- func (a *VendorsApiService) UpdateVendor(ctx context.Context, body UpdateVendorRequest, vendorId string) (UpdateVendorResponse, *http.Response, error)
type VisibilityFilter
type VoidTransactionRequest
type VoidTransactionResponse
type WageSetting
type WebhookSubscription
type WebhookSubscriptionsApiListWebhookEventTypesOpts
type WebhookSubscriptionsApiListWebhookSubscriptionsOpts
type WebhookSubscriptionsApiService
- func (a *WebhookSubscriptionsApiService) CreateWebhookSubscription(ctx context.Context, body CreateWebhookSubscriptionRequest) (CreateWebhookSubscriptionResponse, *http.Response, error)
- func (a *WebhookSubscriptionsApiService) DeleteWebhookSubscription(ctx context.Context, subscriptionId string) (DeleteWebhookSubscriptionResponse, *http.Response, error)
- func (a *WebhookSubscriptionsApiService) ListWebhookEventTypes(ctx context.Context, ...) (ListWebhookEventTypesResponse, *http.Response, error)
- func (a *WebhookSubscriptionsApiService) ListWebhookSubscriptions(ctx context.Context, ...) (ListWebhookSubscriptionsResponse, *http.Response, error)
- func (a *WebhookSubscriptionsApiService) RetrieveWebhookSubscription(ctx context.Context, subscriptionId string) (RetrieveWebhookSubscriptionResponse, *http.Response, error)
- func (a *WebhookSubscriptionsApiService) TestWebhookSubscription(ctx context.Context, body TestWebhookSubscriptionRequest, ...) (TestWebhookSubscriptionResponse, *http.Response, error)
- func (a *WebhookSubscriptionsApiService) UpdateWebhookSubscription(ctx context.Context, body UpdateWebhookSubscriptionRequest, ...) (UpdateWebhookSubscriptionResponse, *http.Response, error)
- func (a *WebhookSubscriptionsApiService) UpdateWebhookSubscriptionSignatureKey(ctx context.Context, body UpdateWebhookSubscriptionSignatureKeyRequest, ...) (UpdateWebhookSubscriptionSignatureKeyResponse, *http.Response, error)
type Weekday
type WorkweekConfig

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	ApplePayApi *ApplePayApiService

	BankAccountsApi *BankAccountsApiService

	BookingCustomAttributesApi *BookingCustomAttributesApiService

	BookingsApi *BookingsApiService

	CardsApi *CardsApiService

	CashDrawersApi *CashDrawersApiService

	CatalogApi *CatalogApiService

	CheckoutApi *CheckoutApiService

	CustomerCustomAttributesApi *CustomerCustomAttributesApiService

	CustomerGroupsApi *CustomerGroupsApiService

	CustomerSegmentsApi *CustomerSegmentsApiService

	CustomersApi *CustomersApiService

	DevicesApi *DevicesApiService

	DisputesApi *DisputesApiService

	EmployeesApi *EmployeesApiService

	EventsApi *EventsApiService

	GiftCardActivitiesApi *GiftCardActivitiesApiService

	GiftCardsApi *GiftCardsApiService

	InventoryApi *InventoryApiService

	InvoicesApi *InvoicesApiService

	LaborApi *LaborApiService

	LocationCustomAttributesApi *LocationCustomAttributesApiService

	LocationsApi *LocationsApiService

	LoyaltyApi *LoyaltyApiService

	MerchantCustomAttributesApi *MerchantCustomAttributesApiService

	MerchantsApi *MerchantsApiService

	MobileAuthorizationApi *MobileAuthorizationApiService

	OAuthApi *OAuthApiService

	OrderCustomAttributesApi *OrderCustomAttributesApiService

	OrdersApi *OrdersApiService

	PaymentsApi *PaymentsApiService

	PayoutsApi *PayoutsApiService

	RefundsApi *RefundsApiService

	SitesApi *SitesApiService

	SnippetsApi *SnippetsApiService

	SubscriptionsApi *SubscriptionsApiService

	TeamApi *TeamApiService

	TerminalApi *TerminalApiService

	TransactionsApi *TransactionsApiService

	V1TransactionsApi *V1TransactionsApiService

	VendorsApi *VendorsApiService

	WebhookSubscriptionsApi *WebhookSubscriptionsApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Square Connect API API v2.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AcceptDisputeRequest ¶

type AcceptDisputeRequest struct{}

Defines the request parameters for the `AcceptDispute` endpoint.

type AcceptDisputeResponse ¶

type AcceptDisputeResponse struct {
	// Information about errors encountered during the request.
	Errors  []ModelError `json:"errors,omitempty"`
	Dispute *Dispute     `json:"dispute,omitempty"`
}

Defines the fields in an `AcceptDispute` response.

type AcceptedPaymentMethods ¶

type AcceptedPaymentMethods struct {
	// Whether Apple Pay is accepted at checkout.
	ApplePay bool `json:"apple_pay,omitempty"`
	// Whether Google Pay is accepted at checkout.
	GooglePay bool `json:"google_pay,omitempty"`
	// Whether Cash App Pay is accepted at checkout.
	CashAppPay bool `json:"cash_app_pay,omitempty"`
	// Whether Afterpay/Clearpay is accepted at checkout.
	AfterpayClearpay bool `json:"afterpay_clearpay,omitempty"`
}

type AccumulateLoyaltyPointsRequest ¶

type AccumulateLoyaltyPointsRequest struct {
	AccumulatePoints *LoyaltyEventAccumulatePoints `json:"accumulate_points"`
	// A unique string that identifies the `AccumulateLoyaltyPoints` request.  Keys can be any valid string but must be unique for every request.
	IdempotencyKey string `json:"idempotency_key"`
	// The [location](https://developer.squareup.com/reference/square_2024-07-17/objects/Location) where the purchase was made.
	LocationId string `json:"location_id"`
}

Represents an [AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/accumulate-loyalty-points) request.

type AccumulateLoyaltyPointsResponse ¶

type AccumulateLoyaltyPointsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError  `json:"errors,omitempty"`
	Event  *LoyaltyEvent `json:"event,omitempty"`
	// The resulting loyalty events. If the purchase qualifies for points, the `ACCUMULATE_POINTS` event is always included. When using the Orders API, the `ACCUMULATE_PROMOTION_POINTS` event is included if the purchase also qualifies for a loyalty promotion.
	Events []LoyaltyEvent `json:"events,omitempty"`
}

Represents an [AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/accumulate-loyalty-points) response.

type AchDetails ¶

type AchDetails struct {
	// The routing number for the bank account.
	RoutingNumber string `json:"routing_number,omitempty"`
	// The last few digits of the bank account number.
	AccountNumberSuffix string `json:"account_number_suffix,omitempty"`
	// The type of the bank account performing the transfer. The account type can be `CHECKING`, `SAVINGS`, or `UNKNOWN`.
	AccountType string `json:"account_type,omitempty"`
}

ACH-specific details about `BANK_ACCOUNT` type payments with the `transfer_type` of `ACH`.

type ActionCancelReason ¶

type ActionCancelReason string

const (
	BUYER_CANCELED_ActionCancelReason  ActionCancelReason = "BUYER_CANCELED"
	SELLER_CANCELED_ActionCancelReason ActionCancelReason = "SELLER_CANCELED"
	TIMED_OUT_ActionCancelReason       ActionCancelReason = "TIMED_OUT"
)

List of ActionCancelReason

type ActivityType ¶

type ActivityType string

const (
	ADJUSTMENT_ActivityType                               ActivityType = "ADJUSTMENT"
	APP_FEE_REFUND_ActivityType                           ActivityType = "APP_FEE_REFUND"
	APP_FEE_REVENUE_ActivityType                          ActivityType = "APP_FEE_REVENUE"
	AUTOMATIC_SAVINGS_ActivityType                        ActivityType = "AUTOMATIC_SAVINGS"
	AUTOMATIC_SAVINGS_REVERSED_ActivityType               ActivityType = "AUTOMATIC_SAVINGS_REVERSED"
	CHARGE_ActivityType                                   ActivityType = "CHARGE"
	DEPOSIT_FEE_ActivityType                              ActivityType = "DEPOSIT_FEE"
	DISPUTE_ActivityType                                  ActivityType = "DISPUTE"
	ESCHEATMENT_ActivityType                              ActivityType = "ESCHEATMENT"
	FEE_ActivityType                                      ActivityType = "FEE"
	FREE_PROCESSING_ActivityType                          ActivityType = "FREE_PROCESSING"
	HOLD_ADJUSTMENT_ActivityType                          ActivityType = "HOLD_ADJUSTMENT"
	INITIAL_BALANCE_CHANGE_ActivityType                   ActivityType = "INITIAL_BALANCE_CHANGE"
	MONEY_TRANSFER_ActivityType                           ActivityType = "MONEY_TRANSFER"
	MONEY_TRANSFER_REVERSAL_ActivityType                  ActivityType = "MONEY_TRANSFER_REVERSAL"
	OPEN_DISPUTE_ActivityType                             ActivityType = "OPEN_DISPUTE"
	OTHER_ActivityType                                    ActivityType = "OTHER"
	OTHER_ADJUSTMENT_ActivityType                         ActivityType = "OTHER_ADJUSTMENT"
	PAID_SERVICE_FEE_ActivityType                         ActivityType = "PAID_SERVICE_FEE"
	PAID_SERVICE_FEE_REFUND_ActivityType                  ActivityType = "PAID_SERVICE_FEE_REFUND"
	REDEMPTION_CODE_ActivityType                          ActivityType = "REDEMPTION_CODE"
	REFUND_ActivityType                                   ActivityType = "REFUND"
	RELEASE_ADJUSTMENT_ActivityType                       ActivityType = "RELEASE_ADJUSTMENT"
	RESERVE_HOLD_ActivityType                             ActivityType = "RESERVE_HOLD"
	RESERVE_RELEASE_ActivityType                          ActivityType = "RESERVE_RELEASE"
	RETURNED_PAYOUT_ActivityType                          ActivityType = "RETURNED_PAYOUT"
	SQUARE_CAPITAL_PAYMENT_ActivityType                   ActivityType = "SQUARE_CAPITAL_PAYMENT"
	SQUARE_CAPITAL_REVERSED_PAYMENT_ActivityType          ActivityType = "SQUARE_CAPITAL_REVERSED_PAYMENT"
	SUBSCRIPTION_FEE_ActivityType                         ActivityType = "SUBSCRIPTION_FEE"
	SUBSCRIPTION_FEE_PAID_REFUND_ActivityType             ActivityType = "SUBSCRIPTION_FEE_PAID_REFUND"
	SUBSCRIPTION_FEE_REFUND_ActivityType                  ActivityType = "SUBSCRIPTION_FEE_REFUND"
	TAX_ON_FEE_ActivityType                               ActivityType = "TAX_ON_FEE"
	THIRD_PARTY_FEE_ActivityType                          ActivityType = "THIRD_PARTY_FEE"
	THIRD_PARTY_FEE_REFUND_ActivityType                   ActivityType = "THIRD_PARTY_FEE_REFUND"
	PAYOUT_ActivityType                                   ActivityType = "PAYOUT"
	AUTOMATIC_BITCOIN_CONVERSIONS_ActivityType            ActivityType = "AUTOMATIC_BITCOIN_CONVERSIONS"
	AUTOMATIC_BITCOIN_CONVERSIONS_REVERSED_ActivityType   ActivityType = "AUTOMATIC_BITCOIN_CONVERSIONS_REVERSED"
	CREDIT_CARD_REPAYMENT_ActivityType                    ActivityType = "CREDIT_CARD_REPAYMENT"
	CREDIT_CARD_REPAYMENT_REVERSED_ActivityType           ActivityType = "CREDIT_CARD_REPAYMENT_REVERSED"
	LOCAL_OFFERS_CASHBACK_ActivityType                    ActivityType = "LOCAL_OFFERS_CASHBACK"
	LOCAL_OFFERS_FEE_ActivityType                         ActivityType = "LOCAL_OFFERS_FEE"
	PERCENTAGE_PROCESSING_ENROLLMENT_ActivityType         ActivityType = "PERCENTAGE_PROCESSING_ENROLLMENT"
	PERCENTAGE_PROCESSING_DEACTIVATION_ActivityType       ActivityType = "PERCENTAGE_PROCESSING_DEACTIVATION"
	PERCENTAGE_PROCESSING_REPAYMENT_ActivityType          ActivityType = "PERCENTAGE_PROCESSING_REPAYMENT"
	PERCENTAGE_PROCESSING_REPAYMENT_REVERSED_ActivityType ActivityType = "PERCENTAGE_PROCESSING_REPAYMENT_REVERSED"
	PROCESSING_FEE_ActivityType                           ActivityType = "PROCESSING_FEE"
	PROCESSING_FEE_REFUND_ActivityType                    ActivityType = "PROCESSING_FEE_REFUND"
	UNDO_PROCESSING_FEE_REFUND_ActivityType               ActivityType = "UNDO_PROCESSING_FEE_REFUND"
	GIFT_CARD_LOAD_FEE_ActivityType                       ActivityType = "GIFT_CARD_LOAD_FEE"
	GIFT_CARD_LOAD_FEE_REFUND_ActivityType                ActivityType = "GIFT_CARD_LOAD_FEE_REFUND"
	UNDO_GIFT_CARD_LOAD_FEE_REFUND_ActivityType           ActivityType = "UNDO_GIFT_CARD_LOAD_FEE_REFUND"
	BALANCE_FOLDERS_TRANSFER_ActivityType                 ActivityType = "BALANCE_FOLDERS_TRANSFER"
	BALANCE_FOLDERS_TRANSFER_REVERSED_ActivityType        ActivityType = "BALANCE_FOLDERS_TRANSFER_REVERSED"
	GIFT_CARD_POOL_TRANSFER_ActivityType                  ActivityType = "GIFT_CARD_POOL_TRANSFER"
	GIFT_CARD_POOL_TRANSFER_REVERSED_ActivityType         ActivityType = "GIFT_CARD_POOL_TRANSFER_REVERSED"
)

List of ActivityType

type AddGroupToCustomerRequest ¶

type AddGroupToCustomerRequest struct{}

Defines the fields that are included in the request body of a request to the [AddGroupToCustomer](https://developer.squareup.com/reference/square_2024-07-17/customers-api/add-group-to-customer) endpoint.

type AddGroupToCustomerResponse ¶

type AddGroupToCustomerResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields that are included in the response body of a request to the [AddGroupToCustomer](https://developer.squareup.com/reference/square_2024-07-17/customers-api/add-group-to-customer) endpoint.

type AdditionalRecipient ¶

type AdditionalRecipient struct {
	// The location ID for a recipient (other than the merchant) receiving a portion of this tender.
	LocationId string `json:"location_id"`
	// The description of the additional recipient.
	Description string `json:"description,omitempty"`
	AmountMoney *Money `json:"amount_money"`
	// The unique ID for the RETIRED `AdditionalRecipientReceivable` object. This field should be empty for any `AdditionalRecipient` objects created after the retirement.
	ReceivableId string `json:"receivable_id,omitempty"`
}

Represents an additional recipient (other than the merchant) receiving a portion of this tender.

type Address ¶

type Address struct {
	// The first line of the address.  Fields that start with `address_line` provide the address's most specific details, like street number, street name, and building name. They do *not* provide less specific details like city, state/province, or country (these details are provided in other fields).
	AddressLine1 string `json:"address_line_1,omitempty"`
	// The second line of the address, if any.
	AddressLine2 string `json:"address_line_2,omitempty"`
	// The third line of the address, if any.
	AddressLine3 string `json:"address_line_3,omitempty"`
	// The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).
	Locality string `json:"locality,omitempty"`
	// A civil region within the address's `locality`, if any.
	Sublocality string `json:"sublocality,omitempty"`
	// A civil region within the address's `sublocality`, if any.
	Sublocality2 string `json:"sublocality_2,omitempty"`
	// A civil region within the address's `sublocality_2`, if any.
	Sublocality3 string `json:"sublocality_3,omitempty"`
	// A civil entity within the address's country. In the US, this is the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).
	AdministrativeDistrictLevel1 string `json:"administrative_district_level_1,omitempty"`
	// A civil entity within the address's `administrative_district_level_1`. In the US, this is the county.
	AdministrativeDistrictLevel2 string `json:"administrative_district_level_2,omitempty"`
	// A civil entity within the address's `administrative_district_level_2`, if any.
	AdministrativeDistrictLevel3 string `json:"administrative_district_level_3,omitempty"`
	// The address's postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).
	PostalCode string `json:"postal_code,omitempty"`
	// The address's country, in the two-letter format of ISO 3166. For example, `US` or `FR`.
	Country string `json:"country,omitempty"`
	// Optional first name when it's representing recipient.
	FirstName string `json:"first_name,omitempty"`
	// Optional last name when it's representing recipient.
	LastName string `json:"last_name,omitempty"`
}

Represents a postal address in a country. For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).

type AdjustLoyaltyPointsRequest ¶

type AdjustLoyaltyPointsRequest struct {
	// A unique string that identifies this `AdjustLoyaltyPoints` request.  Keys can be any valid string, but must be unique for every request.
	IdempotencyKey string                    `json:"idempotency_key"`
	AdjustPoints   *LoyaltyEventAdjustPoints `json:"adjust_points"`
	// Indicates whether to allow a negative adjustment to result in a negative balance. If `true`, a negative balance is allowed when subtracting points. If `false`, Square returns a `BAD_REQUEST` error when subtracting the specified number of points would result in a negative balance. The default value is `false`.
	AllowNegativeBalance bool `json:"allow_negative_balance,omitempty"`
}

Represents an [AdjustLoyaltyPoints](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/adjust-loyalty-points) request.

type AdjustLoyaltyPointsResponse ¶

type AdjustLoyaltyPointsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError  `json:"errors,omitempty"`
	Event  *LoyaltyEvent `json:"event,omitempty"`
}

Represents an [AdjustLoyaltyPoints](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/adjust-loyalty-points) request.

type AfterpayDetails ¶

type AfterpayDetails struct {
	// Email address on the buyer's Afterpay account.
	EmailAddress string `json:"email_address,omitempty"`
}

Additional details about Afterpay payments.

type ApplePayApiService ¶

type ApplePayApiService service

func (*ApplePayApiService) RegisterDomain ¶

func (a *ApplePayApiService) RegisterDomain(ctx context.Context, body RegisterDomainRequest) (RegisterDomainResponse, *http.Response, error)

ApplePayApiService RegisterDomain Activates a domain for use with Apple Pay on the Web and Square. A validation is performed on this domain by Apple to ensure that it is properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Apple Pay on the Web with Square for merchants using their platform. Note: You will need to host a valid domain verification file on your domain to support Apple Pay. The current version of this file is always available at https://app.squareup.com/digital-wallets/apple-pay/apple-developer-merchantid-domain-association, and should be hosted at `.well_known/apple-developer-merchantid-domain-association` on your domain. This file is subject to change; we strongly recommend checking for updates regularly and avoiding long-lived caches that might not keep in sync with the correct file version. To learn more about the Web Payments SDK and how to add Apple Pay, see [Take an Apple Pay Payment](https://developer.squareup.com/docs/web-payments/apple-pay).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return RegisterDomainResponse

type ApplicationDetails ¶

type ApplicationDetails struct {
	// The Square product, such as Square Point of Sale (POS),  Square Invoices, or Square Virtual Terminal.
	SquareProduct string `json:"square_product,omitempty"`
	// The Square ID assigned to the application used to take the payment.  Application developers can use this information to identify payments that  their application processed.  For example, if a developer uses a custom application to process payments,  this field contains the application ID from the Developer Dashboard.  If a seller uses a [Square App Marketplace](https://developer.squareup.com/docs/app-marketplace)  application to process payments, the field contains the corresponding application ID.
	ApplicationId string `json:"application_id,omitempty"`
}

Details about the application that took the payment.

type ApplicationDetailsExternalSquareProduct ¶

type ApplicationDetailsExternalSquareProduct string

ApplicationDetailsExternalSquareProduct : A list of products to return to external callers.

const (
	APPOINTMENTS_ApplicationDetailsExternalSquareProduct     ApplicationDetailsExternalSquareProduct = "APPOINTMENTS"
	ECOMMERCE_API_ApplicationDetailsExternalSquareProduct    ApplicationDetailsExternalSquareProduct = "ECOMMERCE_API"
	INVOICES_ApplicationDetailsExternalSquareProduct         ApplicationDetailsExternalSquareProduct = "INVOICES"
	ONLINE_STORE_ApplicationDetailsExternalSquareProduct     ApplicationDetailsExternalSquareProduct = "ONLINE_STORE"
	OTHER_ApplicationDetailsExternalSquareProduct            ApplicationDetailsExternalSquareProduct = "OTHER"
	RESTAURANTS_ApplicationDetailsExternalSquareProduct      ApplicationDetailsExternalSquareProduct = "RESTAURANTS"
	RETAIL_ApplicationDetailsExternalSquareProduct           ApplicationDetailsExternalSquareProduct = "RETAIL"
	SQUARE_POS_ApplicationDetailsExternalSquareProduct       ApplicationDetailsExternalSquareProduct = "SQUARE_POS"
	TERMINAL_API_ApplicationDetailsExternalSquareProduct     ApplicationDetailsExternalSquareProduct = "TERMINAL_API"
	VIRTUAL_TERMINAL_ApplicationDetailsExternalSquareProduct ApplicationDetailsExternalSquareProduct = "VIRTUAL_TERMINAL"
)

List of ApplicationDetailsExternalSquareProduct

type ApplicationType ¶

type ApplicationType string

const (
	TERMINAL_API_ApplicationType ApplicationType = "TERMINAL_API"
)

List of ApplicationType

type AppointmentSegment ¶

type AppointmentSegment struct {
	// The time span in minutes of an appointment segment.
	DurationMinutes int32 `json:"duration_minutes,omitempty"`
	// The ID of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItemVariation) object representing the service booked in this segment.
	ServiceVariationId string `json:"service_variation_id,omitempty"`
	// The ID of the [TeamMember](https://developer.squareup.com/reference/square_2024-07-17/objects/TeamMember) object representing the team member booked in this segment.
	TeamMemberId string `json:"team_member_id"`
	// The current version of the item variation representing the service booked in this segment.
	ServiceVariationVersion int64 `json:"service_variation_version,omitempty"`
	// Time between the end of this segment and the beginning of the subsequent segment.
	IntermissionMinutes int32 `json:"intermission_minutes,omitempty"`
	// Whether the customer accepts any team member, instead of a specific one, to serve this segment.
	AnyTeamMember bool `json:"any_team_member,omitempty"`
	// The IDs of the seller-accessible resources used for this appointment segment.
	ResourceIds []string `json:"resource_ids,omitempty"`
}

Defines an appointment segment of a booking.

type ArchivedState ¶

type ArchivedState string

ArchivedState : Defines the values for the `archived_state` query expression used in [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-07-17/catalog-api/search-catalog-items) to return the archived, not archived or either type of catalog items.

const (
	NOT_ARCHIVED_ArchivedState ArchivedState = "ARCHIVED_STATE_NOT_ARCHIVED"
	ARCHIVED_ArchivedState     ArchivedState = "ARCHIVED_STATE_ARCHIVED"
	ALL_ArchivedState          ArchivedState = "ARCHIVED_STATE_ALL"
)

List of ArchivedState

type Availability ¶

type Availability struct {
	// The RFC 3339 timestamp specifying the beginning time of the slot available for booking.
	StartAt string `json:"start_at,omitempty"`
	// The ID of the location available for booking.
	LocationId string `json:"location_id,omitempty"`
	// The list of appointment segments available for booking
	AppointmentSegments []AppointmentSegment `json:"appointment_segments,omitempty"`
}

Defines an appointment slot that encapsulates the appointment segments, location and starting time available for booking.

type BankAccount ¶

type BankAccount struct {
	// The unique, Square-issued identifier for the bank account.
	Id string `json:"id"`
	// The last few digits of the account number.
	AccountNumberSuffix string `json:"account_number_suffix"`
	// The ISO 3166 Alpha-2 country code where the bank account is based.
	Country string `json:"country"`
	// The 3-character ISO 4217 currency code indicating the operating currency of the bank account. For example, the currency code for US dollars is `USD`.
	Currency string `json:"currency"`
	// The financial purpose of the associated bank account.
	AccountType string `json:"account_type"`
	// Name of the account holder. This name must match the name  on the targeted bank account record.
	HolderName string `json:"holder_name"`
	// Primary identifier for the bank. For more information, see  [Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api).
	PrimaryBankIdentificationNumber string `json:"primary_bank_identification_number"`
	// Secondary identifier for the bank. For more information, see  [Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api).
	SecondaryBankIdentificationNumber string `json:"secondary_bank_identification_number,omitempty"`
	// Reference identifier that will be displayed to UK bank account owners when collecting direct debit authorization. Only required for UK bank accounts.
	DebitMandateReferenceId string `json:"debit_mandate_reference_id,omitempty"`
	// Client-provided identifier for linking the banking account to an entity in a third-party system (for example, a bank account number or a user identifier).
	ReferenceId string `json:"reference_id,omitempty"`
	// The location to which the bank account belongs.
	LocationId string `json:"location_id,omitempty"`
	// Read-only. The current verification status of this BankAccount object.
	Status string `json:"status"`
	// Indicates whether it is possible for Square to send money to this bank account.
	Creditable bool `json:"creditable"`
	// Indicates whether it is possible for Square to take money from this  bank account.
	Debitable bool `json:"debitable"`
	// A Square-assigned, unique identifier for the bank account based on the account information. The account fingerprint can be used to compare account entries and determine if the they represent the same real-world bank account.
	Fingerprint string `json:"fingerprint,omitempty"`
	// The current version of the `BankAccount`.
	Version int32 `json:"version,omitempty"`
	// Read only. Name of actual financial institution.  For example \"Bank of America\".
	BankName string `json:"bank_name,omitempty"`
}

Represents a bank account. For more information about linking a bank account to a Square account, see [Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api).

type BankAccountPaymentDetails ¶

type BankAccountPaymentDetails struct {
	// The name of the bank associated with the bank account.
	BankName string `json:"bank_name,omitempty"`
	// The type of the bank transfer. The type can be `ACH` or `UNKNOWN`.
	TransferType string `json:"transfer_type,omitempty"`
	// The ownership type of the bank account performing the transfer. The type can be `INDIVIDUAL`, `COMPANY`, or `ACCOUNT_TYPE_UNKNOWN`.
	AccountOwnershipType string `json:"account_ownership_type,omitempty"`
	// Uniquely identifies the bank account for this seller and can be used to determine if payments are from the same bank account.
	Fingerprint string `json:"fingerprint,omitempty"`
	// The two-letter ISO code representing the country the bank account is located in.
	Country string `json:"country,omitempty"`
	// The statement description as sent to the bank.
	StatementDescription string      `json:"statement_description,omitempty"`
	AchDetails           *AchDetails `json:"ach_details,omitempty"`
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Additional details about BANK_ACCOUNT type payments.

type BankAccountStatus ¶

type BankAccountStatus string

BankAccountStatus : Indicates the current verification status of a `BankAccount` object.

const (
	VERIFICATION_IN_PROGRESS_BankAccountStatus BankAccountStatus = "VERIFICATION_IN_PROGRESS"
	VERIFIED_BankAccountStatus                 BankAccountStatus = "VERIFIED"
	DISABLED_BankAccountStatus                 BankAccountStatus = "DISABLED"
)

List of BankAccountStatus

type BankAccountType ¶

type BankAccountType string

BankAccountType : Indicates the financial purpose of the bank account.

const (
	CHECKING_BankAccountType          BankAccountType = "CHECKING"
	SAVINGS_BankAccountType           BankAccountType = "SAVINGS"
	INVESTMENT_BankAccountType        BankAccountType = "INVESTMENT"
	OTHER_BankAccountType             BankAccountType = "OTHER"
	BUSINESS_CHECKING_BankAccountType BankAccountType = "BUSINESS_CHECKING"
)

List of BankAccountType

type BankAccountsApiListBankAccountsOpts ¶

type BankAccountsApiListBankAccountsOpts struct {
	Cursor     optional.String
	Limit      optional.Int32
	LocationId optional.String
}

type BankAccountsApiService ¶

type BankAccountsApiService service

func (*BankAccountsApiService) GetBankAccount ¶

func (a *BankAccountsApiService) GetBankAccount(ctx context.Context, bankAccountId string) (GetBankAccountResponse, *http.Response, error)

BankAccountsApiService GetBankAccount Returns details of a BankAccount(https://developer.squareup.com/reference/square_2024-07-17/objects/BankAccount) linked to a Square account.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param bankAccountId Square-issued ID of the desired `BankAccount`.

@return GetBankAccountResponse

func (*BankAccountsApiService) GetBankAccountByV1Id ¶

func (a *BankAccountsApiService) GetBankAccountByV1Id(ctx context.Context, v1BankAccountId string) (GetBankAccountByV1IdResponse, *http.Response, error)

BankAccountsApiService GetBankAccountByV1Id Returns details of a BankAccount(https://developer.squareup.com/reference/square_2024-07-17/objects/BankAccount) identified by V1 bank account ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param v1BankAccountId Connect V1 ID of the desired `BankAccount`. For more information, see [Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api).

@return GetBankAccountByV1IdResponse

func (*BankAccountsApiService) ListBankAccounts ¶

func (a *BankAccountsApiService) ListBankAccounts(ctx context.Context, localVarOptionals *BankAccountsApiListBankAccountsOpts) (ListBankAccountsResponse, *http.Response, error)

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BatchChangeInventoryRequest ¶

type BatchChangeInventoryRequest struct {
	// A client-supplied, universally unique identifier (UUID) for the request.  See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more information.
	IdempotencyKey string `json:"idempotency_key"`
	// The set of physical counts and inventory adjustments to be made. Changes are applied based on the client-supplied timestamp and may be sent out of order.
	Changes []InventoryChange `json:"changes,omitempty"`
	// Indicates whether the current physical count should be ignored if the quantity is unchanged since the last physical count. Default: `true`.
	IgnoreUnchangedCounts bool `json:"ignore_unchanged_counts,omitempty"`
}

type BatchChangeInventoryResponse ¶

type BatchChangeInventoryResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The current counts for all objects referenced in the request.
	Counts []InventoryCount `json:"counts,omitempty"`
	// Changes created for the request.
	Changes []InventoryChange `json:"changes,omitempty"`
}

type BatchDeleteCatalogObjectsRequest ¶

type BatchDeleteCatalogObjectsRequest struct {
	// The IDs of the CatalogObjects to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a CatalogItem will delete its CatalogItemVariation.
	ObjectIds []string `json:"object_ids,omitempty"`
}

type BatchDeleteCatalogObjectsResponse ¶

type BatchDeleteCatalogObjectsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The IDs of all CatalogObjects deleted by this request.
	DeletedObjectIds []string `json:"deleted_object_ids,omitempty"`
	// The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".
	DeletedAt string `json:"deleted_at,omitempty"`
}

type BatchRetrieveCatalogObjectsRequest ¶

type BatchRetrieveCatalogObjectsRequest struct {
	// The IDs of the CatalogObjects to be retrieved.
	ObjectIds []string `json:"object_ids"`
	// If `true`, the response will include additional objects that are related to the requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field of the response. These objects are put in the `related_objects` field. Setting this to `true` is helpful when the objects are needed for immediate display to a user. This process only goes one level deep. Objects referenced by the related objects will not be included. For example,  if the `objects` field of the response contains a CatalogItem, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response.  Default value: `false`
	IncludeRelatedObjects bool `json:"include_related_objects,omitempty"`
	// The specific version of the catalog objects to be included in the response.  This allows you to retrieve historical versions of objects. The specified version value is matched against the [CatalogObject](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject)s' `version` attribute. If not included, results will be from the current version of the catalog.
	CatalogVersion int64 `json:"catalog_version,omitempty"`
	// Indicates whether to include (`true`) or not (`false`) in the response deleted objects, namely, those with the `is_deleted` attribute set to `true`.
	IncludeDeletedObjects bool `json:"include_deleted_objects,omitempty"`
	// Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned in the response payload.
	IncludeCategoryPathToRoot bool `json:"include_category_path_to_root,omitempty"`
}

type BatchRetrieveCatalogObjectsResponse ¶

type BatchRetrieveCatalogObjectsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// A list of [CatalogObject](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject)s returned.
	Objects []CatalogObject `json:"objects,omitempty"`
	// A list of [CatalogObject](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject)s referenced by the object in the `objects` field.
	RelatedObjects []CatalogObject `json:"related_objects,omitempty"`
}

type BatchRetrieveInventoryChangesRequest ¶

type BatchRetrieveInventoryChangesRequest struct {
	// The filter to return results by `CatalogObject` ID. The filter is only applicable when set. The default value is null.
	CatalogObjectIds []string `json:"catalog_object_ids,omitempty"`
	// The filter to return results by `Location` ID. The filter is only applicable when set. The default value is null.
	LocationIds []string `json:"location_ids,omitempty"`
	// The filter to return results by `InventoryChangeType` values other than `TRANSFER`. The default value is `[PHYSICAL_COUNT, ADJUSTMENT]`.
	Types []string `json:"types,omitempty"`
	// The filter to return `ADJUSTMENT` query results by `InventoryState`. This filter is only applied when set. The default value is null.
	States []string `json:"states,omitempty"`
	// The filter to return results with their `calculated_at` value after the given time as specified in an RFC 3339 timestamp. The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`).
	UpdatedAfter string `json:"updated_after,omitempty"`
	// The filter to return results with their `created_at` or `calculated_at` value strictly before the given time as specified in an RFC 3339 timestamp. The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`).
	UpdatedBefore string `json:"updated_before,omitempty"`
	// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.  See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.
	Cursor string `json:"cursor,omitempty"`
	// The number of [records](https://developer.squareup.com/reference/square_2024-07-17/objects/InventoryChange) to return.
	Limit int32 `json:"limit,omitempty"`
}

type BatchRetrieveInventoryChangesResponse ¶

type BatchRetrieveInventoryChangesResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The current calculated inventory changes for the requested objects and locations.
	Changes []InventoryChange `json:"changes,omitempty"`
	// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.
	Cursor string `json:"cursor,omitempty"`
}

type BatchRetrieveInventoryCountsRequest ¶

type BatchRetrieveInventoryCountsRequest struct {
	// The filter to return results by `CatalogObject` ID. The filter is applicable only when set.  The default is null.
	CatalogObjectIds []string `json:"catalog_object_ids,omitempty"`
	// The filter to return results by `Location` ID. This filter is applicable only when set. The default is null.
	LocationIds []string `json:"location_ids,omitempty"`
	// The filter to return results with their `calculated_at` value after the given time as specified in an RFC 3339 timestamp. The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`).
	UpdatedAfter string `json:"updated_after,omitempty"`
	// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.  See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.
	Cursor string `json:"cursor,omitempty"`
	// The filter to return results by `InventoryState`. The filter is only applicable when set. Ignored are untracked states of `NONE`, `SOLD`, and `UNLINKED_RETURN`. The default is null.
	States []string `json:"states,omitempty"`
	// The number of [records](https://developer.squareup.com/reference/square_2024-07-17/objects/InventoryCount) to return.
	Limit int32 `json:"limit,omitempty"`
}

type BatchRetrieveInventoryCountsResponse ¶

type BatchRetrieveInventoryCountsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The current calculated inventory counts for the requested objects and locations.
	Counts []InventoryCount `json:"counts,omitempty"`
	// The pagination cursor to be used in a subsequent request. If unset, this is the final response.  See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.
	Cursor string `json:"cursor,omitempty"`
}

type BatchRetrieveOrdersRequest ¶

type BatchRetrieveOrdersRequest struct {
	// The ID of the location for these orders. This field is optional: omit it to retrieve orders within the scope of the current authorization's merchant ID.
	LocationId string `json:"location_id,omitempty"`
	// The IDs of the orders to retrieve. A maximum of 100 orders can be retrieved per request.
	OrderIds []string `json:"order_ids"`
}

Defines the fields that are included in requests to the `BatchRetrieveOrders` endpoint.

type BatchRetrieveOrdersResponse ¶

type BatchRetrieveOrdersResponse struct {
	// The requested orders. This will omit any requested orders that do not exist.
	Orders []Order `json:"orders,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields that are included in the response body of a request to the `BatchRetrieveOrders` endpoint.

type BatchUpsertCatalogObjectsRequest ¶

type BatchUpsertCatalogObjectsRequest struct {
	// A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID).  If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects.  See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.
	IdempotencyKey string `json:"idempotency_key"`
	// A batch of CatalogObjects to be inserted/updated atomically. The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error in one batch will not affect other batches within the same request.  For each object, its `updated_at` field is ignored and replaced with a current [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), and its `is_deleted` field must not be set to `true`.  To modify an existing object, supply its ID. To create a new object, use an ID starting with `#`. These IDs may be used to create relationships between an object and attributes of other objects that reference it. For example, you can create a CatalogItem with ID `#ABC` and a CatalogItemVariation with its `item_id` attribute set to `#ABC` in order to associate the CatalogItemVariation with its parent CatalogItem.  Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs.  Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will be inserted or updated.
	Batches []CatalogObjectBatch `json:"batches"`
}

type BatchUpsertCatalogObjectsResponse ¶

type BatchUpsertCatalogObjectsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The created successfully created CatalogObjects.
	Objects []CatalogObject `json:"objects,omitempty"`
	// The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".
	UpdatedAt string `json:"updated_at,omitempty"`
	// The mapping between client and server IDs for this upsert.
	IdMappings []CatalogIdMapping `json:"id_mappings,omitempty"`
}

type Booking ¶

type Booking struct {
	// A unique ID of this object representing a booking.
	Id string `json:"id,omitempty"`
	// The revision number for the booking used for optimistic concurrency.
	Version int32 `json:"version,omitempty"`
	// The status of the booking, describing where the booking stands with respect to the booking state machine.
	Status string `json:"status,omitempty"`
	// The RFC 3339 timestamp specifying the creation time of this booking.
	CreatedAt string `json:"created_at,omitempty"`
	// The RFC 3339 timestamp specifying the most recent update time of this booking.
	UpdatedAt string `json:"updated_at,omitempty"`
	// The RFC 3339 timestamp specifying the starting time of this booking.
	StartAt string `json:"start_at,omitempty"`
	// The ID of the [Location](https://developer.squareup.com/reference/square_2024-07-17/objects/Location) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed.
	LocationId string `json:"location_id,omitempty"`
	// The ID of the [Customer](https://developer.squareup.com/reference/square_2024-07-17/objects/Customer) object representing the customer receiving the booked service.
	CustomerId string `json:"customer_id,omitempty"`
	// The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject) instance.
	CustomerNote string `json:"customer_note,omitempty"`
	// The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject) instance. This field should not be visible to customers.
	SellerNote string `json:"seller_note,omitempty"`
	// A list of appointment segments for this booking.
	AppointmentSegments []AppointmentSegment `json:"appointment_segments,omitempty"`
	// Additional time at the end of a booking. Applications should not make this field visible to customers of a seller.
	TransitionTimeMinutes int32 `json:"transition_time_minutes,omitempty"`
	// Whether the booking is of a full business day.
	AllDay bool `json:"all_day,omitempty"`
	// The type of location where the booking is held. Access to this field requires seller-level permissions.
	LocationType   string                 `json:"location_type,omitempty"`
	CreatorDetails *BookingCreatorDetails `json:"creator_details,omitempty"`
	// The source of the booking. Access to this field requires seller-level permissions.
	Source string `json:"source,omitempty"`
}

Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service at a given location to a requesting customer in one or more appointment segments.

type BookingBookingSource ¶

type BookingBookingSource string

BookingBookingSource : Supported sources a booking was created from.

const (
	FIRST_PARTY_MERCHANT_BookingBookingSource BookingBookingSource = "FIRST_PARTY_MERCHANT"
	FIRST_PARTY_BUYER_BookingBookingSource    BookingBookingSource = "FIRST_PARTY_BUYER"
	THIRD_PARTY_BUYER_BookingBookingSource    BookingBookingSource = "THIRD_PARTY_BUYER"
	API_BookingBookingSource                  BookingBookingSource = "API"
)

List of BookingBookingSource

type BookingCreatorDetails ¶

type BookingCreatorDetails struct {
	// The seller-accessible type of the creator of the booking.
	CreatorType string `json:"creator_type,omitempty"`
	// The ID of the team member who created the booking, when the booking creator is of the `TEAM_MEMBER` type. Access to this field requires seller-level permissions.
	TeamMemberId string `json:"team_member_id,omitempty"`
	// The ID of the customer who created the booking, when the booking creator is of the `CUSTOMER` type. Access to this field requires seller-level permissions.
	CustomerId string `json:"customer_id,omitempty"`
}

Information about a booking creator.

type BookingCreatorDetailsCreatorType ¶

type BookingCreatorDetailsCreatorType string

BookingCreatorDetailsCreatorType : Supported types of a booking creator.

const (
	TEAM_MEMBER_BookingCreatorDetailsCreatorType BookingCreatorDetailsCreatorType = "TEAM_MEMBER"
	CUSTOMER_BookingCreatorDetailsCreatorType    BookingCreatorDetailsCreatorType = "CUSTOMER"
)

List of BookingCreatorDetailsCreatorType

type BookingCustomAttributeDeleteRequest ¶

type BookingCustomAttributeDeleteRequest struct {
	// The ID of the target [booking](https://developer.squareup.com/reference/square_2024-07-17/objects/Booking).
	BookingId string `json:"booking_id"`
	// The key of the custom attribute to delete. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.
	Key string `json:"key"`
}

Represents an individual delete request in a [BulkDeleteBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/bulk-delete-booking-custom-attributes) request. An individual request contains a booking ID, the custom attribute to delete, and an optional idempotency key.

type BookingCustomAttributeDeleteResponse ¶

type BookingCustomAttributeDeleteResponse struct {
	// The ID of the [booking](https://developer.squareup.com/reference/square_2024-07-17/objects/Booking) associated with the custom attribute.
	BookingId string `json:"booking_id,omitempty"`
	// Any errors that occurred while processing the individual request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response for an individual upsert request in a [BulkDeleteBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/bulk-delete-booking-custom-attributes) operation.

type BookingCustomAttributeUpsertRequest ¶

type BookingCustomAttributeUpsertRequest struct {
	// The ID of the target [booking](https://developer.squareup.com/reference/square_2024-07-17/objects/Booking).
	BookingId       string           `json:"booking_id"`
	CustomAttribute *CustomAttribute `json:"custom_attribute"`
	// A unique identifier for this individual upsert request, used to ensure idempotency. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Represents an individual upsert request in a [BulkUpsertBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/bulk-upsert-booking-custom-attributes) request. An individual request contains a booking ID, the custom attribute to create or update, and an optional idempotency key.

type BookingCustomAttributeUpsertResponse ¶

type BookingCustomAttributeUpsertResponse struct {
	// The ID of the [booking](https://developer.squareup.com/reference/square_2024-07-17/objects/Booking) associated with the custom attribute.
	BookingId       string           `json:"booking_id,omitempty"`
	CustomAttribute *CustomAttribute `json:"custom_attribute,omitempty"`
	// Any errors that occurred while processing the individual request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response for an individual upsert request in a [BulkUpsertBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/bulk-upsert-booking-custom-attributes) operation.

type BookingCustomAttributesApiListBookingCustomAttributeDefinitionsOpts ¶

type BookingCustomAttributesApiListBookingCustomAttributeDefinitionsOpts struct {
	Limit  optional.Int32
	Cursor optional.String
}

type BookingCustomAttributesApiListBookingCustomAttributesOpts ¶

type BookingCustomAttributesApiListBookingCustomAttributesOpts struct {
	Limit           optional.Int32
	Cursor          optional.String
	WithDefinitions optional.Bool
}

type BookingCustomAttributesApiRetrieveBookingCustomAttributeDefinitionOpts ¶

type BookingCustomAttributesApiRetrieveBookingCustomAttributeDefinitionOpts struct {
	Version optional.Int32
}

type BookingCustomAttributesApiRetrieveBookingCustomAttributeOpts ¶

type BookingCustomAttributesApiRetrieveBookingCustomAttributeOpts struct {
	WithDefinition optional.Bool
	Version        optional.Int32
}

type BookingCustomAttributesApiService ¶

type BookingCustomAttributesApiService service

func (*BookingCustomAttributesApiService) BulkDeleteBookingCustomAttributes ¶

func (a *BookingCustomAttributesApiService) BulkDeleteBookingCustomAttributes(ctx context.Context, body BulkDeleteBookingCustomAttributesRequest) (BulkDeleteBookingCustomAttributesResponse, *http.Response, error)

BookingCustomAttributesApiService BulkDeleteBookingCustomAttributes Bulk deletes bookings custom attributes. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkDeleteBookingCustomAttributesResponse

func (*BookingCustomAttributesApiService) BulkUpsertBookingCustomAttributes ¶

func (a *BookingCustomAttributesApiService) BulkUpsertBookingCustomAttributes(ctx context.Context, body BulkUpsertBookingCustomAttributesRequest) (BulkUpsertBookingCustomAttributesResponse, *http.Response, error)

BookingCustomAttributesApiService BulkUpsertBookingCustomAttributes Bulk upserts bookings custom attributes. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkUpsertBookingCustomAttributesResponse

func (*BookingCustomAttributesApiService) CreateBookingCustomAttributeDefinition ¶

func (a *BookingCustomAttributesApiService) CreateBookingCustomAttributeDefinition(ctx context.Context, body CreateBookingCustomAttributeDefinitionRequest) (CreateBookingCustomAttributeDefinitionResponse, *http.Response, error)

BookingCustomAttributesApiService CreateBookingCustomAttributeDefinition Creates a bookings custom attribute definition. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateBookingCustomAttributeDefinitionResponse

func (*BookingCustomAttributesApiService) DeleteBookingCustomAttribute ¶

func (a *BookingCustomAttributesApiService) DeleteBookingCustomAttribute(ctx context.Context, bookingId string, key string) (DeleteBookingCustomAttributeResponse, *http.Response, error)

BookingCustomAttributesApiService DeleteBookingCustomAttribute Deletes a bookings custom attribute. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param bookingId The ID of the target [booking](https://developer.squareup.com/reference/square_2024-07-17/objects/Booking).
@param key The key of the custom attribute to delete. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.

@return DeleteBookingCustomAttributeResponse

func (*BookingCustomAttributesApiService) DeleteBookingCustomAttributeDefinition ¶

func (a *BookingCustomAttributesApiService) DeleteBookingCustomAttributeDefinition(ctx context.Context, key string) (DeleteBookingCustomAttributeDefinitionResponse, *http.Response, error)

BookingCustomAttributesApiService DeleteBookingCustomAttributeDefinition Deletes a bookings custom attribute definition. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param key The key of the custom attribute definition to delete.

@return DeleteBookingCustomAttributeDefinitionResponse

func (*BookingCustomAttributesApiService) ListBookingCustomAttributeDefinitions ¶

func (a *BookingCustomAttributesApiService) ListBookingCustomAttributeDefinitions(ctx context.Context, localVarOptionals *BookingCustomAttributesApiListBookingCustomAttributeDefinitionsOpts) (ListBookingCustomAttributeDefinitionsResponse, *http.Response, error)

func (*BookingCustomAttributesApiService) ListBookingCustomAttributes ¶

func (a *BookingCustomAttributesApiService) ListBookingCustomAttributes(ctx context.Context, bookingId string, localVarOptionals *BookingCustomAttributesApiListBookingCustomAttributesOpts) (ListBookingCustomAttributesResponse, *http.Response, error)

func (*BookingCustomAttributesApiService) RetrieveBookingCustomAttribute ¶

func (a *BookingCustomAttributesApiService) RetrieveBookingCustomAttribute(ctx context.Context, bookingId string, key string, localVarOptionals *BookingCustomAttributesApiRetrieveBookingCustomAttributeOpts) (RetrieveBookingCustomAttributeResponse, *http.Response, error)

func (*BookingCustomAttributesApiService) RetrieveBookingCustomAttributeDefinition ¶

func (a *BookingCustomAttributesApiService) RetrieveBookingCustomAttributeDefinition(ctx context.Context, key string, localVarOptionals *BookingCustomAttributesApiRetrieveBookingCustomAttributeDefinitionOpts) (RetrieveBookingCustomAttributeDefinitionResponse, *http.Response, error)

func (*BookingCustomAttributesApiService) UpdateBookingCustomAttributeDefinition ¶

func (a *BookingCustomAttributesApiService) UpdateBookingCustomAttributeDefinition(ctx context.Context, body UpdateBookingCustomAttributeDefinitionRequest, key string) (UpdateBookingCustomAttributeDefinitionResponse, *http.Response, error)

BookingCustomAttributesApiService UpdateBookingCustomAttributeDefinition Updates a bookings custom attribute definition. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param key The key of the custom attribute definition to update.

@return UpdateBookingCustomAttributeDefinitionResponse

func (*BookingCustomAttributesApiService) UpsertBookingCustomAttribute ¶

func (a *BookingCustomAttributesApiService) UpsertBookingCustomAttribute(ctx context.Context, body UpsertBookingCustomAttributeRequest, bookingId string, key string) (UpsertBookingCustomAttributeResponse, *http.Response, error)

BookingCustomAttributesApiService UpsertBookingCustomAttribute Upserts a bookings custom attribute. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param bookingId The ID of the target [booking](https://developer.squareup.com/reference/square_2024-07-17/objects/Booking).
@param key The key of the custom attribute to create or update. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.

@return UpsertBookingCustomAttributeResponse

type BookingStatus ¶

type BookingStatus string

BookingStatus : Supported booking statuses.

const (
	PENDING_BookingStatus               BookingStatus = "PENDING"
	CANCELLED_BY_CUSTOMER_BookingStatus BookingStatus = "CANCELLED_BY_CUSTOMER"
	CANCELLED_BY_SELLER_BookingStatus   BookingStatus = "CANCELLED_BY_SELLER"
	DECLINED_BookingStatus              BookingStatus = "DECLINED"
	ACCEPTED_BookingStatus              BookingStatus = "ACCEPTED"
	NO_SHOW_BookingStatus               BookingStatus = "NO_SHOW"
)

List of BookingStatus

type BookingsApiListBookingsOpts ¶

type BookingsApiListBookingsOpts struct {
	Limit        optional.Int32
	Cursor       optional.String
	CustomerId   optional.String
	TeamMemberId optional.String
	LocationId   optional.String
	StartAtMin   optional.String
	StartAtMax   optional.String
}

type BookingsApiListLocationBookingProfilesOpts ¶

type BookingsApiListLocationBookingProfilesOpts struct {
	Limit  optional.Int32
	Cursor optional.String
}

type BookingsApiListTeamMemberBookingProfilesOpts ¶

type BookingsApiListTeamMemberBookingProfilesOpts struct {
	BookableOnly optional.Bool
	Limit        optional.Int32
	Cursor       optional.String
	LocationId   optional.String
}

type BookingsApiService ¶

type BookingsApiService service

func (*BookingsApiService) BulkRetrieveBookings ¶

func (a *BookingsApiService) BulkRetrieveBookings(ctx context.Context, body BulkRetrieveBookingsRequest) (BulkRetrieveBookingsResponse, *http.Response, error)

BookingsApiService BulkRetrieveBookings Bulk-Retrieves a list of bookings by booking IDs. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkRetrieveBookingsResponse

func (*BookingsApiService) BulkRetrieveTeamMemberBookingProfiles ¶

func (a *BookingsApiService) BulkRetrieveTeamMemberBookingProfiles(ctx context.Context, body BulkRetrieveTeamMemberBookingProfilesRequest) (BulkRetrieveTeamMemberBookingProfilesResponse, *http.Response, error)

BookingsApiService BulkRetrieveTeamMemberBookingProfiles Retrieves one or more team members' booking profiles.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkRetrieveTeamMemberBookingProfilesResponse

func (*BookingsApiService) CancelBooking ¶

func (a *BookingsApiService) CancelBooking(ctx context.Context, body CancelBookingRequest, bookingId string) (CancelBookingResponse, *http.Response, error)

BookingsApiService CancelBooking Cancels an existing booking. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param bookingId The ID of the Booking(https://developer.squareup.com/reference/square_2024-07-17/objects/Booking) object representing the to-be-cancelled booking.

@return CancelBookingResponse

func (*BookingsApiService) CreateBooking ¶

func (a *BookingsApiService) CreateBooking(ctx context.Context, body CreateBookingRequest) (CreateBookingResponse, *http.Response, error)

BookingsApiService CreateBooking Creates a booking. The required input must include the following: - `Booking.location_id` - `Booking.start_at` - `Booking.AppointmentSegment.team_member_id` - `Booking.AppointmentSegment.service_variation_id` - `Booking.AppointmentSegment.service_variation_version` To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateBookingResponse

func (*BookingsApiService) ListBookings ¶

func (a *BookingsApiService) ListBookings(ctx context.Context, localVarOptionals *BookingsApiListBookingsOpts) (ListBookingsResponse, *http.Response, error)

func (*BookingsApiService) ListLocationBookingProfiles ¶

func (a *BookingsApiService) ListLocationBookingProfiles(ctx context.Context, localVarOptionals *BookingsApiListLocationBookingProfilesOpts) (ListLocationBookingProfilesResponse, *http.Response, error)

func (*BookingsApiService) ListTeamMemberBookingProfiles ¶

func (a *BookingsApiService) ListTeamMemberBookingProfiles(ctx context.Context, localVarOptionals *BookingsApiListTeamMemberBookingProfilesOpts) (ListTeamMemberBookingProfilesResponse, *http.Response, error)

func (*BookingsApiService) RetrieveBooking ¶

func (a *BookingsApiService) RetrieveBooking(ctx context.Context, bookingId string) (RetrieveBookingResponse, *http.Response, error)

BookingsApiService RetrieveBooking Retrieves a booking. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param bookingId The ID of the Booking(https://developer.squareup.com/reference/square_2024-07-17/objects/Booking) object representing the to-be-retrieved booking.

@return RetrieveBookingResponse

func (*BookingsApiService) RetrieveBusinessBookingProfile ¶

func (a *BookingsApiService) RetrieveBusinessBookingProfile(ctx context.Context) (RetrieveBusinessBookingProfileResponse, *http.Response, error)

BookingsApiService RetrieveBusinessBookingProfile Retrieves a seller's booking profile.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return RetrieveBusinessBookingProfileResponse

func (*BookingsApiService) RetrieveLocationBookingProfile ¶

func (a *BookingsApiService) RetrieveLocationBookingProfile(ctx context.Context, locationId string) (RetrieveLocationBookingProfileResponse, *http.Response, error)

BookingsApiService RetrieveLocationBookingProfile Retrieves a seller's location booking profile.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the location to retrieve the booking profile.

@return RetrieveLocationBookingProfileResponse

func (*BookingsApiService) RetrieveTeamMemberBookingProfile ¶

func (a *BookingsApiService) RetrieveTeamMemberBookingProfile(ctx context.Context, teamMemberId string) (RetrieveTeamMemberBookingProfileResponse, *http.Response, error)

BookingsApiService RetrieveTeamMemberBookingProfile Retrieves a team member's booking profile.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param teamMemberId The ID of the team member to retrieve.

@return RetrieveTeamMemberBookingProfileResponse

func (*BookingsApiService) SearchAvailability ¶

func (a *BookingsApiService) SearchAvailability(ctx context.Context, body SearchAvailabilityRequest) (SearchAvailabilityResponse, *http.Response, error)

BookingsApiService SearchAvailability Searches for availabilities for booking. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return SearchAvailabilityResponse

func (*BookingsApiService) UpdateBooking ¶

func (a *BookingsApiService) UpdateBooking(ctx context.Context, body UpdateBookingRequest, bookingId string) (UpdateBookingResponse, *http.Response, error)

BookingsApiService UpdateBooking Updates a booking. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param bookingId The ID of the Booking(https://developer.squareup.com/reference/square_2024-07-17/objects/Booking) object representing the to-be-updated booking.

@return UpdateBookingResponse

type BreakType ¶

type BreakType struct {
	// The UUID for this object.
	Id string `json:"id,omitempty"`
	// The ID of the business location this type of break applies to.
	LocationId string `json:"location_id"`
	// A human-readable name for this type of break. The name is displayed to employees in Square products.
	BreakName string `json:"break_name"`
	// Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of this break. Precision less than minutes is truncated.  Example for break expected duration of 15 minutes: T15M
	ExpectedDuration string `json:"expected_duration"`
	// Whether this break counts towards time worked for compensation purposes.
	IsPaid bool `json:"is_paid"`
	// Used for resolving concurrency issues. The request fails if the version provided does not match the server version at the time of the request. If a value is not provided, Square's servers execute a \"blind\" write; potentially overwriting another writer's data.
	Version int32 `json:"version,omitempty"`
	// A read-only timestamp in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// A read-only timestamp in RFC 3339 format.
	UpdatedAt string `json:"updated_at,omitempty"`
}

A defined break template that sets an expectation for possible `Break` instances on a `Shift`.

type BulkCreateCustomerData ¶

type BulkCreateCustomerData struct {
	// The given name (that is, the first name) associated with the customer profile.
	GivenName string `json:"given_name,omitempty"`
	// The family name (that is, the last name) associated with the customer profile.
	FamilyName string `json:"family_name,omitempty"`
	// A business name associated with the customer profile.
	CompanyName string `json:"company_name,omitempty"`
	// A nickname for the customer profile.
	Nickname string `json:"nickname,omitempty"`
	// The email address associated with the customer profile.
	EmailAddress string   `json:"email_address,omitempty"`
	Address      *Address `json:"address,omitempty"`
	// The phone number associated with the customer profile. The phone number must be valid and can contain 9–16 digits, with an optional `+` prefix and country code. For more information, see [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number).
	PhoneNumber string `json:"phone_number,omitempty"`
	// An optional second ID used to associate the customer profile with an entity in another system.
	ReferenceId string `json:"reference_id,omitempty"`
	// A custom note associated with the customer profile.
	Note string `json:"note,omitempty"`
	// The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example, specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD` format, where `YYYY` is the specified birth year or `0000` if a birth year is not specified.
	Birthday string          `json:"birthday,omitempty"`
	TaxIds   *CustomerTaxIds `json:"tax_ids,omitempty"`
}

Defines the customer data provided in individual create requests for a [BulkCreateCustomers](https://developer.squareup.com/reference/square_2024-07-17/customers-api/bulk-create-customers) operation.

type BulkCreateCustomersRequest ¶

type BulkCreateCustomersRequest struct {
	// A map of 1 to 100 individual create requests, represented by `idempotency key: { customer data }` key-value pairs.  Each key is an [idempotency key](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) that uniquely identifies the create request. Each value contains the customer data used to create the customer profile.
	Customers map[string]BulkCreateCustomerData `json:"customers"`
}

Defines the body parameters that can be included in requests to the [BulkCreateCustomers](https://developer.squareup.com/reference/square_2024-07-17/customers-api/bulk-create-customers) endpoint.

type BulkCreateCustomersResponse ¶

type BulkCreateCustomersResponse struct {
	// A map of responses that correspond to individual create requests, represented by key-value pairs.  Each key is the idempotency key that was provided for a create request and each value is the corresponding response. If the request succeeds, the value is the new customer profile. If the request fails, the value contains any errors that occurred during the request.
	Responses map[string]CreateCustomerResponse `json:"responses,omitempty"`
	// Any top-level errors that prevented the bulk operation from running.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields included in the response body from the [BulkCreateCustomers](https://developer.squareup.com/reference/square_2024-07-17/customers-api/bulk-create-customers) endpoint.

type BulkCreateTeamMembersRequest ¶

type BulkCreateTeamMembersRequest struct {
	// The data used to create the `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. The maximum number of create objects is 25.
	TeamMembers map[string]CreateTeamMemberRequest `json:"team_members"`
}

Represents a bulk create request for `TeamMember` objects.

type BulkCreateTeamMembersResponse ¶

type BulkCreateTeamMembersResponse struct {
	// The successfully created `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`.
	TeamMembers map[string]CreateTeamMemberResponse `json:"team_members,omitempty"`
	// The errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response from a bulk create request containing the created `TeamMember` objects or error messages.

type BulkCreateVendorsRequest ¶

type BulkCreateVendorsRequest struct {
	// Specifies a set of new [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) objects as represented by a collection of idempotency-key/`Vendor`-object pairs.
	Vendors map[string]Vendor `json:"vendors"`
}

Represents an input to a call to [BulkCreateVendors](https://developer.squareup.com/reference/square_2024-07-17/vendors-api/bulk-create-vendors).

type BulkCreateVendorsResponse ¶

type BulkCreateVendorsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// A set of [CreateVendorResponse](https://developer.squareup.com/reference/square_2024-07-17/objects/CreateVendorResponse) objects encapsulating successfully created [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) objects or error responses for failed attempts. The set is represented by  a collection of idempotency-key/`Vendor`-object or idempotency-key/error-object pairs. The idempotency keys correspond to those specified in the input.
	Responses map[string]CreateVendorResponse `json:"responses,omitempty"`
}

Represents an output from a call to [BulkCreateVendors](https://developer.squareup.com/reference/square_2024-07-17/vendors-api/bulk-create-vendors).

type BulkDeleteBookingCustomAttributesRequest ¶

type BulkDeleteBookingCustomAttributesRequest struct {
	// A map containing 1 to 25 individual Delete requests. For each request, provide an arbitrary ID that is unique for this `BulkDeleteBookingCustomAttributes` request and the information needed to delete a custom attribute.
	Values map[string]BookingCustomAttributeDeleteRequest `json:"values"`
}

Represents a [BulkDeleteBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/bulk-delete-booking-custom-attributes) request.

type BulkDeleteBookingCustomAttributesResponse ¶

type BulkDeleteBookingCustomAttributesResponse struct {
	// A map of responses that correspond to individual delete requests. Each response has the same ID as the corresponding request and contains `booking_id` and  `errors` field.
	Values map[string]BookingCustomAttributeDeleteResponse `json:"values,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [BulkDeleteBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/bulk-delete-booking-custom-attributes) response, which contains a map of responses that each corresponds to an individual delete request.

type BulkDeleteCustomersRequest ¶

type BulkDeleteCustomersRequest struct {
	// The IDs of the [customer profiles](https://developer.squareup.com/reference/square_2024-07-17/objects/Customer) to delete.
	CustomerIds []string `json:"customer_ids"`
}

Defines the body parameters that can be included in requests to the [BulkDeleteCustomers](https://developer.squareup.com/reference/square_2024-07-17/customers-api/bulk-delete-customers) endpoint.

type BulkDeleteCustomersResponse ¶

type BulkDeleteCustomersResponse struct {
	// A map of responses that correspond to individual delete requests, represented by key-value pairs.  Each key is the customer ID that was specified for a delete request and each value is the corresponding response. If the request succeeds, the value is an empty object (`{ }`). If the request fails, the value contains any errors that occurred during the request.
	Responses map[string]DeleteCustomerResponse `json:"responses,omitempty"`
	// Any top-level errors that prevented the bulk operation from running.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields included in the response body from the [BulkDeleteCustomers](https://developer.squareup.com/reference/square_2024-07-17/customers-api/bulk-delete-customers) endpoint.

type BulkDeleteLocationCustomAttributesRequest ¶

type BulkDeleteLocationCustomAttributesRequest struct {
	// The data used to update the `CustomAttribute` objects. The keys must be unique and are used to map to the corresponding response.
	Values map[string]json.RawMessage `json:"values"`
}

Represents a [BulkDeleteLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/bulk-delete-location-custom-attributes) request.

type BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest ¶

type BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest struct {
	// The key of the associated custom attribute definition. Represented as a qualified key if the requesting app is not the definition owner.
	Key string `json:"key,omitempty"`
}

Represents an individual delete request in a [BulkDeleteLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/bulk-delete-location-custom-attributes) request. An individual request contains an optional ID of the associated custom attribute definition and optional key of the associated custom attribute definition.

type BulkDeleteLocationCustomAttributesResponse ¶

type BulkDeleteLocationCustomAttributesResponse struct {
	// A map of responses that correspond to individual delete requests. Each response has the same key as the corresponding request.
	Values map[string]json.RawMessage `json:"values"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [BulkDeleteLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/bulk-delete-location-custom-attributes) response, which contains a map of responses that each corresponds to an individual delete request.

type BulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponse ¶

type BulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponse struct {
	// The ID of the location associated with the custom attribute.
	LocationId string `json:"location_id,omitempty"`
	// Errors that occurred while processing the individual LocationCustomAttributeDeleteRequest request
	Errors []ModelError `json:"errors,omitempty"`
}

Represents an individual delete response in a [BulkDeleteLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/bulk-delete-location-custom-attributes) request.

type BulkDeleteMerchantCustomAttributesRequest ¶

type BulkDeleteMerchantCustomAttributesRequest struct {
	// The data used to update the `CustomAttribute` objects. The keys must be unique and are used to map to the corresponding response.
	Values map[string]json.RawMessage `json:"values"`
}

Represents a [BulkDeleteMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/bulk-delete-merchant-custom-attributes) request.

type BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequest ¶

type BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequest struct {
	// The key of the associated custom attribute definition. Represented as a qualified key if the requesting app is not the definition owner.
	Key string `json:"key,omitempty"`
}

Represents an individual delete request in a [BulkDeleteMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/bulk-delete-merchant-custom-attributes) request. An individual request contains an optional ID of the associated custom attribute definition and optional key of the associated custom attribute definition.

type BulkDeleteMerchantCustomAttributesResponse ¶

type BulkDeleteMerchantCustomAttributesResponse struct {
	// A map of responses that correspond to individual delete requests. Each response has the same key as the corresponding request.
	Values map[string]json.RawMessage `json:"values"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [BulkDeleteMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/bulk-delete-merchant-custom-attributes) response, which contains a map of responses that each corresponds to an individual delete request.

type BulkDeleteMerchantCustomAttributesResponseMerchantCustomAttributeDeleteResponse ¶

type BulkDeleteMerchantCustomAttributesResponseMerchantCustomAttributeDeleteResponse struct {
	// Errors that occurred while processing the individual MerchantCustomAttributeDeleteRequest request
	Errors []ModelError `json:"errors,omitempty"`
}

Represents an individual delete response in a [BulkDeleteMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/bulk-delete-merchant-custom-attributes) request.

type BulkDeleteOrderCustomAttributesRequest ¶

type BulkDeleteOrderCustomAttributesRequest struct {
	// A map of requests that correspond to individual delete operations for custom attributes.
	Values map[string]json.RawMessage `json:"values"`
}

Represents a bulk delete request for one or more order custom attributes.

type BulkDeleteOrderCustomAttributesRequestDeleteCustomAttribute ¶

type BulkDeleteOrderCustomAttributesRequestDeleteCustomAttribute struct {
	// The key of the custom attribute to delete.  This key must match the key  of an existing custom attribute definition.
	Key string `json:"key,omitempty"`
	// The ID of the target [order](https://developer.squareup.com/reference/square_2024-07-17/objects/Order).
	OrderId string `json:"order_id"`
}

Represents one delete within the bulk operation.

type BulkDeleteOrderCustomAttributesResponse ¶

type BulkDeleteOrderCustomAttributesResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	//  A map of responses that correspond to individual delete requests. Each response has the same ID  as the corresponding request and contains either a `custom_attribute` or an `errors` field.
	Values map[string]DeleteOrderCustomAttributeResponse `json:"values"`
}

Represents a response from deleting one or more order custom attributes.

type BulkRetrieveBookingsRequest ¶

type BulkRetrieveBookingsRequest struct {
	// A non-empty list of [Booking](https://developer.squareup.com/reference/square_2024-07-17/objects/Booking) IDs specifying bookings to retrieve.
	BookingIds []string `json:"booking_ids"`
}

Request payload for bulk retrieval of bookings.

type BulkRetrieveBookingsResponse ¶

type BulkRetrieveBookingsResponse struct {
	// Requested bookings returned as a map containing `booking_id` as the key and `RetrieveBookingResponse` as the value.
	Bookings map[string]RetrieveBookingResponse `json:"bookings,omitempty"`
	// Errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Response payload for bulk retrieval of bookings.

type BulkRetrieveCustomersRequest ¶

type BulkRetrieveCustomersRequest struct {
	// The IDs of the [customer profiles](https://developer.squareup.com/reference/square_2024-07-17/objects/Customer) to retrieve.
	CustomerIds []string `json:"customer_ids"`
}

Defines the body parameters that can be included in requests to the [BulkRetrieveCustomers](https://developer.squareup.com/reference/square_2024-07-17/customers-api/bulk-retrieve-customers) endpoint.

type BulkRetrieveCustomersResponse ¶

type BulkRetrieveCustomersResponse struct {
	// A map of responses that correspond to individual retrieve requests, represented by key-value pairs.  Each key is the customer ID that was specified for a retrieve request and each value is the corresponding response. If the request succeeds, the value is the requested customer profile. If the request fails, the value contains any errors that occurred during the request.
	Responses map[string]RetrieveCustomerResponse `json:"responses,omitempty"`
	// Any top-level errors that prevented the bulk operation from running.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields included in the response body from the [BulkRetrieveCustomers](https://developer.squareup.com/reference/square_2024-07-17/customers-api/bulk-retrieve-customers) endpoint.

type BulkRetrieveTeamMemberBookingProfilesRequest ¶

type BulkRetrieveTeamMemberBookingProfilesRequest struct {
	// A non-empty list of IDs of team members whose booking profiles you want to retrieve.
	TeamMemberIds []string `json:"team_member_ids"`
}

Request payload for the [BulkRetrieveTeamMemberBookingProfiles](https://developer.squareup.com/reference/square_2024-07-17/bookings-api/bulk-retrieve-team-member-booking-profiles) endpoint.

type BulkRetrieveTeamMemberBookingProfilesResponse ¶

type BulkRetrieveTeamMemberBookingProfilesResponse struct {
	// The returned team members' booking profiles, as a map with `team_member_id` as the key and [TeamMemberBookingProfile](https://developer.squareup.com/reference/square_2024-07-17/objects/TeamMemberBookingProfile) the value.
	TeamMemberBookingProfiles map[string]RetrieveTeamMemberBookingProfileResponse `json:"team_member_booking_profiles,omitempty"`
	// Errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Response payload for the [BulkRetrieveTeamMemberBookingProfiles](https://developer.squareup.com/reference/square_2024-07-17/bookings-api/bulk-retrieve-team-member-booking-profiles) endpoint.

type BulkRetrieveVendorsRequest ¶

type BulkRetrieveVendorsRequest struct {
	// IDs of the [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) objects to retrieve.
	VendorIds []string `json:"vendor_ids,omitempty"`
}

Represents an input to a call to [BulkRetrieveVendors](https://developer.squareup.com/reference/square_2024-07-17/vendors-api/bulk-retrieve-vendors).

type BulkRetrieveVendorsResponse ¶

type BulkRetrieveVendorsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The set of [RetrieveVendorResponse](https://developer.squareup.com/reference/square_2024-07-17/objects/RetrieveVendorResponse) objects encapsulating successfully retrieved [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) objects or error responses for failed attempts. The set is represented by  a collection of `Vendor`-ID/`Vendor`-object or `Vendor`-ID/error-object pairs.
	Responses map[string]RetrieveVendorResponse `json:"responses,omitempty"`
}

Represents an output from a call to [BulkRetrieveVendors](https://developer.squareup.com/reference/square_2024-07-17/vendors-api/bulk-retrieve-vendors).

type BulkSwapPlanRequest ¶

type BulkSwapPlanRequest struct {
	// The ID of the new subscription plan variation.  This field is required.
	NewPlanVariationId string `json:"new_plan_variation_id"`
	// The ID of the plan variation whose subscriptions should be swapped. Active subscriptions using this plan variation will be subscribed to the new plan variation on their next billing day.
	OldPlanVariationId string `json:"old_plan_variation_id"`
	// The ID of the location to associate with the swapped subscriptions.
	LocationId string `json:"location_id"`
}

Defines input parameters in a call to the [BulkSwapPlan](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/bulk-swap-plan) endpoint.

type BulkSwapPlanResponse ¶

type BulkSwapPlanResponse struct {
	// Errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The number of affected subscriptions.
	AffectedSubscriptions int32 `json:"affected_subscriptions,omitempty"`
}

Defines output parameters in a response of the [BulkSwapPlan](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/bulk-swap-plan) endpoint.

type BulkUpdateCustomerData ¶

type BulkUpdateCustomerData struct {
	// The given name (that is, the first name) associated with the customer profile.
	GivenName string `json:"given_name,omitempty"`
	// The family name (that is, the last name) associated with the customer profile.
	FamilyName string `json:"family_name,omitempty"`
	// A business name associated with the customer profile.
	CompanyName string `json:"company_name,omitempty"`
	// A nickname for the customer profile.
	Nickname string `json:"nickname,omitempty"`
	// The email address associated with the customer profile.
	EmailAddress string   `json:"email_address,omitempty"`
	Address      *Address `json:"address,omitempty"`
	// The phone number associated with the customer profile. The phone number must be valid and can contain 9–16 digits, with an optional `+` prefix and country code. For more information, see [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number).
	PhoneNumber string `json:"phone_number,omitempty"`
	// An optional second ID used to associate the customer profile with an entity in another system.
	ReferenceId string `json:"reference_id,omitempty"`
	// An custom note associates with the customer profile.
	Note string `json:"note,omitempty"`
	// The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example, specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD` format, where `YYYY` is the specified birth year or `0000` if a birth year is not specified.
	Birthday string          `json:"birthday,omitempty"`
	TaxIds   *CustomerTaxIds `json:"tax_ids,omitempty"`
	// The current version of the customer profile.  As a best practice, you should include this field to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control.
	Version int64 `json:"version,omitempty"`
}

Defines the customer data provided in individual update requests for a [BulkUpdateCustomers](https://developer.squareup.com/reference/square_2024-07-17/customers-api/bulk-update-customers) operation.

type BulkUpdateCustomersRequest ¶

type BulkUpdateCustomersRequest struct {
	// A map of 1 to 100 individual update requests, represented by `customer ID: { customer data }` key-value pairs.  Each key is the ID of the [customer profile](https://developer.squareup.com/reference/square_2024-07-17/objects/Customer) to update. To update a customer profile that was created by merging existing profiles, provide the ID of the newly created profile.  Each value contains the updated customer data. Only new or changed fields are required. To add or update a field, specify the new value. To remove a field, specify `null`.
	Customers map[string]BulkUpdateCustomerData `json:"customers"`
}

Defines the body parameters that can be included in requests to the [BulkUpdateCustomers](https://developer.squareup.com/reference/square_2024-07-17/customers-api/bulk-update-customers) endpoint.

type BulkUpdateCustomersResponse ¶

type BulkUpdateCustomersResponse struct {
	// A map of responses that correspond to individual update requests, represented by key-value pairs.  Each key is the customer ID that was specified for an update request and each value is the corresponding response. If the request succeeds, the value is the updated customer profile. If the request fails, the value contains any errors that occurred during the request.
	Responses map[string]UpdateCustomerResponse `json:"responses,omitempty"`
	// Any top-level errors that prevented the bulk operation from running.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields included in the response body from the [BulkUpdateCustomers](https://developer.squareup.com/reference/square_2024-07-17/customers-api/bulk-update-customers) endpoint.

type BulkUpdateTeamMembersRequest ¶

type BulkUpdateTeamMembersRequest struct {
	// The data used to update the `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. The maximum number of update objects is 25.
	TeamMembers map[string]UpdateTeamMemberRequest `json:"team_members"`
}

Represents a bulk update request for `TeamMember` objects.

type BulkUpdateTeamMembersResponse ¶

type BulkUpdateTeamMembersResponse struct {
	// The successfully updated `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`.
	TeamMembers map[string]UpdateTeamMemberResponse `json:"team_members,omitempty"`
	// The errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response from a bulk update request containing the updated `TeamMember` objects or error messages.

type BulkUpdateVendorsRequest ¶

type BulkUpdateVendorsRequest struct {
	// A set of [UpdateVendorRequest](https://developer.squareup.com/reference/square_2024-07-17/objects/UpdateVendorRequest) objects encapsulating to-be-updated [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) objects. The set is represented by  a collection of `Vendor`-ID/`UpdateVendorRequest`-object pairs.
	Vendors map[string]UpdateVendorRequest `json:"vendors"`
}

Represents an input to a call to [BulkUpdateVendors](https://developer.squareup.com/reference/square_2024-07-17/vendors-api/bulk-update-vendors).

type BulkUpdateVendorsResponse ¶

type BulkUpdateVendorsResponse struct {
	// Errors encountered when the request fails.
	Errors []ModelError `json:"errors,omitempty"`
	// A set of [UpdateVendorResponse](https://developer.squareup.com/reference/square_2024-07-17/objects/UpdateVendorResponse) objects encapsulating successfully created [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) objects or error responses for failed attempts. The set is represented by a collection of `Vendor`-ID/`UpdateVendorResponse`-object or  `Vendor`-ID/error-object pairs.
	Responses map[string]UpdateVendorResponse `json:"responses,omitempty"`
}

Represents an output from a call to [BulkUpdateVendors](https://developer.squareup.com/reference/square_2024-07-17/vendors-api/bulk-update-vendors).

type BulkUpsertBookingCustomAttributesRequest ¶

type BulkUpsertBookingCustomAttributesRequest struct {
	// A map containing 1 to 25 individual upsert requests. For each request, provide an arbitrary ID that is unique for this `BulkUpsertBookingCustomAttributes` request and the information needed to create or update a custom attribute.
	Values map[string]BookingCustomAttributeUpsertRequest `json:"values"`
}

Represents a [BulkUpsertBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/bulk-upsert-booking-custom-attributes) request.

type BulkUpsertBookingCustomAttributesResponse ¶

type BulkUpsertBookingCustomAttributesResponse struct {
	// A map of responses that correspond to individual upsert requests. Each response has the same ID as the corresponding request and contains either a `booking_id` and `custom_attribute` or an `errors` field.
	Values map[string]BookingCustomAttributeUpsertResponse `json:"values,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [BulkUpsertBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/bulk-upsert-booking-custom-attributes) response, which contains a map of responses that each corresponds to an individual upsert request.

type BulkUpsertCustomerCustomAttributesRequest ¶

type BulkUpsertCustomerCustomAttributesRequest struct {
	// A map containing 1 to 25 individual upsert requests. For each request, provide an arbitrary ID that is unique for this `BulkUpsertCustomerCustomAttributes` request and the information needed to create or update a custom attribute.
	Values map[string]json.RawMessage `json:"values"`
}

Represents a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) request.

type BulkUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequest ¶

type BulkUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequest struct {
	// The ID of the target [customer profile](https://developer.squareup.com/reference/square_2024-07-17/objects/Customer).
	CustomerId      string           `json:"customer_id"`
	CustomAttribute *CustomAttribute `json:"custom_attribute"`
	// A unique identifier for this individual upsert request, used to ensure idempotency. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Represents an individual upsert request in a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) request. An individual request contains a customer ID, the custom attribute to create or update, and an optional idempotency key.

type BulkUpsertCustomerCustomAttributesResponse ¶

type BulkUpsertCustomerCustomAttributesResponse struct {
	// A map of responses that correspond to individual upsert requests. Each response has the same ID as the corresponding request and contains either a `customer_id` and `custom_attribute` or an `errors` field.
	Values map[string]json.RawMessage `json:"values,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) response, which contains a map of responses that each corresponds to an individual upsert request.

type BulkUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponse ¶

type BulkUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponse struct {
	// The ID of the customer profile associated with the custom attribute.
	CustomerId      string           `json:"customer_id,omitempty"`
	CustomAttribute *CustomAttribute `json:"custom_attribute,omitempty"`
	// Any errors that occurred while processing the individual request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response for an individual upsert request in a [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) operation.

type BulkUpsertLocationCustomAttributesRequest ¶

type BulkUpsertLocationCustomAttributesRequest struct {
	// A map containing 1 to 25 individual upsert requests. For each request, provide an arbitrary ID that is unique for this `BulkUpsertLocationCustomAttributes` request and the information needed to create or update a custom attribute.
	Values map[string]json.RawMessage `json:"values"`
}

Represents a [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/bulk-upsert-location-custom-attributes) request.

type BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest ¶

type BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest struct {
	// The ID of the target [location](https://developer.squareup.com/reference/square_2024-07-17/objects/Location).
	LocationId      string           `json:"location_id"`
	CustomAttribute *CustomAttribute `json:"custom_attribute"`
	// A unique identifier for this individual upsert request, used to ensure idempotency. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Represents an individual upsert request in a [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/bulk-upsert-location-custom-attributes) request. An individual request contains a location ID, the custom attribute to create or update, and an optional idempotency key.

type BulkUpsertLocationCustomAttributesResponse ¶

type BulkUpsertLocationCustomAttributesResponse struct {
	// A map of responses that correspond to individual upsert requests. Each response has the same ID as the corresponding request and contains either a `location_id` and `custom_attribute` or an `errors` field.
	Values map[string]json.RawMessage `json:"values,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/bulk-upsert-location-custom-attributes) response, which contains a map of responses that each corresponds to an individual upsert request.

type BulkUpsertLocationCustomAttributesResponseLocationCustomAttributeUpsertResponse ¶

type BulkUpsertLocationCustomAttributesResponseLocationCustomAttributeUpsertResponse struct {
	// The ID of the location associated with the custom attribute.
	LocationId      string           `json:"location_id,omitempty"`
	CustomAttribute *CustomAttribute `json:"custom_attribute,omitempty"`
	// Any errors that occurred while processing the individual request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response for an individual upsert request in a [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/bulk-upsert-location-custom-attributes) operation.

type BulkUpsertMerchantCustomAttributesRequest ¶

type BulkUpsertMerchantCustomAttributesRequest struct {
	// A map containing 1 to 25 individual upsert requests. For each request, provide an arbitrary ID that is unique for this `BulkUpsertMerchantCustomAttributes` request and the information needed to create or update a custom attribute.
	Values map[string]json.RawMessage `json:"values"`
}

Represents a [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes) request.

type BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequest ¶

type BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequest struct {
	// The ID of the target [merchant](https://developer.squareup.com/reference/square_2024-07-17/objects/Merchant).
	MerchantId      string           `json:"merchant_id"`
	CustomAttribute *CustomAttribute `json:"custom_attribute"`
	// A unique identifier for this individual upsert request, used to ensure idempotency. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Represents an individual upsert request in a [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes) request. An individual request contains a merchant ID, the custom attribute to create or update, and an optional idempotency key.

type BulkUpsertMerchantCustomAttributesResponse ¶

type BulkUpsertMerchantCustomAttributesResponse struct {
	// A map of responses that correspond to individual upsert requests. Each response has the same ID as the corresponding request and contains either a `merchant_id` and `custom_attribute` or an `errors` field.
	Values map[string]json.RawMessage `json:"values,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes) response, which contains a map of responses that each corresponds to an individual upsert request.

type BulkUpsertMerchantCustomAttributesResponseMerchantCustomAttributeUpsertResponse ¶

type BulkUpsertMerchantCustomAttributesResponseMerchantCustomAttributeUpsertResponse struct {
	// The ID of the merchant associated with the custom attribute.
	MerchantId      string           `json:"merchant_id,omitempty"`
	CustomAttribute *CustomAttribute `json:"custom_attribute,omitempty"`
	// Any errors that occurred while processing the individual request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response for an individual upsert request in a [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes) operation.

type BulkUpsertOrderCustomAttributesRequest ¶

type BulkUpsertOrderCustomAttributesRequest struct {
	// A map of requests that correspond to individual upsert operations for custom attributes.
	Values map[string]json.RawMessage `json:"values"`
}

Represents a bulk upsert request for one or more order custom attributes.

type BulkUpsertOrderCustomAttributesRequestUpsertCustomAttribute ¶

type BulkUpsertOrderCustomAttributesRequestUpsertCustomAttribute struct {
	CustomAttribute *CustomAttribute `json:"custom_attribute"`
	// 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).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
	// The ID of the target [order](https://developer.squareup.com/reference/square_2024-07-17/objects/Order).
	OrderId string `json:"order_id"`
}

Represents one upsert within the bulk operation.

type BulkUpsertOrderCustomAttributesResponse ¶

type BulkUpsertOrderCustomAttributesResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	//  A map of responses that correspond to individual upsert operations for custom attributes.
	Values map[string]UpsertOrderCustomAttributeResponse `json:"values"`
}

Represents a response from a bulk upsert of order custom attributes.

type BusinessAppointmentSettings ¶

type BusinessAppointmentSettings struct {
	// Types of the location allowed for bookings.
	LocationTypes []string `json:"location_types,omitempty"`
	// The time unit of the service duration for bookings.
	AlignmentTime string `json:"alignment_time,omitempty"`
	// The minimum lead time in seconds before a service can be booked. A booking must be created at least this amount of time before its starting time.
	MinBookingLeadTimeSeconds int32 `json:"min_booking_lead_time_seconds,omitempty"`
	// The maximum lead time in seconds before a service can be booked. A booking must be created at most this amount of time before its starting time.
	MaxBookingLeadTimeSeconds int32 `json:"max_booking_lead_time_seconds,omitempty"`
	// Indicates whether a customer can choose from all available time slots and have a staff member assigned automatically (`true`) or not (`false`).
	AnyTeamMemberBookingEnabled bool `json:"any_team_member_booking_enabled,omitempty"`
	// Indicates whether a customer can book multiple services in a single online booking.
	MultipleServiceBookingEnabled bool `json:"multiple_service_booking_enabled,omitempty"`
	// Indicates whether the daily appointment limit applies to team members or to business locations.
	MaxAppointmentsPerDayLimitType string `json:"max_appointments_per_day_limit_type,omitempty"`
	// The maximum number of daily appointments per team member or per location.
	MaxAppointmentsPerDayLimit int32 `json:"max_appointments_per_day_limit,omitempty"`
	// The cut-off time in seconds for allowing clients to cancel or reschedule an appointment.
	CancellationWindowSeconds int32  `json:"cancellation_window_seconds,omitempty"`
	CancellationFeeMoney      *Money `json:"cancellation_fee_money,omitempty"`
	// The cancellation policy adopted by the seller.
	CancellationPolicy string `json:"cancellation_policy,omitempty"`
	// The free-form text of the seller's cancellation policy.
	CancellationPolicyText string `json:"cancellation_policy_text,omitempty"`
	// Indicates whether customers has an assigned staff member (`true`) or can select s staff member of their choice (`false`).
	SkipBookingFlowStaffSelection bool `json:"skip_booking_flow_staff_selection,omitempty"`
}

The service appointment settings, including where and how the service is provided.

type BusinessAppointmentSettingsAlignmentTime ¶

type BusinessAppointmentSettingsAlignmentTime string

BusinessAppointmentSettingsAlignmentTime : Time units of a service duration for bookings.

const (
	SERVICE_DURATION_BusinessAppointmentSettingsAlignmentTime BusinessAppointmentSettingsAlignmentTime = "SERVICE_DURATION"
	QUARTER_HOURLY_BusinessAppointmentSettingsAlignmentTime   BusinessAppointmentSettingsAlignmentTime = "QUARTER_HOURLY"
	HALF_HOURLY_BusinessAppointmentSettingsAlignmentTime      BusinessAppointmentSettingsAlignmentTime = "HALF_HOURLY"
	HOURLY_BusinessAppointmentSettingsAlignmentTime           BusinessAppointmentSettingsAlignmentTime = "HOURLY"
)

List of BusinessAppointmentSettingsAlignmentTime

type BusinessAppointmentSettingsBookingLocationType ¶

type BusinessAppointmentSettingsBookingLocationType string

BusinessAppointmentSettingsBookingLocationType : Supported types of location where service is provided.

const (
	BUSINESS_LOCATION_BusinessAppointmentSettingsBookingLocationType BusinessAppointmentSettingsBookingLocationType = "BUSINESS_LOCATION"
	CUSTOMER_LOCATION_BusinessAppointmentSettingsBookingLocationType BusinessAppointmentSettingsBookingLocationType = "CUSTOMER_LOCATION"
	PHONE_BusinessAppointmentSettingsBookingLocationType             BusinessAppointmentSettingsBookingLocationType = "PHONE"
)

List of BusinessAppointmentSettingsBookingLocationType

type BusinessAppointmentSettingsCancellationPolicy ¶

type BusinessAppointmentSettingsCancellationPolicy string

BusinessAppointmentSettingsCancellationPolicy : The category of the seller’s cancellation policy.

const (
	CANCELLATION_TREATED_AS_NO_SHOW_BusinessAppointmentSettingsCancellationPolicy BusinessAppointmentSettingsCancellationPolicy = "CANCELLATION_TREATED_AS_NO_SHOW"
	CUSTOM_POLICY_BusinessAppointmentSettingsCancellationPolicy                   BusinessAppointmentSettingsCancellationPolicy = "CUSTOM_POLICY"
)

List of BusinessAppointmentSettingsCancellationPolicy

type BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType ¶

type BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType string

BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType : Types of daily appointment limits.

const (
	TEAM_MEMBER_BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType = "PER_TEAM_MEMBER"
	LOCATION_BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType    BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType = "PER_LOCATION"
)

List of BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType

type BusinessBookingProfile ¶

type BusinessBookingProfile struct {
	// The ID of the seller, obtainable using the Merchants API.
	SellerId string `json:"seller_id,omitempty"`
	// The RFC 3339 timestamp specifying the booking's creation time.
	CreatedAt string `json:"created_at,omitempty"`
	// Indicates whether the seller is open for booking.
	BookingEnabled bool `json:"booking_enabled,omitempty"`
	// The choice of customer's time zone information of a booking. The Square online booking site and all notifications to customers uses either the seller location’s time zone or the time zone the customer chooses at booking.
	CustomerTimezoneChoice string `json:"customer_timezone_choice,omitempty"`
	// The policy for the seller to automatically accept booking requests (`ACCEPT_ALL`) or not (`REQUIRES_ACCEPTANCE`).
	BookingPolicy string `json:"booking_policy,omitempty"`
	// Indicates whether customers can cancel or reschedule their own bookings (`true`) or not (`false`).
	AllowUserCancel             bool                         `json:"allow_user_cancel,omitempty"`
	BusinessAppointmentSettings *BusinessAppointmentSettings `json:"business_appointment_settings,omitempty"`
	// Indicates whether the seller's subscription to Square Appointments supports creating, updating or canceling an appointment through the API (`true`) or not (`false`) using seller permission.
	SupportSellerLevelWrites bool `json:"support_seller_level_writes,omitempty"`
}

A seller's business booking profile, including booking policy, appointment settings, etc.

type BusinessBookingProfileBookingPolicy ¶

type BusinessBookingProfileBookingPolicy string

BusinessBookingProfileBookingPolicy : Policies for accepting bookings.

const (
	ACCEPT_ALL_BusinessBookingProfileBookingPolicy          BusinessBookingProfileBookingPolicy = "ACCEPT_ALL"
	REQUIRES_ACCEPTANCE_BusinessBookingProfileBookingPolicy BusinessBookingProfileBookingPolicy = "REQUIRES_ACCEPTANCE"
)

List of BusinessBookingProfileBookingPolicy

type BusinessBookingProfileCustomerTimezoneChoice ¶

type BusinessBookingProfileCustomerTimezoneChoice string

BusinessBookingProfileCustomerTimezoneChoice : Choices of customer-facing time zone used for bookings.

const (
	BUSINESS_LOCATION_TIMEZONE_BusinessBookingProfileCustomerTimezoneChoice BusinessBookingProfileCustomerTimezoneChoice = "BUSINESS_LOCATION_TIMEZONE"
	CUSTOMER_CHOICE_BusinessBookingProfileCustomerTimezoneChoice            BusinessBookingProfileCustomerTimezoneChoice = "CUSTOMER_CHOICE"
)

List of BusinessBookingProfileCustomerTimezoneChoice

type BusinessHours ¶

type BusinessHours struct {
	// The list of time periods during which the business is open. There can be at most 10 periods per day.
	Periods []BusinessHoursPeriod `json:"periods,omitempty"`
}

The hours of operation for a location.

type BusinessHoursPeriod ¶

type BusinessHoursPeriod struct {
	// The day of the week for this time period.
	DayOfWeek string `json:"day_of_week,omitempty"`
	// The start time of a business hours period, specified in local time using partial-time RFC 3339 format. For example, `8:30:00` for a period starting at 8:30 in the morning. Note that the seconds value is always :00, but it is appended for conformance to the RFC.
	StartLocalTime string `json:"start_local_time,omitempty"`
	// The end time of a business hours period, specified in local time using partial-time RFC 3339 format. For example, `21:00:00` for a period ending at 9:00 in the evening. Note that the seconds value is always :00, but it is appended for conformance to the RFC.
	EndLocalTime string `json:"end_local_time,omitempty"`
}

Represents a period of time during which a business location is open.

type BuyNowPayLaterDetails ¶

type BuyNowPayLaterDetails struct {
	// The brand used for the Buy Now Pay Later payment. The brand can be `AFTERPAY`, `CLEARPAY` or `UNKNOWN`.
	Brand           string           `json:"brand,omitempty"`
	AfterpayDetails *AfterpayDetails `json:"afterpay_details,omitempty"`
	ClearpayDetails *ClearpayDetails `json:"clearpay_details,omitempty"`
}

Additional details about a Buy Now Pay Later payment type.

type CalculateLoyaltyPointsRequest ¶

type CalculateLoyaltyPointsRequest struct {
	// The [order](https://developer.squareup.com/reference/square_2024-07-17/objects/Order) ID for which to calculate the points. Specify this field if your application uses the Orders API to process orders. Otherwise, specify the `transaction_amount_money`.
	OrderId                string `json:"order_id,omitempty"`
	TransactionAmountMoney *Money `json:"transaction_amount_money,omitempty"`
	// The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyAccount). Optionally specify this field if your application uses the Orders API to process orders.  If specified, the `promotion_points` field in the response shows the number of points the buyer would earn from the purchase. In this case, Square uses the account ID to determine whether the promotion's `trigger_limit` (the maximum number of times that a buyer can trigger the promotion) has been reached. If not specified, the `promotion_points` field shows the number of points the purchase qualifies for regardless of the trigger limit.
	LoyaltyAccountId string `json:"loyalty_account_id,omitempty"`
}

Represents a [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/calculate-loyalty-points) request.

type CalculateLoyaltyPointsResponse ¶

type CalculateLoyaltyPointsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The number of points that the buyer can earn from the base loyalty program.
	Points int32 `json:"points,omitempty"`
	// The number of points that the buyer can earn from a loyalty promotion. To be eligible to earn promotion points, the purchase must first qualify for program points. When `order_id` is not provided in the request, this value is always 0.
	PromotionPoints int32 `json:"promotion_points,omitempty"`
}

Represents a [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/calculate-loyalty-points) response.

type CalculateOrderRequest ¶

type CalculateOrderRequest struct {
	Order *Order `json:"order"`
	// Identifies one or more loyalty reward tiers to apply during the order calculation. The discounts defined by the reward tiers are added to the order only to preview the effect of applying the specified rewards. The rewards do not correspond to actual redemptions; that is, no `reward`s are created. Therefore, the reward `id`s are random strings used only to reference the reward tier.
	ProposedRewards []OrderReward `json:"proposed_rewards,omitempty"`
}

type CalculateOrderResponse ¶

type CalculateOrderResponse struct {
	Order *Order `json:"order,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type CancelBookingRequest ¶

type CancelBookingRequest struct {
	// A unique key to make this request an idempotent operation.
	IdempotencyKey string `json:"idempotency_key,omitempty"`
	// The revision number for the booking used for optimistic concurrency.
	BookingVersion int32 `json:"booking_version,omitempty"`
}

type CancelBookingResponse ¶

type CancelBookingResponse struct {
	Booking *Booking `json:"booking,omitempty"`
	// Errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type CancelInvoiceRequest ¶

type CancelInvoiceRequest struct {
	// The version of the [invoice](https://developer.squareup.com/reference/square_2024-07-17/objects/Invoice) to cancel. If you do not know the version, you can call  [GetInvoice](https://developer.squareup.com/reference/square_2024-07-17/invoices-api/get-invoice) or [ListInvoices](https://developer.squareup.com/reference/square_2024-07-17/invoices-api/list-invoices).
	Version int32 `json:"version"`
}

Describes a `CancelInvoice` request.

type CancelInvoiceResponse ¶

type CancelInvoiceResponse struct {
	Invoice *Invoice `json:"invoice,omitempty"`
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

The response returned by the `CancelInvoice` request.

type CancelLoyaltyPromotionRequest ¶

type CancelLoyaltyPromotionRequest struct{}

Represents a [CancelLoyaltyPromotion](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/cancel-loyalty-promotion) request.

type CancelLoyaltyPromotionResponse ¶

type CancelLoyaltyPromotionResponse struct {
	// Any errors that occurred during the request.
	Errors           []ModelError      `json:"errors,omitempty"`
	LoyaltyPromotion *LoyaltyPromotion `json:"loyalty_promotion,omitempty"`
}

Represents a [CancelLoyaltyPromotion](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/cancel-loyalty-promotion) response. Either `loyalty_promotion` or `errors` is present in the response.

type CancelPaymentByIdempotencyKeyRequest ¶

type CancelPaymentByIdempotencyKeyRequest struct {
	// The `idempotency_key` identifying the payment to be canceled.
	IdempotencyKey string `json:"idempotency_key"`
}

Describes a request to cancel a payment using [CancelPaymentByIdempotencyKey](https://developer.squareup.com/reference/square_2024-07-17/payments-api/cancel-payment-by-idempotency-key).

type CancelPaymentByIdempotencyKeyResponse ¶

type CancelPaymentByIdempotencyKeyResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the response returned by [CancelPaymentByIdempotencyKey](https://developer.squareup.com/reference/square_2024-07-17/payments-api/cancel-payment-by-idempotency-key). On success, `errors` is empty.

type CancelPaymentRequest ¶

type CancelPaymentRequest struct{}

Describes the request to cancel (void) a payment using [CancelPayment](https://developer.squareup.com/reference/square_2024-07-17/payments-api/cancel-payment). You can only cancel a payment that is approved (not completed). For more information, see [Delayed capture of a payment](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment).

type CancelPaymentResponse ¶

type CancelPaymentResponse struct {
	// Information about errors encountered during the request.
	Errors  []ModelError `json:"errors,omitempty"`
	Payment *Payment     `json:"payment,omitempty"`
}

Defines the response returned by [CancelPayment](https://developer.squareup.com/reference/square_2024-07-17/payments-api/cancel-payment).

type CancelSubscriptionRequest ¶

type CancelSubscriptionRequest struct{}

Defines input parameters in a request to the [CancelSubscription](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/cancel-subscription) endpoint.

type CancelSubscriptionResponse ¶

type CancelSubscriptionResponse struct {
	// Errors encountered during the request.
	Errors       []ModelError  `json:"errors,omitempty"`
	Subscription *Subscription `json:"subscription,omitempty"`
	// A list of a single `CANCEL` action scheduled for the subscription.
	Actions []SubscriptionAction `json:"actions,omitempty"`
}

Defines output parameters in a response from the [CancelSubscription](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/cancel-subscription) endpoint.

type CancelTerminalActionRequest ¶

type CancelTerminalActionRequest struct{}

type CancelTerminalActionResponse ¶

type CancelTerminalActionResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError    `json:"errors,omitempty"`
	Action *TerminalAction `json:"action,omitempty"`
}

type CancelTerminalCheckoutRequest ¶

type CancelTerminalCheckoutRequest struct{}

type CancelTerminalCheckoutResponse ¶

type CancelTerminalCheckoutResponse struct {
	// Information about errors encountered during the request.
	Errors   []ModelError      `json:"errors,omitempty"`
	Checkout *TerminalCheckout `json:"checkout,omitempty"`
}

type CancelTerminalRefundRequest ¶

type CancelTerminalRefundRequest struct{}

type CancelTerminalRefundResponse ¶

type CancelTerminalRefundResponse struct {
	// Information about errors encountered during the request.
	Errors []ModelError    `json:"errors,omitempty"`
	Refund *TerminalRefund `json:"refund,omitempty"`
}

type CaptureTransactionRequest ¶

type CaptureTransactionRequest struct{}

type CaptureTransactionResponse ¶

type CaptureTransactionResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields that are included in the response body of a request to the [CaptureTransaction](https://developer.squareup.com/reference/square_2024-07-17/transactions-api/capture-transaction) endpoint.

type Card ¶

type Card struct {
	// Unique ID for this card. Generated by Square.
	Id string `json:"id,omitempty"`
	// The card's brand.
	CardBrand string `json:"card_brand,omitempty"`
	// The last 4 digits of the card number.
	Last4 string `json:"last_4,omitempty"`
	// The expiration month of the associated card as an integer between 1 and 12.
	ExpMonth int64 `json:"exp_month,omitempty"`
	// The four-digit year of the card's expiration date.
	ExpYear int64 `json:"exp_year,omitempty"`
	// The name of the cardholder.
	CardholderName string   `json:"cardholder_name,omitempty"`
	BillingAddress *Address `json:"billing_address,omitempty"`
	// Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.
	Fingerprint string `json:"fingerprint,omitempty"`
	// **Required** The ID of a customer created using the Customers API to be associated with the card.
	CustomerId string `json:"customer_id,omitempty"`
	// The ID of the merchant associated with the card.
	MerchantId string `json:"merchant_id,omitempty"`
	// An optional user-defined reference ID that associates this card with another entity in an external system. For example, a customer ID from an external customer management system.
	ReferenceId string `json:"reference_id,omitempty"`
	// Indicates whether or not a card can be used for payments.
	Enabled bool `json:"enabled,omitempty"`
	// The type of the card. The Card object includes this field only in response to Payments API calls.
	CardType string `json:"card_type,omitempty"`
	// Indicates whether the Card is prepaid or not. The Card object includes this field only in response to Payments API calls.
	PrepaidType string `json:"prepaid_type,omitempty"`
	// The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API returns this field.
	Bin string `json:"bin,omitempty"`
	// Current version number of the card. Increments with each card update. Requests to update an existing Card object will be rejected unless the version in the request matches the current version for the Card.
	Version int64 `json:"version,omitempty"`
	// The card's co-brand if available. For example, an Afterpay virtual card would have a co-brand of AFTERPAY.
	CardCoBrand string `json:"card_co_brand,omitempty"`
}

Represents the payment details of a card to be used for payments. These details are determined by the payment token generated by Web Payments SDK.

type CardBrand ¶

type CardBrand string

CardBrand : Indicates a card's brand, such as `VISA` or `MASTERCARD`.

const (
	OTHER_BRAND_CardBrand         CardBrand = "OTHER_BRAND"
	VISA_CardBrand                CardBrand = "VISA"
	MASTERCARD_CardBrand          CardBrand = "MASTERCARD"
	AMERICAN_EXPRESS_CardBrand    CardBrand = "AMERICAN_EXPRESS"
	DISCOVER_CardBrand            CardBrand = "DISCOVER"
	DISCOVER_DINERS_CardBrand     CardBrand = "DISCOVER_DINERS"
	JCB_CardBrand                 CardBrand = "JCB"
	CHINA_UNIONPAY_CardBrand      CardBrand = "CHINA_UNIONPAY"
	SQUARE_GIFT_CARD_CardBrand    CardBrand = "SQUARE_GIFT_CARD"
	SQUARE_CAPITAL_CARD_CardBrand CardBrand = "SQUARE_CAPITAL_CARD"
	INTERAC_CardBrand             CardBrand = "INTERAC"
	EFTPOS_CardBrand              CardBrand = "EFTPOS"
	FELICA_CardBrand              CardBrand = "FELICA"
	EBT_CardBrand                 CardBrand = "EBT"
)

List of CardBrand

type CardCoBrand ¶

type CardCoBrand string

CardCoBrand : Indicates the brand for a co-branded card.

const (
	UNKNOWN_CardCoBrand  CardCoBrand = "UNKNOWN"
	AFTERPAY_CardCoBrand CardCoBrand = "AFTERPAY"
	CLEARPAY_CardCoBrand CardCoBrand = "CLEARPAY"
)

List of CardCoBrand

type CardPaymentDetails ¶

type CardPaymentDetails struct {
	// The card payment's current state. The state can be AUTHORIZED, CAPTURED, VOIDED, or FAILED.
	Status string `json:"status,omitempty"`
	Card   *Card  `json:"card,omitempty"`
	// The method used to enter the card's details for the payment. The method can be `KEYED`, `SWIPED`, `EMV`, `ON_FILE`, or `CONTACTLESS`.
	EntryMethod string `json:"entry_method,omitempty"`
	// The status code returned from the Card Verification Value (CVV) check. The code can be `CVV_ACCEPTED`, `CVV_REJECTED`, or `CVV_NOT_CHECKED`.
	CvvStatus string `json:"cvv_status,omitempty"`
	// The status code returned from the Address Verification System (AVS) check. The code can be `AVS_ACCEPTED`, `AVS_REJECTED`, or `AVS_NOT_CHECKED`.
	AvsStatus string `json:"avs_status,omitempty"`
	// The status code returned by the card issuer that describes the payment's authorization status.
	AuthResultCode string `json:"auth_result_code,omitempty"`
	// For EMV payments, the application ID identifies the EMV application used for the payment.
	ApplicationIdentifier string `json:"application_identifier,omitempty"`
	// For EMV payments, the human-readable name of the EMV application used for the payment.
	ApplicationName string `json:"application_name,omitempty"`
	// For EMV payments, the cryptogram generated for the payment.
	ApplicationCryptogram string `json:"application_cryptogram,omitempty"`
	// For EMV payments, the method used to verify the cardholder's identity. The method can be `PIN`, `SIGNATURE`, `PIN_AND_SIGNATURE`, `ON_DEVICE`, or `NONE`.
	VerificationMethod string `json:"verification_method,omitempty"`
	// For EMV payments, the results of the cardholder verification. The result can be `SUCCESS`, `FAILURE`, or `UNKNOWN`.
	VerificationResults string `json:"verification_results,omitempty"`
	// The statement description sent to the card networks.  Note: The actual statement description varies and is likely to be truncated and appended with additional information on a per issuer basis.
	StatementDescription string               `json:"statement_description,omitempty"`
	DeviceDetails        *DeviceDetails       `json:"device_details,omitempty"`
	CardPaymentTimeline  *CardPaymentTimeline `json:"card_payment_timeline,omitempty"`
	// Whether the card must be physically present for the payment to be refunded.  If set to `true`, the card must be present.
	RefundRequiresCardPresence bool `json:"refund_requires_card_presence,omitempty"`
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Reflects the current status of a card payment. Contains only non-confidential information.

type CardPaymentTimeline ¶

type CardPaymentTimeline struct {
	// The timestamp when the payment was authorized, in RFC 3339 format.
	AuthorizedAt string `json:"authorized_at,omitempty"`
	// The timestamp when the payment was captured, in RFC 3339 format.
	CapturedAt string `json:"captured_at,omitempty"`
	// The timestamp when the payment was voided, in RFC 3339 format.
	VoidedAt string `json:"voided_at,omitempty"`
}

The timeline for card payments.

type CardPrepaidType ¶

type CardPrepaidType string

CardPrepaidType : Indicates a card's prepaid type, such as `NOT_PREPAID` or `PREPAID`.

const (
	UNKNOWN_PREPAID_TYPE_CardPrepaidType CardPrepaidType = "UNKNOWN_PREPAID_TYPE"
	NOT_PREPAID_CardPrepaidType          CardPrepaidType = "NOT_PREPAID"
	PREPAID_CardPrepaidType              CardPrepaidType = "PREPAID"
)

List of CardPrepaidType

type CardType ¶

type CardType string

CardType : Indicates a card's type, such as `CREDIT` or `DEBIT`.

const (
	UNKNOWN_CARD_TYPE_CardType CardType = "UNKNOWN_CARD_TYPE"
	CREDIT_CardType            CardType = "CREDIT"
	DEBIT_CardType             CardType = "DEBIT"
)

List of CardType

type CardsApiListCardsOpts ¶

type CardsApiListCardsOpts struct {
	Cursor          optional.String
	CustomerId      optional.String
	IncludeDisabled optional.Bool
	ReferenceId     optional.String
	SortOrder       optional.String
}

type CardsApiService ¶

type CardsApiService service

func (*CardsApiService) CreateCard ¶

func (a *CardsApiService) CreateCard(ctx context.Context, body CreateCardRequest) (CreateCardResponse, *http.Response, error)

CardsApiService CreateCard Adds a card on file to an existing merchant.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateCardResponse

func (*CardsApiService) DisableCard ¶

func (a *CardsApiService) DisableCard(ctx context.Context, cardId string) (DisableCardResponse, *http.Response, error)

CardsApiService DisableCard Disables the card, preventing any further updates or charges. Disabling an already disabled card is allowed but has no effect.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param cardId Unique ID for the desired Card.

@return DisableCardResponse

func (*CardsApiService) ListCards ¶

func (a *CardsApiService) ListCards(ctx context.Context, localVarOptionals *CardsApiListCardsOpts) (ListCardsResponse, *http.Response, error)

func (*CardsApiService) RetrieveCard ¶

func (a *CardsApiService) RetrieveCard(ctx context.Context, cardId string) (RetrieveCardResponse, *http.Response, error)

CardsApiService RetrieveCard Retrieves details for a specific Card.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param cardId Unique ID for the desired Card.

@return RetrieveCardResponse

type CashAppDetails ¶

type CashAppDetails struct {
	// The name of the Cash App account holder.
	BuyerFullName string `json:"buyer_full_name,omitempty"`
	// The country of the Cash App account holder, in ISO 3166-1-alpha-2 format.  For possible values, see [Country](https://developer.squareup.com/reference/square_2024-07-17/enums/Country).
	BuyerCountryCode string `json:"buyer_country_code,omitempty"`
	// $Cashtag of the Cash App account holder.
	BuyerCashtag string `json:"buyer_cashtag,omitempty"`
}

Additional details about `WALLET` type payments with the `brand` of `CASH_APP`.

type CashDrawerDevice ¶

type CashDrawerDevice struct {
	// The device Square-issued ID
	Id string `json:"id,omitempty"`
	// The device merchant-specified name.
	Name string `json:"name,omitempty"`
}

type CashDrawerEventType ¶

type CashDrawerEventType string

CashDrawerEventType : The types of events on a CashDrawerShift. Each event type represents an employee action on the actual cash drawer represented by a CashDrawerShift.

const (
	NO_SALE_CashDrawerEventType                        CashDrawerEventType = "NO_SALE"
	CASH_TENDER_PAYMENT_CashDrawerEventType            CashDrawerEventType = "CASH_TENDER_PAYMENT"
	OTHER_TENDER_PAYMENT_CashDrawerEventType           CashDrawerEventType = "OTHER_TENDER_PAYMENT"
	CASH_TENDER_CANCELLED_PAYMENT_CashDrawerEventType  CashDrawerEventType = "CASH_TENDER_CANCELLED_PAYMENT"
	OTHER_TENDER_CANCELLED_PAYMENT_CashDrawerEventType CashDrawerEventType = "OTHER_TENDER_CANCELLED_PAYMENT"
	CASH_TENDER_REFUND_CashDrawerEventType             CashDrawerEventType = "CASH_TENDER_REFUND"
	OTHER_TENDER_REFUND_CashDrawerEventType            CashDrawerEventType = "OTHER_TENDER_REFUND"
	PAID_IN_CashDrawerEventType                        CashDrawerEventType = "PAID_IN"
	PAID_OUT_CashDrawerEventType                       CashDrawerEventType = "PAID_OUT"
)

List of CashDrawerEventType

type CashDrawerShift ¶

type CashDrawerShift struct {
	// The shift unique ID.
	Id string `json:"id,omitempty"`
	// The shift current state.
	State string `json:"state,omitempty"`
	// The time when the shift began, in ISO 8601 format.
	OpenedAt string `json:"opened_at,omitempty"`
	// The time when the shift ended, in ISO 8601 format.
	EndedAt string `json:"ended_at,omitempty"`
	// The time when the shift was closed, in ISO 8601 format.
	ClosedAt string `json:"closed_at,omitempty"`
	// The free-form text description of a cash drawer by an employee.
	Description       string            `json:"description,omitempty"`
	OpenedCashMoney   *Money            `json:"opened_cash_money,omitempty"`
	CashPaymentMoney  *Money            `json:"cash_payment_money,omitempty"`
	CashRefundsMoney  *Money            `json:"cash_refunds_money,omitempty"`
	CashPaidInMoney   *Money            `json:"cash_paid_in_money,omitempty"`
	CashPaidOutMoney  *Money            `json:"cash_paid_out_money,omitempty"`
	ExpectedCashMoney *Money            `json:"expected_cash_money,omitempty"`
	ClosedCashMoney   *Money            `json:"closed_cash_money,omitempty"`
	Device            *CashDrawerDevice `json:"device,omitempty"`
	// The shift start time in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The shift updated at time in RFC 3339 format.
	UpdatedAt string `json:"updated_at,omitempty"`
	// The ID of the location the cash drawer shift belongs to.
	LocationId string `json:"location_id,omitempty"`
	// The IDs of all team members that were logged into Square Point of Sale at any point while the cash drawer shift was open.
	TeamMemberIds []string `json:"team_member_ids,omitempty"`
	// The ID of the team member that started the cash drawer shift.
	OpeningTeamMemberId string `json:"opening_team_member_id,omitempty"`
	// The ID of the team member that ended the cash drawer shift.
	EndingTeamMemberId string `json:"ending_team_member_id,omitempty"`
	// The ID of the team member that closed the cash drawer shift by auditing the cash drawer contents.
	ClosingTeamMemberId string `json:"closing_team_member_id,omitempty"`
}

This model gives the details of a cash drawer shift. The cash_payment_money, cash_refund_money, cash_paid_in_money, and cash_paid_out_money fields are all computed by summing their respective event types.

type CashDrawerShiftEvent ¶

type CashDrawerShiftEvent struct {
	// The unique ID of the event.
	Id string `json:"id,omitempty"`
	// The type of cash drawer shift event.
	EventType  string `json:"event_type,omitempty"`
	EventMoney *Money `json:"event_money,omitempty"`
	// The event time in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// An optional description of the event, entered by the employee that created the event.
	Description string `json:"description,omitempty"`
	// The ID of the team member that created the event.
	TeamMemberId string `json:"team_member_id,omitempty"`
}

type CashDrawerShiftState ¶

type CashDrawerShiftState string

CashDrawerShiftState : The current state of a cash drawer shift.

const (
	OPEN_CashDrawerShiftState   CashDrawerShiftState = "OPEN"
	ENDED_CashDrawerShiftState  CashDrawerShiftState = "ENDED"
	CLOSED_CashDrawerShiftState CashDrawerShiftState = "CLOSED"
)

List of CashDrawerShiftState

type CashDrawerShiftSummary ¶

type CashDrawerShiftSummary struct {
	// The shift unique ID.
	Id string `json:"id,omitempty"`
	// The shift current state.
	State string `json:"state,omitempty"`
	// The shift start time in ISO 8601 format.
	OpenedAt string `json:"opened_at,omitempty"`
	// The shift end time in ISO 8601 format.
	EndedAt string `json:"ended_at,omitempty"`
	// The shift close time in ISO 8601 format.
	ClosedAt string `json:"closed_at,omitempty"`
	// An employee free-text description of a cash drawer shift.
	Description       string `json:"description,omitempty"`
	OpenedCashMoney   *Money `json:"opened_cash_money,omitempty"`
	ExpectedCashMoney *Money `json:"expected_cash_money,omitempty"`
	ClosedCashMoney   *Money `json:"closed_cash_money,omitempty"`
	// The shift start time in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The shift updated at time in RFC 3339 format.
	UpdatedAt string `json:"updated_at,omitempty"`
	// The ID of the location the cash drawer shift belongs to.
	LocationId string `json:"location_id,omitempty"`
}

The summary of a closed cash drawer shift. This model contains only the money counted to start a cash drawer shift, counted at the end of the shift, and the amount that should be in the drawer at shift end based on summing all cash drawer shift events.

type CashDrawersApiListCashDrawerShiftEventsOpts ¶

type CashDrawersApiListCashDrawerShiftEventsOpts struct {
	Limit  optional.Int32
	Cursor optional.String
}

type CashDrawersApiListCashDrawerShiftsOpts ¶

type CashDrawersApiListCashDrawerShiftsOpts struct {
	SortOrder optional.String
	BeginTime optional.String
	EndTime   optional.String
	Limit     optional.Int32
	Cursor    optional.String
}

type CashDrawersApiService ¶

type CashDrawersApiService service

func (*CashDrawersApiService) ListCashDrawerShiftEvents ¶

func (a *CashDrawersApiService) ListCashDrawerShiftEvents(ctx context.Context, locationId string, shiftId string, localVarOptionals *CashDrawersApiListCashDrawerShiftEventsOpts) (ListCashDrawerShiftEventsResponse, *http.Response, error)

func (*CashDrawersApiService) ListCashDrawerShifts ¶

func (a *CashDrawersApiService) ListCashDrawerShifts(ctx context.Context, locationId string, localVarOptionals *CashDrawersApiListCashDrawerShiftsOpts) (ListCashDrawerShiftsResponse, *http.Response, error)

func (*CashDrawersApiService) RetrieveCashDrawerShift ¶

func (a *CashDrawersApiService) RetrieveCashDrawerShift(ctx context.Context, locationId string, shiftId string) (RetrieveCashDrawerShiftResponse, *http.Response, error)

CashDrawersApiService RetrieveCashDrawerShift Provides the summary details for a single cash drawer shift. See [ListCashDrawerShiftEvents](https://developer.squareup.com/reference/square_2024-07-17/cash-drawers-api/list-cash-drawer-shift-events) for a list of cash drawer shift events.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the location to retrieve cash drawer shifts from.
@param shiftId The shift ID.

@return RetrieveCashDrawerShiftResponse

type CashPaymentDetails ¶

type CashPaymentDetails struct {
	BuyerSuppliedMoney *Money `json:"buyer_supplied_money"`
	ChangeBackMoney    *Money `json:"change_back_money,omitempty"`
}

Stores details about a cash payment. Contains only non-confidential information. For more information, see [Take Cash Payments](https://developer.squareup.com/docs/payments-api/take-payments/cash-payments).

type CatalogApiListCatalogOpts ¶

type CatalogApiListCatalogOpts struct {
	Cursor         optional.String
	Types          optional.String
	CatalogVersion optional.Int64
}

type CatalogApiRetrieveCatalogObjectOpts ¶

type CatalogApiRetrieveCatalogObjectOpts struct {
	IncludeRelatedObjects     optional.Bool
	CatalogVersion            optional.Int64
	IncludeCategoryPathToRoot optional.Bool
}

type CatalogApiService ¶

type CatalogApiService service

func (*CatalogApiService) BatchDeleteCatalogObjects ¶

func (a *CatalogApiService) BatchDeleteCatalogObjects(ctx context.Context, body BatchDeleteCatalogObjectsRequest) (BatchDeleteCatalogObjectsResponse, *http.Response, error)

CatalogApiService BatchDeleteCatalogObjects Deletes a set of CatalogItem(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItem)s based on the provided list of target IDs and returns a set of successfully deleted IDs in the response. Deletion is a cascading event such that all children of the targeted object are also deleted. For example, deleting a CatalogItem will also delete all of its CatalogItemVariation(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItemVariation) children. `BatchDeleteCatalogObjects` succeeds even if only a portion of the targeted IDs can be deleted. The response will only include IDs that were actually deleted. To ensure consistency, only one delete request is processed at a time per seller account. While one (batch or non-batch) delete request is being processed, other (batched and non-batched) delete requests are rejected with the `429` error code.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BatchDeleteCatalogObjectsResponse

func (*CatalogApiService) BatchRetrieveCatalogObjects ¶

func (a *CatalogApiService) BatchRetrieveCatalogObjects(ctx context.Context, body BatchRetrieveCatalogObjectsRequest) (BatchRetrieveCatalogObjectsResponse, *http.Response, error)

CatalogApiService BatchRetrieveCatalogObjects Returns a set of objects based on the provided ID. Each CatalogItem(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItem) returned in the set includes all of its child information including: all of its CatalogItemVariation(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItemVariation) objects, references to its CatalogModifierList(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogModifierList) objects, and the ids of any CatalogTax(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogTax) objects that apply to it.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BatchRetrieveCatalogObjectsResponse

func (*CatalogApiService) BatchUpsertCatalogObjects ¶

func (a *CatalogApiService) BatchUpsertCatalogObjects(ctx context.Context, body BatchUpsertCatalogObjectsRequest) (BatchUpsertCatalogObjectsResponse, *http.Response, error)

CatalogApiService BatchUpsertCatalogObjects Creates or updates up to 10,000 target objects based on the provided list of objects. The target objects are grouped into batches and each batch is inserted/updated in an all-or-nothing manner. If an object within a batch is malformed in some way, or violates a database constraint, the entire batch containing that item will be disregarded. However, other batches in the same request may still succeed. Each batch may contain up to 1,000 objects, and batches will be processed in order as long as the total object count for the request (items, variations, modifier lists, discounts, and taxes) is no more than 10,000. To ensure consistency, only one update request is processed at a time per seller account. While one (batch or non-batch) update request is being processed, other (batched and non-batched) update requests are rejected with the `429` error code.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BatchUpsertCatalogObjectsResponse

func (*CatalogApiService) CatalogInfo ¶

func (a *CatalogApiService) CatalogInfo(ctx context.Context) (CatalogInfoResponse, *http.Response, error)

CatalogApiService CatalogInfo Retrieves information about the Square Catalog API, such as batch size limits that can be used by the `BatchUpsertCatalogObjects` endpoint.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return CatalogInfoResponse

func (*CatalogApiService) DeleteCatalogObject ¶

func (a *CatalogApiService) DeleteCatalogObject(ctx context.Context, objectId string) (DeleteCatalogObjectResponse, *http.Response, error)

CatalogApiService DeleteCatalogObject Deletes a single CatalogObject(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject) based on the provided ID and returns the set of successfully deleted IDs in the response. Deletion is a cascading event such that all children of the targeted object are also deleted. For example, deleting a CatalogItem(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItem) will also delete all of its CatalogItemVariation(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItemVariation) children. To ensure consistency, only one delete request is processed at a time per seller account. While one (batch or non-batch) delete request is being processed, other (batched and non-batched) delete requests are rejected with the `429` error code.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param objectId The ID of the catalog object to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a catalog item will delete its catalog item variations).

@return DeleteCatalogObjectResponse

func (*CatalogApiService) ListCatalog ¶

func (a *CatalogApiService) ListCatalog(ctx context.Context, localVarOptionals *CatalogApiListCatalogOpts) (ListCatalogResponse, *http.Response, error)

func (*CatalogApiService) RetrieveCatalogObject ¶

func (a *CatalogApiService) RetrieveCatalogObject(ctx context.Context, objectId string, localVarOptionals *CatalogApiRetrieveCatalogObjectOpts) (RetrieveCatalogObjectResponse, *http.Response, error)

func (*CatalogApiService) SearchCatalogItems ¶

func (a *CatalogApiService) SearchCatalogItems(ctx context.Context, body SearchCatalogItemsRequest) (SearchCatalogItemsResponse, *http.Response, error)

CatalogApiService SearchCatalogItems Searches for catalog items or item variations by matching supported search attribute values, including custom attribute values, against one or more of the specified query filters. This (`SearchCatalogItems`) endpoint differs from the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2024-07-17/catalog-api/search-catalog-objects) endpoint in the following aspects: - `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects. - `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not. - `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does. - The both endpoints use different call conventions, including the query filter formats.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return SearchCatalogItemsResponse

func (*CatalogApiService) SearchCatalogObjects ¶

func (a *CatalogApiService) SearchCatalogObjects(ctx context.Context, body SearchCatalogObjectsRequest) (SearchCatalogObjectsResponse, *http.Response, error)

CatalogApiService SearchCatalogObjects Searches for CatalogObject(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject) of any type by matching supported search attribute values, excluding custom attribute values on items or item variations, against one or more of the specified query filters. This (`SearchCatalogObjects`) endpoint differs from the [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-07-17/catalog-api/search-catalog-items) endpoint in the following aspects: - `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects. - `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not. - `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does. - The both endpoints have different call conventions, including the query filter formats.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return SearchCatalogObjectsResponse

func (*CatalogApiService) UpdateItemModifierLists ¶

func (a *CatalogApiService) UpdateItemModifierLists(ctx context.Context, body UpdateItemModifierListsRequest) (UpdateItemModifierListsResponse, *http.Response, error)

CatalogApiService UpdateItemModifierLists Updates the CatalogModifierList(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogModifierList) objects that apply to the targeted CatalogItem(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItem) without having to perform an upsert on the entire item.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return UpdateItemModifierListsResponse

func (*CatalogApiService) UpdateItemTaxes ¶

func (a *CatalogApiService) UpdateItemTaxes(ctx context.Context, body UpdateItemTaxesRequest) (UpdateItemTaxesResponse, *http.Response, error)

CatalogApiService UpdateItemTaxes Updates the CatalogTax(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogTax) objects that apply to the targeted CatalogItem(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItem) without having to perform an upsert on the entire item.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return UpdateItemTaxesResponse

func (*CatalogApiService) UpsertCatalogObject ¶

func (a *CatalogApiService) UpsertCatalogObject(ctx context.Context, body UpsertCatalogObjectRequest) (UpsertCatalogObjectResponse, *http.Response, error)

CatalogApiService UpsertCatalogObject Creates a new or updates the specified CatalogObject(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject). To ensure consistency, only one update request is processed at a time per seller account. While one (batch or non-batch) update request is being processed, other (batched and non-batched) update requests are rejected with the `429` error code.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return UpsertCatalogObjectResponse

type CatalogAvailabilityPeriod ¶

type CatalogAvailabilityPeriod struct {
	// The start time of an availability period, specified in local time using partial-time RFC 3339 format. For example, `8:30:00` for a period starting at 8:30 in the morning. Note that the seconds value is always :00, but it is appended for conformance to the RFC.
	StartLocalTime string `json:"start_local_time,omitempty"`
	// The end time of an availability period, specified in local time using partial-time RFC 3339 format. For example, `21:00:00` for a period ending at 9:00 in the evening. Note that the seconds value is always :00, but it is appended for conformance to the RFC.
	EndLocalTime string `json:"end_local_time,omitempty"`
	// The day of the week for this availability period.
	DayOfWeek string `json:"day_of_week,omitempty"`
}

Represents a time period of availability.

type CatalogCategory ¶

type CatalogCategory struct {
	// The category name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.
	Name string `json:"name,omitempty"`
	// The IDs of images associated with this `CatalogCategory` instance. Currently these images are not displayed by Square, but are free to be displayed in 3rd party applications.
	ImageIds []string `json:"image_ids,omitempty"`
	// The type of the category.
	CategoryType   string                 `json:"category_type,omitempty"`
	ParentCategory *CatalogObjectCategory `json:"parent_category,omitempty"`
	// Indicates whether a category is a top level category, which does not have any parent_category.
	IsTopLevel bool `json:"is_top_level,omitempty"`
	// A list of IDs representing channels, such as a Square Online site, where the category can be made visible.
	Channels []string `json:"channels,omitempty"`
	// The IDs of the `CatalogAvailabilityPeriod` objects associated with the category.
	AvailabilityPeriodIds []string `json:"availability_period_ids,omitempty"`
	// Indicates whether the category is visible (`true`) or hidden (`false`) on all of the seller's Square Online sites.
	OnlineVisibility bool `json:"online_visibility,omitempty"`
	// The top-level category in a category hierarchy.
	RootCategory string              `json:"root_category,omitempty"`
	EcomSeoData  *CatalogEcomSeoData `json:"ecom_seo_data,omitempty"`
	// The path from the category to its root category. The first node of the path is the parent of the category and the last is the root category. The path is empty if the category is a root category.
	PathToRoot []CategoryPathToRootNode `json:"path_to_root,omitempty"`
}

A category to which a `CatalogItem` instance belongs.

type CatalogCategoryType ¶

type CatalogCategoryType string

CatalogCategoryType : Indicates the type of a category.

const (
	REGULAR_CATEGORY_CatalogCategoryType CatalogCategoryType = "REGULAR_CATEGORY"
	MENU_CATEGORY_CatalogCategoryType    CatalogCategoryType = "MENU_CATEGORY"
	KITCHEN_CATEGORY_CatalogCategoryType CatalogCategoryType = "KITCHEN_CATEGORY"
)

List of CatalogCategoryType

type CatalogCustomAttributeDefinition ¶

type CatalogCustomAttributeDefinition struct {
	// The type of this custom attribute. Cannot be modified after creation. Required.
	Type_ string `json:"type"`
	//  The name of this definition for API and seller-facing UI purposes. The name must be unique within the (merchant, application) pair. Required. May not be empty and may not exceed 255 characters. Can be modified after creation.
	Name string `json:"name"`
	// Seller-oriented description of the meaning of this Custom Attribute, any constraints that the seller should observe, etc. May be displayed as a tooltip in Square UIs.
	Description       string             `json:"description,omitempty"`
	SourceApplication *SourceApplication `json:"source_application,omitempty"`
	// The set of `CatalogObject` types that this custom atttribute may be applied to. Currently, only `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, and `CATEGORY` are allowed. At least one type must be included.
	AllowedObjectTypes []string `json:"allowed_object_types"`
	// The visibility of a custom attribute in seller-facing UIs (including Square Point of Sale applications and Square Dashboard). May be modified.
	SellerVisibility string `json:"seller_visibility,omitempty"`
	// The visibility of a custom attribute to applications other than the application that created the attribute.
	AppVisibility   string                                           `json:"app_visibility,omitempty"`
	StringConfig    *CatalogCustomAttributeDefinitionStringConfig    `json:"string_config,omitempty"`
	NumberConfig    *CatalogCustomAttributeDefinitionNumberConfig    `json:"number_config,omitempty"`
	SelectionConfig *CatalogCustomAttributeDefinitionSelectionConfig `json:"selection_config,omitempty"`
	// The number of custom attributes that reference this custom attribute definition. Set by the server in response to a ListCatalog request with `include_counts` set to `true`.  If the actual count is greater than 100, `custom_attribute_usage_count` will be set to `100`.
	CustomAttributeUsageCount int32 `json:"custom_attribute_usage_count,omitempty"`
	// The name of the desired custom attribute key that can be used to access the custom attribute value on catalog objects. Cannot be modified after the custom attribute definition has been created. Must be between 1 and 60 characters, and may only contain the characters `[a-zA-Z0-9_-]`.
	Key string `json:"key,omitempty"`
}

Contains information defining a custom attribute. Custom attributes are intended to store additional information about a catalog object or to associate a catalog object with an entity in another system. Do not use custom attributes to store any sensitive information (personally identifiable information, card details, etc.). [Read more about custom attributes](https://developer.squareup.com/docs/catalog-api/add-custom-attributes)

type CatalogCustomAttributeDefinitionAppVisibility ¶

type CatalogCustomAttributeDefinitionAppVisibility string

CatalogCustomAttributeDefinitionAppVisibility : Defines the visibility of a custom attribute to applications other than their creating application.

const (
	HIDDEN_CatalogCustomAttributeDefinitionAppVisibility            CatalogCustomAttributeDefinitionAppVisibility = "APP_VISIBILITY_HIDDEN"
	READ_ONLY_CatalogCustomAttributeDefinitionAppVisibility         CatalogCustomAttributeDefinitionAppVisibility = "APP_VISIBILITY_READ_ONLY"
	READ_WRITE_VALUES_CatalogCustomAttributeDefinitionAppVisibility CatalogCustomAttributeDefinitionAppVisibility = "APP_VISIBILITY_READ_WRITE_VALUES"
)

List of CatalogCustomAttributeDefinitionAppVisibility

type CatalogCustomAttributeDefinitionNumberConfig ¶

type CatalogCustomAttributeDefinitionNumberConfig struct {
	// An integer between 0 and 5 that represents the maximum number of positions allowed after the decimal in number custom attribute values For example:  - if the precision is 0, the quantity can be 1, 2, 3, etc. - if the precision is 1, the quantity can be 0.1, 0.2, etc. - if the precision is 2, the quantity can be 0.01, 0.12, etc.  Default: 5
	Precision int32 `json:"precision,omitempty"`
}

type CatalogCustomAttributeDefinitionSelectionConfig ¶

type CatalogCustomAttributeDefinitionSelectionConfig struct {
	// The maximum number of selections that can be set. The maximum value for this attribute is 100. The default value is 1. The value can be modified, but changing the value will not affect existing custom attribute values on objects. Clients need to handle custom attributes with more selected values than allowed by this limit.
	MaxAllowedSelections int32 `json:"max_allowed_selections,omitempty"`
	// The set of valid `CatalogCustomAttributeSelections`. Up to a maximum of 100 selections can be defined. Can be modified.
	AllowedSelections []CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection `json:"allowed_selections,omitempty"`
}

Configuration associated with `SELECTION`-type custom attribute definitions.

type CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection ¶

type CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection struct {
	// Unique ID set by Square.
	Uid string `json:"uid,omitempty"`
	// Selection name, unique within `allowed_selections`.
	Name string `json:"name"`
}

A named selection for this `SELECTION`-type custom attribute definition.

type CatalogCustomAttributeDefinitionSellerVisibility ¶

type CatalogCustomAttributeDefinitionSellerVisibility string

CatalogCustomAttributeDefinitionSellerVisibility : Defines the visibility of a custom attribute to sellers in Square client applications, Square APIs or in Square UIs (including Square Point of Sale applications and Square Dashboard).

const (
	HIDDEN_CatalogCustomAttributeDefinitionSellerVisibility            CatalogCustomAttributeDefinitionSellerVisibility = "SELLER_VISIBILITY_HIDDEN"
	READ_WRITE_VALUES_CatalogCustomAttributeDefinitionSellerVisibility CatalogCustomAttributeDefinitionSellerVisibility = "SELLER_VISIBILITY_READ_WRITE_VALUES"
)

List of CatalogCustomAttributeDefinitionSellerVisibility

type CatalogCustomAttributeDefinitionStringConfig ¶

type CatalogCustomAttributeDefinitionStringConfig struct {
	// If true, each Custom Attribute instance associated with this Custom Attribute Definition must have a unique value within the seller's catalog. For example, this may be used for a value like a SKU that should not be duplicated within a seller's catalog. May not be modified after the definition has been created.
	EnforceUniqueness bool `json:"enforce_uniqueness,omitempty"`
}

Configuration associated with Custom Attribute Definitions of type `STRING`.

type CatalogCustomAttributeDefinitionType ¶

type CatalogCustomAttributeDefinitionType string

CatalogCustomAttributeDefinitionType : Defines the possible types for a custom attribute.

const (
	STRING__CatalogCustomAttributeDefinitionType   CatalogCustomAttributeDefinitionType = "STRING"
	BOOLEAN_CatalogCustomAttributeDefinitionType   CatalogCustomAttributeDefinitionType = "BOOLEAN"
	NUMBER_CatalogCustomAttributeDefinitionType    CatalogCustomAttributeDefinitionType = "NUMBER"
	SELECTION_CatalogCustomAttributeDefinitionType CatalogCustomAttributeDefinitionType = "SELECTION"
)

List of CatalogCustomAttributeDefinitionType

type CatalogCustomAttributeValue ¶

type CatalogCustomAttributeValue struct {
	// The name of the custom attribute.
	Name string `json:"name,omitempty"`
	// The string value of the custom attribute.  Populated if `type` = `STRING`.
	StringValue string `json:"string_value,omitempty"`
	// The id of the [CatalogCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogCustomAttributeDefinition) this value belongs to.
	CustomAttributeDefinitionId string `json:"custom_attribute_definition_id,omitempty"`
	// A copy of type from the associated `CatalogCustomAttributeDefinition`.
	Type_ string `json:"type,omitempty"`
	// Populated if `type` = `NUMBER`. Contains a string representation of a decimal number, using a `.` as the decimal separator.
	NumberValue string `json:"number_value,omitempty"`
	// A `true` or `false` value. Populated if `type` = `BOOLEAN`.
	BooleanValue bool `json:"boolean_value,omitempty"`
	// One or more choices from `allowed_selections`. Populated if `type` = `SELECTION`.
	SelectionUidValues []string `json:"selection_uid_values,omitempty"`
	// If the associated `CatalogCustomAttributeDefinition` object is defined by another application, this key is prefixed by the defining application ID. For example, if the CatalogCustomAttributeDefinition has a key attribute of \"cocoa_brand\" and the defining application ID is \"abcd1234\", this key is \"abcd1234:cocoa_brand\" when the application making the request is different from the application defining the custom attribute definition. Otherwise, the key is simply \"cocoa_brand\".
	Key string `json:"key,omitempty"`
}

An instance of a custom attribute. Custom attributes can be defined and added to `ITEM` and `ITEM_VARIATION` type catalog objects. [Read more about custom attributes](https://developer.squareup.com/docs/catalog-api/add-custom-attributes).

type CatalogDiscount ¶

type CatalogDiscount struct {
	// The discount name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.
	Name string `json:"name,omitempty"`
	// Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale.
	DiscountType string `json:"discount_type,omitempty"`
	// The percentage of the discount as a string representation of a decimal number, using a `.` as the decimal separator and without a `%` sign. A value of `7.5` corresponds to `7.5%`. Specify a percentage of `0` if `discount_type` is `VARIABLE_PERCENTAGE`.  Do not use this field for amount-based or variable discounts.
	Percentage  string `json:"percentage,omitempty"`
	AmountMoney *Money `json:"amount_money,omitempty"`
	// Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment in the Square Point of Sale app.
	PinRequired bool `json:"pin_required,omitempty"`
	// The color of the discount display label in the Square Point of Sale app. This must be a valid hex color code.
	LabelColor string `json:"label_color,omitempty"`
	// Indicates whether this discount should reduce the price used to calculate tax.  Most discounts should use `MODIFY_TAX_BASIS`. However, in some circumstances taxes must be calculated based on an item's price, ignoring a particular discount. For example, in many US jurisdictions, a manufacturer coupon or instant rebate reduces the price a customer pays but does not reduce the sale price used to calculate how much sales tax is due. In this case, the discount representing that manufacturer coupon should have `DO_NOT_MODIFY_TAX_BASIS` for this field.  If you are unsure whether you need to use this field, consult your tax professional.
	ModifyTaxBasis     string `json:"modify_tax_basis,omitempty"`
	MaximumAmountMoney *Money `json:"maximum_amount_money,omitempty"`
}

A discount applicable to items.

type CatalogDiscountModifyTaxBasis ¶

type CatalogDiscountModifyTaxBasis string

const (
	MODIFY_TAX_BASIS_CatalogDiscountModifyTaxBasis        CatalogDiscountModifyTaxBasis = "MODIFY_TAX_BASIS"
	DO_NOT_MODIFY_TAX_BASIS_CatalogDiscountModifyTaxBasis CatalogDiscountModifyTaxBasis = "DO_NOT_MODIFY_TAX_BASIS"
)

List of CatalogDiscountModifyTaxBasis

type CatalogDiscountType ¶

type CatalogDiscountType string

CatalogDiscountType : How to apply a CatalogDiscount to a CatalogItem.

const (
	FIXED_PERCENTAGE_CatalogDiscountType    CatalogDiscountType = "FIXED_PERCENTAGE"
	FIXED_AMOUNT_CatalogDiscountType        CatalogDiscountType = "FIXED_AMOUNT"
	VARIABLE_PERCENTAGE_CatalogDiscountType CatalogDiscountType = "VARIABLE_PERCENTAGE"
	VARIABLE_AMOUNT_CatalogDiscountType     CatalogDiscountType = "VARIABLE_AMOUNT"
)

List of CatalogDiscountType

type CatalogEcomSeoData ¶

type CatalogEcomSeoData struct {
	// The SEO title used for the Square Online store.
	PageTitle string `json:"page_title,omitempty"`
	// The SEO description used for the Square Online store.
	PageDescription string `json:"page_description,omitempty"`
	// The SEO permalink used for the Square Online store.
	Permalink string `json:"permalink,omitempty"`
}

SEO data for for a seller's Square Online store.

type CatalogIdMapping ¶

type CatalogIdMapping struct {
	// The client-supplied temporary `#`-prefixed ID for a new `CatalogObject`.
	ClientObjectId string `json:"client_object_id,omitempty"`
	// The permanent ID for the CatalogObject created by the server.
	ObjectId string `json:"object_id,omitempty"`
}

A mapping between a temporary client-supplied ID and a permanent server-generated ID. When calling [UpsertCatalogObject](https://developer.squareup.com/reference/square_2024-07-17/catalog-api/upsert-catalog-object) or [BatchUpsertCatalogObjects](https://developer.squareup.com/reference/square_2024-07-17/catalog-api/batch-upsert-catalog-objects) to create a CatalogObject(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject) instance, you can supply a temporary ID for the to-be-created object, especially when the object is to be referenced elsewhere in the same request body. This temporary ID can be any string unique within the call, but must be prefixed by \"#\". After the request is submitted and the object created, a permanent server-generated ID is assigned to the new object. The permanent ID is unique across the Square catalog.

type CatalogImage ¶

type CatalogImage struct {
	// The internal name to identify this image in calls to the Square API. This is a searchable attribute for use in applicable query filters using the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2024-07-17/catalog-api/search-catalog-objects). It is not unique and should not be shown in a buyer facing context.
	Name string `json:"name,omitempty"`
	// The URL of this image, generated by Square after an image is uploaded using the [CreateCatalogImage](https://developer.squareup.com/reference/square_2024-07-17/catalog-api/create-catalog-image) endpoint. To modify the image, use the UpdateCatalogImage endpoint. Do not change the URL field.
	Url string `json:"url,omitempty"`
	// A caption that describes what is shown in the image. Displayed in the Square Online Store. This is a searchable attribute for use in applicable query filters using the [SearchCatalogObjects](https://developer.squareup.com/reference/square_2024-07-17/catalog-api/search-catalog-objects).
	Caption string `json:"caption,omitempty"`
	// The immutable order ID for this image object created by the Photo Studio service in Square Online Store.
	PhotoStudioOrderId string `json:"photo_studio_order_id,omitempty"`
}

An image file to use in Square catalogs. It can be associated with `CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, and `CatalogModifierList` objects. Only the images on items and item variations are exposed in Dashboard. Only the first image on an item is displayed in Square Point of Sale (SPOS). Images on items and variations are displayed through Square Online Store. Images on other object types are for use by 3rd party application developers.

type CatalogInfoRequest ¶

type CatalogInfoRequest struct{}

type CatalogInfoResponse ¶

type CatalogInfoResponse struct {
	// Any errors that occurred during the request.
	Errors                       []ModelError                  `json:"errors,omitempty"`
	Limits                       *CatalogInfoResponseLimits    `json:"limits,omitempty"`
	StandardUnitDescriptionGroup *StandardUnitDescriptionGroup `json:"standard_unit_description_group,omitempty"`
}

type CatalogInfoResponseLimits ¶

type CatalogInfoResponseLimits struct {
	// The maximum number of objects that may appear within a single batch in a `/v2/catalog/batch-upsert` request.
	BatchUpsertMaxObjectsPerBatch int32 `json:"batch_upsert_max_objects_per_batch,omitempty"`
	// The maximum number of objects that may appear across all batches in a `/v2/catalog/batch-upsert` request.
	BatchUpsertMaxTotalObjects int32 `json:"batch_upsert_max_total_objects,omitempty"`
	// The maximum number of object IDs that may appear in a `/v2/catalog/batch-retrieve` request.
	BatchRetrieveMaxObjectIds int32 `json:"batch_retrieve_max_object_ids,omitempty"`
	// The maximum number of results that may be returned in a page of a `/v2/catalog/search` response.
	SearchMaxPageLimit int32 `json:"search_max_page_limit,omitempty"`
	// The maximum number of object IDs that may be included in a single `/v2/catalog/batch-delete` request.
	BatchDeleteMaxObjectIds int32 `json:"batch_delete_max_object_ids,omitempty"`
	// The maximum number of item IDs that may be included in a single `/v2/catalog/update-item-taxes` request.
	UpdateItemTaxesMaxItemIds int32 `json:"update_item_taxes_max_item_ids,omitempty"`
	// The maximum number of tax IDs to be enabled that may be included in a single `/v2/catalog/update-item-taxes` request.
	UpdateItemTaxesMaxTaxesToEnable int32 `json:"update_item_taxes_max_taxes_to_enable,omitempty"`
	// The maximum number of tax IDs to be disabled that may be included in a single `/v2/catalog/update-item-taxes` request.
	UpdateItemTaxesMaxTaxesToDisable int32 `json:"update_item_taxes_max_taxes_to_disable,omitempty"`
	// The maximum number of item IDs that may be included in a single `/v2/catalog/update-item-modifier-lists` request.
	UpdateItemModifierListsMaxItemIds int32 `json:"update_item_modifier_lists_max_item_ids,omitempty"`
	// The maximum number of modifier list IDs to be enabled that may be included in a single `/v2/catalog/update-item-modifier-lists` request.
	UpdateItemModifierListsMaxModifierListsToEnable int32 `json:"update_item_modifier_lists_max_modifier_lists_to_enable,omitempty"`
	// The maximum number of modifier list IDs to be disabled that may be included in a single `/v2/catalog/update-item-modifier-lists` request.
	UpdateItemModifierListsMaxModifierListsToDisable int32 `json:"update_item_modifier_lists_max_modifier_lists_to_disable,omitempty"`
}

type CatalogItem ¶

type CatalogItem struct {
	// The item's name. This is a searchable attribute for use in applicable query filters, its value must not be empty, and the length is of Unicode code points.
	Name string `json:"name,omitempty"`
	// The item's description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.  Deprecated at 2022-07-20, this field is planned to retire in 6 months. You should migrate to use `description_html` to set the description of the [CatalogItem](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItem) instance.  The `description` and `description_html` field values are kept in sync. If you try to set the both fields, the `description_html` text value overwrites the `description` value. Updates in one field are also reflected in the other, except for when you use an early version before Square API 2022-07-20 and `description_html` is set to blank, setting the `description` value to null does not nullify `description_html`.
	Description string `json:"description,omitempty"`
	// The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used. This attribute is searchable, and its value length is of Unicode code points.
	Abbreviation string `json:"abbreviation,omitempty"`
	// The color of the item's display label in the Square Point of Sale app. This must be a valid hex color code.
	LabelColor string `json:"label_color,omitempty"`
	// Indicates whether the item is taxable (`true`) or non-taxable (`false`). Default is `true`.
	IsTaxable bool `json:"is_taxable,omitempty"`
	// If `true`, the item can be added to shipping orders from the merchant's online store.
	AvailableOnline bool `json:"available_online,omitempty"`
	// If `true`, the item can be added to pickup orders from the merchant's online store.
	AvailableForPickup bool `json:"available_for_pickup,omitempty"`
	// If `true`, the item can be added to electronically fulfilled orders from the merchant's online store.
	AvailableElectronically bool `json:"available_electronically,omitempty"`
	// The ID of the item's category, if any. Deprecated since 2023-12-13. Use `CatalogItem.categories`, instead.
	CategoryId string `json:"category_id,omitempty"`
	// A set of IDs indicating the taxes enabled for this item. When updating an item, any taxes listed here will be added to the item. Taxes may also be added to or deleted from an item using `UpdateItemTaxes`.
	TaxIds []string `json:"tax_ids,omitempty"`
	// A set of `CatalogItemModifierListInfo` objects representing the modifier lists that apply to this item, along with the overrides and min and max limits that are specific to this item. Modifier lists may also be added to or deleted from an item using `UpdateItemModifierLists`.
	ModifierListInfo []CatalogItemModifierListInfo `json:"modifier_list_info,omitempty"`
	// A list of [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItemVariation) objects for this item. An item must have at least one variation.
	Variations []CatalogObject `json:"variations,omitempty"`
	// The product type of the item. Once set, the `product_type` value cannot be modified.  Items of the `LEGACY_SQUARE_ONLINE_SERVICE` and `LEGACY_SQUARE_ONLINE_MEMBERSHIP` product types can be updated but cannot be created using the API.
	ProductType string `json:"product_type,omitempty"`
	// If `false`, the Square Point of Sale app will present the `CatalogItem`'s details screen immediately, allowing the merchant to choose `CatalogModifier`s before adding the item to the cart.  This is the default behavior.  If `true`, the Square Point of Sale app will immediately add the item to the cart with the pre-selected modifiers, and merchants can edit modifiers by drilling down onto the item's details.  Third-party clients are encouraged to implement similar behaviors.
	SkipModifierScreen bool `json:"skip_modifier_screen,omitempty"`
	// List of item options IDs for this item. Used to manage and group item variations in a specified order.  Maximum: 6 item options.
	ItemOptions []CatalogItemOptionForItem `json:"item_options,omitempty"`
	// The IDs of images associated with this `CatalogItem` instance. These images will be shown to customers in Square Online Store. The first image will show up as the icon for this item in POS.
	ImageIds []string `json:"image_ids,omitempty"`
	// A name to sort the item by. If this name is unspecified, namely, the `sort_name` field is absent, the regular `name` field is used for sorting. Its value must not be empty.  It is currently supported for sellers of the Japanese locale only.
	SortName string `json:"sort_name,omitempty"`
	// The list of categories.
	Categories []CatalogObjectCategory `json:"categories,omitempty"`
	// The item's description as expressed in valid HTML elements. The length of this field value, including those of HTML tags, is of Unicode points. With application query filters, the text values of the HTML elements and attributes are searchable. Invalid or unsupported HTML elements or attributes are ignored.  Supported HTML elements include: - `a`: Link. Supports linking to website URLs, email address, and telephone numbers. - `b`, `strong`:  Bold text - `br`: Line break - `code`: Computer code - `div`: Section - `h1-h6`: Headings - `i`, `em`: Italics - `li`: List element - `ol`: Numbered list - `p`: Paragraph - `ul`: Bullet list - `u`: Underline   Supported HTML attributes include: - `align`: Alignment of the text content - `href`: Link destination - `rel`: Relationship between link's target and source - `target`: Place to open the linked document
	DescriptionHtml string `json:"description_html,omitempty"`
	// A server-generated plaintext version of the `description_html` field, without formatting tags.
	DescriptionPlaintext string `json:"description_plaintext,omitempty"`
	// A list of IDs representing channels, such as a Square Online site, where the item can be made visible or available.
	Channels []string `json:"channels,omitempty"`
	// Indicates whether this item is archived (`true`) or not (`false`).
	IsArchived             bool                   `json:"is_archived,omitempty"`
	EcomSeoData            *CatalogEcomSeoData    `json:"ecom_seo_data,omitempty"`
	FoodAndBeverageDetails json.RawMessage        `json:"food_and_beverage_details,omitempty"`
	ReportingCategory      *CatalogObjectCategory `json:"reporting_category,omitempty"`
}

A CatalogObject(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject) instance of the `ITEM` type, also referred to as an item, in the catalog.

type CatalogItemFoodAndBeverageDetails ¶

type CatalogItemFoodAndBeverageDetails struct {
	// The calorie count (in the unit of kcal) for the `FOOD_AND_BEV` type of items.
	CalorieCount int32 `json:"calorie_count,omitempty"`
	// The dietary preferences for the `FOOD_AND_BEV` item.
	DietaryPreferences []json.RawMessage `json:"dietary_preferences,omitempty"`
	// The ingredients for the `FOOD_AND_BEV` type item.
	Ingredients []json.RawMessage `json:"ingredients,omitempty"`
}

The food and beverage-specific details of a `FOOD_AND_BEV` item.

type CatalogItemFoodAndBeverageDetailsDietaryPreference ¶

type CatalogItemFoodAndBeverageDetailsDietaryPreference struct {
	Type_ json.RawMessage `json:"type,omitempty"`
	// The name of the dietary preference from a standard pre-defined list. This should be null if it's a custom dietary preference.
	StandardName string `json:"standard_name,omitempty"`
	// The name of a user-defined custom dietary preference. This should be null if it's a standard dietary preference.
	CustomName string `json:"custom_name,omitempty"`
}

Dietary preferences that can be assigned to an `FOOD_AND_BEV` item and its ingredients.

type CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference ¶

type CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference string

CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference : Standard dietary preferences for food and beverage items that are recommended on item creation.

const (
	DAIRY_FREE_CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference  CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference = "DAIRY_FREE"
	GLUTEN_FREE_CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference = "GLUTEN_FREE"
	HALAL_CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference       CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference = "HALAL"
	KOSHER_CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference      CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference = "KOSHER"
	NUT_FREE_CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference    CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference = "NUT_FREE"
	VEGAN_CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference       CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference = "VEGAN"
	VEGETARIAN_CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference  CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference = "VEGETARIAN"
)

List of CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference

type CatalogItemFoodAndBeverageDetailsDietaryPreferenceType ¶

type CatalogItemFoodAndBeverageDetailsDietaryPreferenceType string

CatalogItemFoodAndBeverageDetailsDietaryPreferenceType : The type of dietary preference for the `FOOD_AND_BEV` type of items and integredients.

const (
	STANDARD_CatalogItemFoodAndBeverageDetailsDietaryPreferenceType CatalogItemFoodAndBeverageDetailsDietaryPreferenceType = "STANDARD"
	CUSTOM_CatalogItemFoodAndBeverageDetailsDietaryPreferenceType   CatalogItemFoodAndBeverageDetailsDietaryPreferenceType = "CUSTOM"
)

List of CatalogItemFoodAndBeverageDetailsDietaryPreferenceType

type CatalogItemFoodAndBeverageDetailsIngredient ¶

type CatalogItemFoodAndBeverageDetailsIngredient struct {
	Type_ json.RawMessage `json:"type,omitempty"`
	// The name of the ingredient from a standard pre-defined list. This should be null if it's a custom dietary preference.
	StandardName string `json:"standard_name,omitempty"`
	// The name of a custom user-defined ingredient. This should be null if it's a standard dietary preference.
	CustomName string `json:"custom_name,omitempty"`
}

Describes the ingredient used in a `FOOD_AND_BEV` item.

type CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient ¶

type CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient string

CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient : Standard ingredients for food and beverage items that are recommended on item creation.

const (
	CELERY_CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient      CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient = "CELERY"
	CRUSTACEANS_CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient = "CRUSTACEANS"
	EGGS_CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient        CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient = "EGGS"
	FISH_CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient        CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient = "FISH"
	GLUTEN_CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient      CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient = "GLUTEN"
	LUPIN_CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient       CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient = "LUPIN"
	MILK_CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient        CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient = "MILK"
	MOLLUSCS_CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient    CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient = "MOLLUSCS"
	MUSTARD_CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient     CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient = "MUSTARD"
	PEANUTS_CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient     CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient = "PEANUTS"
	SESAME_CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient      CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient = "SESAME"
	SOY_CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient         CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient = "SOY"
	SULPHITES_CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient   CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient = "SULPHITES"
	TREE_NUTS_CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient   CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient = "TREE_NUTS"
)

List of CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient

type CatalogItemModifierListInfo ¶

type CatalogItemModifierListInfo struct {
	// The ID of the `CatalogModifierList` controlled by this `CatalogModifierListInfo`.
	ModifierListId string `json:"modifier_list_id"`
	// A set of `CatalogModifierOverride` objects that override whether a given `CatalogModifier` is enabled by default.
	ModifierOverrides []CatalogModifierOverride `json:"modifier_overrides,omitempty"`
	// If 0 or larger, the smallest number of `CatalogModifier`s that must be selected from this `CatalogModifierList`. The default value is `-1`.  When  `CatalogModifierList.selection_type` is `MULTIPLE`, `CatalogModifierListInfo.min_selected_modifiers=-1`  and `CatalogModifierListInfo.max_selected_modifier=-1` means that from zero to the maximum number of modifiers of the `CatalogModifierList` can be selected from the `CatalogModifierList`.   When the `CatalogModifierList.selection_type` is `SINGLE`, `CatalogModifierListInfo.min_selected_modifiers=-1` and `CatalogModifierListInfo.max_selected_modifier=-1` means that exactly one modifier must be present in  and can be selected from the `CatalogModifierList`
	MinSelectedModifiers int32 `json:"min_selected_modifiers,omitempty"`
	// If 0 or larger, the largest number of `CatalogModifier`s that can be selected from this `CatalogModifierList`. The default value is `-1`.  When  `CatalogModifierList.selection_type` is `MULTIPLE`, `CatalogModifierListInfo.min_selected_modifiers=-1`  and `CatalogModifierListInfo.max_selected_modifier=-1` means that from zero to the maximum number of modifiers of the `CatalogModifierList` can be selected from the `CatalogModifierList`.   When the `CatalogModifierList.selection_type` is `SINGLE`, `CatalogModifierListInfo.min_selected_modifiers=-1` and `CatalogModifierListInfo.max_selected_modifier=-1` means that exactly one modifier must be present in  and can be selected from the `CatalogModifierList`
	MaxSelectedModifiers int32 `json:"max_selected_modifiers,omitempty"`
	// If `true`, enable this `CatalogModifierList`. The default value is `true`.
	Enabled bool `json:"enabled,omitempty"`
	// The position of this `CatalogItemModifierListInfo` object within the `modifier_list_info` list applied  to a `CatalogItem` instance.
	Ordinal int32 `json:"ordinal,omitempty"`
}

References a text-based modifier or a list of non text-based modifiers applied to a `CatalogItem` instance and specifies supported behaviors of the application.

type CatalogItemOption ¶

type CatalogItemOption struct {
	// The item option's display name for the seller. Must be unique across all item options. This is a searchable attribute for use in applicable query filters.
	Name string `json:"name,omitempty"`
	// The item option's display name for the customer. This is a searchable attribute for use in applicable query filters.
	DisplayName string `json:"display_name,omitempty"`
	// The item option's human-readable description. Displayed in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer. This is a searchable attribute for use in applicable query filters.
	Description string `json:"description,omitempty"`
	// If true, display colors for entries in `values` when present.
	ShowColors bool `json:"show_colors,omitempty"`
	// A list of CatalogObjects containing the `CatalogItemOptionValue`s for this item.
	Values []CatalogObject `json:"values,omitempty"`
}

A group of variations for a `CatalogItem`.

type CatalogItemOptionForItem ¶

type CatalogItemOptionForItem struct {
	// The unique id of the item option, used to form the dimensions of the item option matrix in a specified order.
	ItemOptionId string `json:"item_option_id,omitempty"`
}

An option that can be assigned to an item. For example, a t-shirt item may offer a color option or a size option.

type CatalogItemOptionValue ¶

type CatalogItemOptionValue struct {
	// Unique ID of the associated item option.
	ItemOptionId string `json:"item_option_id,omitempty"`
	// Name of this item option value. This is a searchable attribute for use in applicable query filters.
	Name string `json:"name,omitempty"`
	// A human-readable description for the option value. This is a searchable attribute for use in applicable query filters.
	Description string `json:"description,omitempty"`
	// The HTML-supported hex color for the item option (e.g., \"#ff8d4e85\"). Only displayed if `show_colors` is enabled on the parent `ItemOption`. When left unset, `color` defaults to white (\"#ffffff\") when `show_colors` is enabled on the parent `ItemOption`.
	Color string `json:"color,omitempty"`
	// Determines where this option value appears in a list of option values.
	Ordinal int32 `json:"ordinal,omitempty"`
}

An enumerated value that can link a `CatalogItemVariation` to an item option as one of its item option values.

type CatalogItemOptionValueForItemVariation ¶

type CatalogItemOptionValueForItemVariation struct {
	// The unique id of an item option.
	ItemOptionId string `json:"item_option_id,omitempty"`
	// The unique id of the selected value for the item option.
	ItemOptionValueId string `json:"item_option_value_id,omitempty"`
}

A `CatalogItemOptionValue` links an item variation to an item option as an item option value. For example, a t-shirt item may offer a color option and a size option. An item option value would represent each variation of t-shirt: For example, \"Color:Red, Size:Small\" or \"Color:Blue, Size:Medium\".

type CatalogItemProductType ¶

type CatalogItemProductType string

CatalogItemProductType : The type of a CatalogItem. Connect V2 only allows the creation of `REGULAR` or `APPOINTMENTS_SERVICE` items.

const (
	REGULAR_CatalogItemProductType                         CatalogItemProductType = "REGULAR"
	GIFT_CARD_CatalogItemProductType                       CatalogItemProductType = "GIFT_CARD"
	APPOINTMENTS_SERVICE_CatalogItemProductType            CatalogItemProductType = "APPOINTMENTS_SERVICE"
	FOOD_AND_BEV_CatalogItemProductType                    CatalogItemProductType = "FOOD_AND_BEV"
	EVENT_CatalogItemProductType                           CatalogItemProductType = "EVENT"
	DIGITAL_CatalogItemProductType                         CatalogItemProductType = "DIGITAL"
	DONATION_CatalogItemProductType                        CatalogItemProductType = "DONATION"
	LEGACY_SQUARE_ONLINE_SERVICE_CatalogItemProductType    CatalogItemProductType = "LEGACY_SQUARE_ONLINE_SERVICE"
	LEGACY_SQUARE_ONLINE_MEMBERSHIP_CatalogItemProductType CatalogItemProductType = "LEGACY_SQUARE_ONLINE_MEMBERSHIP"
)

List of CatalogItemProductType

type CatalogItemVariation ¶

type CatalogItemVariation struct {
	// The ID of the `CatalogItem` associated with this item variation.
	ItemId string `json:"item_id,omitempty"`
	// The item variation's name. This is a searchable attribute for use in applicable query filters.  Its value has a maximum length of 255 Unicode code points. However, when the parent [item](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItem) uses [item options](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItemOption), this attribute is auto-generated, read-only, and can be longer than 255 Unicode code points.
	Name string `json:"name,omitempty"`
	// The item variation's SKU, if any. This is a searchable attribute for use in applicable query filters.
	Sku string `json:"sku,omitempty"`
	// The universal product code (UPC) of the item variation, if any. This is a searchable attribute for use in applicable query filters.  The value of this attribute should be a number of 12-14 digits long.  This restriction is enforced on the Square Seller Dashboard, Square Point of Sale or Retail Point of Sale apps, where this attribute shows in the GTIN field. If a non-compliant UPC value is assigned to this attribute using the API, the value is not editable on the Seller Dashboard, Square Point of Sale or Retail Point of Sale apps unless it is updated to fit the expected format.
	Upc string `json:"upc,omitempty"`
	// The order in which this item variation should be displayed. This value is read-only. On writes, the ordinal for each item variation within a parent `CatalogItem` is set according to the item variations's position. On reads, the value is not guaranteed to be sequential or unique.
	Ordinal int32 `json:"ordinal,omitempty"`
	// Indicates whether the item variation's price is fixed or determined at the time of sale.
	PricingType string `json:"pricing_type,omitempty"`
	PriceMoney  *Money `json:"price_money,omitempty"`
	// Per-location price and inventory overrides.
	LocationOverrides []ItemVariationLocationOverrides `json:"location_overrides,omitempty"`
	// If `true`, inventory tracking is active for the variation.
	TrackInventory bool `json:"track_inventory,omitempty"`
	// Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`.
	InventoryAlertType string `json:"inventory_alert_type,omitempty"`
	// If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard.  This value is always an integer.
	InventoryAlertThreshold int64 `json:"inventory_alert_threshold,omitempty"`
	// Arbitrary user metadata to associate with the item variation. This attribute value length is of Unicode code points.
	UserData string `json:"user_data,omitempty"`
	// If the `CatalogItem` that owns this item variation is of type `APPOINTMENTS_SERVICE`, then this is the duration of the service in milliseconds. For example, a 30 minute appointment would have the value `1800000`, which is equal to 30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per second).
	ServiceDuration int64 `json:"service_duration,omitempty"`
	// If the `CatalogItem` that owns this item variation is of type `APPOINTMENTS_SERVICE`, a bool representing whether this service is available for booking.
	AvailableForBooking bool `json:"available_for_booking,omitempty"`
	// List of item option values associated with this item variation. Listed in the same order as the item options of the parent item.
	ItemOptionValues []CatalogItemOptionValueForItemVariation `json:"item_option_values,omitempty"`
	// ID of the ‘CatalogMeasurementUnit’ that is used to measure the quantity sold of this item variation. If left unset, the item will be sold in whole quantities.
	MeasurementUnitId string `json:"measurement_unit_id,omitempty"`
	// Whether this variation can be sold. The inventory count of a sellable variation indicates the number of units available for sale. When a variation is both stockable and sellable, its sellable inventory count can be smaller than or equal to its stockable count.
	Sellable bool `json:"sellable,omitempty"`
	// Whether stock is counted directly on this variation (TRUE) or only on its components (FALSE). When a variation is both stockable and sellable, the inventory count of a stockable variation keeps track of the number of units of this variation in stock and is not an indicator of the number of units of the variation that can be sold.
	Stockable bool `json:"stockable,omitempty"`
	// The IDs of images associated with this `CatalogItemVariation` instance. These images will be shown to customers in Square Online Store.
	ImageIds []string `json:"image_ids,omitempty"`
	// Tokens of employees that can perform the service represented by this variation. Only valid for variations of type `APPOINTMENTS_SERVICE`.
	TeamMemberIds       []string                `json:"team_member_ids,omitempty"`
	StockableConversion *CatalogStockConversion `json:"stockable_conversion,omitempty"`
}

An item variation, representing a product for sale, in the Catalog object model. Each [item](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItem) must have at least one item variation and can have at most 250 item variations. An item variation can be sellable, stockable, or both if it has a unit of measure for its count for the sold number of the variation, the stocked number of the variation, or both. For example, when a variation representing wine is stocked and sold by the bottle, the variation is both stockable and sellable. But when a variation of the wine is sold by the glass, the sold units cannot be used as a measure of the stocked units. This by-the-glass variation is sellable, but not stockable. To accurately keep track of the wine's inventory count at any time, the sellable count must be converted to stockable count. Typically, the seller defines this unit conversion. For example, 1 bottle equals 5 glasses. The Square API exposes the `stockable_conversion` property on the variation to specify the conversion. Thus, when two glasses of the wine are sold, the sellable count decreases by 2, and the stockable count automatically decreases by 0.4 bottle according to the conversion.

type CatalogMeasurementUnit ¶

type CatalogMeasurementUnit struct {
	MeasurementUnit *MeasurementUnit `json:"measurement_unit,omitempty"`
	// An integer between 0 and 5 that represents the maximum number of positions allowed after the decimal in quantities measured with this unit. For example:  - if the precision is 0, the quantity can be 1, 2, 3, etc. - if the precision is 1, the quantity can be 0.1, 0.2, etc. - if the precision is 2, the quantity can be 0.01, 0.12, etc.  Default: 3
	Precision int32 `json:"precision,omitempty"`
}

Represents the unit used to measure a `CatalogItemVariation` and specifies the precision for decimal quantities.

type CatalogModifier ¶

type CatalogModifier struct {
	// The modifier name.  This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.
	Name       string `json:"name,omitempty"`
	PriceMoney *Money `json:"price_money,omitempty"`
	// Determines where this `CatalogModifier` appears in the `CatalogModifierList`.
	Ordinal int32 `json:"ordinal,omitempty"`
	// The ID of the `CatalogModifierList` associated with this modifier.
	ModifierListId string `json:"modifier_list_id,omitempty"`
	// Location-specific price overrides.
	LocationOverrides []ModifierLocationOverrides `json:"location_overrides,omitempty"`
	// The ID of the image associated with this `CatalogModifier` instance. Currently this image is not displayed by Square, but is free to be displayed in 3rd party applications.
	ImageId string `json:"image_id,omitempty"`
}

A modifier applicable to items at the time of sale. An example of a modifier is a Cheese add-on to a Burger item.

type CatalogModifierList ¶

type CatalogModifierList struct {
	// The name of the `CatalogModifierList` instance. This is a searchable attribute for use in applicable query filters, and its value length is of  Unicode code points.
	Name string `json:"name,omitempty"`
	// The position of this `CatalogModifierList` within a list of `CatalogModifierList` instances.
	Ordinal int32 `json:"ordinal,omitempty"`
	// Indicates whether a single (`SINGLE`) or multiple (`MULTIPLE`) modifiers from the list can be applied to a single `CatalogItem`.  For text-based modifiers, the `selection_type` attribute is always `SINGLE`. The other value is ignored.
	SelectionType string `json:"selection_type,omitempty"`
	// A non-empty list of `CatalogModifier` objects to be included in the `CatalogModifierList`,  for non text-based modifiers when the `modifier_type` attribute is `LIST`. Each element of this list  is a `CatalogObject` instance of the `MODIFIER` type, containing the following attributes: “` { \"id\": \"{{catalog_modifier_id}}\", \"type\": \"MODIFIER\",  \"modifier_data\": {{a CatalogModifier instance>}}  } “`
	Modifiers []CatalogObject `json:"modifiers,omitempty"`
	// The IDs of images associated with this `CatalogModifierList` instance. Currently these images are not displayed on Square products, but may be displayed in 3rd-party applications.
	ImageIds []string `json:"image_ids,omitempty"`
	// The type of the modifier.   When this `modifier_type` value is `TEXT`,  the `CatalogModifierList` represents a text-based modifier.  When this `modifier_type` value is `LIST`, the `CatalogModifierList` contains a list of `CatalogModifier` objects.
	ModifierType string `json:"modifier_type,omitempty"`
	// The maximum length, in Unicode points, of the text string of the text-based modifier as represented by  this `CatalogModifierList` object with the `modifier_type` set to `TEXT`.
	MaxLength int32 `json:"max_length,omitempty"`
	// Whether the text string must be a non-empty string (`true`) or not (`false`) for a text-based modifier as represented by this `CatalogModifierList` object with the `modifier_type` set to `TEXT`.
	TextRequired bool `json:"text_required,omitempty"`
	// A note for internal use by the business.     For example, for a text-based modifier applied to a T-shirt item, if the buyer-supplied text of \"Hello, Kitty!\"   is to be printed on the T-shirt, this `internal_name` attribute can be \"Use italic face\" as  an instruction for the business to follow.    For non text-based modifiers, this `internal_name` attribute can be  used to include SKUs, internal codes, or supplemental descriptions for internal use.
	InternalName string `json:"internal_name,omitempty"`
}

For a text-based modifier, this encapsulates the modifier's text when its `modifier_type` is `TEXT`. For example, to sell T-shirts with custom prints, a text-based modifier can be used to capture the buyer-supplied text string to be selected for the T-shirt at the time of sale. For non text-based modifiers, this encapsulates a non-empty list of modifiers applicable to items at the time of sale. Each element of the modifier list is a `CatalogObject` instance of the `MODIFIER` type. For example, a \"Condiments\" modifier list applicable to a \"Hot Dog\" item may contain \"Ketchup\", \"Mustard\", and \"Relish\" modifiers. A non text-based modifier can be applied to the modified item once or multiple times, if the `selection_type` field is set to `SINGLE` or `MULTIPLE`, respectively. On the other hand, a text-based modifier can be applied to the item only once and the `selection_type` field is always set to `SINGLE`.

type CatalogModifierListModifierType ¶

type CatalogModifierListModifierType string

CatalogModifierListModifierType : Defines the type of `CatalogModifierList`.

const (
	LIST_CatalogModifierListModifierType CatalogModifierListModifierType = "LIST"
	TEXT_CatalogModifierListModifierType CatalogModifierListModifierType = "TEXT"
)

List of CatalogModifierListModifierType

type CatalogModifierListSelectionType ¶

type CatalogModifierListSelectionType string

CatalogModifierListSelectionType : Indicates whether a CatalogModifierList supports multiple selections.

const (
	SINGLE_CatalogModifierListSelectionType   CatalogModifierListSelectionType = "SINGLE"
	MULTIPLE_CatalogModifierListSelectionType CatalogModifierListSelectionType = "MULTIPLE"
)

List of CatalogModifierListSelectionType

type CatalogModifierOverride ¶

type CatalogModifierOverride struct {
	// The ID of the `CatalogModifier` whose default behavior is being overridden.
	ModifierId string `json:"modifier_id"`
	// If `true`, this `CatalogModifier` should be selected by default for this `CatalogItem`.
	OnByDefault bool `json:"on_by_default,omitempty"`
}

Options to control how to override the default behavior of the specified modifier.

type CatalogObject ¶

type CatalogObject struct {
	// The type of this object. Each object type has expected properties expressed in a structured format within its corresponding `*_data` field below.
	Type_ string `json:"type"`
	// An identifier to reference this object in the catalog. When a new `CatalogObject` is inserted, the client should set the id to a temporary identifier starting with a \"`#`\" character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object.  When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references.
	Id string `json:"id"`
	// Last modification [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds.
	UpdatedAt string `json:"updated_at,omitempty"`
	// The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting.
	Version int64 `json:"version,omitempty"`
	// If `true`, the object has been deleted from the database. Must be `false` for new objects being inserted. When deleted, the `updated_at` field will equal the deletion time.
	IsDeleted bool `json:"is_deleted,omitempty"`
	// A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair is a [CatalogCustomAttributeValue](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogCustomAttributeValue) object. The key is the `key` attribute value defined in the associated [CatalogCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogCustomAttributeDefinition) object defined by the application making the request.  If the `CatalogCustomAttributeDefinition` object is defined by another application, the `CatalogCustomAttributeDefinition`'s key attribute value is prefixed by the defining application ID. For example, if the `CatalogCustomAttributeDefinition` has a `key` attribute of `\"cocoa_brand\"` and the defining application ID is `\"abcd1234\"`, the key in the map is `\"abcd1234:cocoa_brand\"` if the application making the request is different from the application defining the custom attribute definition. Otherwise, the key used in the map is simply `\"cocoa_brand\"`.  Application-defined custom attributes are set at a global (location-independent) level. Custom attribute values are intended to store additional information about a catalog object or associations with an entity in another system. Do not use custom attributes to store any sensitive information (personally identifiable information, card details, etc.).
	CustomAttributeValues map[string]CatalogCustomAttributeValue `json:"custom_attribute_values,omitempty"`
	// The Connect v1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs.
	CatalogV1Ids []CatalogV1Id `json:"catalog_v1_ids,omitempty"`
	// If `true`, this object is present at all locations (including future locations), except where specified in the `absent_at_location_ids` field. If `false`, this object is not present at any locations (including future locations), except where specified in the `present_at_location_ids` field. If not specified, defaults to `true`.
	PresentAtAllLocations bool `json:"present_at_all_locations,omitempty"`
	// A list of locations where the object is present, even if `present_at_all_locations` is `false`. This can include locations that are deactivated.
	PresentAtLocationIds []string `json:"present_at_location_ids,omitempty"`
	// A list of locations where the object is not present, even if `present_at_all_locations` is `true`. This can include locations that are deactivated.
	AbsentAtLocationIds           []string                          `json:"absent_at_location_ids,omitempty"`
	ItemData                      *CatalogItem                      `json:"item_data,omitempty"`
	CategoryData                  *CatalogCategory                  `json:"category_data,omitempty"`
	ItemVariationData             *CatalogItemVariation             `json:"item_variation_data,omitempty"`
	TaxData                       *CatalogTax                       `json:"tax_data,omitempty"`
	DiscountData                  *CatalogDiscount                  `json:"discount_data,omitempty"`
	ModifierListData              *CatalogModifierList              `json:"modifier_list_data,omitempty"`
	ModifierData                  *CatalogModifier                  `json:"modifier_data,omitempty"`
	TimePeriodData                *CatalogTimePeriod                `json:"time_period_data,omitempty"`
	ProductSetData                *CatalogProductSet                `json:"product_set_data,omitempty"`
	PricingRuleData               *CatalogPricingRule               `json:"pricing_rule_data,omitempty"`
	ImageData                     *CatalogImage                     `json:"image_data,omitempty"`
	MeasurementUnitData           *CatalogMeasurementUnit           `json:"measurement_unit_data,omitempty"`
	SubscriptionPlanData          *CatalogSubscriptionPlan          `json:"subscription_plan_data,omitempty"`
	ItemOptionData                *CatalogItemOption                `json:"item_option_data,omitempty"`
	ItemOptionValueData           *CatalogItemOptionValue           `json:"item_option_value_data,omitempty"`
	CustomAttributeDefinitionData *CatalogCustomAttributeDefinition `json:"custom_attribute_definition_data,omitempty"`
	QuickAmountsSettingsData      *CatalogQuickAmountsSettings      `json:"quick_amounts_settings_data,omitempty"`
	SubscriptionPlanVariationData *CatalogSubscriptionPlanVariation `json:"subscription_plan_variation_data,omitempty"`
	AvailabilityPeriodData        *CatalogAvailabilityPeriod        `json:"availability_period_data,omitempty"`
}

The wrapper object for the catalog entries of a given object type. Depending on the `type` attribute value, a `CatalogObject` instance assumes a type-specific data to yield the corresponding type of catalog object. For example, if `type=ITEM`, the `CatalogObject` instance must have the ITEM-specific data set on the `item_data` attribute. The resulting `CatalogObject` instance is also a `CatalogItem` instance. In general, if `type=<OBJECT_TYPE>`, the `CatalogObject` instance must have the `<OBJECT_TYPE>`-specific data set on the `<object_type>_data` attribute. The resulting `CatalogObject` instance is also a `Catalog<ObjectType>` instance. For a more detailed discussion of the Catalog data model, please see the [Design a Catalog](https://developer.squareup.com/docs/catalog-api/design-a-catalog) guide.

type CatalogObjectBatch ¶

type CatalogObjectBatch struct {
	// A list of CatalogObjects belonging to this batch.
	Objects []CatalogObject `json:"objects"`
}

A batch of catalog objects.

type CatalogObjectCategory ¶

type CatalogObjectCategory struct {
	// The ID of the object's category.
	Id string `json:"id,omitempty"`
	// The order of the object within the context of the category.
	Ordinal int64 `json:"ordinal,omitempty"`
}

A category that can be assigned to an item or a parent category that can be assigned to another category. For example, a clothing category can be assigned to a t-shirt item or be made as the parent category to the pants category.

type CatalogObjectReference ¶

type CatalogObjectReference struct {
	// The ID of the referenced object.
	ObjectId string `json:"object_id,omitempty"`
	// The version of the object.
	CatalogVersion int64 `json:"catalog_version,omitempty"`
}

A reference to a Catalog object at a specific version. In general this is used as an entry point into a graph of catalog objects, where the objects exist at a specific version.

type CatalogObjectType ¶

type CatalogObjectType string

CatalogObjectType : Possible types of CatalogObjects returned from the catalog, each containing type-specific properties in the `*_data` field corresponding to the specified object type.

const (
	ITEM_CatalogObjectType                        CatalogObjectType = "ITEM"
	IMAGE_CatalogObjectType                       CatalogObjectType = "IMAGE"
	CATEGORY_CatalogObjectType                    CatalogObjectType = "CATEGORY"
	ITEM_VARIATION_CatalogObjectType              CatalogObjectType = "ITEM_VARIATION"
	TAX_CatalogObjectType                         CatalogObjectType = "TAX"
	DISCOUNT_CatalogObjectType                    CatalogObjectType = "DISCOUNT"
	MODIFIER_LIST_CatalogObjectType               CatalogObjectType = "MODIFIER_LIST"
	MODIFIER_CatalogObjectType                    CatalogObjectType = "MODIFIER"
	PRICING_RULE_CatalogObjectType                CatalogObjectType = "PRICING_RULE"
	PRODUCT_SET_CatalogObjectType                 CatalogObjectType = "PRODUCT_SET"
	TIME_PERIOD_CatalogObjectType                 CatalogObjectType = "TIME_PERIOD"
	MEASUREMENT_UNIT_CatalogObjectType            CatalogObjectType = "MEASUREMENT_UNIT"
	SUBSCRIPTION_PLAN_VARIATION_CatalogObjectType CatalogObjectType = "SUBSCRIPTION_PLAN_VARIATION"
	ITEM_OPTION_CatalogObjectType                 CatalogObjectType = "ITEM_OPTION"
	ITEM_OPTION_VAL_CatalogObjectType             CatalogObjectType = "ITEM_OPTION_VAL"
	CUSTOM_ATTRIBUTE_DEFINITION_CatalogObjectType CatalogObjectType = "CUSTOM_ATTRIBUTE_DEFINITION"
	QUICK_AMOUNTS_SETTINGS_CatalogObjectType      CatalogObjectType = "QUICK_AMOUNTS_SETTINGS"
	SUBSCRIPTION_PLAN_CatalogObjectType           CatalogObjectType = "SUBSCRIPTION_PLAN"
	AVAILABILITY_PERIOD_CatalogObjectType         CatalogObjectType = "AVAILABILITY_PERIOD"
)

List of CatalogObjectType

type CatalogPricingRule ¶

type CatalogPricingRule struct {
	// User-defined name for the pricing rule. For example, \"Buy one get one free\" or \"10% off\".
	Name string `json:"name,omitempty"`
	// A list of unique IDs for the catalog time periods when this pricing rule is in effect. If left unset, the pricing rule is always in effect.
	TimePeriodIds []string `json:"time_period_ids,omitempty"`
	// Unique ID for the `CatalogDiscount` to take off the price of all matched items.
	DiscountId string `json:"discount_id,omitempty"`
	// Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule matches within the entire cart, and can match multiple times. This field will always be set.
	MatchProductsId string `json:"match_products_id,omitempty"`
	// __Deprecated__: Please use the `exclude_products_id` field to apply an exclude set instead. Exclude sets allow better control over quantity ranges and offer more flexibility for which matched items receive a discount.  `CatalogProductSet` to apply the pricing to. An apply rule matches within the subset of the cart that fits the match rules (the match set). An apply rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules.
	ApplyProductsId string `json:"apply_products_id,omitempty"`
	// `CatalogProductSet` to exclude from the pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules.
	ExcludeProductsId string `json:"exclude_products_id,omitempty"`
	// Represents the date the Pricing Rule is valid from. Represented in RFC 3339 full-date format (YYYY-MM-DD).
	ValidFromDate string `json:"valid_from_date,omitempty"`
	// Represents the local time the pricing rule should be valid from. Represented in RFC 3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.
	ValidFromLocalTime string `json:"valid_from_local_time,omitempty"`
	// Represents the date the Pricing Rule is valid until. Represented in RFC 3339 full-date format (YYYY-MM-DD).
	ValidUntilDate string `json:"valid_until_date,omitempty"`
	// Represents the local time the pricing rule should be valid until. Represented in RFC 3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.
	ValidUntilLocalTime string `json:"valid_until_local_time,omitempty"`
	// If an `exclude_products_id` was given, controls which subset of matched products is excluded from any discounts.  Default value: `LEAST_EXPENSIVE`
	ExcludeStrategy           string `json:"exclude_strategy,omitempty"`
	MinimumOrderSubtotalMoney *Money `json:"minimum_order_subtotal_money,omitempty"`
	// A list of IDs of customer groups, the members of which are eligible for discounts specified in this pricing rule. Notice that a group ID is generated by the Customers API. If this field is not set, the specified discount applies to matched products sold to anyone whether the buyer has a customer profile created or not. If this `customer_group_ids_any` field is set, the specified discount applies only to matched products sold to customers belonging to the specified customer groups.
	CustomerGroupIdsAny []string `json:"customer_group_ids_any,omitempty"`
}

Defines how discounts are automatically applied to a set of items that match the pricing rule during the active time period.

type CatalogPricingType ¶

type CatalogPricingType string

CatalogPricingType : Indicates whether the price of a CatalogItemVariation should be entered manually at the time of sale.

const (
	FIXED_PRICING_CatalogPricingType    CatalogPricingType = "FIXED_PRICING"
	VARIABLE_PRICING_CatalogPricingType CatalogPricingType = "VARIABLE_PRICING"
)

List of CatalogPricingType

type CatalogProductSet ¶

type CatalogProductSet struct {
	// User-defined name for the product set. For example, \"Clearance Items\" or \"Winter Sale Items\".
	Name string `json:"name,omitempty"`
	//  Unique IDs for any `CatalogObject` included in this product set. Any number of these catalog objects can be in an order for a pricing rule to apply.  This can be used with `product_ids_all` in a parent `CatalogProductSet` to match groups of products for a bulk discount, such as a discount for an entree and side combo.  Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set.  Max: 500 catalog object IDs.
	ProductIdsAny []string `json:"product_ids_any,omitempty"`
	// Unique IDs for any `CatalogObject` included in this product set. All objects in this set must be included in an order for a pricing rule to apply.  Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set.  Max: 500 catalog object IDs.
	ProductIdsAll []string `json:"product_ids_all,omitempty"`
	// If set, there must be exactly this many items from `products_any` or `products_all` in the cart for the discount to apply.  Cannot be combined with either `quantity_min` or `quantity_max`.
	QuantityExact int64 `json:"quantity_exact,omitempty"`
	// If set, there must be at least this many items from `products_any` or `products_all` in a cart for the discount to apply. See `quantity_exact`. Defaults to 0 if `quantity_exact`, `quantity_min` and `quantity_max` are all unspecified.
	QuantityMin int64 `json:"quantity_min,omitempty"`
	// If set, the pricing rule will apply to a maximum of this many items from `products_any` or `products_all`.
	QuantityMax int64 `json:"quantity_max,omitempty"`
	// If set to `true`, the product set will include every item in the catalog. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set.
	AllProducts bool `json:"all_products,omitempty"`
}

Represents a collection of catalog objects for the purpose of applying a `PricingRule`. Including a catalog object will include all of its subtypes. For example, including a category in a product set will include all of its items and associated item variations in the product set. Including an item in a product set will also include its item variations.

type CatalogQuery ¶

type CatalogQuery struct {
	SortedAttributeQuery                   *CatalogQuerySortedAttribute                   `json:"sorted_attribute_query,omitempty"`
	ExactQuery                             *CatalogQueryExact                             `json:"exact_query,omitempty"`
	SetQuery                               *CatalogQuerySet                               `json:"set_query,omitempty"`
	PrefixQuery                            *CatalogQueryPrefix                            `json:"prefix_query,omitempty"`
	RangeQuery                             *CatalogQueryRange                             `json:"range_query,omitempty"`
	TextQuery                              *CatalogQueryText                              `json:"text_query,omitempty"`
	ItemsForTaxQuery                       *CatalogQueryItemsForTax                       `json:"items_for_tax_query,omitempty"`
	ItemsForModifierListQuery              *CatalogQueryItemsForModifierList              `json:"items_for_modifier_list_query,omitempty"`
	ItemsForItemOptionsQuery               *CatalogQueryItemsForItemOptions               `json:"items_for_item_options_query,omitempty"`
	ItemVariationsForItemOptionValuesQuery *CatalogQueryItemVariationsForItemOptionValues `json:"item_variations_for_item_option_values_query,omitempty"`
}

A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the `SearchCatalogObjects` endpoint. Although a query can have multiple filters, only certain query types can be combined per call to [SearchCatalogObjects](https://developer.squareup.com/reference/square_2024-07-17/catalog-api/search-catalog-objects). Any combination of the following types may be used together: - [exact_query](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogQueryExact) - [prefix_query](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogQueryPrefix) - [range_query](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogQueryRange) - [sorted_attribute_query](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogQuerySortedAttribute) - [text_query](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogQueryText) All other query types cannot be combined with any others. When a query filter is based on an attribute, the attribute must be searchable. Searchable attributes are listed as follows, along their parent types that can be searched for with applicable query filters. Searchable attribute and objects queryable by searchable attributes: - `name`: `CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, `CatalogTax`, `CatalogDiscount`, `CatalogModifier`, `CatalogModifierList`, `CatalogItemOption`, `CatalogItemOptionValue` - `description`: `CatalogItem`, `CatalogItemOptionValue` - `abbreviation`: `CatalogItem` - `upc`: `CatalogItemVariation` - `sku`: `CatalogItemVariation` - `caption`: `CatalogImage` - `display_name`: `CatalogItemOption` For example, to search for CatalogItem(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItem) objects by searchable attributes, you can use the `\"name\"`, `\"description\"`, or `\"abbreviation\"` attribute in an applicable query filter.

type CatalogQueryExact ¶

type CatalogQueryExact struct {
	// The name of the attribute to be searched. Matching of the attribute name is exact.
	AttributeName string `json:"attribute_name"`
	// The desired value of the search attribute. Matching of the attribute value is case insensitive and can be partial. For example, if a specified value of \"sma\", objects with the named attribute value of \"Small\", \"small\" are both matched.
	AttributeValue string `json:"attribute_value"`
}

The query filter to return the search result by exact match of the specified attribute name and value.

type CatalogQueryItemVariationsForItemOptionValues ¶

type CatalogQueryItemVariationsForItemOptionValues struct {
	// A set of `CatalogItemOptionValue` IDs to be used to find associated `CatalogItemVariation`s. All ItemVariations that contain all of the given Item Option Values (in any order) will be returned.
	ItemOptionValueIds []string `json:"item_option_value_ids,omitempty"`
}

The query filter to return the item variations containing the specified item option value IDs.

type CatalogQueryItemsForItemOptions ¶

type CatalogQueryItemsForItemOptions struct {
	// A set of `CatalogItemOption` IDs to be used to find associated `CatalogItem`s. All Items that contain all of the given Item Options (in any order) will be returned.
	ItemOptionIds []string `json:"item_option_ids,omitempty"`
}

The query filter to return the items containing the specified item option IDs.

type CatalogQueryItemsForModifierList ¶

type CatalogQueryItemsForModifierList struct {
	// A set of `CatalogModifierList` IDs to be used to find associated `CatalogItem`s.
	ModifierListIds []string `json:"modifier_list_ids"`
}

The query filter to return the items containing the specified modifier list IDs.

type CatalogQueryItemsForTax ¶

type CatalogQueryItemsForTax struct {
	// A set of `CatalogTax` IDs to be used to find associated `CatalogItem`s.
	TaxIds []string `json:"tax_ids"`
}

The query filter to return the items containing the specified tax IDs.

type CatalogQueryPrefix ¶

type CatalogQueryPrefix struct {
	// The name of the attribute to be searched.
	AttributeName string `json:"attribute_name"`
	// The desired prefix of the search attribute value.
	AttributePrefix string `json:"attribute_prefix"`
}

The query filter to return the search result whose named attribute values are prefixed by the specified attribute value.

type CatalogQueryRange ¶

type CatalogQueryRange struct {
	// The name of the attribute to be searched.
	AttributeName string `json:"attribute_name"`
	// The desired minimum value for the search attribute (inclusive).
	AttributeMinValue int64 `json:"attribute_min_value,omitempty"`
	// The desired maximum value for the search attribute (inclusive).
	AttributeMaxValue int64 `json:"attribute_max_value,omitempty"`
}

The query filter to return the search result whose named attribute values fall between the specified range.

type CatalogQuerySet ¶

type CatalogQuerySet struct {
	// The name of the attribute to be searched. Matching of the attribute name is exact.
	AttributeName string `json:"attribute_name"`
	// The desired values of the search attribute. Matching of the attribute values is exact and case insensitive. A maximum of 250 values may be searched in a request.
	AttributeValues []string `json:"attribute_values"`
}

The query filter to return the search result(s) by exact match of the specified `attribute_name` and any of the `attribute_values`.

type CatalogQuerySortedAttribute ¶

type CatalogQuerySortedAttribute struct {
	// The attribute whose value is used as the sort key.
	AttributeName string `json:"attribute_name"`
	// The first attribute value to be returned by the query. Ascending sorts will return only objects with this value or greater, while descending sorts will return only objects with this value or less. If unset, start at the beginning (for ascending sorts) or end (for descending sorts).
	InitialAttributeValue string `json:"initial_attribute_value,omitempty"`
	// The desired sort order, `\"ASC\"` (ascending) or `\"DESC\"` (descending).
	SortOrder string `json:"sort_order,omitempty"`
}

The query expression to specify the key to sort search results.

type CatalogQueryText ¶

type CatalogQueryText struct {
	// A list of 1, 2, or 3 search keywords. Keywords with fewer than 3 alphanumeric characters are ignored.
	Keywords []string `json:"keywords"`
}

The query filter to return the search result whose searchable attribute values contain all of the specified keywords or tokens, independent of the token order or case.

type CatalogQuickAmount ¶

type CatalogQuickAmount struct {
	// Represents the type of the Quick Amount.
	Type_  string `json:"type"`
	Amount *Money `json:"amount"`
	// Describes the ranking of the Quick Amount provided by machine learning model, in the range [0, 100]. MANUAL type amount will always have score = 100.
	Score int64 `json:"score,omitempty"`
	// The order in which this Quick Amount should be displayed.
	Ordinal int64 `json:"ordinal,omitempty"`
}

Represents a Quick Amount in the Catalog.

type CatalogQuickAmountType ¶

type CatalogQuickAmountType string

CatalogQuickAmountType : Determines the type of a specific Quick Amount.

const (
	MANUAL_CatalogQuickAmountType CatalogQuickAmountType = "QUICK_AMOUNT_TYPE_MANUAL"
	AUTO_CatalogQuickAmountType   CatalogQuickAmountType = "QUICK_AMOUNT_TYPE_AUTO"
)

List of CatalogQuickAmountType

type CatalogQuickAmountsSettings ¶

type CatalogQuickAmountsSettings struct {
	// Represents the option seller currently uses on Quick Amounts.
	Option string `json:"option"`
	// Represents location's eligibility for auto amounts The boolean should be consistent with whether there are AUTO amounts in the `amounts`.
	EligibleForAutoAmounts bool `json:"eligible_for_auto_amounts,omitempty"`
	// Represents a set of Quick Amounts at this location.
	Amounts []CatalogQuickAmount `json:"amounts,omitempty"`
}

A parent Catalog Object model represents a set of Quick Amounts and the settings control the amounts.

type CatalogQuickAmountsSettingsOption ¶

type CatalogQuickAmountsSettingsOption string

CatalogQuickAmountsSettingsOption : Determines a seller's option on Quick Amounts feature.

const (
	DISABLED_CatalogQuickAmountsSettingsOption CatalogQuickAmountsSettingsOption = "DISABLED"
	MANUAL_CatalogQuickAmountsSettingsOption   CatalogQuickAmountsSettingsOption = "MANUAL"
	AUTO_CatalogQuickAmountsSettingsOption     CatalogQuickAmountsSettingsOption = "AUTO"
)

List of CatalogQuickAmountsSettingsOption

type CatalogStockConversion ¶

type CatalogStockConversion struct {
	// References to the stockable [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItemVariation) for this stock conversion. Selling, receiving or recounting the non-stockable `CatalogItemVariation` defined with a stock conversion results in adjustments of this stockable `CatalogItemVariation`. This immutable field must reference a stockable `CatalogItemVariation` that shares the parent [CatalogItem](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItem) of the converted `CatalogItemVariation.`
	StockableItemVariationId string `json:"stockable_item_variation_id"`
	// The quantity of the stockable item variation (as identified by `stockable_item_variation_id`) equivalent to the non-stockable item variation quantity (as specified in `nonstockable_quantity`) as defined by this stock conversion.  It accepts a decimal number in a string format that can take up to 10 digits before the decimal point and up to 5 digits after the decimal point.
	StockableQuantity string `json:"stockable_quantity"`
	// The converted equivalent quantity of the non-stockable [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItemVariation) in its measurement unit. The `stockable_quantity` value and this `nonstockable_quantity` value together define the conversion ratio between stockable item variation and the non-stockable item variation. It accepts a decimal number in a string format that can take up to 10 digits before the decimal point and up to 5 digits after the decimal point.
	NonstockableQuantity string `json:"nonstockable_quantity"`
}

Represents the rule of conversion between a stockable CatalogItemVariation(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItemVariation) and a non-stockable sell-by or receive-by `CatalogItemVariation` that share the same underlying stock.

type CatalogSubscriptionPlan ¶

type CatalogSubscriptionPlan struct {
	// The name of the plan.
	Name string `json:"name"`
	// A list of SubscriptionPhase containing the [SubscriptionPhase](https://developer.squareup.com/reference/square_2024-07-17/objects/SubscriptionPhase) for this plan. This field it required. Not including this field will throw a REQUIRED_FIELD_MISSING error
	Phases []SubscriptionPhase `json:"phases,omitempty"`
	// The list of subscription plan variations available for this product
	SubscriptionPlanVariations []CatalogObject `json:"subscription_plan_variations,omitempty"`
	// The list of IDs of `CatalogItems` that are eligible for subscription by this SubscriptionPlan's variations.
	EligibleItemIds []string `json:"eligible_item_ids,omitempty"`
	// The list of IDs of `CatalogCategory` that are eligible for subscription by this SubscriptionPlan's variations.
	EligibleCategoryIds []string `json:"eligible_category_ids,omitempty"`
	// If true, all items in the merchant's catalog are subscribable by this SubscriptionPlan.
	AllItems bool `json:"all_items,omitempty"`
}

Describes a subscription plan. A subscription plan represents what you want to sell in a subscription model, and includes references to each of the associated subscription plan variations. For more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations).

type CatalogSubscriptionPlanVariation ¶

type CatalogSubscriptionPlanVariation struct {
	// The name of the plan variation.
	Name string `json:"name"`
	// A list containing each [SubscriptionPhase](https://developer.squareup.com/reference/square_2024-07-17/objects/SubscriptionPhase) for this plan variation.
	Phases []SubscriptionPhase `json:"phases"`
	// The id of the subscription plan, if there is one.
	SubscriptionPlanId string `json:"subscription_plan_id,omitempty"`
	// The day of the month the billing period starts.
	MonthlyBillingAnchorDate int64 `json:"monthly_billing_anchor_date,omitempty"`
	// Whether bills for this plan variation can be split for proration.
	CanProrate bool `json:"can_prorate,omitempty"`
	// The ID of a \"successor\" plan variation to this one. If the field is set, and this object is disabled at all locations, it indicates that this variation is deprecated and the object identified by the successor ID be used in its stead.
	SuccessorPlanVariationId string `json:"successor_plan_variation_id,omitempty"`
}

Describes a subscription plan variation. A subscription plan variation represents how the subscription for a product or service is sold. For more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations).

type CatalogTax ¶

type CatalogTax struct {
	// The tax's name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.
	Name string `json:"name,omitempty"`
	// Whether the tax is calculated based on a payment's subtotal or total.
	CalculationPhase string `json:"calculation_phase,omitempty"`
	// Whether the tax is `ADDITIVE` or `INCLUSIVE`.
	InclusionType string `json:"inclusion_type,omitempty"`
	// The percentage of the tax in decimal form, using a `'.'` as the decimal separator and without a `'%'` sign. A value of `7.5` corresponds to 7.5%. For a location-specific tax rate, contact the tax authority of the location or a tax consultant.
	Percentage string `json:"percentage,omitempty"`
	// If `true`, the fee applies to custom amounts entered into the Square Point of Sale app that are not associated with a particular `CatalogItem`.
	AppliesToCustomAmounts bool `json:"applies_to_custom_amounts,omitempty"`
	// A Boolean flag to indicate whether the tax is displayed as enabled (`true`) in the Square Point of Sale app or not (`false`).
	Enabled bool `json:"enabled,omitempty"`
	// The ID of a `CatalogProductSet` object. If set, the tax is applicable to all products in the product set.
	AppliesToProductSetId string `json:"applies_to_product_set_id,omitempty"`
}

A tax applicable to an item.

type CatalogTimePeriod ¶

type CatalogTimePeriod struct {
	// An iCalendar (RFC 5545) [event](https://tools.ietf.org/html/rfc5545#section-3.6.1), which specifies the name, timing, duration and recurrence of this time period.  Example:  “` DTSTART:20190707T180000 DURATION:P2H RRULE:FREQ=WEEKLY;BYDAY=MO,WE,FR “`  Only `SUMMARY`, `DTSTART`, `DURATION` and `RRULE` fields are supported. `DTSTART` must be in local (unzoned) time format. Note that while `BEGIN:VEVENT` and `END:VEVENT` is not required in the request. The response will always include them.
	Event string `json:"event,omitempty"`
}

Represents a time period - either a single period or a repeating period.

type CatalogV1Id ¶

type CatalogV1Id struct {
	// The ID for an object used in the Square API V1, if the object ID differs from the Square API V2 object ID.
	CatalogV1Id string `json:"catalog_v1_id,omitempty"`
	// The ID of the `Location` this Connect V1 ID is associated with.
	LocationId string `json:"location_id,omitempty"`
}

A Square API V1 identifier of an item, including the object ID and its associated location ID.

type CategoryPathToRootNode ¶

type CategoryPathToRootNode struct {
	// The category's ID.
	CategoryId string `json:"category_id,omitempty"`
	// The category's name.
	CategoryName string `json:"category_name,omitempty"`
}

A node in the path from a retrieved category to its root node.

type ChangeBillingAnchorDateRequest ¶

type ChangeBillingAnchorDateRequest struct {
	// The anchor day for the billing cycle.
	MonthlyBillingAnchorDate int32 `json:"monthly_billing_anchor_date,omitempty"`
	// The `YYYY-MM-DD`-formatted date when the scheduled `BILLING_ANCHOR_CHANGE` action takes place on the subscription.  When this date is unspecified or falls within the current billing cycle, the billing anchor date is changed immediately.
	EffectiveDate string `json:"effective_date,omitempty"`
}

Defines input parameters in a request to the [ChangeBillingAnchorDate](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/change-billing-anchor-date) endpoint.

type ChangeBillingAnchorDateResponse ¶

type ChangeBillingAnchorDateResponse struct {
	// Errors encountered during the request.
	Errors       []ModelError  `json:"errors,omitempty"`
	Subscription *Subscription `json:"subscription,omitempty"`
	// A list of a single billing anchor date change for the subscription.
	Actions []SubscriptionAction `json:"actions,omitempty"`
}

Defines output parameters in a request to the [ChangeBillingAnchorDate](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/change-billing-anchor-date) endpoint.

type ChangeTiming ¶

type ChangeTiming string

ChangeTiming : Supported timings when a pending change, as an action, takes place to a subscription.

const (
	IMMEDIATE_ChangeTiming            ChangeTiming = "IMMEDIATE"
	END_OF_BILLING_CYCLE_ChangeTiming ChangeTiming = "END_OF_BILLING_CYCLE"
)

List of ChangeTiming

type ChargeRequest ¶

type ChargeRequest struct {
	// A value you specify that uniquely identifies this transaction among transactions you've created.  If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer.  See [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency) for more information.
	IdempotencyKey string `json:"idempotency_key"`
	AmountMoney    *Money `json:"amount_money"`
	// A payment token generated from the [Card.tokenize()](https://developer.squareup.com/reference/sdks/web/payments/objects/Card#Card.tokenize) that represents the card to charge.  The application that provides a payment token to this endpoint must be the _same application_ that generated the payment token with the Web Payments SDK. Otherwise, the nonce is invalid.  Do not provide a value for this field if you provide a value for `customer_card_id`.
	CardNonce string `json:"card_nonce,omitempty"`
	// The ID of the customer card on file to charge. Do not provide a value for this field if you provide a value for `card_nonce`.  If you provide this value, you _must_ also provide a value for `customer_id`.
	CustomerCardId string `json:"customer_card_id,omitempty"`
	// If `true`, the request will only perform an Auth on the provided card. You can then later perform either a Capture (with the [CaptureTransaction](https://developer.squareup.com/reference/square_2024-07-17/transactions-api/capture-transaction) endpoint) or a Void (with the [VoidTransaction](https://developer.squareup.com/reference/square_2024-07-17/transactions-api/void-transaction) endpoint).  Default value: `false`
	DelayCapture bool `json:"delay_capture,omitempty"`
	// An optional ID you can associate with the transaction for your own purposes (such as to associate the transaction with an entity ID in your own database).  This value cannot exceed 40 characters.
	ReferenceId string `json:"reference_id,omitempty"`
	// An optional note to associate with the transaction.  This value cannot exceed 60 characters.
	Note string `json:"note,omitempty"`
	// The ID of the customer to associate this transaction with. This field is required if you provide a value for `customer_card_id`, and optional otherwise.
	CustomerId      string   `json:"customer_id,omitempty"`
	BillingAddress  *Address `json:"billing_address,omitempty"`
	ShippingAddress *Address `json:"shipping_address,omitempty"`
	// The buyer's email address, if available. This value is optional, but this transaction is ineligible for chargeback protection if it is not provided.
	BuyerEmailAddress string `json:"buyer_email_address,omitempty"`
	// The ID of the order to associate with this transaction.  If you provide this value, the `amount_money` value of your request must __exactly match__ the value of the order's `total_money` field.
	OrderId string `json:"order_id,omitempty"`
	// The basic primitive of multi-party transaction. The value is optional. The transaction facilitated by you can be split from here.  If you provide this value, the `amount_money` value in your additional_recipients must not be more than 90% of the `amount_money` value in the charge request. The `location_id` must be the valid location of the app owner merchant.  This field requires the `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission.  This field is currently not supported in sandbox.
	AdditionalRecipients []AdditionalRecipient `json:"additional_recipients,omitempty"`
	// A token generated by SqPaymentForm's verifyBuyer() that represents customer's device info and 3ds challenge result.
	VerificationToken string `json:"verification_token,omitempty"`
}

Defines the parameters that can be included in the body of a request to the [Charge](https://developer.squareup.com/reference/square_2024-07-17/transactions-api/charge) endpoint. Deprecated - recommend using [CreatePayment](https://developer.squareup.com/reference/square_2024-07-17/payments-api/create-payment)

type ChargeRequestAdditionalRecipient ¶

type ChargeRequestAdditionalRecipient struct {
	// The location ID for a recipient (other than the merchant) receiving a portion of the tender.
	LocationId string `json:"location_id"`
	// The description of the additional recipient.
	Description string `json:"description"`
	AmountMoney *Money `json:"amount_money"`
}

Represents an additional recipient (other than the merchant) entitled to a portion of the tender. Support is currently limited to USD, CAD and GBP currencies

type ChargeResponse ¶

type ChargeResponse struct {
	// Any errors that occurred during the request.
	Errors      []ModelError `json:"errors,omitempty"`
	Transaction *Transaction `json:"transaction,omitempty"`
}

Defines the fields that are included in the response body of a request to the [Charge](https://developer.squareup.com/reference/square_2024-07-17/transactions-api/charge) endpoint. One of `errors` or `transaction` is present in a given response (never both).

type Checkout ¶

type Checkout struct {
	// ID generated by Square Checkout when a new checkout is requested.
	Id string `json:"id,omitempty"`
	// The URL that the buyer's browser should be redirected to after the checkout is completed.
	CheckoutPageUrl string `json:"checkout_page_url,omitempty"`
	// If `true`, Square Checkout will collect shipping information on your behalf and store that information with the transaction information in your Square Dashboard.  Default: `false`.
	AskForShippingAddress bool `json:"ask_for_shipping_address,omitempty"`
	// The email address to display on the Square Checkout confirmation page and confirmation email that the buyer can use to contact the merchant.  If this value is not set, the confirmation page and email will display the primary email address associated with the merchant's Square account.  Default: none; only exists if explicitly set.
	MerchantSupportEmail string `json:"merchant_support_email,omitempty"`
	// If provided, the buyer's email is pre-populated on the checkout page as an editable text field.  Default: none; only exists if explicitly set.
	PrePopulateBuyerEmail      string   `json:"pre_populate_buyer_email,omitempty"`
	PrePopulateShippingAddress *Address `json:"pre_populate_shipping_address,omitempty"`
	// The URL to redirect to after checkout is completed with `checkoutId`, Square's `orderId`, `transactionId`, and `referenceId` appended as URL parameters. For example, if the provided redirect_url is `http://www.example.com/order-complete`, a successful transaction redirects the customer to:  <pre><code>http://www.example.com/order-complete?checkoutId=xxxxxx&amp;orderId=xxxxxx&amp;referenceId=xxxxxx&amp;transactionId=xxxxxx</code></pre>  If you do not provide a redirect URL, Square Checkout will display an order confirmation page on your behalf; however Square strongly recommends that you provide a redirect URL so you can verify the transaction results and finalize the order through your existing/normal confirmation workflow.
	RedirectUrl string `json:"redirect_url,omitempty"`
	Order       *Order `json:"order,omitempty"`
	// The time when the checkout was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// Additional recipients (other than the merchant) receiving a portion of this checkout. For example, fees assessed on the purchase by a third party integration.
	AdditionalRecipients []AdditionalRecipient `json:"additional_recipients,omitempty"`
}

Square Checkout lets merchants accept online payments for supported payment types using a checkout workflow hosted on squareup.com.

type CheckoutApiListPaymentLinksOpts ¶

type CheckoutApiListPaymentLinksOpts struct {
	Cursor optional.String
	Limit  optional.Int32
}

type CheckoutApiService ¶

type CheckoutApiService service

func (*CheckoutApiService) CreateCheckout ¶

func (a *CheckoutApiService) CreateCheckout(ctx context.Context, body CreateCheckoutRequest, locationId string) (CreateCheckoutResponse, *http.Response, error)

CheckoutApiService CreateCheckout Links a `checkoutId` to a `checkout_page_url` that customers are directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com. NOTE: The Checkout API has been updated with new features. For more information, see [Checkout API highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-highlights).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param locationId The ID of the business location to associate the checkout with.

@return CreateCheckoutResponse

func (*CheckoutApiService) CreatePaymentLink ¶

func (a *CheckoutApiService) CreatePaymentLink(ctx context.Context, body CreatePaymentLinkRequest) (CreatePaymentLinkResponse, *http.Response, error)

CheckoutApiService CreatePaymentLink Creates a Square-hosted checkout page. Applications can share the resulting payment link with their buyer to pay for goods and services.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreatePaymentLinkResponse

func (*CheckoutApiService) DeletePaymentLink ¶

func (a *CheckoutApiService) DeletePaymentLink(ctx context.Context, id string) (DeletePaymentLinkResponse, *http.Response, error)

CheckoutApiService DeletePaymentLink Deletes a payment link.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The ID of the payment link to delete.

@return DeletePaymentLinkResponse

func (*CheckoutApiService) ListPaymentLinks ¶

func (a *CheckoutApiService) ListPaymentLinks(ctx context.Context, localVarOptionals *CheckoutApiListPaymentLinksOpts) (ListPaymentLinksResponse, *http.Response, error)

func (*CheckoutApiService) RetrieveLocationSettings ¶

func (a *CheckoutApiService) RetrieveLocationSettings(ctx context.Context, locationId string) (RetrieveLocationSettingsResponse, *http.Response, error)

CheckoutApiService RetrieveLocationSettings Retrieves the location-level settings for a Square-hosted checkout page.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the location for which to retrieve settings.

@return RetrieveLocationSettingsResponse

func (*CheckoutApiService) RetrieveMerchantSettings ¶

func (a *CheckoutApiService) RetrieveMerchantSettings(ctx context.Context) (RetrieveMerchantSettingsResponse, *http.Response, error)

CheckoutApiService RetrieveMerchantSettings Retrieves the merchant-level settings for a Square-hosted checkout page.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return RetrieveMerchantSettingsResponse

func (*CheckoutApiService) RetrievePaymentLink ¶

func (a *CheckoutApiService) RetrievePaymentLink(ctx context.Context, id string) (RetrievePaymentLinkResponse, *http.Response, error)

CheckoutApiService RetrievePaymentLink Retrieves a payment link.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The ID of link to retrieve.

@return RetrievePaymentLinkResponse

func (*CheckoutApiService) UpdateLocationSettings ¶

func (a *CheckoutApiService) UpdateLocationSettings(ctx context.Context, body UpdateLocationSettingsRequest, locationId string) (UpdateLocationSettingsResponse, *http.Response, error)

CheckoutApiService UpdateLocationSettings Updates the location-level settings for a Square-hosted checkout page.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param locationId The ID of the location for which to retrieve settings.

@return UpdateLocationSettingsResponse

func (*CheckoutApiService) UpdateMerchantSettings ¶

func (a *CheckoutApiService) UpdateMerchantSettings(ctx context.Context, body UpdateMerchantSettingsRequest) (UpdateMerchantSettingsResponse, *http.Response, error)

CheckoutApiService UpdateMerchantSettings Updates the merchant-level settings for a Square-hosted checkout page.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return UpdateMerchantSettingsResponse

func (*CheckoutApiService) UpdatePaymentLink ¶

func (a *CheckoutApiService) UpdatePaymentLink(ctx context.Context, body UpdatePaymentLinkRequest, id string) (UpdatePaymentLinkResponse, *http.Response, error)

CheckoutApiService UpdatePaymentLink Updates a payment link. You can update the `payment_link` fields such as `description`, `checkout_options`, and `pre_populated_data`. You cannot update other fields such as the `order_id`, `version`, `URL`, or `timestamp` field.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param id The ID of the payment link to update.

@return UpdatePaymentLinkResponse

type CheckoutLocationSettings ¶

type CheckoutLocationSettings struct {
	// The ID of the location that these settings apply to.
	LocationId string `json:"location_id,omitempty"`
	// Indicates whether customers are allowed to leave notes at checkout.
	CustomerNotesEnabled bool `json:"customer_notes_enabled,omitempty"`
	// Policy information is displayed at the bottom of the checkout pages. You can set a maximum of two policies.
	Policies []json.RawMessage `json:"policies,omitempty"`
	Branding json.RawMessage   `json:"branding,omitempty"`
	Tipping  json.RawMessage   `json:"tipping,omitempty"`
	Coupons  json.RawMessage   `json:"coupons,omitempty"`
	// The timestamp when the settings were last updated, in RFC 3339 format. Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00
	UpdatedAt string `json:"updated_at,omitempty"`
}

type CheckoutLocationSettingsBranding ¶

type CheckoutLocationSettingsBranding struct {
	// Show the location logo on the checkout page.
	HeaderType string `json:"header_type,omitempty"`
	// The HTML-supported hex color for the button on the checkout page (for example, \"#FFFFFF\").
	ButtonColor string `json:"button_color,omitempty"`
	// The shape of the button on the checkout page.
	ButtonShape string `json:"button_shape,omitempty"`
}

type CheckoutLocationSettingsBrandingButtonShape ¶

type CheckoutLocationSettingsBrandingButtonShape string

const (
	SQUARED_CheckoutLocationSettingsBrandingButtonShape CheckoutLocationSettingsBrandingButtonShape = "SQUARED"
	ROUNDED_CheckoutLocationSettingsBrandingButtonShape CheckoutLocationSettingsBrandingButtonShape = "ROUNDED"
	PILL_CheckoutLocationSettingsBrandingButtonShape    CheckoutLocationSettingsBrandingButtonShape = "PILL"
)

List of CheckoutLocationSettingsBrandingButtonShape

type CheckoutLocationSettingsBrandingHeaderType ¶

type CheckoutLocationSettingsBrandingHeaderType string

const (
	BUSINESS_NAME_CheckoutLocationSettingsBrandingHeaderType   CheckoutLocationSettingsBrandingHeaderType = "BUSINESS_NAME"
	FRAMED_LOGO_CheckoutLocationSettingsBrandingHeaderType     CheckoutLocationSettingsBrandingHeaderType = "FRAMED_LOGO"
	FULL_WIDTH_LOGO_CheckoutLocationSettingsBrandingHeaderType CheckoutLocationSettingsBrandingHeaderType = "FULL_WIDTH_LOGO"
)

List of CheckoutLocationSettingsBrandingHeaderType

type CheckoutLocationSettingsCoupons ¶

type CheckoutLocationSettingsCoupons struct {
	// Indicates whether coupons are enabled for this location.
	Enabled bool `json:"enabled,omitempty"`
}

type CheckoutLocationSettingsPolicy ¶

type CheckoutLocationSettingsPolicy struct {
	// A unique ID to identify the policy when making changes. You must set the UID for policy updates, but it’s optional when setting new policies.
	Uid string `json:"uid,omitempty"`
	// The title of the policy. This is required when setting the description, though you can update it in a different request.
	Title string `json:"title,omitempty"`
	// The description of the policy.
	Description string `json:"description,omitempty"`
}

type CheckoutLocationSettingsTipping ¶

type CheckoutLocationSettingsTipping struct {
	// Set three custom percentage amounts that buyers can select at checkout. If Smart Tip is enabled, this only applies to transactions totaling $10 or more.
	Percentages []int32 `json:"percentages,omitempty"`
	// Enables Smart Tip Amounts. If Smart Tip Amounts is enabled, tipping works as follows: If a transaction is less than $10, the available tipping options include No Tip, $1, $2, or $3. If a transaction is $10 or more, the available tipping options include No Tip, 15%, 20%, or 25%.  You can set custom percentage amounts with the `percentages` field.
	SmartTippingEnabled bool `json:"smart_tipping_enabled,omitempty"`
	// Set the pre-selected percentage amounts that appear at checkout. If Smart Tip is enabled, this only applies to transactions totaling $10 or more.
	DefaultPercent int32 `json:"default_percent,omitempty"`
	// Show the Smart Tip Amounts for this location.
	SmartTips       []Money `json:"smart_tips,omitempty"`
	DefaultSmartTip *Money  `json:"default_smart_tip,omitempty"`
}

type CheckoutMerchantSettings ¶

type CheckoutMerchantSettings struct {
	PaymentMethods json.RawMessage `json:"payment_methods,omitempty"`
	// The timestamp when the settings were last updated, in RFC 3339 format. Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00
	UpdatedAt string `json:"updated_at,omitempty"`
}

type CheckoutMerchantSettingsPaymentMethods ¶

type CheckoutMerchantSettingsPaymentMethods struct {
	ApplePay         json.RawMessage `json:"apple_pay,omitempty"`
	GooglePay        json.RawMessage `json:"google_pay,omitempty"`
	CashApp          json.RawMessage `json:"cash_app,omitempty"`
	AfterpayClearpay json.RawMessage `json:"afterpay_clearpay,omitempty"`
}

type CheckoutMerchantSettingsPaymentMethodsAfterpayClearpay ¶

type CheckoutMerchantSettingsPaymentMethodsAfterpayClearpay struct {
	OrderEligibilityRange json.RawMessage `json:"order_eligibility_range,omitempty"`
	ItemEligibilityRange  json.RawMessage `json:"item_eligibility_range,omitempty"`
	// Indicates whether the payment method is enabled for the account.
	Enabled bool `json:"enabled,omitempty"`
}

The settings allowed for AfterpayClearpay.

type CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange ¶

type CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange struct {
	Min *Money `json:"min"`
	Max *Money `json:"max"`
}

A range of purchase price that qualifies.

type CheckoutMerchantSettingsPaymentMethodsPaymentMethod ¶

type CheckoutMerchantSettingsPaymentMethodsPaymentMethod struct {
	// Indicates whether the payment method is enabled for the account.
	Enabled bool `json:"enabled,omitempty"`
}

The settings allowed for a payment method.

type CheckoutOptions ¶

type CheckoutOptions struct {
	// Indicates whether the payment allows tipping.
	AllowTipping bool `json:"allow_tipping,omitempty"`
	// The custom fields requesting information from the buyer.
	CustomFields []CustomField `json:"custom_fields,omitempty"`
	// The ID of the subscription plan for the buyer to pay and subscribe. For more information, see [Subscription Plan Checkout](https://developer.squareup.com/docs/checkout-api/subscription-plan-checkout).
	SubscriptionPlanId string `json:"subscription_plan_id,omitempty"`
	// The confirmation page URL to redirect the buyer to after Square processes the payment.
	RedirectUrl string `json:"redirect_url,omitempty"`
	// The email address that buyers can use to contact the seller.
	MerchantSupportEmail string `json:"merchant_support_email,omitempty"`
	// Indicates whether to include the address fields in the payment form.
	AskForShippingAddress  bool                    `json:"ask_for_shipping_address,omitempty"`
	AcceptedPaymentMethods *AcceptedPaymentMethods `json:"accepted_payment_methods,omitempty"`
	AppFeeMoney            *Money                  `json:"app_fee_money,omitempty"`
	ShippingFee            *ShippingFee            `json:"shipping_fee,omitempty"`
	// Indicates whether to include the `Add coupon` section for the buyer to provide a Square marketing coupon in the payment form.
	EnableCoupon bool `json:"enable_coupon,omitempty"`
	// Indicates whether to include the `REWARDS` section for the buyer to opt in to loyalty, redeem rewards in the payment form, or both.
	EnableLoyalty bool `json:"enable_loyalty,omitempty"`
}

type CheckoutOptionsPaymentType ¶

type CheckoutOptionsPaymentType string

const (
	CARD_PRESENT_CheckoutOptionsPaymentType                CheckoutOptionsPaymentType = "CARD_PRESENT"
	MANUAL_CARD_ENTRY_CheckoutOptionsPaymentType           CheckoutOptionsPaymentType = "MANUAL_CARD_ENTRY"
	FELICA_ID_CheckoutOptionsPaymentType                   CheckoutOptionsPaymentType = "FELICA_ID"
	FELICA_QUICPAY_CheckoutOptionsPaymentType              CheckoutOptionsPaymentType = "FELICA_QUICPAY"
	FELICA_TRANSPORTATION_GROUP_CheckoutOptionsPaymentType CheckoutOptionsPaymentType = "FELICA_TRANSPORTATION_GROUP"
	FELICA_ALL_CheckoutOptionsPaymentType                  CheckoutOptionsPaymentType = "FELICA_ALL"
	PAYPAY_CheckoutOptionsPaymentType                      CheckoutOptionsPaymentType = "PAYPAY"
)

List of CheckoutOptionsPaymentType

type ClearpayDetails ¶

type ClearpayDetails struct {
	// Email address on the buyer's Clearpay account.
	EmailAddress string `json:"email_address,omitempty"`
}

Additional details about Clearpay payments.

type CloneOrderRequest ¶

type CloneOrderRequest struct {
	// The ID of the order to clone.
	OrderId string `json:"order_id"`
	// An optional order version for concurrency protection.  If a version is provided, it must match the latest stored version of the order to clone. If a version is not provided, the API clones the latest version.
	Version int32 `json:"version,omitempty"`
	// A value you specify that uniquely identifies this clone request.  If you are unsure whether a particular order was cloned successfully, you can reattempt the call with the same idempotency key without worrying about creating duplicate cloned orders. The originally cloned order is returned.  For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Defines the fields that are included in requests to the [CloneOrder](https://developer.squareup.com/reference/square_2024-07-17/orders-api/clone-order) endpoint.

type CloneOrderResponse ¶

type CloneOrderResponse struct {
	Order *Order `json:"order,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields that are included in the response body of a request to the [CloneOrder](https://developer.squareup.com/reference/square_2024-07-17/orders-api/clone-order) endpoint.

type CollectedData ¶

type CollectedData struct {
	// The buyer's input text.
	InputText string `json:"input_text,omitempty"`
}

type CompletePaymentRequest ¶

type CompletePaymentRequest struct {
	// Used for optimistic concurrency. This opaque token identifies the current `Payment`  version that the caller expects. If the server has a different version of the Payment,  the update fails and a response with a VERSION_MISMATCH error is returned.
	VersionToken string `json:"version_token,omitempty"`
}

Describes a request to complete (capture) a payment using [CompletePayment](https://developer.squareup.com/reference/square_2024-07-17/payments-api/complete-payment). By default, payments are set to `autocomplete` immediately after they are created. To complete payments manually, set `autocomplete` to `false`.

type CompletePaymentResponse ¶

type CompletePaymentResponse struct {
	// Information about errors encountered during the request.
	Errors  []ModelError `json:"errors,omitempty"`
	Payment *Payment     `json:"payment,omitempty"`
}

Defines the response returned by[CompletePayment](https://developer.squareup.com/reference/square_2024-07-17/payments-api/complete-payment).

type Component ¶

type Component struct {
	// The type of this component. Each component type has expected properties expressed in a structured format within its corresponding `*_details` field.
	Type_              string                                    `json:"type"`
	ApplicationDetails *DeviceComponentDetailsApplicationDetails `json:"application_details,omitempty"`
	CardReaderDetails  *DeviceComponentDetailsCardReaderDetails  `json:"card_reader_details,omitempty"`
	BatteryDetails     *DeviceComponentDetailsBatteryDetails     `json:"battery_details,omitempty"`
	WifiDetails        *DeviceComponentDetailsWiFiDetails        `json:"wifi_details,omitempty"`
	EthernetDetails    *DeviceComponentDetailsEthernetDetails    `json:"ethernet_details,omitempty"`
}

The wrapper object for the component entries of a given component type.

type ComponentComponentType ¶

type ComponentComponentType string

ComponentComponentType : An enum for ComponentType.

const (
	APPLICATION_ComponentComponentType ComponentComponentType = "APPLICATION"
	CARD_READER_ComponentComponentType ComponentComponentType = "CARD_READER"
	BATTERY_ComponentComponentType     ComponentComponentType = "BATTERY"
	WIFI_ComponentComponentType        ComponentComponentType = "WIFI"
	ETHERNET_ComponentComponentType    ComponentComponentType = "ETHERNET"
	PRINTER_ComponentComponentType     ComponentComponentType = "PRINTER"
)

List of ComponentComponentType

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type ConfirmationDecision ¶

type ConfirmationDecision struct {
	// The buyer's decision to the displayed terms.
	HasAgreed bool `json:"has_agreed,omitempty"`
}

type ConfirmationOptions ¶

type ConfirmationOptions struct {
	// The title text to display in the confirmation screen flow on the Terminal.
	Title string `json:"title"`
	// The agreement details to display in the confirmation flow on the Terminal.
	Body string `json:"body"`
	// The button text to display indicating the customer agrees to the displayed terms.
	AgreeButtonText string `json:"agree_button_text"`
	// The button text to display indicating the customer does not agree to the displayed terms.
	DisagreeButtonText string                `json:"disagree_button_text,omitempty"`
	Decision           *ConfirmationDecision `json:"decision,omitempty"`
}

type Coordinates ¶

type Coordinates struct {
	// The latitude of the coordinate expressed in degrees.
	Latitude float64 `json:"latitude,omitempty"`
	// The longitude of the coordinate expressed in degrees.
	Longitude float64 `json:"longitude,omitempty"`
}

Latitude and longitude coordinates.

type Country ¶

type Country string

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).

const (
	ZZ_Country Country = "ZZ"
	AD_Country Country = "AD"
	AE_Country Country = "AE"
	AF_Country Country = "AF"
	AG_Country Country = "AG"
	AI_Country Country = "AI"
	AL_Country Country = "AL"
	AM_Country Country = "AM"
	AO_Country Country = "AO"
	AQ_Country Country = "AQ"
	AR_Country Country = "AR"
	AS_Country Country = "AS"
	AT_Country Country = "AT"
	AU_Country Country = "AU"
	AW_Country Country = "AW"
	AX_Country Country = "AX"
	AZ_Country Country = "AZ"
	BA_Country Country = "BA"
	BB_Country Country = "BB"
	BD_Country Country = "BD"
	BE_Country Country = "BE"
	BF_Country Country = "BF"
	BG_Country Country = "BG"
	BH_Country Country = "BH"
	BI_Country Country = "BI"
	BJ_Country Country = "BJ"
	BL_Country Country = "BL"
	BM_Country Country = "BM"
	BN_Country Country = "BN"
	BO_Country Country = "BO"
	BQ_Country Country = "BQ"
	BR_Country Country = "BR"
	BS_Country Country = "BS"
	BT_Country Country = "BT"
	BV_Country Country = "BV"
	BW_Country Country = "BW"
	BY_Country Country = "BY"
	BZ_Country Country = "BZ"
	CA_Country Country = "CA"
	CC_Country Country = "CC"
	CD_Country Country = "CD"
	CF_Country Country = "CF"
	CG_Country Country = "CG"
	CH_Country Country = "CH"
	CI_Country Country = "CI"
	CK_Country Country = "CK"
	CL_Country Country = "CL"
	CM_Country Country = "CM"
	CN_Country Country = "CN"
	CO_Country Country = "CO"
	CR_Country Country = "CR"
	CU_Country Country = "CU"
	CV_Country Country = "CV"
	CW_Country Country = "CW"
	CX_Country Country = "CX"
	CY_Country Country = "CY"
	CZ_Country Country = "CZ"
	DE_Country Country = "DE"
	DJ_Country Country = "DJ"
	DK_Country Country = "DK"
	DM_Country Country = "DM"
	DO_Country Country = "DO"
	DZ_Country Country = "DZ"
	EC_Country Country = "EC"
	EE_Country Country = "EE"
	EG_Country Country = "EG"
	EH_Country Country = "EH"
	ER_Country Country = "ER"
	ES_Country Country = "ES"
	ET_Country Country = "ET"
	FI_Country Country = "FI"
	FJ_Country Country = "FJ"
	FK_Country Country = "FK"
	FM_Country Country = "FM"
	FO_Country Country = "FO"
	FR_Country Country = "FR"
	GA_Country Country = "GA"
	GB_Country Country = "GB"
	GD_Country Country = "GD"
	GE_Country Country = "GE"
	GF_Country Country = "GF"
	GG_Country Country = "GG"
	GH_Country Country = "GH"
	GI_Country Country = "GI"
	GL_Country Country = "GL"
	GM_Country Country = "GM"
	GN_Country Country = "GN"
	GP_Country Country = "GP"
	GQ_Country Country = "GQ"
	GR_Country Country = "GR"
	GS_Country Country = "GS"
	GT_Country Country = "GT"
	GU_Country Country = "GU"
	GW_Country Country = "GW"
	GY_Country Country = "GY"
	HK_Country Country = "HK"
	HM_Country Country = "HM"
	HN_Country Country = "HN"
	HR_Country Country = "HR"
	HT_Country Country = "HT"
	HU_Country Country = "HU"
	ID_Country Country = "ID"
	IE_Country Country = "IE"
	IL_Country Country = "IL"
	IM_Country Country = "IM"
	IN_Country Country = "IN"
	IO_Country Country = "IO"
	IQ_Country Country = "IQ"
	IR_Country Country = "IR"
	IS_Country Country = "IS"
	IT_Country Country = "IT"
	JE_Country Country = "JE"
	JM_Country Country = "JM"
	JO_Country Country = "JO"
	JP_Country Country = "JP"
	KE_Country Country = "KE"
	KG_Country Country = "KG"
	KH_Country Country = "KH"
	KI_Country Country = "KI"
	KM_Country Country = "KM"
	KN_Country Country = "KN"
	KP_Country Country = "KP"
	KR_Country Country = "KR"
	KW_Country Country = "KW"
	KY_Country Country = "KY"
	KZ_Country Country = "KZ"
	LA_Country Country = "LA"
	LB_Country Country = "LB"
	LC_Country Country = "LC"
	LI_Country Country = "LI"
	LK_Country Country = "LK"
	LR_Country Country = "LR"
	LS_Country Country = "LS"
	LT_Country Country = "LT"
	LU_Country Country = "LU"
	LV_Country Country = "LV"
	LY_Country Country = "LY"
	MA_Country Country = "MA"
	MC_Country Country = "MC"
	MD_Country Country = "MD"
	ME_Country Country = "ME"
	MF_Country Country = "MF"
	MG_Country Country = "MG"
	MH_Country Country = "MH"
	MK_Country Country = "MK"
	ML_Country Country = "ML"
	MM_Country Country = "MM"
	MN_Country Country = "MN"
	MO_Country Country = "MO"
	MP_Country Country = "MP"
	MQ_Country Country = "MQ"
	MR_Country Country = "MR"
	MS_Country Country = "MS"
	MT_Country Country = "MT"
	MU_Country Country = "MU"
	MV_Country Country = "MV"
	MW_Country Country = "MW"
	MX_Country Country = "MX"
	MY_Country Country = "MY"
	MZ_Country Country = "MZ"
	NA_Country Country = "NA"
	NC_Country Country = "NC"
	NE_Country Country = "NE"
	NF_Country Country = "NF"
	NG_Country Country = "NG"
	NI_Country Country = "NI"
	NL_Country Country = "NL"
	NO_Country Country = "NO"
	NP_Country Country = "NP"
	NR_Country Country = "NR"
	NU_Country Country = "NU"
	NZ_Country Country = "NZ"
	OM_Country Country = "OM"
	PA_Country Country = "PA"
	PE_Country Country = "PE"
	PF_Country Country = "PF"
	PG_Country Country = "PG"
	PH_Country Country = "PH"
	PK_Country Country = "PK"
	PL_Country Country = "PL"
	PM_Country Country = "PM"
	PN_Country Country = "PN"
	PR_Country Country = "PR"
	PS_Country Country = "PS"
	PT_Country Country = "PT"
	PW_Country Country = "PW"
	PY_Country Country = "PY"
	QA_Country Country = "QA"
	RE_Country Country = "RE"
	RO_Country Country = "RO"
	RS_Country Country = "RS"
	RU_Country Country = "RU"
	RW_Country Country = "RW"
	SA_Country Country = "SA"
	SB_Country Country = "SB"
	SC_Country Country = "SC"
	SD_Country Country = "SD"
	SE_Country Country = "SE"
	SG_Country Country = "SG"
	SH_Country Country = "SH"
	SI_Country Country = "SI"
	SJ_Country Country = "SJ"
	SK_Country Country = "SK"
	SL_Country Country = "SL"
	SM_Country Country = "SM"
	SN_Country Country = "SN"
	SO_Country Country = "SO"
	SR_Country Country = "SR"
	SS_Country Country = "SS"
	ST_Country Country = "ST"
	SV_Country Country = "SV"
	SX_Country Country = "SX"
	SY_Country Country = "SY"
	SZ_Country Country = "SZ"
	TC_Country Country = "TC"
	TD_Country Country = "TD"
	TF_Country Country = "TF"
	TG_Country Country = "TG"
	TH_Country Country = "TH"
	TJ_Country Country = "TJ"
	TK_Country Country = "TK"
	TL_Country Country = "TL"
	TM_Country Country = "TM"
	TN_Country Country = "TN"
	TO_Country Country = "TO"
	TR_Country Country = "TR"
	TT_Country Country = "TT"
	TV_Country Country = "TV"
	TW_Country Country = "TW"
	TZ_Country Country = "TZ"
	UA_Country Country = "UA"
	UG_Country Country = "UG"
	UM_Country Country = "UM"
	US_Country Country = "US"
	UY_Country Country = "UY"
	UZ_Country Country = "UZ"
	VA_Country Country = "VA"
	VC_Country Country = "VC"
	VE_Country Country = "VE"
	VG_Country Country = "VG"
	VI_Country Country = "VI"
	VN_Country Country = "VN"
	VU_Country Country = "VU"
	WF_Country Country = "WF"
	WS_Country Country = "WS"
	YE_Country Country = "YE"
	YT_Country Country = "YT"
	ZA_Country Country = "ZA"
	ZM_Country Country = "ZM"
	ZW_Country Country = "ZW"
)

List of Country

type CreateBookingCustomAttributeDefinitionRequest ¶

type CreateBookingCustomAttributeDefinitionRequest struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition"`
	// 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).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Represents a [CreateBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/create-booking-custom-attribute-definition) request.

type CreateBookingCustomAttributeDefinitionResponse ¶

type CreateBookingCustomAttributeDefinitionResponse struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [CreateBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/create-booking-custom-attribute-definition) response. Either `custom_attribute_definition` or `errors` is present in the response.

type CreateBookingRequest ¶

type CreateBookingRequest struct {
	// A unique key to make this request an idempotent operation.
	IdempotencyKey string   `json:"idempotency_key,omitempty"`
	Booking        *Booking `json:"booking"`
}

type CreateBookingResponse ¶

type CreateBookingResponse struct {
	Booking *Booking `json:"booking,omitempty"`
	// Errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type CreateBreakTypeRequest ¶

type CreateBreakTypeRequest struct {
	// A unique string value to ensure the idempotency of the operation.
	IdempotencyKey string     `json:"idempotency_key,omitempty"`
	BreakType      *BreakType `json:"break_type"`
}

A request to create a new `BreakType`.

type CreateBreakTypeResponse ¶

type CreateBreakTypeResponse struct {
	BreakType *BreakType `json:"break_type,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

The response to the request to create a `BreakType`. The response contains the created `BreakType` object and might contain a set of `Error` objects if the request resulted in errors.

type CreateCardRequest ¶

type CreateCardRequest struct {
	// A unique string that identifies this CreateCard request. Keys can be any valid string and must be unique for every request.  Max: 45 characters  See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.
	IdempotencyKey string `json:"idempotency_key"`
	// The ID of the source which represents the card information to be stored. This can be a card nonce or a payment id.
	SourceId string `json:"source_id"`
	// An identifying token generated by [Payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity.  See the [SCA Overview](https://developer.squareup.com/docs/sca-overview).
	VerificationToken string `json:"verification_token,omitempty"`
	Card              *Card  `json:"card"`
}

Creates a card from the source (payment token or payment id). Accessible via HTTP requests at POST https://connect.squareup.com/v2/cards

type CreateCardResponse ¶

type CreateCardResponse struct {
	// Errors resulting from the request.
	Errors []ModelError `json:"errors,omitempty"`
	Card   *Card        `json:"card,omitempty"`
}

Defines the fields that are included in the response body of a request to the [CreateCard](https://developer.squareup.com/reference/square_2024-07-17/cards-api/create-card) endpoint. Note: if there are errors processing the request, the card field will not be present.

type CreateCheckoutRequest ¶

type CreateCheckoutRequest struct {
	// A unique string that identifies this checkout among others you have created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID.  The idempotency key is used to avoid processing the same order more than once. If you are  unsure whether a particular checkout was created successfully, you can attempt it again with the same idempotency key and all the same other parameters without worrying about creating duplicates.  You should use a random number/string generator native to the language you are working in to generate strings for your idempotency keys.  For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
	IdempotencyKey string              `json:"idempotency_key"`
	Order          *CreateOrderRequest `json:"order"`
	// If `true`, Square Checkout collects shipping information on your behalf and stores  that information with the transaction information in the Square Seller Dashboard.  Default: `false`.
	AskForShippingAddress bool `json:"ask_for_shipping_address,omitempty"`
	// The email address to display on the Square Checkout confirmation page and confirmation email that the buyer can use to contact the seller.  If this value is not set, the confirmation page and email display the primary email address associated with the seller's Square account.  Default: none; only exists if explicitly set.
	MerchantSupportEmail string `json:"merchant_support_email,omitempty"`
	// If provided, the buyer's email is prepopulated on the checkout page as an editable text field.  Default: none; only exists if explicitly set.
	PrePopulateBuyerEmail      string   `json:"pre_populate_buyer_email,omitempty"`
	PrePopulateShippingAddress *Address `json:"pre_populate_shipping_address,omitempty"`
	// The URL to redirect to after the checkout is completed with `checkoutId`, `transactionId`, and `referenceId` appended as URL parameters. For example, if the provided redirect URL is `http://www.example.com/order-complete`, a successful transaction redirects the customer to:  `http://www.example.com/order-complete?checkoutId=xxxxxx&amp;referenceId=xxxxxx&amp;transactionId=xxxxxx`  If you do not provide a redirect URL, Square Checkout displays an order confirmation page on your behalf; however, it is strongly recommended that you provide a redirect URL so you can verify the transaction results and finalize the order through your existing/normal confirmation workflow.  Default: none; only exists if explicitly set.
	RedirectUrl string `json:"redirect_url,omitempty"`
	// The basic primitive of a multi-party transaction. The value is optional. The transaction facilitated by you can be split from here.  If you provide this value, the `amount_money` value in your `additional_recipients` field cannot be more than 90% of the `total_money` calculated by Square for your order. The `location_id` must be a valid seller location where the checkout is occurring.  This field requires `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission.  This field is currently not supported in the Square Sandbox.
	AdditionalRecipients []ChargeRequestAdditionalRecipient `json:"additional_recipients,omitempty"`
	// An optional note to associate with the `checkout` object.  This value cannot exceed 60 characters.
	Note string `json:"note,omitempty"`
}

Defines the parameters that can be included in the body of a request to the `CreateCheckout` endpoint.

type CreateCheckoutResponse ¶

type CreateCheckoutResponse struct {
	Checkout *Checkout `json:"checkout,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields that are included in the response body of a request to the `CreateCheckout` endpoint.

type CreateCustomerCardRequest ¶

type CreateCustomerCardRequest struct {
	// A card nonce representing the credit card to link to the customer.  Card nonces are generated by the Square payment form when customers enter their card information. For more information, see [Walkthrough: Integrate Square Payments in a Website](https://developer.squareup.com/docs/web-payments/take-card-payment).  __NOTE:__ Card nonces generated by digital wallets (such as Apple Pay) cannot be used to create a customer card.
	CardNonce      string   `json:"card_nonce"`
	BillingAddress *Address `json:"billing_address,omitempty"`
	// The full name printed on the credit card.
	CardholderName string `json:"cardholder_name,omitempty"`
	// An identifying token generated by [Payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity.
	VerificationToken string `json:"verification_token,omitempty"`
}

Defines the fields that are included in the request body of a request to the `CreateCustomerCard` endpoint.

type CreateCustomerCardResponse ¶

type CreateCustomerCardResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	Card   *Card        `json:"card,omitempty"`
}

Defines the fields that are included in the response body of a request to the `CreateCustomerCard` endpoint. Either `errors` or `card` is present in a given response (never both).

type CreateCustomerCustomAttributeDefinitionRequest ¶

type CreateCustomerCustomAttributeDefinitionRequest struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition"`
	// 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).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Represents a [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/create-customer-custom-attribute-definition) request.

type CreateCustomerCustomAttributeDefinitionResponse ¶

type CreateCustomerCustomAttributeDefinitionResponse struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/create-customer-custom-attribute-definition) response. Either `custom_attribute_definition` or `errors` is present in the response.

type CreateCustomerGroupRequest ¶

type CreateCustomerGroupRequest struct {
	// The idempotency key for the request. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
	IdempotencyKey string         `json:"idempotency_key,omitempty"`
	Group          *CustomerGroup `json:"group"`
}

Defines the body parameters that can be included in a request to the [CreateCustomerGroup](https://developer.squareup.com/reference/square_2024-07-17/customer-groups-api/create-customer-group) endpoint.

type CreateCustomerGroupResponse ¶

type CreateCustomerGroupResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError   `json:"errors,omitempty"`
	Group  *CustomerGroup `json:"group,omitempty"`
}

Defines the fields that are included in the response body of a request to the [CreateCustomerGroup](https://developer.squareup.com/reference/square_2024-07-17/customer-groups-api/create-customer-group) endpoint. Either `errors` or `group` is present in a given response (never both).

type CreateCustomerRequest ¶

type CreateCustomerRequest struct {
	// The idempotency key for the request. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
	// The given name (that is, the first name) associated with the customer profile.  The maximum length for this value is 300 characters.
	GivenName string `json:"given_name,omitempty"`
	// The family name (that is, the last name) associated with the customer profile.  The maximum length for this value is 300 characters.
	FamilyName string `json:"family_name,omitempty"`
	// A business name associated with the customer profile.  The maximum length for this value is 500 characters.
	CompanyName string `json:"company_name,omitempty"`
	// A nickname for the customer profile.  The maximum length for this value is 100 characters.
	Nickname string `json:"nickname,omitempty"`
	// The email address associated with the customer profile.  The maximum length for this value is 254 characters.
	EmailAddress string   `json:"email_address,omitempty"`
	Address      *Address `json:"address,omitempty"`
	// The phone number associated with the customer profile. The phone number must be valid and can contain 9–16 digits, with an optional `+` prefix and country code. For more information, see [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number).
	PhoneNumber string `json:"phone_number,omitempty"`
	// An optional second ID used to associate the customer profile with an entity in another system.  The maximum length for this value is 100 characters.
	ReferenceId string `json:"reference_id,omitempty"`
	// A custom note associated with the customer profile.
	Note string `json:"note,omitempty"`
	// The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example, specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD` format, where `YYYY` is the specified birth year or `0000` if a birth year is not specified.
	Birthday string          `json:"birthday,omitempty"`
	TaxIds   *CustomerTaxIds `json:"tax_ids,omitempty"`
}

Defines the body parameters that can be included in a request to the `CreateCustomer` endpoint.

type CreateCustomerResponse ¶

type CreateCustomerResponse struct {
	// Any errors that occurred during the request.
	Errors   []ModelError `json:"errors,omitempty"`
	Customer *Customer    `json:"customer,omitempty"`
}

Defines the fields that are included in the response body of a request to the [CreateCustomer](https://developer.squareup.com/reference/square_2024-07-17/customers-api/create-customer) or [BulkCreateCustomers](https://developer.squareup.com/reference/square_2024-07-17/customers-api/bulk-create-customers) endpoint. Either `errors` or `customer` is present in a given response (never both).

type CreateDeviceCodeRequest ¶

type CreateDeviceCodeRequest struct {
	// A unique string that identifies this CreateDeviceCode request. Keys can be any valid string but must be unique for every CreateDeviceCode request.  See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.
	IdempotencyKey string      `json:"idempotency_key"`
	DeviceCode     *DeviceCode `json:"device_code"`
}

type CreateDeviceCodeResponse ¶

type CreateDeviceCodeResponse struct {
	// Any errors that occurred during the request.
	Errors     []ModelError `json:"errors,omitempty"`
	DeviceCode *DeviceCode  `json:"device_code,omitempty"`
}

type CreateDisputeEvidenceTextRequest ¶

type CreateDisputeEvidenceTextRequest struct {
	// A unique key identifying the request. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
	IdempotencyKey string `json:"idempotency_key"`
	// The type of evidence you are uploading.
	EvidenceType string `json:"evidence_type,omitempty"`
	// The evidence string.
	EvidenceText string `json:"evidence_text"`
}

Defines the parameters for a `CreateDisputeEvidenceText` request.

type CreateDisputeEvidenceTextResponse ¶

type CreateDisputeEvidenceTextResponse struct {
	// Any errors that occurred during the request.
	Errors   []ModelError     `json:"errors,omitempty"`
	Evidence *DisputeEvidence `json:"evidence,omitempty"`
}

Defines the fields in a `CreateDisputeEvidenceText` response.

type CreateGiftCardActivityRequest ¶

type CreateGiftCardActivityRequest struct {
	// A unique string that identifies the `CreateGiftCardActivity` request.
	IdempotencyKey   string            `json:"idempotency_key"`
	GiftCardActivity *GiftCardActivity `json:"gift_card_activity"`
}

A request to create a gift card activity.

type CreateGiftCardActivityResponse ¶

type CreateGiftCardActivityResponse struct {
	// Any errors that occurred during the request.
	Errors           []ModelError      `json:"errors,omitempty"`
	GiftCardActivity *GiftCardActivity `json:"gift_card_activity,omitempty"`
}

A response that contains a `GiftCardActivity` that was created. The response might contain a set of `Error` objects if the request resulted in errors.

type CreateGiftCardRequest ¶

type CreateGiftCardRequest struct {
	// 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).
	IdempotencyKey string `json:"idempotency_key"`
	// The ID of the [location](https://developer.squareup.com/reference/square_2024-07-17/objects/Location) where the gift card should be registered for  reporting purposes. Gift cards can be redeemed at any of the seller's locations.
	LocationId string    `json:"location_id"`
	GiftCard   *GiftCard `json:"gift_card"`
}

Represents a [CreateGiftCard](https://developer.squareup.com/reference/square_2024-07-17/gift-cards-api/create-gift-card) request.

type CreateGiftCardResponse ¶

type CreateGiftCardResponse struct {
	// Any errors that occurred during the request.
	Errors   []ModelError `json:"errors,omitempty"`
	GiftCard *GiftCard    `json:"gift_card,omitempty"`
}

A response that contains a `GiftCard`. The response might contain a set of `Error` objects if the request resulted in errors.

type CreateInvoiceRequest ¶

type CreateInvoiceRequest struct {
	Invoice *Invoice `json:"invoice"`
	// A unique string that identifies the `CreateInvoice` request. If you do not  provide `idempotency_key` (or provide an empty string as the value), the endpoint  treats each request as independent.  For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Describes a `CreateInvoice` request.

type CreateInvoiceResponse ¶

type CreateInvoiceResponse struct {
	Invoice *Invoice `json:"invoice,omitempty"`
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

The response returned by the `CreateInvoice` request.

type CreateLocationCustomAttributeDefinitionRequest ¶

type CreateLocationCustomAttributeDefinitionRequest struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition"`
	// 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).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Represents a [CreateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/create-location-custom-attribute-definition) request.

type CreateLocationCustomAttributeDefinitionResponse ¶

type CreateLocationCustomAttributeDefinitionResponse struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [CreateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/create-location-custom-attribute-definition) response. Either `custom_attribute_definition` or `errors` is present in the response.

type CreateLocationRequest ¶

type CreateLocationRequest struct {
	Location *Location `json:"location,omitempty"`
}

The request object for the [CreateLocation](https://developer.squareup.com/reference/square_2024-07-17/locations-api/create-location) endpoint.

type CreateLocationResponse ¶

type CreateLocationResponse struct {
	// Information about [errors](https://developer.squareup.com/docs/build-basics/handling-errors) encountered during the request.
	Errors   []ModelError `json:"errors,omitempty"`
	Location *Location    `json:"location,omitempty"`
}

The response object returned by the [CreateLocation](https://developer.squareup.com/reference/square_2024-07-17/locations-api/create-location) endpoint.

type CreateLoyaltyAccountRequest ¶

type CreateLoyaltyAccountRequest struct {
	LoyaltyAccount *LoyaltyAccount `json:"loyalty_account"`
	// A unique string that identifies this `CreateLoyaltyAccount` request.  Keys can be any valid string, but must be unique for every request.
	IdempotencyKey string `json:"idempotency_key"`
}

A request to create a new loyalty account.

type CreateLoyaltyAccountResponse ¶

type CreateLoyaltyAccountResponse struct {
	// Any errors that occurred during the request.
	Errors         []ModelError    `json:"errors,omitempty"`
	LoyaltyAccount *LoyaltyAccount `json:"loyalty_account,omitempty"`
}

A response that includes loyalty account created.

type CreateLoyaltyPromotionRequest ¶

type CreateLoyaltyPromotionRequest struct {
	LoyaltyPromotion *LoyaltyPromotion `json:"loyalty_promotion"`
	// A unique identifier for this request, which is used to ensure idempotency. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
	IdempotencyKey string `json:"idempotency_key"`
}

Represents a [CreateLoyaltyPromotion](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/create-loyalty-promotion) request.

type CreateLoyaltyPromotionResponse ¶

type CreateLoyaltyPromotionResponse struct {
	// Any errors that occurred during the request.
	Errors           []ModelError      `json:"errors,omitempty"`
	LoyaltyPromotion *LoyaltyPromotion `json:"loyalty_promotion,omitempty"`
}

Represents a [CreateLoyaltyPromotion](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/create-loyalty-promotion) response. Either `loyalty_promotion` or `errors` is present in the response.

type CreateLoyaltyRewardRequest ¶

type CreateLoyaltyRewardRequest struct {
	Reward *LoyaltyReward `json:"reward"`
	// A unique string that identifies this `CreateLoyaltyReward` request.  Keys can be any valid string, but must be unique for every request.
	IdempotencyKey string `json:"idempotency_key"`
}

A request to create a loyalty reward.

type CreateLoyaltyRewardResponse ¶

type CreateLoyaltyRewardResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError   `json:"errors,omitempty"`
	Reward *LoyaltyReward `json:"reward,omitempty"`
}

A response that includes the loyalty reward created.

type CreateMerchantCustomAttributeDefinitionRequest ¶

type CreateMerchantCustomAttributeDefinitionRequest struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition"`
	// 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).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Represents a [CreateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/create-merchant-custom-attribute-definition) request.

type CreateMerchantCustomAttributeDefinitionResponse ¶

type CreateMerchantCustomAttributeDefinitionResponse struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [CreateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/create-merchant-custom-attribute-definition) response. Either `custom_attribute_definition` or `errors` is present in the response.

type CreateMobileAuthorizationCodeRequest ¶

type CreateMobileAuthorizationCodeRequest struct {
	// The Square location ID that the authorization code should be tied to.
	LocationId string `json:"location_id,omitempty"`
}

Defines the body parameters that can be provided in a request to the `CreateMobileAuthorizationCode` endpoint.

type CreateMobileAuthorizationCodeResponse ¶

type CreateMobileAuthorizationCodeResponse struct {
	// The generated authorization code that connects a mobile application instance to a Square account.
	AuthorizationCode string `json:"authorization_code,omitempty"`
	// The timestamp when `authorization_code` expires, in [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, \"2016-09-04T23:59:33.123Z\").
	ExpiresAt string `json:"expires_at,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields that are included in the response body of a request to the `CreateMobileAuthorizationCode` endpoint.

type CreateOrderCustomAttributeDefinitionRequest ¶

type CreateOrderCustomAttributeDefinitionRequest struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition"`
	// 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).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Represents a create request for an order custom attribute definition.

type CreateOrderCustomAttributeDefinitionResponse ¶

type CreateOrderCustomAttributeDefinitionResponse struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response from creating an order custom attribute definition.

type CreateOrderRequest ¶

type CreateOrderRequest struct {
	Order *Order `json:"order,omitempty"`
	// A value you specify that uniquely identifies this order among orders you have created.  If you are unsure whether a particular order was created successfully, you can try it again with the same idempotency key without worrying about creating duplicate orders.  For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

type CreateOrderResponse ¶

type CreateOrderResponse struct {
	Order *Order `json:"order,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields that are included in the response body of a request to the `CreateOrder` endpoint. Either `errors` or `order` is present in a given response, but never both.

type CreatePaymentLinkRequest ¶

type CreatePaymentLinkRequest struct {
	// A unique string that identifies this `CreatePaymentLinkRequest` request. If you do not provide a unique string (or provide an empty string as the value), the endpoint treats each request as independent.  For more information, see [Idempotency](https://developer.squareup.com/docs/docs/working-with-apis/idempotency).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
	// A description of the payment link. You provide this optional description that is useful in your application context. It is not used anywhere.
	Description      string            `json:"description,omitempty"`
	QuickPay         *QuickPay         `json:"quick_pay,omitempty"`
	Order            *Order            `json:"order,omitempty"`
	CheckoutOptions  *CheckoutOptions  `json:"checkout_options,omitempty"`
	PrePopulatedData *PrePopulatedData `json:"pre_populated_data,omitempty"`
	// A note for the payment. After processing the payment, Square adds this note to the resulting `Payment`.
	PaymentNote string `json:"payment_note,omitempty"`
}

type CreatePaymentLinkResponse ¶

type CreatePaymentLinkResponse struct {
	// Any errors that occurred during the request.
	Errors           []ModelError                 `json:"errors,omitempty"`
	PaymentLink      *PaymentLink                 `json:"payment_link,omitempty"`
	RelatedResources *PaymentLinkRelatedResources `json:"related_resources,omitempty"`
}

type CreatePaymentRequest ¶

type CreatePaymentRequest struct {
	// The ID for the source of funds for this payment. This could be a payment token generated by the Web Payments SDK for any of its [supported methods](https://developer.squareup.com/docs/web-payments/overview#explore-payment-methods), including cards, bank transfers, Afterpay or Cash App Pay. If recording a payment that the seller received outside of Square, specify either \"CASH\" or \"EXTERNAL\". For more information, see  [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments).
	SourceId string `json:"source_id"`
	// A unique string that identifies this `CreatePayment` request. Keys can be any valid string but must be unique for every `CreatePayment` request.  Note: The number of allowed characters might be less than the stated maximum, if multi-byte characters are used.  For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
	IdempotencyKey string `json:"idempotency_key"`
	AmountMoney    *Money `json:"amount_money,omitempty"`
	TipMoney       *Money `json:"tip_money,omitempty"`
	AppFeeMoney    *Money `json:"app_fee_money,omitempty"`
	// The duration of time after the payment's creation when Square automatically  either completes or cancels the payment depending on the `delay_action` field value.  For more information, see  [Time threshold](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold).   This parameter should be specified as a time duration, in RFC 3339 format.  Note: This feature is only supported for card payments. This parameter can only be set for a delayed capture payment (`autocomplete=false`).  Default:  - Card-present payments: \"PT36H\" (36 hours) from the creation time. - Card-not-present payments: \"P7D\" (7 days) from the creation time.
	DelayDuration string `json:"delay_duration,omitempty"`
	// The action to be applied to the payment when the `delay_duration` has elapsed. The action must be CANCEL or COMPLETE. For more information, see  [Time Threshold](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold).   Default: CANCEL
	DelayAction string `json:"delay_action,omitempty"`
	// If set to `true`, this payment will be completed when possible. If set to `false`, this payment is held in an approved state until either explicitly completed (captured) or canceled (voided). For more information, see [Delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment).  Default: true
	Autocomplete bool `json:"autocomplete,omitempty"`
	// Associates a previously created order with this payment.
	OrderId string `json:"order_id,omitempty"`
	// The [Customer](https://developer.squareup.com/reference/square_2024-07-17/objects/Customer) ID of the customer associated with the payment.  This is required if the `source_id` refers to a card on file created using the Cards API.
	CustomerId string `json:"customer_id,omitempty"`
	// The location ID to associate with the payment. If not specified, the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location) is used.
	LocationId string `json:"location_id,omitempty"`
	// An optional [TeamMember](https://developer.squareup.com/reference/square_2024-07-17/objects/TeamMember) ID to associate with  this payment.
	TeamMemberId string `json:"team_member_id,omitempty"`
	// A user-defined ID to associate with the payment.  You can use this field to associate the payment to an entity in an external system  (for example, you might specify an order ID that is generated by a third-party shopping cart).
	ReferenceId string `json:"reference_id,omitempty"`
	// An identifying token generated by [payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer). Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity.  For more information, see [SCA Overview](https://developer.squareup.com/docs/sca-overview).
	VerificationToken string `json:"verification_token,omitempty"`
	// If set to `true` and charging a Square Gift Card, a payment might be returned with `amount_money` equal to less than what was requested. For example, a request for $20 when charging a Square Gift Card with a balance of $5 results in an APPROVED payment of $5. You might choose to prompt the buyer for an additional payment to cover the remainder or cancel the Gift Card payment. This field cannot be `true` when `autocomplete = true`.  For more information, see [Partial amount with Square Gift Cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card).  Default: false
	AcceptPartialAuthorization bool `json:"accept_partial_authorization,omitempty"`
	// The buyer's email address.
	BuyerEmailAddress string   `json:"buyer_email_address,omitempty"`
	BillingAddress    *Address `json:"billing_address,omitempty"`
	ShippingAddress   *Address `json:"shipping_address,omitempty"`
	// An optional note to be entered by the developer when creating a payment.
	Note string `json:"note,omitempty"`
	// Optional additional payment information to include on the customer's card statement as part of the statement description. This can be, for example, an invoice number, ticket number, or short description that uniquely identifies the purchase.  Note that the `statement_description_identifier` might get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the seller taking the payment.
	StatementDescriptionIdentifier string                  `json:"statement_description_identifier,omitempty"`
	CashDetails                    *CashPaymentDetails     `json:"cash_details,omitempty"`
	ExternalDetails                *ExternalPaymentDetails `json:"external_details,omitempty"`
	CustomerDetails                *CustomerDetails        `json:"customer_details,omitempty"`
}

Describes a request to create a payment using [CreatePayment](https://developer.squareup.com/reference/square_2024-07-17/payments-api/create-payment).

type CreatePaymentResponse ¶

type CreatePaymentResponse struct {
	// Information about errors encountered during the request.
	Errors  []ModelError `json:"errors,omitempty"`
	Payment *Payment     `json:"payment,omitempty"`
}

Defines the response returned by [CreatePayment](https://developer.squareup.com/reference/square_2024-07-17/payments-api/create-payment). If there are errors processing the request, the `payment` field might not be present, or it might be present with a status of `FAILED`.

type CreateRefundRequest ¶

type CreateRefundRequest struct {
	// A value you specify that uniquely identifies this refund among refunds you've created for the tender.  If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund.  See [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency) for more information.
	IdempotencyKey string `json:"idempotency_key"`
	// The ID of the tender to refund.  A [`Transaction`](https://developer.squareup.com/reference/square_2024-07-17/objects/Transaction) has one or more `tenders` (i.e., methods of payment) associated with it, and you refund each tender separately with the Connect API.
	TenderId string `json:"tender_id"`
	// A description of the reason for the refund.  Default value: `Refund via API`
	Reason      string `json:"reason,omitempty"`
	AmountMoney *Money `json:"amount_money"`
}

Defines the body parameters that can be included in a request to the [CreateRefund](https://developer.squareup.com/reference/square_2024-07-17/transactions-api/create-refund) endpoint. Deprecated - recommend using [RefundPayment](https://developer.squareup.com/reference/square_2024-07-17/refunds-api/refund-payment)

type CreateRefundResponse ¶

type CreateRefundResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	Refund *Refund      `json:"refund,omitempty"`
}

Defines the fields that are included in the response body of a request to the [CreateRefund](https://developer.squareup.com/reference/square_2024-07-17/transactions-api/create-refund) endpoint. One of `errors` or `refund` is present in a given response (never both).

type CreateShiftRequest ¶

type CreateShiftRequest struct {
	// A unique string value to ensure the idempotency of the operation.
	IdempotencyKey string `json:"idempotency_key,omitempty"`
	Shift          *Shift `json:"shift"`
}

Represents a request to create a `Shift`.

type CreateShiftResponse ¶

type CreateShiftResponse struct {
	Shift *Shift `json:"shift,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

The response to a request to create a `Shift`. The response contains the created `Shift` object and might contain a set of `Error` objects if the request resulted in errors.

type CreateSubscriptionRequest ¶

type CreateSubscriptionRequest struct {
	// A unique string that identifies this `CreateSubscription` request. If you do not provide a unique string (or provide an empty string as the value), the endpoint treats each request as independent.  For more information, see [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
	// The ID of the location the subscription is associated with.
	LocationId string `json:"location_id"`
	// The ID of the [subscription plan variation](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations#plan-variations) created using the Catalog API.
	PlanVariationId string `json:"plan_variation_id,omitempty"`
	// The ID of the [customer](https://developer.squareup.com/reference/square_2024-07-17/objects/Customer) subscribing to the subscription plan variation.
	CustomerId string `json:"customer_id"`
	// The `YYYY-MM-DD`-formatted date to start the subscription.  If it is unspecified, the subscription starts immediately.
	StartDate string `json:"start_date,omitempty"`
	// The `YYYY-MM-DD`-formatted date when the newly created subscription is scheduled for cancellation.   This date overrides the cancellation date set in the plan variation configuration. If the cancellation date is earlier than the end date of a subscription cycle, the subscription stops at the canceled date and the subscriber is sent a prorated invoice at the beginning of the canceled cycle.   When the subscription plan of the newly created subscription has a fixed number of cycles and the `canceled_date` occurs before the subscription plan expires, the specified `canceled_date` sets the date when the subscription  stops through the end of the last cycle.
	CanceledDate string `json:"canceled_date,omitempty"`
	// The tax to add when billing the subscription. The percentage is expressed in decimal form, using a `'.'` as the decimal separator and without a `'%'` sign. For example, a value of 7.5 corresponds to 7.5%.
	TaxPercentage      string `json:"tax_percentage,omitempty"`
	PriceOverrideMoney *Money `json:"price_override_money,omitempty"`
	// The ID of the [subscriber's](https://developer.squareup.com/reference/square_2024-07-17/objects/Customer) [card](https://developer.squareup.com/reference/square_2024-07-17/objects/Card) to charge. If it is not specified, the subscriber receives an invoice via email with a link to pay for their subscription.
	CardId string `json:"card_id,omitempty"`
	// The timezone that is used in date calculations for the subscription. If unset, defaults to the location timezone. If a timezone is not configured for the location, defaults to \"America/New_York\". Format: the IANA Timezone Database identifier for the location timezone. For a list of time zones, see [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
	Timezone string              `json:"timezone,omitempty"`
	Source   *SubscriptionSource `json:"source,omitempty"`
	// The day-of-the-month to change the billing date to.
	MonthlyBillingAnchorDate int32 `json:"monthly_billing_anchor_date,omitempty"`
	// array of phases for this subscription
	Phases []Phase `json:"phases,omitempty"`
}

Defines input parameters in a request to the [CreateSubscription](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/create-subscription) endpoint.

type CreateSubscriptionResponse ¶

type CreateSubscriptionResponse struct {
	// Errors encountered during the request.
	Errors       []ModelError  `json:"errors,omitempty"`
	Subscription *Subscription `json:"subscription,omitempty"`
}

Defines output parameters in a response from the [CreateSubscription](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/create-subscription) endpoint.

type CreateTeamMemberRequest ¶

type CreateTeamMemberRequest struct {
	// A unique string that identifies this `CreateTeamMember` request. Keys can be any valid string, but must be unique for every request. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).  The minimum length is 1 and the maximum length is 45.
	IdempotencyKey string      `json:"idempotency_key,omitempty"`
	TeamMember     *TeamMember `json:"team_member,omitempty"`
}

Represents a create request for a `TeamMember` object.

type CreateTeamMemberResponse ¶

type CreateTeamMemberResponse struct {
	TeamMember *TeamMember `json:"team_member,omitempty"`
	// The errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response from a create request containing the created `TeamMember` object or error messages.

type CreateTerminalActionRequest ¶

type CreateTerminalActionRequest struct {
	// A unique string that identifies this `CreateAction` request. Keys can be any valid string but must be unique for every `CreateAction` request.  See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.
	IdempotencyKey string          `json:"idempotency_key"`
	Action         *TerminalAction `json:"action"`
}

type CreateTerminalActionResponse ¶

type CreateTerminalActionResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError    `json:"errors,omitempty"`
	Action *TerminalAction `json:"action,omitempty"`
}

type CreateTerminalCheckoutRequest ¶

type CreateTerminalCheckoutRequest struct {
	// A unique string that identifies this `CreateCheckout` request. Keys can be any valid string but must be unique for every `CreateCheckout` request.  See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.
	IdempotencyKey string            `json:"idempotency_key"`
	Checkout       *TerminalCheckout `json:"checkout"`
}

type CreateTerminalCheckoutResponse ¶

type CreateTerminalCheckoutResponse struct {
	// Information about errors encountered during the request.
	Errors   []ModelError      `json:"errors,omitempty"`
	Checkout *TerminalCheckout `json:"checkout,omitempty"`
}

type CreateTerminalRefundRequest ¶

type CreateTerminalRefundRequest struct {
	// A unique string that identifies this `CreateRefund` request. Keys can be any valid string but must be unique for every `CreateRefund` request.  See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.
	IdempotencyKey string          `json:"idempotency_key"`
	Refund         *TerminalRefund `json:"refund,omitempty"`
}

type CreateTerminalRefundResponse ¶

type CreateTerminalRefundResponse struct {
	// Information about errors encountered during the request.
	Errors []ModelError    `json:"errors,omitempty"`
	Refund *TerminalRefund `json:"refund,omitempty"`
}

type CreateVendorRequest ¶

type CreateVendorRequest struct {
	// A client-supplied, universally unique identifier (UUID) to make this [CreateVendor](https://developer.squareup.com/reference/square_2024-07-17/vendors-api/create-vendor) call idempotent.  See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more information.
	IdempotencyKey string  `json:"idempotency_key"`
	Vendor         *Vendor `json:"vendor,omitempty"`
}

Represents an input to a call to [CreateVendor](https://developer.squareup.com/reference/square_2024-07-17/vendors-api/create-vendor).

type CreateVendorResponse ¶

type CreateVendorResponse struct {
	// Errors encountered when the request fails.
	Errors []ModelError `json:"errors,omitempty"`
	Vendor *Vendor      `json:"vendor,omitempty"`
}

Represents an output from a call to [CreateVendor](https://developer.squareup.com/reference/square_2024-07-17/vendors-api/create-vendor).

type CreateWebhookSubscriptionRequest ¶

type CreateWebhookSubscriptionRequest struct {
	// A unique string that identifies the [CreateWebhookSubscription](https://developer.squareup.com/reference/square_2024-07-17/webhook-subscriptions-api/create-webhook-subscription) request.
	IdempotencyKey string               `json:"idempotency_key,omitempty"`
	Subscription   *WebhookSubscription `json:"subscription"`
}

Creates a Subscription(https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription).

type CreateWebhookSubscriptionResponse ¶

type CreateWebhookSubscriptionResponse struct {
	// Information on errors encountered during the request.
	Errors       []ModelError         `json:"errors,omitempty"`
	Subscription *WebhookSubscription `json:"subscription,omitempty"`
}

Defines the fields that are included in the response body of a request to the [CreateWebhookSubscription](https://developer.squareup.com/reference/square_2024-07-17/webhook-subscriptions-api/create-webhook-subscription) endpoint. Note: if there are errors processing the request, the Subscription(https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription) will not be present.

type Currency ¶

type Currency string

Currency : Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO_4217).

const (
	UNKNOWN_CURRENCY_Currency Currency = "UNKNOWN_CURRENCY"
	AED_Currency              Currency = "AED"
	AFN_Currency              Currency = "AFN"
	ALL_Currency              Currency = "ALL"
	AMD_Currency              Currency = "AMD"
	ANG_Currency              Currency = "ANG"
	AOA_Currency              Currency = "AOA"
	ARS_Currency              Currency = "ARS"
	AUD_Currency              Currency = "AUD"
	AWG_Currency              Currency = "AWG"
	AZN_Currency              Currency = "AZN"
	BAM_Currency              Currency = "BAM"
	BBD_Currency              Currency = "BBD"
	BDT_Currency              Currency = "BDT"
	BGN_Currency              Currency = "BGN"
	BHD_Currency              Currency = "BHD"
	BIF_Currency              Currency = "BIF"
	BMD_Currency              Currency = "BMD"
	BND_Currency              Currency = "BND"
	BOB_Currency              Currency = "BOB"
	BOV_Currency              Currency = "BOV"
	BRL_Currency              Currency = "BRL"
	BSD_Currency              Currency = "BSD"
	BTN_Currency              Currency = "BTN"
	BWP_Currency              Currency = "BWP"
	BYR_Currency              Currency = "BYR"
	BZD_Currency              Currency = "BZD"
	CAD_Currency              Currency = "CAD"
	CDF_Currency              Currency = "CDF"
	CHE_Currency              Currency = "CHE"
	CHF_Currency              Currency = "CHF"
	CHW_Currency              Currency = "CHW"
	CLF_Currency              Currency = "CLF"
	CLP_Currency              Currency = "CLP"
	CNY_Currency              Currency = "CNY"
	COP_Currency              Currency = "COP"
	COU_Currency              Currency = "COU"
	CRC_Currency              Currency = "CRC"
	CUC_Currency              Currency = "CUC"
	CUP_Currency              Currency = "CUP"
	CVE_Currency              Currency = "CVE"
	CZK_Currency              Currency = "CZK"
	DJF_Currency              Currency = "DJF"
	DKK_Currency              Currency = "DKK"
	DOP_Currency              Currency = "DOP"
	DZD_Currency              Currency = "DZD"
	EGP_Currency              Currency = "EGP"
	ERN_Currency              Currency = "ERN"
	ETB_Currency              Currency = "ETB"
	EUR_Currency              Currency = "EUR"
	FJD_Currency              Currency = "FJD"
	FKP_Currency              Currency = "FKP"
	GBP_Currency              Currency = "GBP"
	GEL_Currency              Currency = "GEL"
	GHS_Currency              Currency = "GHS"
	GIP_Currency              Currency = "GIP"
	GMD_Currency              Currency = "GMD"
	GNF_Currency              Currency = "GNF"
	GTQ_Currency              Currency = "GTQ"
	GYD_Currency              Currency = "GYD"
	HKD_Currency              Currency = "HKD"
	HNL_Currency              Currency = "HNL"
	HRK_Currency              Currency = "HRK"
	HTG_Currency              Currency = "HTG"
	HUF_Currency              Currency = "HUF"
	IDR_Currency              Currency = "IDR"
	ILS_Currency              Currency = "ILS"
	INR_Currency              Currency = "INR"
	IQD_Currency              Currency = "IQD"
	IRR_Currency              Currency = "IRR"
	ISK_Currency              Currency = "ISK"
	JMD_Currency              Currency = "JMD"
	JOD_Currency              Currency = "JOD"
	JPY_Currency              Currency = "JPY"
	KES_Currency              Currency = "KES"
	KGS_Currency              Currency = "KGS"
	KHR_Currency              Currency = "KHR"
	KMF_Currency              Currency = "KMF"
	KPW_Currency              Currency = "KPW"
	KRW_Currency              Currency = "KRW"
	KWD_Currency              Currency = "KWD"
	KYD_Currency              Currency = "KYD"
	KZT_Currency              Currency = "KZT"
	LAK_Currency              Currency = "LAK"
	LBP_Currency              Currency = "LBP"
	LKR_Currency              Currency = "LKR"
	LRD_Currency              Currency = "LRD"
	LSL_Currency              Currency = "LSL"
	LTL_Currency              Currency = "LTL"
	LVL_Currency              Currency = "LVL"
	LYD_Currency              Currency = "LYD"
	MAD_Currency              Currency = "MAD"
	MDL_Currency              Currency = "MDL"
	MGA_Currency              Currency = "MGA"
	MKD_Currency              Currency = "MKD"
	MMK_Currency              Currency = "MMK"
	MNT_Currency              Currency = "MNT"
	MOP_Currency              Currency = "MOP"
	MRO_Currency              Currency = "MRO"
	MUR_Currency              Currency = "MUR"
	MVR_Currency              Currency = "MVR"
	MWK_Currency              Currency = "MWK"
	MXN_Currency              Currency = "MXN"
	MXV_Currency              Currency = "MXV"
	MYR_Currency              Currency = "MYR"
	MZN_Currency              Currency = "MZN"
	NAD_Currency              Currency = "NAD"
	NGN_Currency              Currency = "NGN"
	NIO_Currency              Currency = "NIO"
	NOK_Currency              Currency = "NOK"
	NPR_Currency              Currency = "NPR"
	NZD_Currency              Currency = "NZD"
	OMR_Currency              Currency = "OMR"
	PAB_Currency              Currency = "PAB"
	PEN_Currency              Currency = "PEN"
	PGK_Currency              Currency = "PGK"
	PHP_Currency              Currency = "PHP"
	PKR_Currency              Currency = "PKR"
	PLN_Currency              Currency = "PLN"
	PYG_Currency              Currency = "PYG"
	QAR_Currency              Currency = "QAR"
	RON_Currency              Currency = "RON"
	RSD_Currency              Currency = "RSD"
	RUB_Currency              Currency = "RUB"
	RWF_Currency              Currency = "RWF"
	SAR_Currency              Currency = "SAR"
	SBD_Currency              Currency = "SBD"
	SCR_Currency              Currency = "SCR"
	SDG_Currency              Currency = "SDG"
	SEK_Currency              Currency = "SEK"
	SGD_Currency              Currency = "SGD"
	SHP_Currency              Currency = "SHP"
	SLL_Currency              Currency = "SLL"
	SOS_Currency              Currency = "SOS"
	SRD_Currency              Currency = "SRD"
	SSP_Currency              Currency = "SSP"
	STD_Currency              Currency = "STD"
	SVC_Currency              Currency = "SVC"
	SYP_Currency              Currency = "SYP"
	SZL_Currency              Currency = "SZL"
	THB_Currency              Currency = "THB"
	TJS_Currency              Currency = "TJS"
	TMT_Currency              Currency = "TMT"
	TND_Currency              Currency = "TND"
	TOP_Currency              Currency = "TOP"
	TRY_Currency              Currency = "TRY"
	TTD_Currency              Currency = "TTD"
	TWD_Currency              Currency = "TWD"
	TZS_Currency              Currency = "TZS"
	UAH_Currency              Currency = "UAH"
	UGX_Currency              Currency = "UGX"
	USD_Currency              Currency = "USD"
	USN_Currency              Currency = "USN"
	USS_Currency              Currency = "USS"
	UYI_Currency              Currency = "UYI"
	UYU_Currency              Currency = "UYU"
	UZS_Currency              Currency = "UZS"
	VEF_Currency              Currency = "VEF"
	VND_Currency              Currency = "VND"
	VUV_Currency              Currency = "VUV"
	WST_Currency              Currency = "WST"
	XAF_Currency              Currency = "XAF"
	XAG_Currency              Currency = "XAG"
	XAU_Currency              Currency = "XAU"
	XBA_Currency              Currency = "XBA"
	XBB_Currency              Currency = "XBB"
	XBC_Currency              Currency = "XBC"
	XBD_Currency              Currency = "XBD"
	XCD_Currency              Currency = "XCD"
	XDR_Currency              Currency = "XDR"
	XOF_Currency              Currency = "XOF"
	XPD_Currency              Currency = "XPD"
	XPF_Currency              Currency = "XPF"
	XPT_Currency              Currency = "XPT"
	XTS_Currency              Currency = "XTS"
	XXX_Currency              Currency = "XXX"
	YER_Currency              Currency = "YER"
	ZAR_Currency              Currency = "ZAR"
	ZMK_Currency              Currency = "ZMK"
	ZMW_Currency              Currency = "ZMW"
	BTC_Currency              Currency = "BTC"
	XUS_Currency              Currency = "XUS"
)

List of Currency

type CustomAttribute ¶

type CustomAttribute struct {
	// The identifier of the custom attribute definition and its corresponding custom attributes. This value can be a simple key, which is the key that is provided when the custom attribute definition is created, or a qualified key, if the requesting application is not the definition owner. The qualified key consists of the application ID of the custom attribute definition owner followed by the simple key that was provided when the definition was created. It has the format application_id:simple key.  The value for a simple key can contain up to 60 alphanumeric characters, periods (.), underscores (_), and hyphens (-).
	Key string `json:"key,omitempty"`
	// The value assigned to the custom attribute. It is validated against the custom attribute definition's schema on write operations. For more information about custom attribute values, see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).
	Value *interface{} `json:"value,omitempty"`
	// Read only. The current version of the custom attribute. This field is incremented when the custom attribute is changed. When updating an existing custom attribute value, you can provide this field and specify the current version of the custom attribute to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency). This field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads, see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).
	Version int32 `json:"version,omitempty"`
	// A copy of the `visibility` field value for the associated custom attribute definition.
	Visibility string                     `json:"visibility,omitempty"`
	Definition *CustomAttributeDefinition `json:"definition,omitempty"`
	// The timestamp that indicates when the custom attribute was created or was most recently updated, in RFC 3339 format.
	UpdatedAt string `json:"updated_at,omitempty"`
	// The timestamp that indicates when the custom attribute was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
}

A custom attribute value. Each custom attribute value has a corresponding `CustomAttributeDefinition` object.

type CustomAttributeDefinition ¶

type CustomAttributeDefinition struct {
	// The identifier of the custom attribute definition and its corresponding custom attributes. This value can be a simple key, which is the key that is provided when the custom attribute definition is created, or a qualified key, if the requesting application is not the definition owner. The qualified key consists of the application ID of the custom attribute definition owner followed by the simple key that was provided when the definition was created. It has the format application_id:simple key.  The value for a simple key can contain up to 60 alphanumeric characters, periods (.), underscores (_), and hyphens (-).  This field can not be changed after the custom attribute definition is created. This field is required when creating a definition and must be unique per application, seller, and resource type.
	Key string `json:"key,omitempty"`
	// The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information, see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition.
	Schema *interface{} `json:"schema,omitempty"`
	// The name of the custom attribute definition for API and seller-facing UI purposes. The name must be unique within the seller and application pair. This field is required if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
	Name string `json:"name,omitempty"`
	// Seller-oriented description of the custom attribute definition, including any constraints that the seller should observe. May be displayed as a tooltip in Square UIs. This field is required if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
	Description string `json:"description,omitempty"`
	// Specifies how the custom attribute definition and its values should be shared with the seller and other applications. If no value is specified, the value defaults to `VISIBILITY_HIDDEN`.
	Visibility string `json:"visibility,omitempty"`
	// Read only. The current version of the custom attribute definition. The value is incremented each time the custom attribute definition is updated. When updating a custom attribute definition, you can provide this field and specify the current version of the custom attribute definition to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).  On writes, this field must be set to the latest version. Stale writes are rejected.  This field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads, see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).
	Version int32 `json:"version,omitempty"`
	// The timestamp that indicates when the custom attribute definition was created or most recently updated, in RFC 3339 format.
	UpdatedAt string `json:"updated_at,omitempty"`
	// The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
}

Represents a definition for custom attribute values. A custom attribute definition specifies the key, visibility, schema, and other properties for a custom attribute.

type CustomAttributeDefinitionVisibility ¶

type CustomAttributeDefinitionVisibility string

CustomAttributeDefinitionVisibility : The level of permission that a seller or other applications requires to view this custom attribute definition. The `Visibility` field controls who can read and write the custom attribute values and custom attribute definition.

const (
	HIDDEN_CustomAttributeDefinitionVisibility            CustomAttributeDefinitionVisibility = "VISIBILITY_HIDDEN"
	READ_ONLY_CustomAttributeDefinitionVisibility         CustomAttributeDefinitionVisibility = "VISIBILITY_READ_ONLY"
	READ_WRITE_VALUES_CustomAttributeDefinitionVisibility CustomAttributeDefinitionVisibility = "VISIBILITY_READ_WRITE_VALUES"
)

List of CustomAttributeDefinitionVisibility

type CustomAttributeFilter ¶

type CustomAttributeFilter struct {
	// A query expression to filter items or item variations by matching their custom attributes' `custom_attribute_definition_id` property value against the the specified id. Exactly one of `custom_attribute_definition_id` or `key` must be specified.
	CustomAttributeDefinitionId string `json:"custom_attribute_definition_id,omitempty"`
	// A query expression to filter items or item variations by matching their custom attributes' `key` property value against the specified key. Exactly one of `custom_attribute_definition_id` or `key` must be specified.
	Key string `json:"key,omitempty"`
	// A query expression to filter items or item variations by matching their custom attributes' `string_value`  property value against the specified text. Exactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified.
	StringFilter string      `json:"string_filter,omitempty"`
	NumberFilter *ModelRange `json:"number_filter,omitempty"`
	// A query expression to filter items or item variations by matching  their custom attributes' `selection_uid_values` values against the specified selection uids. Exactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified.
	SelectionUidsFilter []string `json:"selection_uids_filter,omitempty"`
	// A query expression to filter items or item variations by matching their custom attributes' `boolean_value` property values against the specified Boolean expression. Exactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified.
	BoolFilter bool `json:"bool_filter,omitempty"`
}

Supported custom attribute query expressions for calling the [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-07-17/catalog-api/search-catalog-items) endpoint to search for items or item variations.

type CustomField ¶

type CustomField struct {
	// The title of the custom field.
	Title string `json:"title"`
}

Describes a custom form field to add to the checkout page to collect more information from buyers during checkout. For more information, see [Specify checkout options](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations#specify-checkout-options-1).

type Customer ¶

type Customer struct {
	// A unique Square-assigned ID for the customer profile.  If you need this ID for an API request, use the ID returned when you created the customer profile or call the [SearchCustomers](https://developer.squareup.com/reference/square_2024-07-17/customers-api/search-customers)  or [ListCustomers](https://developer.squareup.com/reference/square_2024-07-17/customers-api/list-customers) endpoint.
	Id string `json:"id,omitempty"`
	// The timestamp when the customer profile was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp when the customer profile was last updated, in RFC 3339 format.
	UpdatedAt string `json:"updated_at,omitempty"`
	// Payment details of the credit, debit, and gift cards stored on file for the customer profile.   DEPRECATED at version 2021-06-16. Replaced by calling [ListCards](https://developer.squareup.com/reference/square_2024-07-17/cards-api/list-cards) (for credit and debit cards on file)  or [ListGiftCards](https://developer.squareup.com/reference/square_2024-07-17/gift-cards-api/list-gift-cards) (for gift cards on file) and including the `customer_id` query parameter.  For more information, see [Migration notes](https://developer.squareup.com/docs/customers-api/what-it-does#migrate-customer-cards).
	Cards []Card `json:"cards,omitempty"`
	// The given name (that is, the first name) associated with the customer profile.
	GivenName string `json:"given_name,omitempty"`
	// The family name (that is, the last name) associated with the customer profile.
	FamilyName string `json:"family_name,omitempty"`
	// A nickname for the customer profile.
	Nickname string `json:"nickname,omitempty"`
	// A business name associated with the customer profile.
	CompanyName string `json:"company_name,omitempty"`
	// The email address associated with the customer profile.
	EmailAddress string   `json:"email_address,omitempty"`
	Address      *Address `json:"address,omitempty"`
	// The phone number associated with the customer profile.
	PhoneNumber string `json:"phone_number,omitempty"`
	// The birthday associated with the customer profile, in `YYYY-MM-DD` format. For example, `1998-09-21` represents September 21, 1998, and `0000-09-21` represents September 21 (without a birth year).
	Birthday string `json:"birthday,omitempty"`
	// An optional second ID used to associate the customer profile with an entity in another system.
	ReferenceId string `json:"reference_id,omitempty"`
	// A custom note associated with the customer profile.
	Note        string               `json:"note,omitempty"`
	Preferences *CustomerPreferences `json:"preferences,omitempty"`
	// The method used to create the customer profile.
	CreationSource string `json:"creation_source,omitempty"`
	// The IDs of [customer groups](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomerGroup) the customer belongs to.
	GroupIds []string `json:"group_ids,omitempty"`
	// The IDs of [customer segments](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomerSegment) the customer belongs to.
	SegmentIds []string `json:"segment_ids,omitempty"`
	// The Square-assigned version number of the customer profile. The version number is incremented each time an update is committed to the customer profile, except for changes to customer segment membership and cards on file.
	Version int64   `json:"version,omitempty"`
	TaxIds  *TaxIds `json:"tax_ids,omitempty"`
}

Represents a Square customer profile in the Customer Directory of a Square seller.

type CustomerAddressFilter ¶

type CustomerAddressFilter struct {
	PostalCode *CustomerTextFilter `json:"postal_code,omitempty"`
	// The country code to search for.
	Country string `json:"country,omitempty"`
}

The customer address filter. This filter is used in a CustomerCustomAttributeFilterValue(https://developer.squareup.com/reference/square_2024-07-17/objects/CustomerCustomAttributeFilterValue) filter when searching by an `Address`-type custom attribute.

type CustomerCreationSource ¶

type CustomerCreationSource string

CustomerCreationSource : Indicates the method used to create the customer profile.

const (
	OTHER_CustomerCreationSource              CustomerCreationSource = "OTHER"
	APPOINTMENTS_CustomerCreationSource       CustomerCreationSource = "APPOINTMENTS"
	COUPON_CustomerCreationSource             CustomerCreationSource = "COUPON"
	DELETION_RECOVERY_CustomerCreationSource  CustomerCreationSource = "DELETION_RECOVERY"
	DIRECTORY_CustomerCreationSource          CustomerCreationSource = "DIRECTORY"
	EGIFTING_CustomerCreationSource           CustomerCreationSource = "EGIFTING"
	EMAIL_COLLECTION_CustomerCreationSource   CustomerCreationSource = "EMAIL_COLLECTION"
	FEEDBACK_CustomerCreationSource           CustomerCreationSource = "FEEDBACK"
	IMPORT__CustomerCreationSource            CustomerCreationSource = "IMPORT"
	INVOICES_CustomerCreationSource           CustomerCreationSource = "INVOICES"
	LOYALTY_CustomerCreationSource            CustomerCreationSource = "LOYALTY"
	MARKETING_CustomerCreationSource          CustomerCreationSource = "MARKETING"
	MERGE_CustomerCreationSource              CustomerCreationSource = "MERGE"
	ONLINE_STORE_CustomerCreationSource       CustomerCreationSource = "ONLINE_STORE"
	INSTANT_PROFILE_CustomerCreationSource    CustomerCreationSource = "INSTANT_PROFILE"
	TERMINAL_CustomerCreationSource           CustomerCreationSource = "TERMINAL"
	THIRD_PARTY_CustomerCreationSource        CustomerCreationSource = "THIRD_PARTY"
	THIRD_PARTY_IMPORT_CustomerCreationSource CustomerCreationSource = "THIRD_PARTY_IMPORT"
	UNMERGE_RECOVERY_CustomerCreationSource   CustomerCreationSource = "UNMERGE_RECOVERY"
)

List of CustomerCreationSource

type CustomerCreationSourceFilter ¶

type CustomerCreationSourceFilter struct {
	// The list of creation sources used as filtering criteria.
	Values []string `json:"values,omitempty"`
	// Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result.  Default: `INCLUDE`.
	Rule string `json:"rule,omitempty"`
}

The creation source filter. If one or more creation sources are set, customer profiles are included in, or excluded from, the result if they match at least one of the filter criteria.

type CustomerCustomAttributeFilter ¶

type CustomerCustomAttributeFilter struct {
	// The `key` of the [custom attribute](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttribute) to filter by. The key is the identifier of the custom attribute (and the corresponding custom attribute definition) and can be retrieved using the [Customer Custom Attributes API](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api).
	Key       string                              `json:"key"`
	Filter    *CustomerCustomAttributeFilterValue `json:"filter,omitempty"`
	UpdatedAt *TimeRange                          `json:"updated_at,omitempty"`
}

The custom attribute filter. Use this filter in a set of [custom attribute filters](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomerCustomAttributeFilters) to search based on the value or last updated date of a customer-related [custom attribute](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttribute).

type CustomerCustomAttributeFilterValue ¶

type CustomerCustomAttributeFilterValue struct {
	Email     *CustomerTextFilter `json:"email,omitempty"`
	Phone     *CustomerTextFilter `json:"phone,omitempty"`
	Text      *CustomerTextFilter `json:"text,omitempty"`
	Selection *FilterValue        `json:"selection,omitempty"`
	Date      *TimeRange          `json:"date,omitempty"`
	Number    *FloatNumberRange   `json:"number,omitempty"`
	// A filter for a query based on the value of a `Boolean`-type custom attribute.
	Boolean bool                   `json:"boolean,omitempty"`
	Address *CustomerAddressFilter `json:"address,omitempty"`
}

A type-specific filter used in a [custom attribute filter](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomerCustomAttributeFilter) to search based on the value of a customer-related [custom attribute](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttribute).

type CustomerCustomAttributeFilters ¶

type CustomerCustomAttributeFilters struct {
	// The custom attribute filters. Each filter must specify `key` and include the `filter` field with a type-specific filter, the `updated_at` field, or both. The provided keys must be unique within the list of custom attribute filters.
	Filters []CustomerCustomAttributeFilter `json:"filters,omitempty"`
}

The custom attribute filters in a set of [customer filters](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomerFilter) used in a search query. Use this filter to search based on [custom attributes](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttribute) that are assigned to customer profiles. For more information, see [Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute).

type CustomerCustomAttributesApiListCustomerCustomAttributeDefinitionsOpts ¶

type CustomerCustomAttributesApiListCustomerCustomAttributeDefinitionsOpts struct {
	Limit  optional.Int32
	Cursor optional.String
}

type CustomerCustomAttributesApiListCustomerCustomAttributesOpts ¶

type CustomerCustomAttributesApiListCustomerCustomAttributesOpts struct {
	Limit           optional.Int32
	Cursor          optional.String
	WithDefinitions optional.Bool
}

type CustomerCustomAttributesApiRetrieveCustomerCustomAttributeDefinitionOpts ¶

type CustomerCustomAttributesApiRetrieveCustomerCustomAttributeDefinitionOpts struct {
	Version optional.Int32
}

type CustomerCustomAttributesApiRetrieveCustomerCustomAttributeOpts ¶

type CustomerCustomAttributesApiRetrieveCustomerCustomAttributeOpts struct {
	WithDefinition optional.Bool
	Version        optional.Int32
}

type CustomerCustomAttributesApiService ¶

type CustomerCustomAttributesApiService service

func (*CustomerCustomAttributesApiService) BulkUpsertCustomerCustomAttributes ¶

func (a *CustomerCustomAttributesApiService) BulkUpsertCustomerCustomAttributes(ctx context.Context, body BulkUpsertCustomerCustomAttributesRequest) (BulkUpsertCustomerCustomAttributesResponse, *http.Response, error)

CustomerCustomAttributesApiService BulkUpsertCustomerCustomAttributes Creates or updates [custom attributes](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttribute) for customer profiles as a bulk operation. Use this endpoint to set the value of one or more custom attributes for one or more customer profiles. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/create-customer-custom-attribute-definition) endpoint. This `BulkUpsertCustomerCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert requests and returns a map of individual upsert responses. Each upsert request has a unique ID and provides a customer ID and custom attribute. Each upsert response is returned with the ID of the corresponding request. To create or update a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkUpsertCustomerCustomAttributesResponse

func (*CustomerCustomAttributesApiService) CreateCustomerCustomAttributeDefinition ¶

func (a *CustomerCustomAttributesApiService) CreateCustomerCustomAttributeDefinition(ctx context.Context, body CreateCustomerCustomAttributeDefinitionRequest) (CreateCustomerCustomAttributeDefinitionResponse, *http.Response, error)

CustomerCustomAttributesApiService CreateCustomerCustomAttributeDefinition Creates a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttributeDefinition) for a Square seller account. Use this endpoint to define a custom attribute that can be associated with customer profiles. A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties for a custom attribute. After the definition is created, you can call [UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/upsert-customer-custom-attribute) or [BulkUpsertCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/bulk-upsert-customer-custom-attributes) to set the custom attribute for customer profiles in the seller's Customer Directory. Sellers can view all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateCustomerCustomAttributeDefinitionResponse

func (*CustomerCustomAttributesApiService) DeleteCustomerCustomAttribute ¶

func (a *CustomerCustomAttributesApiService) DeleteCustomerCustomAttribute(ctx context.Context, customerId string, key string) (DeleteCustomerCustomAttributeResponse, *http.Response, error)

CustomerCustomAttributesApiService DeleteCustomerCustomAttribute Deletes a [custom attribute](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttribute) associated with a customer profile. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerId The ID of the target [customer profile](https://developer.squareup.com/reference/square_2024-07-17/objects/Customer).
@param key The key of the custom attribute to delete. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.

@return DeleteCustomerCustomAttributeResponse

func (*CustomerCustomAttributesApiService) DeleteCustomerCustomAttributeDefinition ¶

func (a *CustomerCustomAttributesApiService) DeleteCustomerCustomAttributeDefinition(ctx context.Context, key string) (DeleteCustomerCustomAttributeDefinitionResponse, *http.Response, error)

CustomerCustomAttributesApiService DeleteCustomerCustomAttributeDefinition Deletes a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttributeDefinition) from a Square seller account. Deleting a custom attribute definition also deletes the corresponding custom attribute from all customer profiles in the seller's Customer Directory. Only the definition owner can delete a custom attribute definition.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param key The key of the custom attribute definition to delete.

@return DeleteCustomerCustomAttributeDefinitionResponse

func (*CustomerCustomAttributesApiService) ListCustomerCustomAttributeDefinitions ¶

func (a *CustomerCustomAttributesApiService) ListCustomerCustomAttributeDefinitions(ctx context.Context, localVarOptionals *CustomerCustomAttributesApiListCustomerCustomAttributeDefinitionsOpts) (ListCustomerCustomAttributeDefinitionsResponse, *http.Response, error)

func (*CustomerCustomAttributesApiService) ListCustomerCustomAttributes ¶

func (a *CustomerCustomAttributesApiService) ListCustomerCustomAttributes(ctx context.Context, customerId string, localVarOptionals *CustomerCustomAttributesApiListCustomerCustomAttributesOpts) (ListCustomerCustomAttributesResponse, *http.Response, error)

func (*CustomerCustomAttributesApiService) RetrieveCustomerCustomAttribute ¶

func (a *CustomerCustomAttributesApiService) RetrieveCustomerCustomAttribute(ctx context.Context, customerId string, key string, localVarOptionals *CustomerCustomAttributesApiRetrieveCustomerCustomAttributeOpts) (RetrieveCustomerCustomAttributeResponse, *http.Response, error)

func (*CustomerCustomAttributesApiService) RetrieveCustomerCustomAttributeDefinition ¶

func (a *CustomerCustomAttributesApiService) RetrieveCustomerCustomAttributeDefinition(ctx context.Context, key string, localVarOptionals *CustomerCustomAttributesApiRetrieveCustomerCustomAttributeDefinitionOpts) (RetrieveCustomerCustomAttributeDefinitionResponse, *http.Response, error)

func (*CustomerCustomAttributesApiService) UpdateCustomerCustomAttributeDefinition ¶

func (a *CustomerCustomAttributesApiService) UpdateCustomerCustomAttributeDefinition(ctx context.Context, body UpdateCustomerCustomAttributeDefinitionRequest, key string) (UpdateCustomerCustomAttributeDefinitionResponse, *http.Response, error)

CustomerCustomAttributesApiService UpdateCustomerCustomAttributeDefinition Updates a customer-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttributeDefinition) for a Square seller account. Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the `schema` for a `Selection` data type. Only the definition owner can update a custom attribute definition. Note that sellers can view all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param key The key of the custom attribute definition to update.

@return UpdateCustomerCustomAttributeDefinitionResponse

func (*CustomerCustomAttributesApiService) UpsertCustomerCustomAttribute ¶

func (a *CustomerCustomAttributesApiService) UpsertCustomerCustomAttribute(ctx context.Context, body UpsertCustomerCustomAttributeRequest, customerId string, key string) (UpsertCustomerCustomAttributeResponse, *http.Response, error)

CustomerCustomAttributesApiService UpsertCustomerCustomAttribute Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttribute) for a customer profile. Use this endpoint to set the value of a custom attribute for a specified customer profile. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the [CreateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/create-customer-custom-attribute-definition) endpoint. To create or update a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param customerId The ID of the target [customer profile](https://developer.squareup.com/reference/square_2024-07-17/objects/Customer).
@param key The key of the custom attribute to create or update. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.

@return UpsertCustomerCustomAttributeResponse

type CustomerDetails ¶

type CustomerDetails struct {
	// Indicates whether the customer initiated the payment.
	CustomerInitiated bool `json:"customer_initiated,omitempty"`
	// Indicates that the seller keyed in payment details on behalf of the customer. This is used to flag a payment as Mail Order / Telephone Order (MOTO).
	SellerKeyedIn bool `json:"seller_keyed_in,omitempty"`
}

Details about the customer making the payment.

type CustomerFilter ¶

type CustomerFilter struct {
	CreationSource  *CustomerCreationSourceFilter   `json:"creation_source,omitempty"`
	CreatedAt       *TimeRange                      `json:"created_at,omitempty"`
	UpdatedAt       *TimeRange                      `json:"updated_at,omitempty"`
	EmailAddress    *CustomerTextFilter             `json:"email_address,omitempty"`
	PhoneNumber     *CustomerTextFilter             `json:"phone_number,omitempty"`
	ReferenceId     *CustomerTextFilter             `json:"reference_id,omitempty"`
	GroupIds        *FilterValue                    `json:"group_ids,omitempty"`
	CustomAttribute *CustomerCustomAttributeFilters `json:"custom_attribute,omitempty"`
	SegmentIds      *FilterValue                    `json:"segment_ids,omitempty"`
}

Represents the filtering criteria in a [search query](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomerQuery) that defines how to filter customer profiles returned in [SearchCustomers](https://developer.squareup.com/reference/square_2024-07-17/customers-api/search-customers) results.

type CustomerGroup ¶

type CustomerGroup struct {
	// A unique Square-generated ID for the customer group.
	Id string `json:"id,omitempty"`
	// The name of the customer group.
	Name string `json:"name"`
	// The timestamp when the customer group was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp when the customer group was last updated, in RFC 3339 format.
	UpdatedAt string `json:"updated_at,omitempty"`
}

Represents a group of customer profiles. Customer groups can be created, be modified, and have their membership defined using the Customers API or within the Customer Directory in the Square Seller Dashboard or Point of Sale.

type CustomerGroupsApiListCustomerGroupsOpts ¶

type CustomerGroupsApiListCustomerGroupsOpts struct {
	Cursor optional.String
	Limit  optional.Int32
}

type CustomerGroupsApiService ¶

type CustomerGroupsApiService service

func (*CustomerGroupsApiService) CreateCustomerGroup ¶

func (a *CustomerGroupsApiService) CreateCustomerGroup(ctx context.Context, body CreateCustomerGroupRequest) (CreateCustomerGroupResponse, *http.Response, error)

CustomerGroupsApiService CreateCustomerGroup Creates a new customer group for a business. The request must include the `name` value of the group.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateCustomerGroupResponse

func (*CustomerGroupsApiService) DeleteCustomerGroup ¶

func (a *CustomerGroupsApiService) DeleteCustomerGroup(ctx context.Context, groupId string) (DeleteCustomerGroupResponse, *http.Response, error)

CustomerGroupsApiService DeleteCustomerGroup Deletes a customer group as identified by the `group_id` value.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId The ID of the customer group to delete.

@return DeleteCustomerGroupResponse

func (*CustomerGroupsApiService) ListCustomerGroups ¶

func (a *CustomerGroupsApiService) ListCustomerGroups(ctx context.Context, localVarOptionals *CustomerGroupsApiListCustomerGroupsOpts) (ListCustomerGroupsResponse, *http.Response, error)

func (*CustomerGroupsApiService) RetrieveCustomerGroup ¶

func (a *CustomerGroupsApiService) RetrieveCustomerGroup(ctx context.Context, groupId string) (RetrieveCustomerGroupResponse, *http.Response, error)

CustomerGroupsApiService RetrieveCustomerGroup Retrieves a specific customer group as identified by the `group_id` value.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param groupId The ID of the customer group to retrieve.

@return RetrieveCustomerGroupResponse

func (*CustomerGroupsApiService) UpdateCustomerGroup ¶

func (a *CustomerGroupsApiService) UpdateCustomerGroup(ctx context.Context, body UpdateCustomerGroupRequest, groupId string) (UpdateCustomerGroupResponse, *http.Response, error)

CustomerGroupsApiService UpdateCustomerGroup Updates a customer group as identified by the `group_id` value.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param groupId The ID of the customer group to update.

@return UpdateCustomerGroupResponse

type CustomerInclusionExclusion ¶

type CustomerInclusionExclusion string

CustomerInclusionExclusion : Indicates whether customers should be included in, or excluded from, the result set when they match the filtering criteria.

const (
	INCLUDE_CustomerInclusionExclusion CustomerInclusionExclusion = "INCLUDE"
	EXCLUDE_CustomerInclusionExclusion CustomerInclusionExclusion = "EXCLUDE"
)

List of CustomerInclusionExclusion

type CustomerPreferences ¶

type CustomerPreferences struct {
	// Indicates whether the customer has unsubscribed from marketing campaign emails. A value of `true` means that the customer chose to opt out of email marketing from the current Square seller or from all Square sellers. This value is read-only from the Customers API.
	EmailUnsubscribed bool `json:"email_unsubscribed,omitempty"`
}

Represents communication preferences for the customer profile.

type CustomerQuery ¶

type CustomerQuery struct {
	Filter *CustomerFilter `json:"filter,omitempty"`
	Sort   *CustomerSort   `json:"sort,omitempty"`
}

Represents filtering and sorting criteria for a [SearchCustomers](https://developer.squareup.com/reference/square_2024-07-17/customers-api/search-customers) request.

type CustomerSegment ¶

type CustomerSegment struct {
	// A unique Square-generated ID for the segment.
	Id string `json:"id,omitempty"`
	// The name of the segment.
	Name string `json:"name"`
	// The timestamp when the segment was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp when the segment was last updated, in RFC 3339 format.
	UpdatedAt string `json:"updated_at,omitempty"`
}

Represents a group of customer profiles that match one or more predefined filter criteria. Segments (also known as Smart Groups) are defined and created within the Customer Directory in the Square Seller Dashboard or Point of Sale.

type CustomerSegmentsApiListCustomerSegmentsOpts ¶

type CustomerSegmentsApiListCustomerSegmentsOpts struct {
	Cursor optional.String
	Limit  optional.Int32
}

type CustomerSegmentsApiService ¶

type CustomerSegmentsApiService service

func (*CustomerSegmentsApiService) ListCustomerSegments ¶

func (a *CustomerSegmentsApiService) ListCustomerSegments(ctx context.Context, localVarOptionals *CustomerSegmentsApiListCustomerSegmentsOpts) (ListCustomerSegmentsResponse, *http.Response, error)

func (*CustomerSegmentsApiService) RetrieveCustomerSegment ¶

func (a *CustomerSegmentsApiService) RetrieveCustomerSegment(ctx context.Context, segmentId string) (RetrieveCustomerSegmentResponse, *http.Response, error)

CustomerSegmentsApiService RetrieveCustomerSegment Retrieves a specific customer segment as identified by the `segment_id` value.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param segmentId The Square-issued ID of the customer segment.

@return RetrieveCustomerSegmentResponse

type CustomerSort ¶

type CustomerSort struct {
	// Indicates the fields to use as the sort key, which is either the default set of fields or `created_at`.  The default value is `DEFAULT`.
	Field string `json:"field,omitempty"`
	// Indicates the order in which results should be sorted based on the sort field value. Strings use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings.  The default value is `ASC`.
	Order string `json:"order,omitempty"`
}

Represents the sorting criteria in a [search query](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomerQuery) that defines how to sort customer profiles returned in [SearchCustomers](https://developer.squareup.com/reference/square_2024-07-17/customers-api/search-customers) results.

type CustomerSortField ¶

type CustomerSortField string

CustomerSortField : Specifies customer attributes as the sort key to customer profiles returned from a search.

const (
	DEFAULT__CustomerSortField   CustomerSortField = "DEFAULT"
	CREATED_AT_CustomerSortField CustomerSortField = "CREATED_AT"
)

List of CustomerSortField

type CustomerTaxIds ¶

type CustomerTaxIds struct {
	// The EU VAT identification number for the customer. For example, `IE3426675K`. The ID can contain alphanumeric characters only.
	EuVat string `json:"eu_vat,omitempty"`
}

Represents the tax ID associated with a [customer profile](https://developer.squareup.com/reference/square_2024-07-17/objects/Customer). The corresponding `tax_ids` field is available only for customers of sellers in EU countries or the United Kingdom. For more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids).

type CustomerTextFilter ¶

type CustomerTextFilter struct {
	// Use the exact filter to select customers whose attributes match exactly the specified query.
	Exact string `json:"exact,omitempty"`
	// Use the fuzzy filter to select customers whose attributes match the specified query  in a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then  each query token must be matched somewhere in the searched attribute. For single token queries,  this is effectively the same behavior as a partial match operation.
	Fuzzy string `json:"fuzzy,omitempty"`
}

A filter to select customers based on exact or fuzzy matching of customer attributes against a specified query. Depending on the customer attributes, the filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both.

type CustomersApiDeleteCustomerOpts ¶

type CustomersApiDeleteCustomerOpts struct {
	Version optional.Int64
}

type CustomersApiListCustomersOpts ¶

type CustomersApiListCustomersOpts struct {
	Cursor    optional.String
	Limit     optional.Int32
	SortField optional.String
	SortOrder optional.String
	Count     optional.Bool
}

type CustomersApiService ¶

type CustomersApiService service

func (*CustomersApiService) AddGroupToCustomer ¶

func (a *CustomersApiService) AddGroupToCustomer(ctx context.Context, customerId string, groupId string) (AddGroupToCustomerResponse, *http.Response, error)

CustomersApiService AddGroupToCustomer Adds a group membership to a customer. The customer is identified by the `customer_id` value and the customer group is identified by the `group_id` value.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerId The ID of the customer to add to a group.
@param groupId The ID of the customer group to add the customer to.

@return AddGroupToCustomerResponse

func (*CustomersApiService) BulkCreateCustomers ¶

func (a *CustomersApiService) BulkCreateCustomers(ctx context.Context, body BulkCreateCustomersRequest) (BulkCreateCustomersResponse, *http.Response, error)

CustomersApiService BulkCreateCustomers Creates multiple [customer profiles](https://developer.squareup.com/reference/square_2024-07-17/objects/Customer) for a business. This endpoint takes a map of individual create requests and returns a map of responses. You must provide at least one of the following values in each create request: - `given_name` - `family_name` - `company_name` - `email_address` - `phone_number`

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkCreateCustomersResponse

func (*CustomersApiService) BulkDeleteCustomers ¶

func (a *CustomersApiService) BulkDeleteCustomers(ctx context.Context, body BulkDeleteCustomersRequest) (BulkDeleteCustomersResponse, *http.Response, error)

CustomersApiService BulkDeleteCustomers Deletes multiple customer profiles. The endpoint takes a list of customer IDs and returns a map of responses.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkDeleteCustomersResponse

func (*CustomersApiService) BulkRetrieveCustomers ¶

func (a *CustomersApiService) BulkRetrieveCustomers(ctx context.Context, body BulkRetrieveCustomersRequest) (BulkRetrieveCustomersResponse, *http.Response, error)

CustomersApiService BulkRetrieveCustomers Retrieves multiple customer profiles. This endpoint takes a list of customer IDs and returns a map of responses.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkRetrieveCustomersResponse

func (*CustomersApiService) BulkUpdateCustomers ¶

func (a *CustomersApiService) BulkUpdateCustomers(ctx context.Context, body BulkUpdateCustomersRequest) (BulkUpdateCustomersResponse, *http.Response, error)

CustomersApiService BulkUpdateCustomers Updates multiple customer profiles. This endpoint takes a map of individual update requests and returns a map of responses. You cannot use this endpoint to change cards on file. To make changes, use the [Cards API](https://developer.squareup.com/reference/square_2024-07-17/cards-api) or [Gift Cards API](https://developer.squareup.com/reference/square_2024-07-17/gift-cards-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkUpdateCustomersResponse

func (*CustomersApiService) CreateCustomer ¶

func (a *CustomersApiService) CreateCustomer(ctx context.Context, body CreateCustomerRequest) (CreateCustomerResponse, *http.Response, error)

CustomersApiService CreateCustomer Creates a new customer for a business. You must provide at least one of the following values in your request to this endpoint: - `given_name` - `family_name` - `company_name` - `email_address` - `phone_number`

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateCustomerResponse

func (*CustomersApiService) CreateCustomerCard ¶

func (a *CustomersApiService) CreateCustomerCard(ctx context.Context, body CreateCustomerCardRequest, customerId string) (CreateCustomerCardResponse, *http.Response, error)

CustomersApiService CreateCustomerCard Adds a card on file to an existing customer. As with charges, calls to `CreateCustomerCard` are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the _first_ call.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param customerId The Square ID of the customer profile the card is linked to.

@return CreateCustomerCardResponse

func (*CustomersApiService) DeleteCustomer ¶

func (a *CustomersApiService) DeleteCustomer(ctx context.Context, customerId string, localVarOptionals *CustomersApiDeleteCustomerOpts) (DeleteCustomerResponse, *http.Response, error)

func (*CustomersApiService) DeleteCustomerCard ¶

func (a *CustomersApiService) DeleteCustomerCard(ctx context.Context, customerId string, cardId string) (DeleteCustomerCardResponse, *http.Response, error)

CustomersApiService DeleteCustomerCard Removes a card on file from a customer.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerId The ID of the customer that the card on file belongs to.
@param cardId The ID of the card on file to delete.

@return DeleteCustomerCardResponse

func (*CustomersApiService) ListCustomers ¶

func (a *CustomersApiService) ListCustomers(ctx context.Context, localVarOptionals *CustomersApiListCustomersOpts) (ListCustomersResponse, *http.Response, error)

func (*CustomersApiService) RemoveGroupFromCustomer ¶

func (a *CustomersApiService) RemoveGroupFromCustomer(ctx context.Context, customerId string, groupId string) (RemoveGroupFromCustomerResponse, *http.Response, error)

CustomersApiService RemoveGroupFromCustomer Removes a group membership from a customer. The customer is identified by the `customer_id` value and the customer group is identified by the `group_id` value.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerId The ID of the customer to remove from the group.
@param groupId The ID of the customer group to remove the customer from.

@return RemoveGroupFromCustomerResponse

func (*CustomersApiService) RetrieveCustomer ¶

func (a *CustomersApiService) RetrieveCustomer(ctx context.Context, customerId string) (RetrieveCustomerResponse, *http.Response, error)

CustomersApiService RetrieveCustomer Returns details for a single customer.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param customerId The ID of the customer to retrieve.

@return RetrieveCustomerResponse

func (*CustomersApiService) SearchCustomers ¶

func (a *CustomersApiService) SearchCustomers(ctx context.Context, body SearchCustomersRequest) (SearchCustomersResponse, *http.Response, error)

CustomersApiService SearchCustomers Searches the customer profiles associated with a Square account using one or more supported query filters. Calling `SearchCustomers` without any explicit query filter returns all customer profiles ordered alphabetically based on `given_name` and `family_name`. Under normal operating conditions, newly created or updated customer profiles become available for the search operation in well under 30 seconds. Occasionally, propagation of the new or updated profiles can take closer to one minute or longer, especially during network incidents and outages.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return SearchCustomersResponse

func (*CustomersApiService) UpdateCustomer ¶

func (a *CustomersApiService) UpdateCustomer(ctx context.Context, body UpdateCustomerRequest, customerId string) (UpdateCustomerResponse, *http.Response, error)

CustomersApiService UpdateCustomer Updates a customer profile. This endpoint supports sparse updates, so only new or changed fields are required in the request. To add or update a field, specify the new value. To remove a field, specify `null`. To update a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile. You cannot use this endpoint to change cards on file. To make changes, use the [Cards API](https://developer.squareup.com/reference/square_2024-07-17/cards-api) or [Gift Cards API](https://developer.squareup.com/reference/square_2024-07-17/gift-cards-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param customerId The ID of the customer to update.

@return UpdateCustomerResponse

type DataCollectionOptions ¶

type DataCollectionOptions struct {
	// The title text to display in the data collection flow on the Terminal.
	Title string `json:"title"`
	// The body text to display under the title in the data collection screen flow on the Terminal.
	Body string `json:"body"`
	// Represents the type of the input text.
	InputType     string         `json:"input_type"`
	CollectedData *CollectedData `json:"collected_data,omitempty"`
}

type DataCollectionOptionsInputType ¶

type DataCollectionOptionsInputType string

DataCollectionOptionsInputType : Describes the input type of the data.

const (
	EMAIL_DataCollectionOptionsInputType        DataCollectionOptionsInputType = "EMAIL"
	PHONE_NUMBER_DataCollectionOptionsInputType DataCollectionOptionsInputType = "PHONE_NUMBER"
)

List of DataCollectionOptionsInputType

type DateRange ¶

type DateRange struct {
	// A string in `YYYY-MM-DD` format, such as `2017-10-31`, per the ISO 8601 extended format for calendar dates. The beginning of a date range (inclusive).
	StartDate string `json:"start_date,omitempty"`
	// A string in `YYYY-MM-DD` format, such as `2017-10-31`, per the ISO 8601 extended format for calendar dates. The end of a date range (inclusive).
	EndDate string `json:"end_date,omitempty"`
}

A range defined by two dates. Used for filtering a query for Connect v2 objects that have date properties.

type DayOfWeek ¶

type DayOfWeek string

DayOfWeek : Indicates the specific day of the week.

const (
	SUN_DayOfWeek DayOfWeek = "SUN"
	MON_DayOfWeek DayOfWeek = "MON"
	TUE_DayOfWeek DayOfWeek = "TUE"
	WED_DayOfWeek DayOfWeek = "WED"
	THU_DayOfWeek DayOfWeek = "THU"
	FRI_DayOfWeek DayOfWeek = "FRI"
	SAT_DayOfWeek DayOfWeek = "SAT"
)

List of DayOfWeek

type DeleteBookingCustomAttributeDefinitionRequest ¶

type DeleteBookingCustomAttributeDefinitionRequest struct{}

Represents a [DeleteBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/delete-booking-custom-attribute-definition) request.

type DeleteBookingCustomAttributeDefinitionResponse ¶

type DeleteBookingCustomAttributeDefinitionResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [DeleteBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/delete-booking-custom-attribute-definition) response containing error messages when errors occurred during the request. The successful response does not contain any payload.

type DeleteBookingCustomAttributeRequest ¶

type DeleteBookingCustomAttributeRequest struct{}

Represents a [DeleteBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/delete-booking-custom-attribute) request.

type DeleteBookingCustomAttributeResponse ¶

type DeleteBookingCustomAttributeResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [DeleteBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/delete-booking-custom-attribute) response. Either an empty object `{}` (for a successful deletion) or `errors` is present in the response.

type DeleteBreakTypeRequest ¶

type DeleteBreakTypeRequest struct{}

A request to delete a `BreakType`.

type DeleteBreakTypeResponse ¶

type DeleteBreakTypeResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

The response to a request to delete a `BreakType`. The response might contain a set of `Error` objects if the request resulted in errors.

type DeleteCatalogObjectRequest ¶

type DeleteCatalogObjectRequest struct{}

type DeleteCatalogObjectResponse ¶

type DeleteCatalogObjectResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The IDs of all catalog objects deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a catalog item variation will be deleted (and its ID included in this field) when its parent catalog item is deleted.
	DeletedObjectIds []string `json:"deleted_object_ids,omitempty"`
	// The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`.
	DeletedAt string `json:"deleted_at,omitempty"`
}

type DeleteCustomerCardRequest ¶

type DeleteCustomerCardRequest struct{}

Defines the fields that are included in requests to the `DeleteCustomerCard` endpoint.

type DeleteCustomerCardResponse ¶

type DeleteCustomerCardResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields that are included in the response body of a request to the `DeleteCustomerCard` endpoint.

type DeleteCustomerCustomAttributeDefinitionRequest ¶

type DeleteCustomerCustomAttributeDefinitionRequest struct{}

Represents a [DeleteCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/delete-customer-custom-attribute-definition) request.

type DeleteCustomerCustomAttributeDefinitionResponse ¶

type DeleteCustomerCustomAttributeDefinitionResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response from a delete request containing error messages if there are any.

type DeleteCustomerCustomAttributeRequest ¶

type DeleteCustomerCustomAttributeRequest struct{}

Represents a [DeleteCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/delete-customer-custom-attribute) request.

type DeleteCustomerCustomAttributeResponse ¶

type DeleteCustomerCustomAttributeResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [DeleteCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/delete-customer-custom-attribute) response. Either an empty object `{}` (for a successful deletion) or `errors` is present in the response.

type DeleteCustomerGroupRequest ¶

type DeleteCustomerGroupRequest struct{}

Defines the fields that can be included in a request to the [DeleteCustomerGroup](https://developer.squareup.com/reference/square_2024-07-17/customer-groups-api/delete-customer-group) endpoint.

type DeleteCustomerGroupResponse ¶

type DeleteCustomerGroupResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields that are included in the response body of a request to the [DeleteCustomerGroup](https://developer.squareup.com/reference/square_2024-07-17/customer-groups-api/delete-customer-group) endpoint.

type DeleteCustomerRequest ¶

type DeleteCustomerRequest struct {
	// The current version of the customer profile.  As a best practice, you should include this parameter to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control.  For more information, see [Delete a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#delete-customer-profile).
	Version int64 `json:"version,omitempty"`
}

Defines the fields that are included in a request to the `DeleteCustomer` endpoint.

type DeleteCustomerResponse ¶

type DeleteCustomerResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields that are included in the response body of a request to the `DeleteCustomer` endpoint.

type DeleteDisputeEvidenceRequest ¶

type DeleteDisputeEvidenceRequest struct{}

Defines the parameters for a `DeleteDisputeEvidence` request.

type DeleteDisputeEvidenceResponse ¶

type DeleteDisputeEvidenceResponse struct {
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields in a `DeleteDisputeEvidence` response.

type DeleteInvoiceAttachmentRequest ¶

type DeleteInvoiceAttachmentRequest struct{}

Represents a [DeleteInvoiceAttachment](https://developer.squareup.com/reference/square_2024-07-17/invoices-api/delete-invoice-attachment) request.

type DeleteInvoiceAttachmentResponse ¶

type DeleteInvoiceAttachmentResponse struct {
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [DeleteInvoiceAttachment](https://developer.squareup.com/reference/square_2024-07-17/invoices-api/delete-invoice-attachment) response.

type DeleteInvoiceRequest ¶

type DeleteInvoiceRequest struct {
	// The version of the [invoice](https://developer.squareup.com/reference/square_2024-07-17/objects/Invoice) to delete. If you do not know the version, you can call [GetInvoice](https://developer.squareup.com/reference/square_2024-07-17/invoices-api/get-invoice) or  [ListInvoices](https://developer.squareup.com/reference/square_2024-07-17/invoices-api/list-invoices).
	Version int32 `json:"version,omitempty"`
}

Describes a `DeleteInvoice` request.

type DeleteInvoiceResponse ¶

type DeleteInvoiceResponse struct {
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Describes a `DeleteInvoice` response.

type DeleteLocationCustomAttributeDefinitionRequest ¶

type DeleteLocationCustomAttributeDefinitionRequest struct{}

Represents a [DeleteLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/delete-location-custom-attributeDefinition) request.

type DeleteLocationCustomAttributeDefinitionResponse ¶

type DeleteLocationCustomAttributeDefinitionResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response from a delete request containing error messages if there are any.

type DeleteLocationCustomAttributeRequest ¶

type DeleteLocationCustomAttributeRequest struct{}

Represents a [DeleteLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/delete-location-custom-attribute) request.

type DeleteLocationCustomAttributeResponse ¶

type DeleteLocationCustomAttributeResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [DeleteLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/delete-location-custom-attribute) response. Either an empty object `{}` (for a successful deletion) or `errors` is present in the response.

type DeleteLoyaltyRewardRequest ¶

type DeleteLoyaltyRewardRequest struct{}

A request to delete a loyalty reward.

type DeleteLoyaltyRewardResponse ¶

type DeleteLoyaltyRewardResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

A response returned by the API call.

type DeleteMerchantCustomAttributeDefinitionRequest ¶

type DeleteMerchantCustomAttributeDefinitionRequest struct{}

Represents a [DeleteMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/delete-merchant-custom-attributeDefinition) request.

type DeleteMerchantCustomAttributeDefinitionResponse ¶

type DeleteMerchantCustomAttributeDefinitionResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response from a delete request containing error messages if there are any.

type DeleteMerchantCustomAttributeRequest ¶

type DeleteMerchantCustomAttributeRequest struct{}

Represents a [DeleteMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/delete-merchant-custom-attribute) request.

type DeleteMerchantCustomAttributeResponse ¶

type DeleteMerchantCustomAttributeResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [DeleteMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/delete-merchant-custom-attribute) response. Either an empty object `{}` (for a successful deletion) or `errors` is present in the response.

type DeleteOrderCustomAttributeDefinitionRequest ¶

type DeleteOrderCustomAttributeDefinitionRequest struct{}

Represents a delete request for an order custom attribute definition.

type DeleteOrderCustomAttributeDefinitionResponse ¶

type DeleteOrderCustomAttributeDefinitionResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response from deleting an order custom attribute definition.

type DeleteOrderCustomAttributeRequest ¶

type DeleteOrderCustomAttributeRequest struct{}

Represents a delete request for an order custom attribute.

type DeleteOrderCustomAttributeResponse ¶

type DeleteOrderCustomAttributeResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response from deleting an order custom attribute.

type DeletePaymentLinkRequest ¶

type DeletePaymentLinkRequest struct{}

type DeletePaymentLinkResponse ¶

type DeletePaymentLinkResponse struct {
	Errors []ModelError `json:"errors,omitempty"`
	// The ID of the link that is deleted.
	Id string `json:"id,omitempty"`
	// The ID of the order that is canceled. When a payment link is deleted, Square updates the the `state` (of the order that the checkout link created) to CANCELED.
	CancelledOrderId string `json:"cancelled_order_id,omitempty"`
}

type DeleteShiftRequest ¶

type DeleteShiftRequest struct{}

A request to delete a `Shift`.

type DeleteShiftResponse ¶

type DeleteShiftResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

The response to a request to delete a `Shift`. The response might contain a set of `Error` objects if the request resulted in errors.

type DeleteSnippetRequest ¶

type DeleteSnippetRequest struct{}

Represents a `DeleteSnippet` request.

type DeleteSnippetResponse ¶

type DeleteSnippetResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a `DeleteSnippet` response.

type DeleteSubscriptionActionRequest ¶

type DeleteSubscriptionActionRequest struct{}

Defines input parameters in a call to the [DeleteSubscriptionAction](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/delete-subscription-action) endpoint.

type DeleteSubscriptionActionResponse ¶

type DeleteSubscriptionActionResponse struct {
	// Errors encountered during the request.
	Errors       []ModelError  `json:"errors,omitempty"`
	Subscription *Subscription `json:"subscription,omitempty"`
}

Defines output parameters in a response of the [DeleteSubscriptionAction](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/delete-subscription-action) endpoint.

type DeleteWebhookSubscriptionRequest ¶

type DeleteWebhookSubscriptionRequest struct{}

Deletes a Subscription(https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription).

type DeleteWebhookSubscriptionResponse ¶

type DeleteWebhookSubscriptionResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields that are included in the response body of a request to the [DeleteWebhookSubscription](https://developer.squareup.com/reference/square_2024-07-17/webhook-subscriptions-api/delete-webhook-subscription) endpoint.

type DeprecatedCreateDisputeEvidenceFileRequest ¶

type DeprecatedCreateDisputeEvidenceFileRequest struct {
	// The Unique ID. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
	IdempotencyKey string `json:"idempotency_key"`
	// The type of evidence you are uploading.
	EvidenceType string `json:"evidence_type,omitempty"`
	// The MIME type of the uploaded file. The type can be image/heic, image/heif, image/jpeg, application/pdf, image/png, or image/tiff.
	ContentType string `json:"content_type,omitempty"`
}

Defines the parameters for a `DeprecatedCreateDisputeEvidenceFile` request.

type DeprecatedCreateDisputeEvidenceFileResponse ¶

type DeprecatedCreateDisputeEvidenceFileResponse struct {
	// Any errors that occurred during the request.
	Errors   []ModelError     `json:"errors,omitempty"`
	Evidence *DisputeEvidence `json:"evidence,omitempty"`
}

Defines the fields in a `DeprecatedCreateDisputeEvidenceFile` response.

type DeprecatedCreateDisputeEvidenceTextRequest ¶

type DeprecatedCreateDisputeEvidenceTextRequest struct {
	// The Unique ID. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
	IdempotencyKey string `json:"idempotency_key"`
	// The type of evidence you are uploading.
	EvidenceType string `json:"evidence_type,omitempty"`
	// The evidence string.
	EvidenceText string `json:"evidence_text"`
}

Defines the parameters for a `DeprecatedCreateDisputeEvidenceText` request.

type DeprecatedCreateDisputeEvidenceTextResponse ¶

type DeprecatedCreateDisputeEvidenceTextResponse struct {
	// Any errors that occurred during the request.
	Errors   []ModelError     `json:"errors,omitempty"`
	Evidence *DisputeEvidence `json:"evidence,omitempty"`
}

Defines the fields in a `DeprecatedCreateDisputeEvidenceText` response.

type Destination ¶

type Destination struct {
	// Type of the destination such as a bank account or debit card.
	Type_ string `json:"type,omitempty"`
	// Square issued unique ID (also known as the instrument ID) associated with this destination.
	Id string `json:"id,omitempty"`
}

Information about the destination against which the payout was made.

type DestinationDetails ¶

type DestinationDetails struct {
	CardDetails *any `json:"card_details,omitempty"`
}

Details about a refund's destination.

type DestinationDetailsCardRefundDetails ¶

type DestinationDetailsCardRefundDetails struct {
	Card *Card `json:"card,omitempty"`
	// The method used to enter the card's details for the refund. The method can be `KEYED`, `SWIPED`, `EMV`, `ON_FILE`, or `CONTACTLESS`.
	EntryMethod string `json:"entry_method,omitempty"`
	// The authorization code provided by the issuer when a refund is approved.
	AuthResultCode string `json:"auth_result_code,omitempty"`
}

type DestinationType ¶

type DestinationType string

DestinationType : List of possible destinations against which a payout can be made.

const (
	BANK_ACCOUNT_DestinationType          DestinationType = "BANK_ACCOUNT"
	CARD_DestinationType                  DestinationType = "CARD"
	SQUARE_BALANCE_DestinationType        DestinationType = "SQUARE_BALANCE"
	SQUARE_STORED_BALANCE_DestinationType DestinationType = "SQUARE_STORED_BALANCE"
)

List of DestinationType

type Device ¶

type Device struct {
	// A synthetic identifier for the device. The identifier includes a standardized prefix and is otherwise an opaque id generated from key device fields.
	Id         string            `json:"id,omitempty"`
	Attributes *DeviceAttributes `json:"attributes"`
	// A list of components applicable to the device.
	Components []Component   `json:"components,omitempty"`
	Status     *DeviceStatus `json:"status,omitempty"`
}

type DeviceAttributes ¶

type DeviceAttributes struct {
	// The device type.
	Type_ string `json:"type"`
	// The maker of the device.
	Manufacturer string `json:"manufacturer"`
	// The specific model of the device.
	Model string `json:"model,omitempty"`
	// A seller-specified name for the device.
	Name string `json:"name,omitempty"`
	// The manufacturer-supplied identifier for the device (where available). In many cases, this identifier will be a serial number.
	ManufacturersId string `json:"manufacturers_id,omitempty"`
	// The RFC 3339-formatted value of the most recent update to the device information. (Could represent any field update on the device.)
	UpdatedAt string `json:"updated_at,omitempty"`
	// The current version of software installed on the device.
	Version string `json:"version,omitempty"`
	// The merchant_token identifying the merchant controlling the device.
	MerchantToken string `json:"merchant_token,omitempty"`
}

type DeviceAttributesDeviceType ¶

type DeviceAttributesDeviceType string

DeviceAttributesDeviceType : An enum identifier of the device type.

const (
	TERMINAL_DeviceAttributesDeviceType DeviceAttributesDeviceType = "TERMINAL"
)

List of DeviceAttributesDeviceType

type DeviceCheckoutOptions ¶

type DeviceCheckoutOptions struct {
	// The unique ID of the device intended for this `TerminalCheckout`. A list of `DeviceCode` objects can be retrieved from the /v2/devices/codes endpoint. Match a `DeviceCode.device_id` value with `device_id` to get the associated device code.
	DeviceId string `json:"device_id"`
	// Instructs the device to skip the receipt screen. Defaults to false.
	SkipReceiptScreen bool `json:"skip_receipt_screen,omitempty"`
	// Indicates that signature collection is desired during checkout. Defaults to false.
	CollectSignature bool         `json:"collect_signature,omitempty"`
	TipSettings      *TipSettings `json:"tip_settings,omitempty"`
	// Show the itemization screen prior to taking a payment. This field is only meaningful when the checkout includes an order ID. Defaults to true.
	ShowItemizedCart bool `json:"show_itemized_cart,omitempty"`
}

type DeviceCode ¶

type DeviceCode struct {
	// The unique id for this device code.
	Id string `json:"id,omitempty"`
	// An optional user-defined name for the device code.
	Name string `json:"name,omitempty"`
	// The unique code that can be used to login.
	Code string `json:"code,omitempty"`
	// The unique id of the device that used this code. Populated when the device is paired up.
	DeviceId string `json:"device_id,omitempty"`
	// The targeting product type of the device code.
	ProductType string `json:"product_type"`
	// The location assigned to this code.
	LocationId string `json:"location_id,omitempty"`
	// The pairing status of the device code.
	Status string `json:"status,omitempty"`
	// When this DeviceCode will expire and no longer login. Timestamp in RFC 3339 format.
	PairBy string `json:"pair_by,omitempty"`
	// When this DeviceCode was created. Timestamp in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// When this DeviceCode's status was last changed. Timestamp in RFC 3339 format.
	StatusChangedAt string `json:"status_changed_at,omitempty"`
	// When this DeviceCode was paired. Timestamp in RFC 3339 format.
	PairedAt string `json:"paired_at,omitempty"`
}

type DeviceCodeStatus ¶

type DeviceCodeStatus string

DeviceCodeStatus : DeviceCode.Status enum.

const (
	UNKNOWN_DeviceCodeStatus  DeviceCodeStatus = "UNKNOWN"
	UNPAIRED_DeviceCodeStatus DeviceCodeStatus = "UNPAIRED"
	PAIRED_DeviceCodeStatus   DeviceCodeStatus = "PAIRED"
	EXPIRED_DeviceCodeStatus  DeviceCodeStatus = "EXPIRED"
)

List of DeviceCodeStatus

type DeviceComponentDetails ¶

type DeviceComponentDetails struct{}

type DeviceComponentDetailsApplicationDetails ¶

type DeviceComponentDetailsApplicationDetails struct {
	// The type of application.
	ApplicationType string `json:"application_type,omitempty"`
	// The version of the application.
	Version string `json:"version,omitempty"`
	// The location_id of the session for the application.
	SessionLocation string `json:"session_location,omitempty"`
	// The id of the device code that was used to log in to the device.
	DeviceCodeId string `json:"device_code_id,omitempty"`
}

type DeviceComponentDetailsBatteryDetails ¶

type DeviceComponentDetailsBatteryDetails struct {
	// The battery charge percentage as displayed on the device.
	VisiblePercent int32 `json:"visible_percent,omitempty"`
	ExternalPower  *any  `json:"external_power,omitempty"`
}

type DeviceComponentDetailsCardReaderDetails ¶

type DeviceComponentDetailsCardReaderDetails struct {
	// The version of the card reader.
	Version string `json:"version,omitempty"`
}

type DeviceComponentDetailsEthernetDetails ¶

type DeviceComponentDetailsEthernetDetails struct {
	// A boolean to represent whether the Ethernet interface is currently active.
	Active bool `json:"active,omitempty"`
	// The string representation of the device’s IPv4 address.
	IpAddressV4 string `json:"ip_address_v4,omitempty"`
}

type DeviceComponentDetailsExternalPower ¶

type DeviceComponentDetailsExternalPower string

DeviceComponentDetailsExternalPower : An enum for ExternalPower.

const (
	AVAILABLE_CHARGING_DeviceComponentDetailsExternalPower     DeviceComponentDetailsExternalPower = "AVAILABLE_CHARGING"
	AVAILABLE_NOT_IN_USE_DeviceComponentDetailsExternalPower   DeviceComponentDetailsExternalPower = "AVAILABLE_NOT_IN_USE"
	UNAVAILABLE_DeviceComponentDetailsExternalPower            DeviceComponentDetailsExternalPower = "UNAVAILABLE"
	AVAILABLE_INSUFFICIENT_DeviceComponentDetailsExternalPower DeviceComponentDetailsExternalPower = "AVAILABLE_INSUFFICIENT"
)

List of DeviceComponentDetailsExternalPower

type DeviceComponentDetailsMeasurement ¶

type DeviceComponentDetailsMeasurement struct {
	Value int32 `json:"value,omitempty"`
}

A value qualified by unit of measure.

type DeviceComponentDetailsNetworkInterfaceDetails ¶

type DeviceComponentDetailsNetworkInterfaceDetails struct {
	// The string representation of the device’s IPv4 address.
	IpAddressV4 string `json:"ip_address_v4,omitempty"`
}

type DeviceComponentDetailsWiFiDetails ¶

type DeviceComponentDetailsWiFiDetails struct {
	// A boolean to represent whether the WiFI interface is currently active.
	Active bool `json:"active,omitempty"`
	// The name of the connected WIFI network.
	Ssid string `json:"ssid,omitempty"`
	// The string representation of the device’s IPv4 address.
	IpAddressV4 string `json:"ip_address_v4,omitempty"`
	// The security protocol for a secure connection (e.g. WPA2). None provided if the connection is unsecured.
	SecureConnection string `json:"secure_connection,omitempty"`
	SignalStrength   *any   `json:"signal_strength,omitempty"`
}

type DeviceDetails ¶

type DeviceDetails struct {
	// The Square-issued ID of the device.
	DeviceId string `json:"device_id,omitempty"`
	// The Square-issued installation ID for the device.
	DeviceInstallationId string `json:"device_installation_id,omitempty"`
	// The name of the device set by the seller.
	DeviceName string `json:"device_name,omitempty"`
}

Details about the device that took the payment.

type DeviceMetadata ¶

type DeviceMetadata struct {
	// The Terminal’s remaining battery percentage, between 1-100.
	BatteryPercentage string `json:"battery_percentage,omitempty"`
	// The current charging state of the Terminal. Options: `CHARGING`, `NOT_CHARGING`
	ChargingState string `json:"charging_state,omitempty"`
	// The ID of the Square seller business location associated with the Terminal.
	LocationId string `json:"location_id,omitempty"`
	// The ID of the Square merchant account that is currently signed-in to the Terminal.
	MerchantId string `json:"merchant_id,omitempty"`
	// The Terminal’s current network connection type. Options: `WIFI`, `ETHERNET`
	NetworkConnectionType string `json:"network_connection_type,omitempty"`
	// The country in which the Terminal is authorized to take payments.
	PaymentRegion string `json:"payment_region,omitempty"`
	// The unique identifier assigned to the Terminal, which can be found on the lower back of the device.
	SerialNumber string `json:"serial_number,omitempty"`
	// The current version of the Terminal’s operating system.
	OsVersion string `json:"os_version,omitempty"`
	// The current version of the application running on the Terminal.
	AppVersion string `json:"app_version,omitempty"`
	// The name of the Wi-Fi network to which the Terminal is connected.
	WifiNetworkName string `json:"wifi_network_name,omitempty"`
	// The signal strength of the Wi-FI network connection. Options: `POOR`, `FAIR`, `GOOD`, `EXCELLENT`
	WifiNetworkStrength string `json:"wifi_network_strength,omitempty"`
	// The IP address of the Terminal.
	IpAddress string `json:"ip_address,omitempty"`
}

type DeviceStatus ¶

type DeviceStatus struct {
	Category string `json:"category,omitempty"`
}

type DeviceStatusCategory ¶

type DeviceStatusCategory string

const (
	AVAILABLE_DeviceStatusCategory       DeviceStatusCategory = "AVAILABLE"
	NEEDS_ATTENTION_DeviceStatusCategory DeviceStatusCategory = "NEEDS_ATTENTION"
	OFFLINE_DeviceStatusCategory         DeviceStatusCategory = "OFFLINE"
)

List of DeviceStatusCategory

type DevicesApiListDeviceCodesOpts ¶

type DevicesApiListDeviceCodesOpts struct {
	Cursor      optional.String
	LocationId  optional.String
	ProductType optional.String
	Status      optional.String
}

type DevicesApiListDevicesOpts ¶

type DevicesApiListDevicesOpts struct {
	Cursor     optional.String
	SortOrder  optional.String
	Limit      optional.Int32
	LocationId optional.String
}

type DevicesApiService ¶

type DevicesApiService service

func (*DevicesApiService) CreateDeviceCode ¶

func (a *DevicesApiService) CreateDeviceCode(ctx context.Context, body CreateDeviceCodeRequest) (CreateDeviceCodeResponse, *http.Response, error)

DevicesApiService CreateDeviceCode Creates a DeviceCode that can be used to login to a Square Terminal device to enter the connected terminal mode.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateDeviceCodeResponse

func (*DevicesApiService) GetDevice ¶

func (a *DevicesApiService) GetDevice(ctx context.Context, deviceId string) (GetDeviceResponse, *http.Response, error)

DevicesApiService GetDevice Retrieves Device with the associated `device_id`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param deviceId The unique ID for the desired `Device`.

@return GetDeviceResponse

func (*DevicesApiService) GetDeviceCode ¶

func (a *DevicesApiService) GetDeviceCode(ctx context.Context, id string) (GetDeviceCodeResponse, *http.Response, error)

DevicesApiService GetDeviceCode Retrieves DeviceCode with the associated ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The unique identifier for the device code.

@return GetDeviceCodeResponse

func (*DevicesApiService) ListDeviceCodes ¶

func (a *DevicesApiService) ListDeviceCodes(ctx context.Context, localVarOptionals *DevicesApiListDeviceCodesOpts) (ListDeviceCodesResponse, *http.Response, error)

func (*DevicesApiService) ListDevices ¶

func (a *DevicesApiService) ListDevices(ctx context.Context, localVarOptionals *DevicesApiListDevicesOpts) (ListDevicesResponse, *http.Response, error)

type DigitalWalletDetails ¶

type DigitalWalletDetails struct {
	// The status of the `WALLET` payment. The status can be `AUTHORIZED`, `CAPTURED`, `VOIDED`, or `FAILED`.
	Status string `json:"status,omitempty"`
	// The brand used for the `WALLET` payment. The brand can be `CASH_APP`, `PAYPAY`, `ALIPAY`, `RAKUTEN_PAY`, `AU_PAY`, `D_BARAI`, `MERPAY`, `WECHAT_PAY` or `UNKNOWN`.
	Brand          string          `json:"brand,omitempty"`
	CashAppDetails *CashAppDetails `json:"cash_app_details,omitempty"`
}

Additional details about `WALLET` type payments. Contains only non-confidential information.

type DisableCardRequest ¶

type DisableCardRequest struct{}

Disables the card, preventing any further updates or charges. Disabling an already disabled card is allowed but has no effect. Accessible via HTTP requests at POST https://connect.squareup.com/v2/cards/{card_id}/disable

type DisableCardResponse ¶

type DisableCardResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	Card   *Card        `json:"card,omitempty"`
}

Defines the fields that are included in the response body of a request to the [DisableCard](https://developer.squareup.com/reference/square_2024-07-17/cards-api/disable-card) endpoint. Note: if there are errors processing the request, the card field will not be present.

type DisableEventsRequest ¶

type DisableEventsRequest struct{}

Disables Event(https://developer.squareup.com/reference/square_2024-07-17/objects/Event)s for your application.

type DisableEventsResponse ¶

type DisableEventsResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields that are included in the response body of a request to the [DisableEvents](https://developer.squareup.com/reference/square_2024-07-17/events-api/disable-events) endpoint. Note: if there are errors processing the request, the events field will not be present.

type DismissTerminalActionRequest ¶

type DismissTerminalActionRequest struct{}

type DismissTerminalActionResponse ¶

type DismissTerminalActionResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError    `json:"errors,omitempty"`
	Action *TerminalAction `json:"action,omitempty"`
}

type DismissTerminalCheckoutRequest ¶

type DismissTerminalCheckoutRequest struct{}

type DismissTerminalCheckoutResponse ¶

type DismissTerminalCheckoutResponse struct {
	// Information on errors encountered during the request.
	Errors   []ModelError      `json:"errors,omitempty"`
	Checkout *TerminalCheckout `json:"checkout,omitempty"`
}

type DismissTerminalRefundRequest ¶

type DismissTerminalRefundRequest struct{}

type DismissTerminalRefundResponse ¶

type DismissTerminalRefundResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError    `json:"errors,omitempty"`
	Refund *TerminalRefund `json:"refund,omitempty"`
}

type Dispute ¶

type Dispute struct {
	// The unique ID for this `Dispute`, generated by Square.
	DisputeId string `json:"dispute_id,omitempty"`
	// The unique ID for this `Dispute`, generated by Square.
	Id          string `json:"id,omitempty"`
	AmountMoney *Money `json:"amount_money,omitempty"`
	// The reason why the cardholder initiated the dispute.
	Reason string `json:"reason,omitempty"`
	// The current state of this dispute.
	State string `json:"state,omitempty"`
	// The deadline by which the seller must respond to the dispute, in [RFC 3339 format](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-dates).
	DueAt           string           `json:"due_at,omitempty"`
	DisputedPayment *DisputedPayment `json:"disputed_payment,omitempty"`
	// The IDs of the evidence associated with the dispute.
	EvidenceIds []string `json:"evidence_ids,omitempty"`
	// The card brand used in the disputed payment.
	CardBrand string `json:"card_brand,omitempty"`
	// The timestamp when the dispute was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp when the dispute was last updated, in RFC 3339 format.
	UpdatedAt string `json:"updated_at,omitempty"`
	// The ID of the dispute in the card brand system, generated by the card brand.
	BrandDisputeId string `json:"brand_dispute_id,omitempty"`
	// The timestamp when the dispute was reported, in RFC 3339 format.
	ReportedDate string `json:"reported_date,omitempty"`
	// The timestamp when the dispute was reported, in RFC 3339 format.
	ReportedAt string `json:"reported_at,omitempty"`
	// The current version of the `Dispute`.
	Version int32 `json:"version,omitempty"`
	// The ID of the location where the dispute originated.
	LocationId string `json:"location_id,omitempty"`
}

Represents a [dispute](https://developer.squareup.com/docs/disputes-api/overview) a cardholder initiated with their bank.

type DisputeEvidence ¶

type DisputeEvidence struct {
	// The Square-generated ID of the evidence.
	EvidenceId string `json:"evidence_id,omitempty"`
	// The Square-generated ID of the evidence.
	Id string `json:"id,omitempty"`
	// The ID of the dispute the evidence is associated with.
	DisputeId    string               `json:"dispute_id,omitempty"`
	EvidenceFile *DisputeEvidenceFile `json:"evidence_file,omitempty"`
	// Raw text
	EvidenceText string `json:"evidence_text,omitempty"`
	// The time when the evidence was uploaded, in RFC 3339 format.
	UploadedAt string `json:"uploaded_at,omitempty"`
	// The type of the evidence.
	EvidenceType string `json:"evidence_type,omitempty"`
}

type DisputeEvidenceFile ¶

type DisputeEvidenceFile struct {
	// The file name including the file extension. For example: \"receipt.tiff\".
	Filename string `json:"filename,omitempty"`
	// Dispute evidence files must be application/pdf, image/heic, image/heif, image/jpeg, image/png, or image/tiff formats.
	Filetype string `json:"filetype,omitempty"`
}

A file to be uploaded as dispute evidence.

type DisputeEvidenceType ¶

type DisputeEvidenceType string

DisputeEvidenceType : The type of the dispute evidence.

const (
	GENERIC_EVIDENCE_DisputeEvidenceType                     DisputeEvidenceType = "GENERIC_EVIDENCE"
	ONLINE_OR_APP_ACCESS_LOG_DisputeEvidenceType             DisputeEvidenceType = "ONLINE_OR_APP_ACCESS_LOG"
	AUTHORIZATION_DOCUMENTATION_DisputeEvidenceType          DisputeEvidenceType = "AUTHORIZATION_DOCUMENTATION"
	CANCELLATION_OR_REFUND_DOCUMENTATION_DisputeEvidenceType DisputeEvidenceType = "CANCELLATION_OR_REFUND_DOCUMENTATION"
	CARDHOLDER_COMMUNICATION_DisputeEvidenceType             DisputeEvidenceType = "CARDHOLDER_COMMUNICATION"
	CARDHOLDER_INFORMATION_DisputeEvidenceType               DisputeEvidenceType = "CARDHOLDER_INFORMATION"
	PURCHASE_ACKNOWLEDGEMENT_DisputeEvidenceType             DisputeEvidenceType = "PURCHASE_ACKNOWLEDGEMENT"
	DUPLICATE_CHARGE_DOCUMENTATION_DisputeEvidenceType       DisputeEvidenceType = "DUPLICATE_CHARGE_DOCUMENTATION"
	PRODUCT_OR_SERVICE_DESCRIPTION_DisputeEvidenceType       DisputeEvidenceType = "PRODUCT_OR_SERVICE_DESCRIPTION"
	RECEIPT_DisputeEvidenceType                              DisputeEvidenceType = "RECEIPT"
	SERVICE_RECEIVED_DOCUMENTATION_DisputeEvidenceType       DisputeEvidenceType = "SERVICE_RECEIVED_DOCUMENTATION"
	PROOF_OF_DELIVERY_DOCUMENTATION_DisputeEvidenceType      DisputeEvidenceType = "PROOF_OF_DELIVERY_DOCUMENTATION"
	RELATED_TRANSACTION_DOCUMENTATION_DisputeEvidenceType    DisputeEvidenceType = "RELATED_TRANSACTION_DOCUMENTATION"
	REBUTTAL_EXPLANATION_DisputeEvidenceType                 DisputeEvidenceType = "REBUTTAL_EXPLANATION"
	TRACKING_NUMBER_DisputeEvidenceType                      DisputeEvidenceType = "TRACKING_NUMBER"
)

List of DisputeEvidenceType

type DisputeReason ¶

type DisputeReason string

DisputeReason : The list of possible reasons why a cardholder might initiate a dispute with their bank.

const (
	AMOUNT_DIFFERS_DisputeReason           DisputeReason = "AMOUNT_DIFFERS"
	CANCELLED_DisputeReason                DisputeReason = "CANCELLED"
	DUPLICATE_DisputeReason                DisputeReason = "DUPLICATE"
	NO_KNOWLEDGE_DisputeReason             DisputeReason = "NO_KNOWLEDGE"
	NOT_AS_DESCRIBED_DisputeReason         DisputeReason = "NOT_AS_DESCRIBED"
	NOT_RECEIVED_DisputeReason             DisputeReason = "NOT_RECEIVED"
	PAID_BY_OTHER_MEANS_DisputeReason      DisputeReason = "PAID_BY_OTHER_MEANS"
	CUSTOMER_REQUESTS_CREDIT_DisputeReason DisputeReason = "CUSTOMER_REQUESTS_CREDIT"
	EMV_LIABILITY_SHIFT_DisputeReason      DisputeReason = "EMV_LIABILITY_SHIFT"
)

List of DisputeReason

type DisputeState ¶

type DisputeState string

DisputeState : The list of possible dispute states.

const (
	INQUIRY_EVIDENCE_REQUIRED_DisputeState DisputeState = "INQUIRY_EVIDENCE_REQUIRED"
	INQUIRY_PROCESSING_DisputeState        DisputeState = "INQUIRY_PROCESSING"
	INQUIRY_CLOSED_DisputeState            DisputeState = "INQUIRY_CLOSED"
	EVIDENCE_REQUIRED_DisputeState         DisputeState = "EVIDENCE_REQUIRED"
	PROCESSING_DisputeState                DisputeState = "PROCESSING"
	WON_DisputeState                       DisputeState = "WON"
	LOST_DisputeState                      DisputeState = "LOST"
	ACCEPTED_DisputeState                  DisputeState = "ACCEPTED"
)

List of DisputeState

type DisputedPayment ¶

type DisputedPayment struct {
	// Square-generated unique ID of the payment being disputed.
	PaymentId string `json:"payment_id,omitempty"`
}

The payment the cardholder disputed.

type DisputesApiListDisputeEvidenceOpts ¶

type DisputesApiListDisputeEvidenceOpts struct {
	Cursor optional.String
}

type DisputesApiListDisputesOpts ¶

type DisputesApiListDisputesOpts struct {
	Cursor     optional.String
	States     optional.String
	LocationId optional.String
}

type DisputesApiService ¶

type DisputesApiService service

func (*DisputesApiService) AcceptDispute ¶

func (a *DisputesApiService) AcceptDispute(ctx context.Context, disputeId string) (AcceptDisputeResponse, *http.Response, error)

DisputesApiService AcceptDispute Accepts the loss on a dispute. Square returns the disputed amount to the cardholder and updates the dispute state to ACCEPTED. Square debits the disputed amount from the seller’s Square account. If the Square account does not have sufficient funds, Square debits the associated bank account.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param disputeId The ID of the dispute you want to accept.

@return AcceptDisputeResponse

func (*DisputesApiService) CreateDisputeEvidenceText ¶

func (a *DisputesApiService) CreateDisputeEvidenceText(ctx context.Context, body CreateDisputeEvidenceTextRequest, disputeId string) (CreateDisputeEvidenceTextResponse, *http.Response, error)

DisputesApiService CreateDisputeEvidenceText Uploads text to use as evidence for a dispute challenge.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param disputeId The ID of the dispute for which you want to upload evidence.

@return CreateDisputeEvidenceTextResponse

func (*DisputesApiService) DeleteDisputeEvidence ¶

func (a *DisputesApiService) DeleteDisputeEvidence(ctx context.Context, disputeId string, evidenceId string) (DeleteDisputeEvidenceResponse, *http.Response, error)

DisputesApiService DeleteDisputeEvidence Removes specified evidence from a dispute. Square does not send the bank any evidence that is removed.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param disputeId The ID of the dispute from which you want to remove evidence.
@param evidenceId The ID of the evidence you want to remove.

@return DeleteDisputeEvidenceResponse

func (*DisputesApiService) ListDisputeEvidence ¶

func (a *DisputesApiService) ListDisputeEvidence(ctx context.Context, disputeId string, localVarOptionals *DisputesApiListDisputeEvidenceOpts) (ListDisputeEvidenceResponse, *http.Response, error)

func (*DisputesApiService) ListDisputes ¶

func (a *DisputesApiService) ListDisputes(ctx context.Context, localVarOptionals *DisputesApiListDisputesOpts) (ListDisputesResponse, *http.Response, error)

func (*DisputesApiService) RetrieveDispute ¶

func (a *DisputesApiService) RetrieveDispute(ctx context.Context, disputeId string) (RetrieveDisputeResponse, *http.Response, error)

DisputesApiService RetrieveDispute Returns details about a specific dispute.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param disputeId The ID of the dispute you want more details about.

@return RetrieveDisputeResponse

func (*DisputesApiService) RetrieveDisputeEvidence ¶

func (a *DisputesApiService) RetrieveDisputeEvidence(ctx context.Context, disputeId string, evidenceId string) (RetrieveDisputeEvidenceResponse, *http.Response, error)

DisputesApiService RetrieveDisputeEvidence Returns the metadata for the evidence specified in the request URL path. You must maintain a copy of any evidence uploaded if you want to reference it later. Evidence cannot be downloaded after you upload it.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param disputeId The ID of the dispute from which you want to retrieve evidence metadata.
@param evidenceId The ID of the evidence to retrieve.

@return RetrieveDisputeEvidenceResponse

func (*DisputesApiService) SubmitEvidence ¶

func (a *DisputesApiService) SubmitEvidence(ctx context.Context, disputeId string) (SubmitEvidenceResponse, *http.Response, error)

DisputesApiService SubmitEvidence Submits evidence to the cardholder's bank. The evidence submitted by this endpoint includes evidence uploaded using the [CreateDisputeEvidenceFile](https://developer.squareup.com/reference/square_2024-07-17/disputes-api/create-dispute-evidence-file) and [CreateDisputeEvidenceText](https://developer.squareup.com/reference/square_2024-07-17/disputes-api/create-dispute-evidence-text) endpoints and evidence automatically provided by Square, when available. Evidence cannot be removed from a dispute after submission.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param disputeId The ID of the dispute for which you want to submit evidence.

@return SubmitEvidenceResponse

type EcomVisibility ¶

type EcomVisibility string

EcomVisibility : Determines item visibility in Ecom (Online Store) and Online Checkout.

const (
	UNINDEXED_EcomVisibility   EcomVisibility = "UNINDEXED"
	UNAVAILABLE_EcomVisibility EcomVisibility = "UNAVAILABLE"
	HIDDEN_EcomVisibility      EcomVisibility = "HIDDEN"
	VISIBLE_EcomVisibility     EcomVisibility = "VISIBLE"
)

List of EcomVisibility

type Employee ¶

type Employee struct {
	// UUID for this object.
	Id string `json:"id,omitempty"`
	// The employee's first name.
	FirstName string `json:"first_name,omitempty"`
	// The employee's last name.
	LastName string `json:"last_name,omitempty"`
	// The employee's email address
	Email string `json:"email,omitempty"`
	// The employee's phone number in E.164 format, i.e. \"+12125554250\"
	PhoneNumber string `json:"phone_number,omitempty"`
	// A list of location IDs where this employee has access to.
	LocationIds []string `json:"location_ids,omitempty"`
	// Specifies the status of the employees being fetched.
	Status string `json:"status,omitempty"`
	// Whether this employee is the owner of the merchant. Each merchant has one owner employee, and that employee has full authority over the account.
	IsOwner bool `json:"is_owner,omitempty"`
	// A read-only timestamp in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// A read-only timestamp in RFC 3339 format.
	UpdatedAt string `json:"updated_at,omitempty"`
}

An employee object that is used by the external API. DEPRECATED at version 2020-08-26. Replaced by TeamMember(https://developer.squareup.com/reference/square_2024-07-17/objects/TeamMember).

type EmployeeStatus ¶

type EmployeeStatus string

EmployeeStatus : The status of the Employee being retrieved. DEPRECATED at version 2020-08-26. Replaced by TeamMemberStatus(https://developer.squareup.com/reference/square_2024-07-17/objects/TeamMemberStatus).

const (
	ACTIVE_EmployeeStatus   EmployeeStatus = "ACTIVE"
	INACTIVE_EmployeeStatus EmployeeStatus = "INACTIVE"
)

List of EmployeeStatus

type EmployeeWage ¶

type EmployeeWage struct {
	// The UUID for this object.
	Id string `json:"id,omitempty"`
	// The `Employee` that this wage is assigned to.
	EmployeeId string `json:"employee_id,omitempty"`
	// The job title that this wage relates to.
	Title      string `json:"title,omitempty"`
	HourlyRate *Money `json:"hourly_rate,omitempty"`
}

The hourly wage rate that an employee earns on a `Shift` for doing the job specified by the `title` property of this object. Deprecated at version 2020-08-26. Use TeamMemberWage(https://developer.squareup.com/reference/square_2024-07-17/objects/TeamMemberWage).

type EmployeesApiListEmployeesOpts ¶

type EmployeesApiListEmployeesOpts struct {
	LocationId optional.String
	Status     optional.String
	Limit      optional.Int32
	Cursor     optional.String
}

type EmployeesApiService ¶

type EmployeesApiService service

func (*EmployeesApiService) ListEmployees ¶

func (a *EmployeesApiService) ListEmployees(ctx context.Context, localVarOptionals *EmployeesApiListEmployeesOpts) (ListEmployeesResponse, *http.Response, error)

func (*EmployeesApiService) RetrieveEmployee ¶

func (a *EmployeesApiService) RetrieveEmployee(ctx context.Context, id string) (RetrieveEmployeeResponse, *http.Response, error)

EmployeesApiService RetrieveEmployee

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id UUID for the employee that was requested.

@return RetrieveEmployeeResponse

type EnableEventsRequest ¶

type EnableEventsRequest struct{}

Enables Event(https://developer.squareup.com/reference/square_2024-07-17/objects/Event)s for your application.

type EnableEventsResponse ¶

type EnableEventsResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields that are included in the response body of a request to the [EnableEvents](https://developer.squareup.com/reference/square_2024-07-17/events-api/enable-events) endpoint. Note: if there are errors processing the request, the events field will not be present.

type ErrorCategory ¶

type ErrorCategory string

ErrorCategory : Indicates which high-level category of error has occurred during a request to the Connect API.

const (
	API_ERROR_ErrorCategory                   ErrorCategory = "API_ERROR"
	AUTHENTICATION_ERROR_ErrorCategory        ErrorCategory = "AUTHENTICATION_ERROR"
	INVALID_REQUEST_ERROR_ErrorCategory       ErrorCategory = "INVALID_REQUEST_ERROR"
	RATE_LIMIT_ERROR_ErrorCategory            ErrorCategory = "RATE_LIMIT_ERROR"
	PAYMENT_METHOD_ERROR_ErrorCategory        ErrorCategory = "PAYMENT_METHOD_ERROR"
	REFUND_ERROR_ErrorCategory                ErrorCategory = "REFUND_ERROR"
	MERCHANT_SUBSCRIPTION_ERROR_ErrorCategory ErrorCategory = "MERCHANT_SUBSCRIPTION_ERROR"
	EXTERNAL_VENDOR_ERROR_ErrorCategory       ErrorCategory = "EXTERNAL_VENDOR_ERROR"
)

List of ErrorCategory

type ErrorCode ¶

type ErrorCode string

ErrorCode : Indicates the specific error that occurred during a request to a Square API.

const (
	INTERNAL_SERVER_ERROR_ErrorCode                               ErrorCode = "INTERNAL_SERVER_ERROR"
	UNAUTHORIZED_ErrorCode                                        ErrorCode = "UNAUTHORIZED"
	ACCESS_TOKEN_EXPIRED_ErrorCode                                ErrorCode = "ACCESS_TOKEN_EXPIRED"
	ACCESS_TOKEN_REVOKED_ErrorCode                                ErrorCode = "ACCESS_TOKEN_REVOKED"
	CLIENT_DISABLED_ErrorCode                                     ErrorCode = "CLIENT_DISABLED"
	FORBIDDEN_ErrorCode                                           ErrorCode = "FORBIDDEN"
	INSUFFICIENT_SCOPES_ErrorCode                                 ErrorCode = "INSUFFICIENT_SCOPES"
	APPLICATION_DISABLED_ErrorCode                                ErrorCode = "APPLICATION_DISABLED"
	V1_APPLICATION_ErrorCode                                      ErrorCode = "V1_APPLICATION"
	V1_ACCESS_TOKEN_ErrorCode                                     ErrorCode = "V1_ACCESS_TOKEN"
	CARD_PROCESSING_NOT_ENABLED_ErrorCode                         ErrorCode = "CARD_PROCESSING_NOT_ENABLED"
	MERCHANT_SUBSCRIPTION_NOT_FOUND_ErrorCode                     ErrorCode = "MERCHANT_SUBSCRIPTION_NOT_FOUND"
	BAD_REQUEST_ErrorCode                                         ErrorCode = "BAD_REQUEST"
	MISSING_REQUIRED_PARAMETER_ErrorCode                          ErrorCode = "MISSING_REQUIRED_PARAMETER"
	INCORRECT_TYPE_ErrorCode                                      ErrorCode = "INCORRECT_TYPE"
	INVALID_TIME_ErrorCode                                        ErrorCode = "INVALID_TIME"
	INVALID_TIME_RANGE_ErrorCode                                  ErrorCode = "INVALID_TIME_RANGE"
	INVALID_VALUE_ErrorCode                                       ErrorCode = "INVALID_VALUE"
	INVALID_CURSOR_ErrorCode                                      ErrorCode = "INVALID_CURSOR"
	UNKNOWN_QUERY_PARAMETER_ErrorCode                             ErrorCode = "UNKNOWN_QUERY_PARAMETER"
	CONFLICTING_PARAMETERS_ErrorCode                              ErrorCode = "CONFLICTING_PARAMETERS"
	EXPECTED_JSON_BODY_ErrorCode                                  ErrorCode = "EXPECTED_JSON_BODY"
	INVALID_SORT_ORDER_ErrorCode                                  ErrorCode = "INVALID_SORT_ORDER"
	VALUE_REGEX_MISMATCH_ErrorCode                                ErrorCode = "VALUE_REGEX_MISMATCH"
	VALUE_TOO_SHORT_ErrorCode                                     ErrorCode = "VALUE_TOO_SHORT"
	VALUE_TOO_LONG_ErrorCode                                      ErrorCode = "VALUE_TOO_LONG"
	VALUE_TOO_LOW_ErrorCode                                       ErrorCode = "VALUE_TOO_LOW"
	VALUE_TOO_HIGH_ErrorCode                                      ErrorCode = "VALUE_TOO_HIGH"
	VALUE_EMPTY_ErrorCode                                         ErrorCode = "VALUE_EMPTY"
	ARRAY_LENGTH_TOO_LONG_ErrorCode                               ErrorCode = "ARRAY_LENGTH_TOO_LONG"
	ARRAY_LENGTH_TOO_SHORT_ErrorCode                              ErrorCode = "ARRAY_LENGTH_TOO_SHORT"
	ARRAY_EMPTY_ErrorCode                                         ErrorCode = "ARRAY_EMPTY"
	EXPECTED_BOOLEAN_ErrorCode                                    ErrorCode = "EXPECTED_BOOLEAN"
	EXPECTED_INTEGER_ErrorCode                                    ErrorCode = "EXPECTED_INTEGER"
	EXPECTED_FLOAT_ErrorCode                                      ErrorCode = "EXPECTED_FLOAT"
	EXPECTED_STRING_ErrorCode                                     ErrorCode = "EXPECTED_STRING"
	EXPECTED_OBJECT_ErrorCode                                     ErrorCode = "EXPECTED_OBJECT"
	EXPECTED_ARRAY_ErrorCode                                      ErrorCode = "EXPECTED_ARRAY"
	EXPECTED_MAP_ErrorCode                                        ErrorCode = "EXPECTED_MAP"
	EXPECTED_BASE64_ENCODED_BYTE_ARRAY_ErrorCode                  ErrorCode = "EXPECTED_BASE64_ENCODED_BYTE_ARRAY"
	INVALID_ARRAY_VALUE_ErrorCode                                 ErrorCode = "INVALID_ARRAY_VALUE"
	INVALID_ENUM_VALUE_ErrorCode                                  ErrorCode = "INVALID_ENUM_VALUE"
	INVALID_CONTENT_TYPE_ErrorCode                                ErrorCode = "INVALID_CONTENT_TYPE"
	INVALID_FORM_VALUE_ErrorCode                                  ErrorCode = "INVALID_FORM_VALUE"
	CUSTOMER_NOT_FOUND_ErrorCode                                  ErrorCode = "CUSTOMER_NOT_FOUND"
	ONE_INSTRUMENT_EXPECTED_ErrorCode                             ErrorCode = "ONE_INSTRUMENT_EXPECTED"
	NO_FIELDS_SET_ErrorCode                                       ErrorCode = "NO_FIELDS_SET"
	TOO_MANY_MAP_ENTRIES_ErrorCode                                ErrorCode = "TOO_MANY_MAP_ENTRIES"
	MAP_KEY_LENGTH_TOO_SHORT_ErrorCode                            ErrorCode = "MAP_KEY_LENGTH_TOO_SHORT"
	MAP_KEY_LENGTH_TOO_LONG_ErrorCode                             ErrorCode = "MAP_KEY_LENGTH_TOO_LONG"
	CUSTOMER_MISSING_NAME_ErrorCode                               ErrorCode = "CUSTOMER_MISSING_NAME"
	CUSTOMER_MISSING_EMAIL_ErrorCode                              ErrorCode = "CUSTOMER_MISSING_EMAIL"
	INVALID_PAUSE_LENGTH_ErrorCode                                ErrorCode = "INVALID_PAUSE_LENGTH"
	INVALID_DATE_ErrorCode                                        ErrorCode = "INVALID_DATE"
	UNSUPPORTED_COUNTRY_ErrorCode                                 ErrorCode = "UNSUPPORTED_COUNTRY"
	UNSUPPORTED_CURRENCY_ErrorCode                                ErrorCode = "UNSUPPORTED_CURRENCY"
	APPLE_TTP_PIN_TOKEN_ErrorCode                                 ErrorCode = "APPLE_TTP_PIN_TOKEN"
	CARD_EXPIRED_ErrorCode                                        ErrorCode = "CARD_EXPIRED"
	INVALID_EXPIRATION_ErrorCode                                  ErrorCode = "INVALID_EXPIRATION"
	INVALID_EXPIRATION_YEAR_ErrorCode                             ErrorCode = "INVALID_EXPIRATION_YEAR"
	INVALID_EXPIRATION_DATE_ErrorCode                             ErrorCode = "INVALID_EXPIRATION_DATE"
	UNSUPPORTED_CARD_BRAND_ErrorCode                              ErrorCode = "UNSUPPORTED_CARD_BRAND"
	UNSUPPORTED_ENTRY_METHOD_ErrorCode                            ErrorCode = "UNSUPPORTED_ENTRY_METHOD"
	INVALID_ENCRYPTED_CARD_ErrorCode                              ErrorCode = "INVALID_ENCRYPTED_CARD"
	INVALID_CARD_ErrorCode                                        ErrorCode = "INVALID_CARD"
	PAYMENT_AMOUNT_MISMATCH_ErrorCode                             ErrorCode = "PAYMENT_AMOUNT_MISMATCH"
	GENERIC_DECLINE_ErrorCode                                     ErrorCode = "GENERIC_DECLINE"
	CVV_FAILURE_ErrorCode                                         ErrorCode = "CVV_FAILURE"
	ADDRESS_VERIFICATION_FAILURE_ErrorCode                        ErrorCode = "ADDRESS_VERIFICATION_FAILURE"
	INVALID_ACCOUNT_ErrorCode                                     ErrorCode = "INVALID_ACCOUNT"
	CURRENCY_MISMATCH_ErrorCode                                   ErrorCode = "CURRENCY_MISMATCH"
	INSUFFICIENT_FUNDS_ErrorCode                                  ErrorCode = "INSUFFICIENT_FUNDS"
	INSUFFICIENT_PERMISSIONS_ErrorCode                            ErrorCode = "INSUFFICIENT_PERMISSIONS"
	CARDHOLDER_INSUFFICIENT_PERMISSIONS_ErrorCode                 ErrorCode = "CARDHOLDER_INSUFFICIENT_PERMISSIONS"
	INVALID_LOCATION_ErrorCode                                    ErrorCode = "INVALID_LOCATION"
	TRANSACTION_LIMIT_ErrorCode                                   ErrorCode = "TRANSACTION_LIMIT"
	VOICE_FAILURE_ErrorCode                                       ErrorCode = "VOICE_FAILURE"
	PAN_FAILURE_ErrorCode                                         ErrorCode = "PAN_FAILURE"
	EXPIRATION_FAILURE_ErrorCode                                  ErrorCode = "EXPIRATION_FAILURE"
	CARD_NOT_SUPPORTED_ErrorCode                                  ErrorCode = "CARD_NOT_SUPPORTED"
	INVALID_PIN_ErrorCode                                         ErrorCode = "INVALID_PIN"
	MISSING_PIN_ErrorCode                                         ErrorCode = "MISSING_PIN"
	MISSING_ACCOUNT_TYPE_ErrorCode                                ErrorCode = "MISSING_ACCOUNT_TYPE"
	INVALID_POSTAL_CODE_ErrorCode                                 ErrorCode = "INVALID_POSTAL_CODE"
	INVALID_FEES_ErrorCode                                        ErrorCode = "INVALID_FEES"
	MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED_ErrorCode              ErrorCode = "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED"
	PAYMENT_LIMIT_EXCEEDED_ErrorCode                              ErrorCode = "PAYMENT_LIMIT_EXCEEDED"
	GIFT_CARD_AVAILABLE_AMOUNT_ErrorCode                          ErrorCode = "GIFT_CARD_AVAILABLE_AMOUNT"
	ACCOUNT_UNUSABLE_ErrorCode                                    ErrorCode = "ACCOUNT_UNUSABLE"
	BUYER_REFUSED_PAYMENT_ErrorCode                               ErrorCode = "BUYER_REFUSED_PAYMENT"
	DELAYED_TRANSACTION_EXPIRED_ErrorCode                         ErrorCode = "DELAYED_TRANSACTION_EXPIRED"
	DELAYED_TRANSACTION_CANCELED_ErrorCode                        ErrorCode = "DELAYED_TRANSACTION_CANCELED"
	DELAYED_TRANSACTION_CAPTURED_ErrorCode                        ErrorCode = "DELAYED_TRANSACTION_CAPTURED"
	DELAYED_TRANSACTION_FAILED_ErrorCode                          ErrorCode = "DELAYED_TRANSACTION_FAILED"
	CARD_TOKEN_EXPIRED_ErrorCode                                  ErrorCode = "CARD_TOKEN_EXPIRED"
	CARD_TOKEN_USED_ErrorCode                                     ErrorCode = "CARD_TOKEN_USED"
	AMOUNT_TOO_HIGH_ErrorCode                                     ErrorCode = "AMOUNT_TOO_HIGH"
	UNSUPPORTED_INSTRUMENT_TYPE_ErrorCode                         ErrorCode = "UNSUPPORTED_INSTRUMENT_TYPE"
	REFUND_AMOUNT_INVALID_ErrorCode                               ErrorCode = "REFUND_AMOUNT_INVALID"
	REFUND_ALREADY_PENDING_ErrorCode                              ErrorCode = "REFUND_ALREADY_PENDING"
	PAYMENT_NOT_REFUNDABLE_ErrorCode                              ErrorCode = "PAYMENT_NOT_REFUNDABLE"
	REFUND_DECLINED_ErrorCode                                     ErrorCode = "REFUND_DECLINED"
	INSUFFICIENT_PERMISSIONS_FOR_REFUND_ErrorCode                 ErrorCode = "INSUFFICIENT_PERMISSIONS_FOR_REFUND"
	INVALID_CARD_DATA_ErrorCode                                   ErrorCode = "INVALID_CARD_DATA"
	SOURCE_USED_ErrorCode                                         ErrorCode = "SOURCE_USED"
	SOURCE_EXPIRED_ErrorCode                                      ErrorCode = "SOURCE_EXPIRED"
	UNSUPPORTED_LOYALTY_REWARD_TIER_ErrorCode                     ErrorCode = "UNSUPPORTED_LOYALTY_REWARD_TIER"
	LOCATION_MISMATCH_ErrorCode                                   ErrorCode = "LOCATION_MISMATCH"
	IDEMPOTENCY_KEY_REUSED_ErrorCode                              ErrorCode = "IDEMPOTENCY_KEY_REUSED"
	UNEXPECTED_VALUE_ErrorCode                                    ErrorCode = "UNEXPECTED_VALUE"
	SANDBOX_NOT_SUPPORTED_ErrorCode                               ErrorCode = "SANDBOX_NOT_SUPPORTED"
	INVALID_EMAIL_ADDRESS_ErrorCode                               ErrorCode = "INVALID_EMAIL_ADDRESS"
	INVALID_PHONE_NUMBER_ErrorCode                                ErrorCode = "INVALID_PHONE_NUMBER"
	CHECKOUT_EXPIRED_ErrorCode                                    ErrorCode = "CHECKOUT_EXPIRED"
	BAD_CERTIFICATE_ErrorCode                                     ErrorCode = "BAD_CERTIFICATE"
	INVALID_SQUARE_VERSION_FORMAT_ErrorCode                       ErrorCode = "INVALID_SQUARE_VERSION_FORMAT"
	API_VERSION_INCOMPATIBLE_ErrorCode                            ErrorCode = "API_VERSION_INCOMPATIBLE"
	CARD_PRESENCE_REQUIRED_ErrorCode                              ErrorCode = "CARD_PRESENCE_REQUIRED"
	UNSUPPORTED_SOURCE_TYPE_ErrorCode                             ErrorCode = "UNSUPPORTED_SOURCE_TYPE"
	CARD_MISMATCH_ErrorCode                                       ErrorCode = "CARD_MISMATCH"
	PLAID_ERROR_ErrorCode                                         ErrorCode = "PLAID_ERROR"
	PLAID_ERROR_ITEM_LOGIN_REQUIRED_ErrorCode                     ErrorCode = "PLAID_ERROR_ITEM_LOGIN_REQUIRED"
	PLAID_ERROR_RATE_LIMIT_ErrorCode                              ErrorCode = "PLAID_ERROR_RATE_LIMIT"
	CARD_DECLINED_ErrorCode                                       ErrorCode = "CARD_DECLINED"
	VERIFY_CVV_FAILURE_ErrorCode                                  ErrorCode = "VERIFY_CVV_FAILURE"
	VERIFY_AVS_FAILURE_ErrorCode                                  ErrorCode = "VERIFY_AVS_FAILURE"
	CARD_DECLINED_CALL_ISSUER_ErrorCode                           ErrorCode = "CARD_DECLINED_CALL_ISSUER"
	CARD_DECLINED_VERIFICATION_REQUIRED_ErrorCode                 ErrorCode = "CARD_DECLINED_VERIFICATION_REQUIRED"
	BAD_EXPIRATION_ErrorCode                                      ErrorCode = "BAD_EXPIRATION"
	CHIP_INSERTION_REQUIRED_ErrorCode                             ErrorCode = "CHIP_INSERTION_REQUIRED"
	ALLOWABLE_PIN_TRIES_EXCEEDED_ErrorCode                        ErrorCode = "ALLOWABLE_PIN_TRIES_EXCEEDED"
	RESERVATION_DECLINED_ErrorCode                                ErrorCode = "RESERVATION_DECLINED"
	UNKNOWN_BODY_PARAMETER_ErrorCode                              ErrorCode = "UNKNOWN_BODY_PARAMETER"
	NOT_FOUND_ErrorCode                                           ErrorCode = "NOT_FOUND"
	APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND_ErrorCode ErrorCode = "APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND"
	METHOD_NOT_ALLOWED_ErrorCode                                  ErrorCode = "METHOD_NOT_ALLOWED"
	NOT_ACCEPTABLE_ErrorCode                                      ErrorCode = "NOT_ACCEPTABLE"
	REQUEST_TIMEOUT_ErrorCode                                     ErrorCode = "REQUEST_TIMEOUT"
	CONFLICT_ErrorCode                                            ErrorCode = "CONFLICT"
	GONE_ErrorCode                                                ErrorCode = "GONE"
	REQUEST_ENTITY_TOO_LARGE_ErrorCode                            ErrorCode = "REQUEST_ENTITY_TOO_LARGE"
	UNSUPPORTED_MEDIA_TYPE_ErrorCode                              ErrorCode = "UNSUPPORTED_MEDIA_TYPE"
	UNPROCESSABLE_ENTITY_ErrorCode                                ErrorCode = "UNPROCESSABLE_ENTITY"
	RATE_LIMITED_ErrorCode                                        ErrorCode = "RATE_LIMITED"
	NOT_IMPLEMENTED_ErrorCode                                     ErrorCode = "NOT_IMPLEMENTED"
	BAD_GATEWAY_ErrorCode                                         ErrorCode = "BAD_GATEWAY"
	SERVICE_UNAVAILABLE_ErrorCode                                 ErrorCode = "SERVICE_UNAVAILABLE"
	TEMPORARY_ERROR_ErrorCode                                     ErrorCode = "TEMPORARY_ERROR"
	GATEWAY_TIMEOUT_ErrorCode                                     ErrorCode = "GATEWAY_TIMEOUT"
)

List of ErrorCode

type Event ¶

type Event struct {
	// The ID of the target merchant associated with the event.
	MerchantId string `json:"merchant_id,omitempty"`
	// The ID of the target location associated with the event.
	LocationId string `json:"location_id,omitempty"`
	// The type of event this represents.
	Type_ string `json:"type,omitempty"`
	// A unique ID for the event.
	EventId string `json:"event_id,omitempty"`
	// Timestamp of when the event was created, in RFC 3339 format.
	CreatedAt string     `json:"created_at,omitempty"`
	Data      *EventData `json:"data,omitempty"`
}

type EventData ¶

type EventData struct {
	// The name of the affected object’s type.
	Type_ string `json:"type,omitempty"`
	// The ID of the affected object.
	Id string `json:"id,omitempty"`
	// This is true if the affected object has been deleted; otherwise, it's absent.
	Deleted bool `json:"deleted,omitempty"`
	// An object containing fields and values relevant to the event. It is absent if the affected object has been deleted.
	Object *interface{} `json:"object,omitempty"`
}

type EventMetadata ¶

type EventMetadata struct {
	// A unique ID for the event.
	EventId string `json:"event_id,omitempty"`
	// The API version of the event. This corresponds to the default API version of the developer application at the time when the event was created.
	ApiVersion string `json:"api_version,omitempty"`
}

Contains metadata about a particular Event(https://developer.squareup.com/reference/square_2024-07-17/objects/Event).

type EventTypeMetadata ¶

type EventTypeMetadata struct {
	// The event type.
	EventType string `json:"event_type,omitempty"`
	// The API version at which the event type was introduced.
	ApiVersionIntroduced string `json:"api_version_introduced,omitempty"`
	// The release status of the event type.
	ReleaseStatus string `json:"release_status,omitempty"`
}

Contains the metadata of a webhook event type.

type EventsApiListEventTypesOpts ¶

type EventsApiListEventTypesOpts struct {
	ApiVersion optional.String
}

type EventsApiService ¶

type EventsApiService service

func (*EventsApiService) DisableEvents ¶

func (a *EventsApiService) DisableEvents(ctx context.Context) (DisableEventsResponse, *http.Response, error)

EventsApiService DisableEvents Disables events to prevent them from being searchable. All events are disabled by default. You must enable events to make them searchable. Disabling events for a specific time period prevents them from being searchable, even if you re-enable them later.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return DisableEventsResponse

func (*EventsApiService) EnableEvents ¶

func (a *EventsApiService) EnableEvents(ctx context.Context) (EnableEventsResponse, *http.Response, error)

EventsApiService EnableEvents Enables events to make them searchable. Only events that occur while in the enabled state are searchable.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return EnableEventsResponse

func (*EventsApiService) ListEventTypes ¶

func (a *EventsApiService) ListEventTypes(ctx context.Context, localVarOptionals *EventsApiListEventTypesOpts) (ListEventTypesResponse, *http.Response, error)

func (*EventsApiService) SearchEvents ¶

func (a *EventsApiService) SearchEvents(ctx context.Context, body SearchEventsRequest) (SearchEventsResponse, *http.Response, error)

EventsApiService SearchEvents Search for Square API events that occur within a 28-day timeframe.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return SearchEventsResponse

type ExcludeStrategy ¶

type ExcludeStrategy string

ExcludeStrategy : Indicates which products matched by a CatalogPricingRule will be excluded if the pricing rule uses an exclude set.

const (
	LEAST_EXPENSIVE_ExcludeStrategy ExcludeStrategy = "LEAST_EXPENSIVE"
	MOST_EXPENSIVE_ExcludeStrategy  ExcludeStrategy = "MOST_EXPENSIVE"
)

List of ExcludeStrategy

type ExternalPaymentDetails ¶

type ExternalPaymentDetails struct {
	// The type of external payment the seller received. It can be one of the following: - CHECK - Paid using a physical check. - BANK_TRANSFER - Paid using external bank transfer. - OTHER\\_GIFT\\_CARD - Paid using a non-Square gift card. - CRYPTO - Paid using a crypto currency. - SQUARE_CASH - Paid using Square Cash App. - SOCIAL - Paid using peer-to-peer payment applications. - EXTERNAL - A third-party application gathered this payment outside of Square. - EMONEY - Paid using an E-money provider. - CARD - A credit or debit card that Square does not support. - STORED_BALANCE - Use for house accounts, store credit, and so forth. - FOOD_VOUCHER - Restaurant voucher provided by employers to employees to pay for meals - OTHER - A type not listed here.
	Type_ string `json:"type"`
	// A description of the external payment source. For example,  \"Food Delivery Service\".
	Source string `json:"source"`
	// An ID to associate the payment to its originating source.
	SourceId       string `json:"source_id,omitempty"`
	SourceFeeMoney *Money `json:"source_fee_money,omitempty"`
}

Stores details about an external payment. Contains only non-confidential information. For more information, see [Take External Payments](https://developer.squareup.com/docs/payments-api/take-payments/external-payments).

type FilterValue ¶

type FilterValue struct {
	// A list of terms that must be present on the field of the resource.
	All []string `json:"all,omitempty"`
	// A list of terms where at least one of them must be present on the field of the resource.
	Any []string `json:"any,omitempty"`
	// A list of terms that must not be present on the field the resource
	None []string `json:"none,omitempty"`
}

A filter to select resources based on an exact field value. For any given value, the value can only be in one property. Depending on the field, either all properties can be set or only a subset will be available. Refer to the documentation of the field.

type FloatNumberRange ¶

type FloatNumberRange struct {
	// A decimal value indicating where the range starts.
	StartAt string `json:"start_at,omitempty"`
	// A decimal value indicating where the range ends.
	EndAt string `json:"end_at,omitempty"`
}

Specifies a decimal number range.

type Fulfillment ¶

type Fulfillment struct {
	// A unique ID that identifies the fulfillment only within this order.
	Uid string `json:"uid,omitempty"`
	// The type of the fulfillment.
	Type_ string `json:"type,omitempty"`
	// The state of the fulfillment.
	State string `json:"state,omitempty"`
	// Describes what order line items this fulfillment applies to. It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries.
	LineItemApplication string `json:"line_item_application,omitempty"`
	// A list of entries pertaining to the fulfillment of an order. Each entry must reference a valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to fulfill.  Multiple entries can reference the same line item `uid`, as long as the total quantity among all fulfillment entries referencing a single line item does not exceed the quantity of the order's line item itself.  An order cannot be marked as `COMPLETED` before all fulfillments are `COMPLETED`, `CANCELED`, or `FAILED`. Fulfillments can be created and completed independently before order completion.
	Entries []FulfillmentFulfillmentEntry `json:"entries,omitempty"`
	// Application-defined data attached to this fulfillment. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details).  Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character.  Values have a maximum length of 255 characters.  An application can have up to 10 entries per metadata field.  Entries written by applications are private and can only be read or modified by the same application.  For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).
	Metadata        map[string]string           `json:"metadata,omitempty"`
	PickupDetails   *FulfillmentPickupDetails   `json:"pickup_details,omitempty"`
	ShipmentDetails *FulfillmentShipmentDetails `json:"shipment_details,omitempty"`
	DeliveryDetails *FulfillmentDeliveryDetails `json:"delivery_details,omitempty"`
}

Contains details about how to fulfill this order. Orders can only be created with at most one fulfillment using the API. However, orders returned by the Orders API might contain multiple fulfillments because sellers can create multiple fulfillments using Square products such as Square Online.

type FulfillmentDeliveryDetails ¶

type FulfillmentDeliveryDetails struct {
	Recipient *FulfillmentRecipient `json:"recipient,omitempty"`
	// Indicates the fulfillment delivery schedule type. If `SCHEDULED`, then `deliver_at` is required. If `ASAP`, then `prep_time_duration` is required. The default is `SCHEDULED`.
	ScheduleType string `json:"schedule_type,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was placed. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").  Must be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\".
	PlacedAt string `json:"placed_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) that represents the start of the delivery period. When the fulfillment `schedule_type` is `ASAP`, the field is automatically set to the current time plus the `prep_time_duration`. Otherwise, the application can set this field while the fulfillment `state` is `PROPOSED`, `RESERVED`, or `PREPARED` (any time before the terminal state such as `COMPLETED`, `CANCELED`, and `FAILED`).  The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	DeliverAt string `json:"deliver_at,omitempty"`
	// The duration of time it takes to prepare and deliver this fulfillment. The duration must be in RFC 3339 format (for example, \"P1W3D\").
	PrepTimeDuration string `json:"prep_time_duration,omitempty"`
	// The time period after `deliver_at` in which to deliver the order. Applications can set this field when the fulfillment `state` is `PROPOSED`, `RESERVED`, or `PREPARED` (any time before the terminal state such as `COMPLETED`, `CANCELED`, and `FAILED`).  The duration must be in RFC 3339 format (for example, \"P1W3D\").
	DeliveryWindowDuration string `json:"delivery_window_duration,omitempty"`
	// Provides additional instructions about the delivery fulfillment. It is displayed in the Square Point of Sale application and set by the API.
	Note string `json:"note,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicates when the seller completed the fulfillment. This field is automatically set when  fulfillment `state` changes to `COMPLETED`. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	CompletedAt string `json:"completed_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicates when the seller started processing the fulfillment. This field is automatically set when the fulfillment `state` changes to `RESERVED`. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	InProgressAt string `json:"in_progress_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was rejected. This field is automatically set when the fulfillment `state` changes to `FAILED`. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	RejectedAt string `json:"rejected_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the seller marked the fulfillment as ready for courier pickup. This field is automatically set when the fulfillment `state` changes to PREPARED. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	ReadyAt string `json:"ready_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was delivered to the recipient. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	DeliveredAt string `json:"delivered_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was canceled. This field is automatically set when the fulfillment `state` changes to `CANCELED`.  The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	CanceledAt string `json:"canceled_at,omitempty"`
	// The delivery cancellation reason. Max length: 100 characters.
	CancelReason string `json:"cancel_reason,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when an order can be picked up by the courier for delivery. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	CourierPickupAt string `json:"courier_pickup_at,omitempty"`
	// The time period after `courier_pickup_at` in which the courier should pick up the order. The duration must be in RFC 3339 format (for example, \"P1W3D\").
	CourierPickupWindowDuration string `json:"courier_pickup_window_duration,omitempty"`
	// Whether the delivery is preferred to be no contact.
	IsNoContactDelivery bool `json:"is_no_contact_delivery,omitempty"`
	// A note to provide additional instructions about how to deliver the order.
	DropoffNotes string `json:"dropoff_notes,omitempty"`
	// The name of the courier provider.
	CourierProviderName string `json:"courier_provider_name,omitempty"`
	// The support phone number of the courier.
	CourierSupportPhoneNumber string `json:"courier_support_phone_number,omitempty"`
	// The identifier for the delivery created by Square.
	SquareDeliveryId string `json:"square_delivery_id,omitempty"`
	// The identifier for the delivery created by the third-party courier service.
	ExternalDeliveryId string `json:"external_delivery_id,omitempty"`
	// The flag to indicate the delivery is managed by a third party (ie DoorDash), which means we may not receive all recipient information for PII purposes.
	ManagedDelivery bool `json:"managed_delivery,omitempty"`
}

Describes delivery details of an order fulfillment.

type FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType ¶

type FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType string

FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType : The schedule type of the delivery fulfillment.

const (
	SCHEDULED_FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType = "SCHEDULED"
	ASAP_FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType      FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType = "ASAP"
)

List of FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType

type FulfillmentFulfillmentEntry ¶

type FulfillmentFulfillmentEntry struct {
	// A unique ID that identifies the fulfillment entry only within this order.
	Uid string `json:"uid,omitempty"`
	// The `uid` from the order line item.
	LineItemUid string `json:"line_item_uid"`
	// The quantity of the line item being fulfilled, formatted as a decimal number. For example, `\"3\"`.  Fulfillments for line items with a `quantity_unit` can have non-integer quantities. For example, `\"1.70000\"`.
	Quantity string `json:"quantity"`
	// Application-defined data attached to this fulfillment entry. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details).  Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character.  Values have a maximum length of 255 characters.  An application can have up to 10 entries per metadata field.  Entries written by applications are private and can only be read or modified by the same application.  For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).
	Metadata map[string]string `json:"metadata,omitempty"`
}

Links an order line item to a fulfillment. Each entry must reference a valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to fulfill.

type FulfillmentFulfillmentLineItemApplication ¶

type FulfillmentFulfillmentLineItemApplication string

FulfillmentFulfillmentLineItemApplication : The `line_item_application` describes what order line items this fulfillment applies to. It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries.

const (
	ALL_FulfillmentFulfillmentLineItemApplication        FulfillmentFulfillmentLineItemApplication = "ALL"
	ENTRY_LIST_FulfillmentFulfillmentLineItemApplication FulfillmentFulfillmentLineItemApplication = "ENTRY_LIST"
)

List of FulfillmentFulfillmentLineItemApplication

type FulfillmentPickupDetails ¶

type FulfillmentPickupDetails struct {
	Recipient *FulfillmentRecipient `json:"recipient,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when this fulfillment expires if it is not marked in progress. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\"). The expiration time can only be set up to 7 days in the future. If `expires_at` is not set, any new payments attached to the order are automatically completed.
	ExpiresAt string `json:"expires_at,omitempty"`
	// The duration of time after which an in progress pickup fulfillment is automatically moved to the `COMPLETED` state. The duration must be in RFC 3339 format (for example, \"P1W3D\").  If not set, this pickup fulfillment remains in progress until it is canceled or completed.
	AutoCompleteDuration string `json:"auto_complete_duration,omitempty"`
	// The schedule type of the pickup fulfillment. Defaults to `SCHEDULED`.
	ScheduleType string `json:"schedule_type,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) that represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\".  For fulfillments with the schedule type `ASAP`, this is automatically set to the current time plus the expected duration to prepare the fulfillment.
	PickupAt string `json:"pickup_at,omitempty"`
	// The window of time in which the order should be picked up after the `pickup_at` timestamp. Must be in RFC 3339 duration format, e.g., \"P1W3D\". Can be used as an informational guideline for merchants.
	PickupWindowDuration string `json:"pickup_window_duration,omitempty"`
	// The duration of time it takes to prepare this fulfillment. The duration must be in RFC 3339 format (for example, \"P1W3D\").
	PrepTimeDuration string `json:"prep_time_duration,omitempty"`
	// A note to provide additional instructions about the pickup fulfillment displayed in the Square Point of Sale application and set by the API.
	Note string `json:"note,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was placed. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	PlacedAt string `json:"placed_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was marked in progress. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	AcceptedAt string `json:"accepted_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was rejected. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	RejectedAt string `json:"rejected_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment is marked as ready for pickup. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	ReadyAt string `json:"ready_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment expired. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	ExpiredAt string `json:"expired_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was picked up by the recipient. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	PickedUpAt string `json:"picked_up_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was canceled. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	CanceledAt string `json:"canceled_at,omitempty"`
	// A description of why the pickup was canceled. The maximum length: 100 characters.
	CancelReason string `json:"cancel_reason,omitempty"`
	// If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup.
	IsCurbsidePickup      bool                                           `json:"is_curbside_pickup,omitempty"`
	CurbsidePickupDetails *FulfillmentPickupDetailsCurbsidePickupDetails `json:"curbside_pickup_details,omitempty"`
}

Contains details necessary to fulfill a pickup order.

type FulfillmentPickupDetailsCurbsidePickupDetails ¶

type FulfillmentPickupDetailsCurbsidePickupDetails struct {
	// Specific details for curbside pickup, such as parking number and vehicle model.
	CurbsideDetails string `json:"curbside_details,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the buyer arrived and is waiting for pickup. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	BuyerArrivedAt string `json:"buyer_arrived_at,omitempty"`
}

Specific details for curbside pickup.

type FulfillmentPickupDetailsScheduleType ¶

type FulfillmentPickupDetailsScheduleType string

FulfillmentPickupDetailsScheduleType : The schedule type of the pickup fulfillment.

const (
	SCHEDULED_FulfillmentPickupDetailsScheduleType FulfillmentPickupDetailsScheduleType = "SCHEDULED"
	ASAP_FulfillmentPickupDetailsScheduleType      FulfillmentPickupDetailsScheduleType = "ASAP"
)

List of FulfillmentPickupDetailsScheduleType

type FulfillmentRecipient ¶

type FulfillmentRecipient struct {
	// The ID of the customer associated with the fulfillment.  If `customer_id` is provided, the fulfillment recipient's `display_name`, `email_address`, and `phone_number` are automatically populated from the targeted customer profile. If these fields are set in the request, the request values override the information from the customer profile. If the targeted customer profile does not contain the necessary information and these fields are left unset, the request results in an error.
	CustomerId string `json:"customer_id,omitempty"`
	// The display name of the fulfillment recipient. This field is required.  If provided, the display name overrides the corresponding customer profile value indicated by `customer_id`.
	DisplayName string `json:"display_name,omitempty"`
	// The email address of the fulfillment recipient.  If provided, the email address overrides the corresponding customer profile value indicated by `customer_id`.
	EmailAddress string `json:"email_address,omitempty"`
	// The phone number of the fulfillment recipient. This field is required.  If provided, the phone number overrides the corresponding customer profile value indicated by `customer_id`.
	PhoneNumber string   `json:"phone_number,omitempty"`
	Address     *Address `json:"address,omitempty"`
}

Information about the fulfillment recipient.

type FulfillmentShipmentDetails ¶

type FulfillmentShipmentDetails struct {
	Recipient *FulfillmentRecipient `json:"recipient,omitempty"`
	// The shipping carrier being used to ship this fulfillment (such as UPS, FedEx, or USPS).
	Carrier string `json:"carrier,omitempty"`
	// A note with additional information for the shipping carrier.
	ShippingNote string `json:"shipping_note,omitempty"`
	// A description of the type of shipping product purchased from the carrier (such as First Class, Priority, or Express).
	ShippingType string `json:"shipping_type,omitempty"`
	// The reference number provided by the carrier to track the shipment's progress.
	TrackingNumber string `json:"tracking_number,omitempty"`
	// A link to the tracking webpage on the carrier's website.
	TrackingUrl string `json:"tracking_url,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the shipment was requested. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	PlacedAt string `json:"placed_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when this fulfillment was moved to the `RESERVED` state, which  indicates that preparation of this shipment has begun. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	InProgressAt string `json:"in_progress_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when this fulfillment was moved to the `PREPARED` state, which indicates that the fulfillment is packaged. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	PackagedAt string `json:"packaged_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the shipment is expected to be delivered to the shipping carrier. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	ExpectedShippedAt string `json:"expected_shipped_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when this fulfillment was moved to the `COMPLETED` state, which indicates that the fulfillment has been given to the shipping carrier. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	ShippedAt string `json:"shipped_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating the shipment was canceled. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	CanceledAt string `json:"canceled_at,omitempty"`
	// A description of why the shipment was canceled.
	CancelReason string `json:"cancel_reason,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the shipment failed to be completed. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	FailedAt string `json:"failed_at,omitempty"`
	// A description of why the shipment failed to be completed.
	FailureReason string `json:"failure_reason,omitempty"`
}

Contains the details necessary to fulfill a shipment order.

type FulfillmentState ¶

type FulfillmentState string

FulfillmentState : The current state of this fulfillment.

const (
	PROPOSED_FulfillmentState  FulfillmentState = "PROPOSED"
	RESERVED_FulfillmentState  FulfillmentState = "RESERVED"
	PREPARED_FulfillmentState  FulfillmentState = "PREPARED"
	COMPLETED_FulfillmentState FulfillmentState = "COMPLETED"
	CANCELED_FulfillmentState  FulfillmentState = "CANCELED"
	FAILED_FulfillmentState    FulfillmentState = "FAILED"
)

List of FulfillmentState

type FulfillmentType ¶

type FulfillmentType string

FulfillmentType : The type of fulfillment.

const (
	PICKUP_FulfillmentType   FulfillmentType = "PICKUP"
	SHIPMENT_FulfillmentType FulfillmentType = "SHIPMENT"
	DELIVERY_FulfillmentType FulfillmentType = "DELIVERY"
)

List of FulfillmentType

type GenericSwaggerError ¶

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type GetBankAccountByV1IdRequest ¶

type GetBankAccountByV1IdRequest struct{}

Request object for fetching a specific `BankAccount` by the object ID.

type GetBankAccountByV1IdResponse ¶

type GetBankAccountByV1IdResponse struct {
	// Information on errors encountered during the request.
	Errors      []ModelError `json:"errors,omitempty"`
	BankAccount *BankAccount `json:"bank_account,omitempty"`
}

Response object returned by GetBankAccountByV1Id.

type GetBankAccountRequest ¶

type GetBankAccountRequest struct{}

Request object to fetch a specific `BankAccount` by the object ID.

type GetBankAccountResponse ¶

type GetBankAccountResponse struct {
	// Information on errors encountered during the request.
	Errors      []ModelError `json:"errors,omitempty"`
	BankAccount *BankAccount `json:"bank_account,omitempty"`
}

Response object returned by `GetBankAccount`.

type GetBreakTypeRequest ¶

type GetBreakTypeRequest struct{}

A request to get a `BreakType` by ID.

type GetBreakTypeResponse ¶

type GetBreakTypeResponse struct {
	BreakType *BreakType `json:"break_type,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

The response to a request to get a `BreakType`. The response contains the requested `BreakType` objects and might contain a set of `Error` objects if the request resulted in errors.

type GetDeviceCodeRequest ¶

type GetDeviceCodeRequest struct{}

type GetDeviceCodeResponse ¶

type GetDeviceCodeResponse struct {
	// Any errors that occurred during the request.
	Errors     []ModelError `json:"errors,omitempty"`
	DeviceCode *DeviceCode  `json:"device_code,omitempty"`
}

type GetDeviceRequest ¶

type GetDeviceRequest struct{}

type GetDeviceResponse ¶

type GetDeviceResponse struct {
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	Device *Device      `json:"device,omitempty"`
}

type GetEmployeeWageRequest ¶

type GetEmployeeWageRequest struct{}

A request to get an `EmployeeWage`.

type GetEmployeeWageResponse ¶

type GetEmployeeWageResponse struct {
	EmployeeWage *EmployeeWage `json:"employee_wage,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

A response to a request to get an `EmployeeWage`. The response contains the requested `EmployeeWage` objects and might contain a set of `Error` objects if the request resulted in errors.

type GetInvoiceRequest ¶

type GetInvoiceRequest struct{}

Describes a `GetInvoice` request.

type GetInvoiceResponse ¶

type GetInvoiceResponse struct {
	Invoice *Invoice `json:"invoice,omitempty"`
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Describes a `GetInvoice` response.

type GetPaymentRefundRequest ¶

type GetPaymentRefundRequest struct{}

Describes a request to retrieve a refund using [GetPaymentRefund](https://developer.squareup.com/reference/square_2024-07-17/refunds-api/get-payment-refund).

type GetPaymentRefundResponse ¶

type GetPaymentRefundResponse struct {
	// Information about errors encountered during the request.
	Errors []ModelError   `json:"errors,omitempty"`
	Refund *PaymentRefund `json:"refund,omitempty"`
}

Defines the response returned by [GetRefund](https://developer.squareup.com/reference/square_2024-07-17/refunds-api/get-payment-refund). Note: If there are errors processing the request, the refund field might not be present or it might be present in a FAILED state.

type GetPaymentRequest ¶

type GetPaymentRequest struct{}

Describes a request to retrieve a payment using [GetPayment](https://developer.squareup.com/reference/square_2024-07-17/payments-api/get-payment).

type GetPaymentResponse ¶

type GetPaymentResponse struct {
	// Information about errors encountered during the request.
	Errors  []ModelError `json:"errors,omitempty"`
	Payment *Payment     `json:"payment,omitempty"`
}

Defines the response returned by [GetPayment](https://developer.squareup.com/reference/square_2024-07-17/payments-api/get-payment).

type GetPayoutRequest ¶

type GetPayoutRequest struct{}

type GetPayoutResponse ¶

type GetPayoutResponse struct {
	Payout *Payout `json:"payout,omitempty"`
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type GetShiftRequest ¶

type GetShiftRequest struct{}

A request to get a `Shift` by ID.

type GetShiftResponse ¶

type GetShiftResponse struct {
	Shift *Shift `json:"shift,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

A response to a request to get a `Shift`. The response contains the requested `Shift` object and might contain a set of `Error` objects if the request resulted in errors.

type GetTeamMemberWageRequest ¶

type GetTeamMemberWageRequest struct{}

A request to get a `TeamMemberWage`.

type GetTeamMemberWageResponse ¶

type GetTeamMemberWageResponse struct {
	TeamMemberWage *TeamMemberWage `json:"team_member_wage,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

A response to a request to get a `TeamMemberWage`. The response contains the requested `TeamMemberWage` objects and might contain a set of `Error` objects if the request resulted in errors.

type GetTerminalActionRequest ¶

type GetTerminalActionRequest struct{}

type GetTerminalActionResponse ¶

type GetTerminalActionResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError    `json:"errors,omitempty"`
	Action *TerminalAction `json:"action,omitempty"`
}

type GetTerminalCheckoutRequest ¶

type GetTerminalCheckoutRequest struct{}

type GetTerminalCheckoutResponse ¶

type GetTerminalCheckoutResponse struct {
	// Information about errors encountered during the request.
	Errors   []ModelError      `json:"errors,omitempty"`
	Checkout *TerminalCheckout `json:"checkout,omitempty"`
}

type GetTerminalRefundRequest ¶

type GetTerminalRefundRequest struct{}

type GetTerminalRefundResponse ¶

type GetTerminalRefundResponse struct {
	// Information about errors encountered during the request.
	Errors []ModelError    `json:"errors,omitempty"`
	Refund *TerminalRefund `json:"refund,omitempty"`
}

type GiftCard ¶

type GiftCard struct {
	// The Square-assigned ID of the gift card.
	Id string `json:"id,omitempty"`
	// The gift card type.
	Type_ string `json:"type"`
	// The source that generated the gift card account number (GAN). The default value is `SQUARE`.
	GanSource string `json:"gan_source,omitempty"`
	// The current gift card state.
	State        string `json:"state,omitempty"`
	BalanceMoney *Money `json:"balance_money,omitempty"`
	// The gift card account number (GAN). Buyers can use the GAN to make purchases or check  the gift card balance.
	Gan string `json:"gan,omitempty"`
	// The timestamp when the gift card was created, in RFC 3339 format.  In the case of a digital gift card, it is the time when you create a card  (using the Square Point of Sale application, Seller Dashboard, or Gift Cards API).   In the case of a plastic gift card, it is the time when Square associates the card with the  seller at the time of activation.
	CreatedAt string `json:"created_at,omitempty"`
	// The IDs of the [customer profiles](https://developer.squareup.com/reference/square_2024-07-17/objects/Customer) to whom this gift card is linked.
	CustomerIds []string `json:"customer_ids,omitempty"`
}

Represents a Square gift card.

type GiftCardActivitiesApiListGiftCardActivitiesOpts ¶

type GiftCardActivitiesApiListGiftCardActivitiesOpts struct {
	GiftCardId optional.String
	Type_      optional.String
	LocationId optional.String
	BeginTime  optional.String
	EndTime    optional.String
	Limit      optional.Int32
	Cursor     optional.String
	SortOrder  optional.String
}

type GiftCardActivitiesApiService ¶

type GiftCardActivitiesApiService service

func (*GiftCardActivitiesApiService) CreateGiftCardActivity ¶

func (a *GiftCardActivitiesApiService) CreateGiftCardActivity(ctx context.Context, body CreateGiftCardActivityRequest) (CreateGiftCardActivityResponse, *http.Response, error)

GiftCardActivitiesApiService CreateGiftCardActivity Creates a gift card activity to manage the balance or state of a [gift card](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCard). For example, you create an `ACTIVATE` activity to activate a gift card with an initial balance before the gift card can be used.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateGiftCardActivityResponse

func (*GiftCardActivitiesApiService) ListGiftCardActivities ¶

func (a *GiftCardActivitiesApiService) ListGiftCardActivities(ctx context.Context, localVarOptionals *GiftCardActivitiesApiListGiftCardActivitiesOpts) (ListGiftCardActivitiesResponse, *http.Response, error)

type GiftCardActivity ¶

type GiftCardActivity struct {
	// The Square-assigned ID of the gift card activity.
	Id string `json:"id,omitempty"`
	// The type of gift card activity.
	Type_ string `json:"type"`
	// The ID of the [business location](https://developer.squareup.com/reference/square_2024-07-17/objects/Location) where the activity occurred.
	LocationId string `json:"location_id"`
	// The timestamp when the gift card activity was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The gift card ID. When creating a gift card activity, `gift_card_id` is not required if  `gift_card_gan` is specified.
	GiftCardId string `json:"gift_card_id,omitempty"`
	// The gift card account number (GAN). When creating a gift card activity, `gift_card_gan`  is not required if `gift_card_id` is specified.
	GiftCardGan                           string                                  `json:"gift_card_gan,omitempty"`
	GiftCardBalanceMoney                  *Money                                  `json:"gift_card_balance_money,omitempty"`
	LoadActivityDetails                   *GiftCardActivityLoad                   `json:"load_activity_details,omitempty"`
	ActivateActivityDetails               *GiftCardActivityActivate               `json:"activate_activity_details,omitempty"`
	RedeemActivityDetails                 *GiftCardActivityRedeem                 `json:"redeem_activity_details,omitempty"`
	ClearBalanceActivityDetails           *GiftCardActivityClearBalance           `json:"clear_balance_activity_details,omitempty"`
	DeactivateActivityDetails             *GiftCardActivityDeactivate             `json:"deactivate_activity_details,omitempty"`
	AdjustIncrementActivityDetails        *GiftCardActivityAdjustIncrement        `json:"adjust_increment_activity_details,omitempty"`
	AdjustDecrementActivityDetails        *GiftCardActivityAdjustDecrement        `json:"adjust_decrement_activity_details,omitempty"`
	RefundActivityDetails                 *GiftCardActivityRefund                 `json:"refund_activity_details,omitempty"`
	UnlinkedActivityRefundActivityDetails *GiftCardActivityUnlinkedActivityRefund `json:"unlinked_activity_refund_activity_details,omitempty"`
	ImportActivityDetails                 *GiftCardActivityImport                 `json:"import_activity_details,omitempty"`
	BlockActivityDetails                  *GiftCardActivityBlock                  `json:"block_activity_details,omitempty"`
	UnblockActivityDetails                *GiftCardActivityUnblock                `json:"unblock_activity_details,omitempty"`
	ImportReversalActivityDetails         *GiftCardActivityImportReversal         `json:"import_reversal_activity_details,omitempty"`
	TransferBalanceToActivityDetails      *GiftCardActivityTransferBalanceTo      `json:"transfer_balance_to_activity_details,omitempty"`
	TransferBalanceFromActivityDetails    *GiftCardActivityTransferBalanceFrom    `json:"transfer_balance_from_activity_details,omitempty"`
}

Represents an action performed on a [gift card](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCard) that affects its state or balance. A gift card activity contains information about a specific activity type. For example, a `REDEEM` activity includes a `redeem_activity_details` field that contains information about the redemption.

type GiftCardActivityActivate ¶

type GiftCardActivityActivate struct {
	AmountMoney *Money `json:"amount_money,omitempty"`
	// The ID of the [order](https://developer.squareup.com/reference/square_2024-07-17/objects/Order) that contains the `GIFT_CARD` line item.  Applications that use the Square Orders API to process orders must specify the order ID [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-07-17/gift-card-activities-api/create-gift-card-activity) request.
	OrderId string `json:"order_id,omitempty"`
	// The UID of the `GIFT_CARD` line item in the order that represents the gift card purchase.  Applications that use the Square Orders API to process orders must specify the line item UID in the [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-07-17/gift-card-activities-api/create-gift-card-activity) request.
	LineItemUid string `json:"line_item_uid,omitempty"`
	// A client-specified ID that associates the gift card activity with an entity in another system.   Applications that use a custom order processing system can use this field to track information  related to an order or payment.
	ReferenceId string `json:"reference_id,omitempty"`
	// The payment instrument IDs used to process the gift card purchase, such as a credit card ID  or bank account ID.   Applications that use a custom order processing system must specify payment instrument IDs in  the [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-07-17/gift-card-activities-api/create-gift-card-activity) request. Square uses this information to perform compliance checks.   For applications that use the Square Orders API to process payments, Square has the necessary  instrument IDs to perform compliance checks.
	BuyerPaymentInstrumentIds []string `json:"buyer_payment_instrument_ids,omitempty"`
}

Represents details about an `ACTIVATE` [gift card activity type](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCardActivityType).

type GiftCardActivityAdjustDecrement ¶

type GiftCardActivityAdjustDecrement struct {
	AmountMoney *Money `json:"amount_money"`
	// The reason the gift card balance was adjusted.
	Reason string `json:"reason"`
}

Represents details about an `ADJUST_DECREMENT` [gift card activity type](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCardActivityType).

type GiftCardActivityAdjustDecrementReason ¶

type GiftCardActivityAdjustDecrementReason string

GiftCardActivityAdjustDecrementReason : Indicates the reason for deducting money from a [gift card](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCard).

const (
	SUSPICIOUS_ACTIVITY_GiftCardActivityAdjustDecrementReason            GiftCardActivityAdjustDecrementReason = "SUSPICIOUS_ACTIVITY"
	BALANCE_ACCIDENTALLY_INCREASED_GiftCardActivityAdjustDecrementReason GiftCardActivityAdjustDecrementReason = "BALANCE_ACCIDENTALLY_INCREASED"
	SUPPORT_ISSUE_GiftCardActivityAdjustDecrementReason                  GiftCardActivityAdjustDecrementReason = "SUPPORT_ISSUE"
	PURCHASE_WAS_REFUNDED_GiftCardActivityAdjustDecrementReason          GiftCardActivityAdjustDecrementReason = "PURCHASE_WAS_REFUNDED"
)

List of GiftCardActivityAdjustDecrementReason

type GiftCardActivityAdjustIncrement ¶

type GiftCardActivityAdjustIncrement struct {
	AmountMoney *Money `json:"amount_money"`
	// The reason the gift card balance was adjusted.
	Reason string `json:"reason"`
}

Represents details about an `ADJUST_INCREMENT` [gift card activity type](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCardActivityType).

type GiftCardActivityAdjustIncrementReason ¶

type GiftCardActivityAdjustIncrementReason string

GiftCardActivityAdjustIncrementReason : Indicates the reason for adding money to a [gift card](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCard).

const (
	COMPLIMENTARY_GiftCardActivityAdjustIncrementReason      GiftCardActivityAdjustIncrementReason = "COMPLIMENTARY"
	SUPPORT_ISSUE_GiftCardActivityAdjustIncrementReason      GiftCardActivityAdjustIncrementReason = "SUPPORT_ISSUE"
	TRANSACTION_VOIDED_GiftCardActivityAdjustIncrementReason GiftCardActivityAdjustIncrementReason = "TRANSACTION_VOIDED"
)

List of GiftCardActivityAdjustIncrementReason

type GiftCardActivityBlock ¶

type GiftCardActivityBlock struct {
	// The reason the gift card was blocked.
	Reason string `json:"reason"`
}

Represents details about a `BLOCK` [gift card activity type](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCardActivityType).

type GiftCardActivityBlockReason ¶

type GiftCardActivityBlockReason string

GiftCardActivityBlockReason : Indicates the reason for blocking a [gift card](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCard).

const (
	CHARGEBACK_BLOCK_GiftCardActivityBlockReason GiftCardActivityBlockReason = "CHARGEBACK_BLOCK"
)

List of GiftCardActivityBlockReason

type GiftCardActivityClearBalance ¶

type GiftCardActivityClearBalance struct {
	// The reason the gift card balance was cleared.
	Reason string `json:"reason"`
}

Represents details about a `CLEAR_BALANCE` [gift card activity type](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCardActivityType).

type GiftCardActivityClearBalanceReason ¶

type GiftCardActivityClearBalanceReason string

GiftCardActivityClearBalanceReason : Indicates the reason for clearing the balance of a [gift card](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCard).

const (
	SUSPICIOUS_ACTIVITY_GiftCardActivityClearBalanceReason GiftCardActivityClearBalanceReason = "SUSPICIOUS_ACTIVITY"
	REUSE_GIFTCARD_GiftCardActivityClearBalanceReason      GiftCardActivityClearBalanceReason = "REUSE_GIFTCARD"
	UNKNOWN_REASON_GiftCardActivityClearBalanceReason      GiftCardActivityClearBalanceReason = "UNKNOWN_REASON"
)

List of GiftCardActivityClearBalanceReason

type GiftCardActivityDeactivate ¶

type GiftCardActivityDeactivate struct {
	// The reason the gift card was deactivated.
	Reason string `json:"reason"`
}

Represents details about a `DEACTIVATE` [gift card activity type](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCardActivityType).

type GiftCardActivityDeactivateReason ¶

type GiftCardActivityDeactivateReason string

GiftCardActivityDeactivateReason : Indicates the reason for deactivating a [gift card](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCard).

const (
	SUSPICIOUS_ACTIVITY_GiftCardActivityDeactivateReason   GiftCardActivityDeactivateReason = "SUSPICIOUS_ACTIVITY"
	UNKNOWN_REASON_GiftCardActivityDeactivateReason        GiftCardActivityDeactivateReason = "UNKNOWN_REASON"
	CHARGEBACK_DEACTIVATE_GiftCardActivityDeactivateReason GiftCardActivityDeactivateReason = "CHARGEBACK_DEACTIVATE"
)

List of GiftCardActivityDeactivateReason

type GiftCardActivityImport ¶

type GiftCardActivityImport struct {
	AmountMoney *Money `json:"amount_money"`
}

Represents details about an `IMPORT` [gift card activity type](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCardActivityType). This activity type is used when Square imports a third-party gift card, in which case the `gan_source` of the gift card is set to `OTHER`.

type GiftCardActivityImportReversal ¶

type GiftCardActivityImportReversal struct {
	AmountMoney *Money `json:"amount_money"`
}

Represents details about an `IMPORT_REVERSAL` [gift card activity type](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCardActivityType).

type GiftCardActivityLoad ¶

type GiftCardActivityLoad struct {
	AmountMoney *Money `json:"amount_money,omitempty"`
	// The ID of the [order](https://developer.squareup.com/reference/square_2024-07-17/objects/Order) that contains the `GIFT_CARD` line item.  Applications that use the Square Orders API to process orders must specify the order ID in the  [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-07-17/gift-card-activities-api/create-gift-card-activity) request.
	OrderId string `json:"order_id,omitempty"`
	// The UID of the `GIFT_CARD` line item in the order that represents the additional funds for the gift card.  Applications that use the Square Orders API to process orders must specify the line item UID in the [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-07-17/gift-card-activities-api/create-gift-card-activity) request.
	LineItemUid string `json:"line_item_uid,omitempty"`
	// A client-specified ID that associates the gift card activity with an entity in another system.   Applications that use a custom order processing system can use this field to track information related to  an order or payment.
	ReferenceId string `json:"reference_id,omitempty"`
	// The payment instrument IDs used to process the order for the additional funds, such as a credit card ID  or bank account ID.   Applications that use a custom order processing system must specify payment instrument IDs in  the [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-07-17/gift-card-activities-api/create-gift-card-activity) request. Square uses this information to perform compliance checks.   For applications that use the Square Orders API to process payments, Square has the necessary  instrument IDs to perform compliance checks.
	BuyerPaymentInstrumentIds []string `json:"buyer_payment_instrument_ids,omitempty"`
}

Represents details about a `LOAD` [gift card activity type](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCardActivityType).

type GiftCardActivityRedeem ¶

type GiftCardActivityRedeem struct {
	AmountMoney *Money `json:"amount_money"`
	// The ID of the payment that represents the gift card redemption. Square populates this field  if the payment was processed by Square.
	PaymentId string `json:"payment_id,omitempty"`
	// A client-specified ID that associates the gift card activity with an entity in another system.   Applications that use a custom payment processing system can use this field to track information related to an order or payment.
	ReferenceId string `json:"reference_id,omitempty"`
	// The status of the gift card redemption. Gift cards redeemed from Square Point of Sale or the  Square Seller Dashboard use a two-state process: `PENDING`  to `COMPLETED` or `PENDING` to  `CANCELED`. Gift cards redeemed using the Gift Card Activities API  always have a `COMPLETED` status.
	Status string `json:"status,omitempty"`
}

Represents details about a `REDEEM` [gift card activity type](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCardActivityType).

type GiftCardActivityRedeemStatus ¶

type GiftCardActivityRedeemStatus string

GiftCardActivityRedeemStatus : Indicates the status of a [gift card](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCard) redemption. This status is relevant only for redemptions made from Square products (such as Square Point of Sale) because Square products use a two-state process. Gift cards redeemed using the Gift Card Activities API always have a `COMPLETED` status.

const (
	PENDING_GiftCardActivityRedeemStatus   GiftCardActivityRedeemStatus = "PENDING"
	COMPLETED_GiftCardActivityRedeemStatus GiftCardActivityRedeemStatus = "COMPLETED"
	CANCELED_GiftCardActivityRedeemStatus  GiftCardActivityRedeemStatus = "CANCELED"
)

List of GiftCardActivityRedeemStatus

type GiftCardActivityRefund ¶

type GiftCardActivityRefund struct {
	// The ID of the refunded `REDEEM` gift card activity. Square populates this field if the  `payment_id` in the corresponding [RefundPayment](https://developer.squareup.com/reference/square_2024-07-17/refunds-api/refund-payment) request  represents a redemption made by the same gift card. Note that you must use `RefundPayment`  to refund a gift card payment to the same gift card if the payment was processed by Square.  For applications that use a custom payment processing system, this field is required when creating a `REFUND` activity. The provided `REDEEM` activity ID must be linked to the same gift card.
	RedeemActivityId string `json:"redeem_activity_id,omitempty"`
	AmountMoney      *Money `json:"amount_money,omitempty"`
	// A client-specified ID that associates the gift card activity with an entity in another system.
	ReferenceId string `json:"reference_id,omitempty"`
	// The ID of the refunded payment. Square populates this field if the refund is for a  payment processed by Square and one of the following conditions is true:  - The Refunds API is used to refund a gift card payment to the same gift card. - A seller initiated the refund from Square Point of Sale or the Seller Dashboard. The payment source can be the  same gift card or a cross-tender payment from a credit card or a different gift card.
	PaymentId string `json:"payment_id,omitempty"`
}

Represents details about a `REFUND` [gift card activity type](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCardActivityType).

type GiftCardActivityTransferBalanceFrom ¶

type GiftCardActivityTransferBalanceFrom struct {
	// The ID of the gift card to which the specified amount was transferred.
	TransferToGiftCardId string `json:"transfer_to_gift_card_id"`
	AmountMoney          *Money `json:"amount_money"`
}

Represents details about a `TRANSFER_BALANCE_FROM` [gift card activity type](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCardActivityType).

type GiftCardActivityTransferBalanceTo ¶

type GiftCardActivityTransferBalanceTo struct {
	// The ID of the gift card from which the specified amount was transferred.
	TransferFromGiftCardId string `json:"transfer_from_gift_card_id"`
	AmountMoney            *Money `json:"amount_money"`
}

Represents details about a `TRANSFER_BALANCE_TO` [gift card activity type](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCardActivityType).

type GiftCardActivityType ¶

type GiftCardActivityType string

GiftCardActivityType : Indicates the type of [gift card activity](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCardActivity).

const (
	ACTIVATE_GiftCardActivityType                 GiftCardActivityType = "ACTIVATE"
	LOAD_GiftCardActivityType                     GiftCardActivityType = "LOAD"
	REDEEM_GiftCardActivityType                   GiftCardActivityType = "REDEEM"
	CLEAR_BALANCE_GiftCardActivityType            GiftCardActivityType = "CLEAR_BALANCE"
	DEACTIVATE_GiftCardActivityType               GiftCardActivityType = "DEACTIVATE"
	ADJUST_INCREMENT_GiftCardActivityType         GiftCardActivityType = "ADJUST_INCREMENT"
	ADJUST_DECREMENT_GiftCardActivityType         GiftCardActivityType = "ADJUST_DECREMENT"
	REFUND_GiftCardActivityType                   GiftCardActivityType = "REFUND"
	UNLINKED_ACTIVITY_REFUND_GiftCardActivityType GiftCardActivityType = "UNLINKED_ACTIVITY_REFUND"
	IMPORT__GiftCardActivityType                  GiftCardActivityType = "IMPORT"
	BLOCK_GiftCardActivityType                    GiftCardActivityType = "BLOCK"
	UNBLOCK_GiftCardActivityType                  GiftCardActivityType = "UNBLOCK"
	IMPORT_REVERSAL_GiftCardActivityType          GiftCardActivityType = "IMPORT_REVERSAL"
	TRANSFER_BALANCE_FROM_GiftCardActivityType    GiftCardActivityType = "TRANSFER_BALANCE_FROM"
	TRANSFER_BALANCE_TO_GiftCardActivityType      GiftCardActivityType = "TRANSFER_BALANCE_TO"
)

List of GiftCardActivityType

type GiftCardActivityUnblock ¶

type GiftCardActivityUnblock struct {
	// The reason the gift card was unblocked.
	Reason string `json:"reason"`
}

Represents details about an `UNBLOCK` [gift card activity type](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCardActivityType).

type GiftCardActivityUnblockReason ¶

type GiftCardActivityUnblockReason string

GiftCardActivityUnblockReason : Indicates the reason for unblocking a [gift card](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCard).

const (
	CHARGEBACK_UNBLOCK_GiftCardActivityUnblockReason GiftCardActivityUnblockReason = "CHARGEBACK_UNBLOCK"
)

List of GiftCardActivityUnblockReason

type GiftCardActivityUnlinkedActivityRefund ¶

type GiftCardActivityUnlinkedActivityRefund struct {
	AmountMoney *Money `json:"amount_money"`
	// A client-specified ID that associates the gift card activity with an entity in another system.
	ReferenceId string `json:"reference_id,omitempty"`
	// The ID of the refunded payment. This field is not used starting in Square version 2022-06-16.
	PaymentId string `json:"payment_id,omitempty"`
}

Represents details about an `UNLINKED_ACTIVITY_REFUND` [gift card activity type](https://developer.squareup.com/reference/square_2024-07-17/objects/GiftCardActivityType).

type GiftCardGanSource ¶

type GiftCardGanSource string

GiftCardGanSource : Indicates the source that generated the gift card account number (GAN).

const (
	SQUARE_GiftCardGanSource GiftCardGanSource = "SQUARE"
	OTHER_GiftCardGanSource  GiftCardGanSource = "OTHER"
)

List of GiftCardGANSource

type GiftCardStatus ¶

type GiftCardStatus string

GiftCardStatus : Indicates the gift card state.

const (
	ACTIVE_GiftCardStatus      GiftCardStatus = "ACTIVE"
	DEACTIVATED_GiftCardStatus GiftCardStatus = "DEACTIVATED"
	BLOCKED_GiftCardStatus     GiftCardStatus = "BLOCKED"
	PENDING_GiftCardStatus     GiftCardStatus = "PENDING"
)

List of GiftCardStatus

type GiftCardType ¶

type GiftCardType string

GiftCardType : Indicates the gift card type.

const (
	PHYSICAL_GiftCardType GiftCardType = "PHYSICAL"
	DIGITAL_GiftCardType  GiftCardType = "DIGITAL"
)

List of GiftCardType

type GiftCardsApiListGiftCardsOpts ¶

type GiftCardsApiListGiftCardsOpts struct {
	Type_      optional.String
	State      optional.String
	Limit      optional.Int32
	Cursor     optional.String
	CustomerId optional.String
}

type GiftCardsApiService ¶

type GiftCardsApiService service

func (*GiftCardsApiService) CreateGiftCard ¶

func (a *GiftCardsApiService) CreateGiftCard(ctx context.Context, body CreateGiftCardRequest) (CreateGiftCardResponse, *http.Response, error)

GiftCardsApiService CreateGiftCard Creates a digital gift card or registers a physical (plastic) gift card. After the gift card is created, you must call [CreateGiftCardActivity](https://developer.squareup.com/reference/square_2024-07-17/gift-card-activities-api/create-gift-card-activity) to activate the card with an initial balance before it can be used for payment.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateGiftCardResponse

func (*GiftCardsApiService) LinkCustomerToGiftCard ¶

func (a *GiftCardsApiService) LinkCustomerToGiftCard(ctx context.Context, body LinkCustomerToGiftCardRequest, giftCardId string) (LinkCustomerToGiftCardResponse, *http.Response, error)

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

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param giftCardId The ID of the gift card to be linked.

@return LinkCustomerToGiftCardResponse

func (*GiftCardsApiService) ListGiftCards ¶

func (a *GiftCardsApiService) ListGiftCards(ctx context.Context, localVarOptionals *GiftCardsApiListGiftCardsOpts) (ListGiftCardsResponse, *http.Response, error)

func (*GiftCardsApiService) RetrieveGiftCard ¶

func (a *GiftCardsApiService) RetrieveGiftCard(ctx context.Context, id string) (RetrieveGiftCardResponse, *http.Response, error)

GiftCardsApiService RetrieveGiftCard Retrieves a gift card using the gift card ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The ID of the gift card to retrieve.

@return RetrieveGiftCardResponse

func (*GiftCardsApiService) RetrieveGiftCardFromGAN ¶

func (a *GiftCardsApiService) RetrieveGiftCardFromGAN(ctx context.Context, body RetrieveGiftCardFromGanRequest) (RetrieveGiftCardFromGanResponse, *http.Response, error)

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

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return RetrieveGiftCardFromGanResponse

func (*GiftCardsApiService) RetrieveGiftCardFromNonce ¶

func (a *GiftCardsApiService) RetrieveGiftCardFromNonce(ctx context.Context, body RetrieveGiftCardFromNonceRequest) (RetrieveGiftCardFromNonceResponse, *http.Response, error)

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

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return RetrieveGiftCardFromNonceResponse

func (*GiftCardsApiService) UnlinkCustomerFromGiftCard ¶

func (a *GiftCardsApiService) UnlinkCustomerFromGiftCard(ctx context.Context, body UnlinkCustomerFromGiftCardRequest, giftCardId string) (UnlinkCustomerFromGiftCardResponse, *http.Response, error)

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

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param giftCardId The ID of the gift card to be unlinked.

@return UnlinkCustomerFromGiftCardResponse

type InventoryAdjustment ¶

type InventoryAdjustment struct {
	// A unique ID generated by Square for the `InventoryAdjustment`.
	Id string `json:"id,omitempty"`
	// An optional ID provided by the application to tie the `InventoryAdjustment` to an external system.
	ReferenceId string `json:"reference_id,omitempty"`
	// The [inventory state](https://developer.squareup.com/reference/square_2024-07-17/enums/InventoryState) of the related quantity of items before the adjustment.
	FromState string `json:"from_state,omitempty"`
	// The [inventory state](https://developer.squareup.com/reference/square_2024-07-17/enums/InventoryState) of the related quantity of items after the adjustment.
	ToState string `json:"to_state,omitempty"`
	// The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2024-07-17/objects/Location) where the related quantity of items is being tracked.
	LocationId string `json:"location_id,omitempty"`
	// The Square-generated ID of the [CatalogObject](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject) being tracked.
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The [type](https://developer.squareup.com/reference/square_2024-07-17/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject) being tracked.   The Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value.  In addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app.
	CatalogObjectType string `json:"catalog_object_type,omitempty"`
	// The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point.
	Quantity        string `json:"quantity,omitempty"`
	TotalPriceMoney *Money `json:"total_price_money,omitempty"`
	// A client-generated RFC 3339-formatted timestamp that indicates when the inventory adjustment took place. For inventory adjustment updates, the `occurred_at` timestamp cannot be older than 24 hours or in the future relative to the time of the request.
	OccurredAt string `json:"occurred_at,omitempty"`
	// An RFC 3339-formatted timestamp that indicates when the inventory adjustment is received.
	CreatedAt string             `json:"created_at,omitempty"`
	Source    *SourceApplication `json:"source,omitempty"`
	// The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2024-07-17/objects/Employee) responsible for the inventory adjustment.
	EmployeeId string `json:"employee_id,omitempty"`
	// The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2024-07-17/objects/TeamMember) responsible for the inventory adjustment.
	TeamMemberId string `json:"team_member_id,omitempty"`
	// The Square-generated ID of the [Transaction](https://developer.squareup.com/reference/square_2024-07-17/objects/Transaction) that caused the adjustment. Only relevant for payment-related state transitions.
	TransactionId string `json:"transaction_id,omitempty"`
	// The Square-generated ID of the [Refund](https://developer.squareup.com/reference/square_2024-07-17/objects/Refund) that caused the adjustment. Only relevant for refund-related state transitions.
	RefundId string `json:"refund_id,omitempty"`
	// The Square-generated ID of the purchase order that caused the adjustment. Only relevant for state transitions from the Square for Retail app.
	PurchaseOrderId string `json:"purchase_order_id,omitempty"`
	// The Square-generated ID of the goods receipt that caused the adjustment. Only relevant for state transitions from the Square for Retail app.
	GoodsReceiptId  string                    `json:"goods_receipt_id,omitempty"`
	AdjustmentGroup *InventoryAdjustmentGroup `json:"adjustment_group,omitempty"`
}

Represents a change in state or quantity of product inventory at a particular time and location.

type InventoryAdjustmentGroup ¶

type InventoryAdjustmentGroup struct {
	// A unique ID generated by Square for the `InventoryAdjustmentGroup`.
	Id string `json:"id,omitempty"`
	// The inventory adjustment of the composed variation.
	RootAdjustmentId string `json:"root_adjustment_id,omitempty"`
	// Representative `from_state` for adjustments within the group. For example, for a group adjustment from `IN_STOCK` to `SOLD`, there can be two component adjustments in the group: one from `IN_STOCK`to `COMPOSED` and the other one from `COMPOSED` to `SOLD`. Here, the representative `from_state` for the `InventoryAdjustmentGroup` is `IN_STOCK`.
	FromState string `json:"from_state,omitempty"`
	// Representative `to_state` for adjustments within group. For example, for a group adjustment from `IN_STOCK` to `SOLD`, the two component adjustments in the group can be from `IN_STOCK` to `COMPOSED` and from `COMPOSED` to `SOLD`. Here, the representative `to_state` of the `InventoryAdjustmentGroup` is `SOLD`.
	ToState string `json:"to_state,omitempty"`
}

type InventoryAlertType ¶

type InventoryAlertType string

InventoryAlertType : Indicates whether Square should alert the merchant when the inventory quantity of a CatalogItemVariation is low.

const (
	NONE_InventoryAlertType         InventoryAlertType = "NONE"
	LOW_QUANTITY_InventoryAlertType InventoryAlertType = "LOW_QUANTITY"
)

List of InventoryAlertType

type InventoryApiRetrieveInventoryChangesOpts ¶

type InventoryApiRetrieveInventoryChangesOpts struct {
	LocationIds optional.String
	Cursor      optional.String
}

type InventoryApiRetrieveInventoryCountOpts ¶

type InventoryApiRetrieveInventoryCountOpts struct {
	LocationIds optional.String
	Cursor      optional.String
}

type InventoryApiService ¶

type InventoryApiService service

func (*InventoryApiService) BatchChangeInventory ¶

func (a *InventoryApiService) BatchChangeInventory(ctx context.Context, body BatchChangeInventoryRequest) (BatchChangeInventoryResponse, *http.Response, error)

InventoryApiService BatchChangeInventory Applies adjustments and counts to the provided item quantities. On success: returns the current calculated counts for all objects referenced in the request. On failure: returns a list of related errors.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BatchChangeInventoryResponse

func (*InventoryApiService) BatchRetrieveInventoryChanges ¶

func (a *InventoryApiService) BatchRetrieveInventoryChanges(ctx context.Context, body BatchRetrieveInventoryChangesRequest) (BatchRetrieveInventoryChangesResponse, *http.Response, error)

InventoryApiService BatchRetrieveInventoryChanges Returns historical physical counts and adjustments based on the provided filter criteria. Results are paginated and sorted in ascending order according their `occurred_at` timestamp (oldest first). BatchRetrieveInventoryChanges is a catch-all query endpoint for queries that cannot be handled by other, simpler endpoints.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BatchRetrieveInventoryChangesResponse

func (*InventoryApiService) BatchRetrieveInventoryCounts ¶

func (a *InventoryApiService) BatchRetrieveInventoryCounts(ctx context.Context, body BatchRetrieveInventoryCountsRequest) (BatchRetrieveInventoryCountsResponse, *http.Response, error)

InventoryApiService BatchRetrieveInventoryCounts Returns current counts for the provided CatalogObject(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject)s at the requested Location(https://developer.squareup.com/reference/square_2024-07-17/objects/Location)s. Results are paginated and sorted in descending order according to their `calculated_at` timestamp (newest first). When `updated_after` is specified, only counts that have changed since that time (based on the server timestamp for the most recent change) are returned. This allows clients to perform a \"sync\" operation, for example in response to receiving a Webhook notification.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BatchRetrieveInventoryCountsResponse

func (*InventoryApiService) DeprecatedBatchChangeInventory ¶

func (a *InventoryApiService) DeprecatedBatchChangeInventory(ctx context.Context, body BatchChangeInventoryRequest) (BatchChangeInventoryResponse, *http.Response, error)

InventoryApiService DeprecatedBatchChangeInventory Deprecated version of [BatchChangeInventory](https://developer.squareup.com/reference/square_2024-07-17/inventory-api/batch-change-inventory) after the endpoint URL is updated to conform to the standard convention.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BatchChangeInventoryResponse

func (*InventoryApiService) DeprecatedBatchRetrieveInventoryChanges ¶

func (a *InventoryApiService) DeprecatedBatchRetrieveInventoryChanges(ctx context.Context, body BatchRetrieveInventoryChangesRequest) (BatchRetrieveInventoryChangesResponse, *http.Response, error)

InventoryApiService DeprecatedBatchRetrieveInventoryChanges Deprecated version of [BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2024-07-17/inventory-api/batch-retrieve-inventory-changes) after the endpoint URL is updated to conform to the standard convention.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BatchRetrieveInventoryChangesResponse

func (*InventoryApiService) DeprecatedBatchRetrieveInventoryCounts ¶

func (a *InventoryApiService) DeprecatedBatchRetrieveInventoryCounts(ctx context.Context, body BatchRetrieveInventoryCountsRequest) (BatchRetrieveInventoryCountsResponse, *http.Response, error)

InventoryApiService DeprecatedBatchRetrieveInventoryCounts Deprecated version of [BatchRetrieveInventoryCounts](https://developer.squareup.com/reference/square_2024-07-17/inventory-api/batch-retrieve-inventory-counts) after the endpoint URL is updated to conform to the standard convention.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BatchRetrieveInventoryCountsResponse

func (*InventoryApiService) DeprecatedRetrieveInventoryAdjustment ¶

func (a *InventoryApiService) DeprecatedRetrieveInventoryAdjustment(ctx context.Context, adjustmentId string) (RetrieveInventoryAdjustmentResponse, *http.Response, error)

InventoryApiService DeprecatedRetrieveInventoryAdjustment Deprecated version of [RetrieveInventoryAdjustment](https://developer.squareup.com/reference/square_2024-07-17/inventory-api/retrieve-inventory-adjustment) after the endpoint URL is updated to conform to the standard convention.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param adjustmentId ID of the InventoryAdjustment(https://developer.squareup.com/reference/square_2024-07-17/objects/InventoryAdjustment) to retrieve.

@return RetrieveInventoryAdjustmentResponse

func (*InventoryApiService) DeprecatedRetrieveInventoryPhysicalCount ¶

func (a *InventoryApiService) DeprecatedRetrieveInventoryPhysicalCount(ctx context.Context, physicalCountId string) (RetrieveInventoryPhysicalCountResponse, *http.Response, error)

InventoryApiService DeprecatedRetrieveInventoryPhysicalCount Deprecated version of [RetrieveInventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-07-17/inventory-api/retrieve-inventory-physical-count) after the endpoint URL is updated to conform to the standard convention.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param physicalCountId ID of the InventoryPhysicalCount(https://developer.squareup.com/reference/square_2024-07-17/objects/InventoryPhysicalCount) to retrieve.

@return RetrieveInventoryPhysicalCountResponse

func (*InventoryApiService) RetrieveInventoryAdjustment ¶

func (a *InventoryApiService) RetrieveInventoryAdjustment(ctx context.Context, adjustmentId string) (RetrieveInventoryAdjustmentResponse, *http.Response, error)

InventoryApiService RetrieveInventoryAdjustment Returns the InventoryAdjustment(https://developer.squareup.com/reference/square_2024-07-17/objects/InventoryAdjustment) object with the provided `adjustment_id`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param adjustmentId ID of the InventoryAdjustment(https://developer.squareup.com/reference/square_2024-07-17/objects/InventoryAdjustment) to retrieve.

@return RetrieveInventoryAdjustmentResponse

func (*InventoryApiService) RetrieveInventoryChanges ¶

func (a *InventoryApiService) RetrieveInventoryChanges(ctx context.Context, catalogObjectId string, localVarOptionals *InventoryApiRetrieveInventoryChangesOpts) (RetrieveInventoryChangesResponse, *http.Response, error)

func (*InventoryApiService) RetrieveInventoryCount ¶

func (a *InventoryApiService) RetrieveInventoryCount(ctx context.Context, catalogObjectId string, localVarOptionals *InventoryApiRetrieveInventoryCountOpts) (RetrieveInventoryCountResponse, *http.Response, error)

func (*InventoryApiService) RetrieveInventoryPhysicalCount ¶

func (a *InventoryApiService) RetrieveInventoryPhysicalCount(ctx context.Context, physicalCountId string) (RetrieveInventoryPhysicalCountResponse, *http.Response, error)

InventoryApiService RetrieveInventoryPhysicalCount Returns the InventoryPhysicalCount(https://developer.squareup.com/reference/square_2024-07-17/objects/InventoryPhysicalCount) object with the provided `physical_count_id`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param physicalCountId ID of the InventoryPhysicalCount(https://developer.squareup.com/reference/square_2024-07-17/objects/InventoryPhysicalCount) to retrieve.

@return RetrieveInventoryPhysicalCountResponse

func (*InventoryApiService) RetrieveInventoryTransfer ¶

func (a *InventoryApiService) RetrieveInventoryTransfer(ctx context.Context, transferId string) (RetrieveInventoryTransferResponse, *http.Response, error)

InventoryApiService RetrieveInventoryTransfer Returns the InventoryTransfer(https://developer.squareup.com/reference/square_2024-07-17/objects/InventoryTransfer) object with the provided `transfer_id`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param transferId ID of the InventoryTransfer(https://developer.squareup.com/reference/square_2024-07-17/objects/InventoryTransfer) to retrieve.

@return RetrieveInventoryTransferResponse

type InventoryChange ¶

type InventoryChange struct {
	// Indicates how the inventory change is applied. See [InventoryChangeType](https://developer.squareup.com/reference/square_2024-07-17/enums/InventoryChangeType) for all possible values.
	Type_           string                  `json:"type,omitempty"`
	PhysicalCount   *InventoryPhysicalCount `json:"physical_count,omitempty"`
	Adjustment      *InventoryAdjustment    `json:"adjustment,omitempty"`
	Transfer        *InventoryTransfer      `json:"transfer,omitempty"`
	MeasurementUnit *CatalogMeasurementUnit `json:"measurement_unit,omitempty"`
	// The ID of the [CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change.
	MeasurementUnitId string `json:"measurement_unit_id,omitempty"`
}

Represents a single physical count, inventory, adjustment, or transfer that is part of the history of inventory changes for a particular CatalogObject(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject) instance.

type InventoryChangeType ¶

type InventoryChangeType string

InventoryChangeType : Indicates how the inventory change was applied to a tracked product quantity.

const (
	PHYSICAL_COUNT_InventoryChangeType InventoryChangeType = "PHYSICAL_COUNT"
	ADJUSTMENT_InventoryChangeType     InventoryChangeType = "ADJUSTMENT"
	TRANSFER_InventoryChangeType       InventoryChangeType = "TRANSFER"
)

List of InventoryChangeType

type InventoryCount ¶

type InventoryCount struct {
	// The Square-generated ID of the [CatalogObject](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject) being tracked.
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The [type](https://developer.squareup.com/reference/square_2024-07-17/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject) being tracked.   The Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value.  In addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app.
	CatalogObjectType string `json:"catalog_object_type,omitempty"`
	// The current [inventory state](https://developer.squareup.com/reference/square_2024-07-17/enums/InventoryState) for the related quantity of items.
	State string `json:"state,omitempty"`
	// The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2024-07-17/objects/Location) where the related quantity of items is being tracked.
	LocationId string `json:"location_id,omitempty"`
	// The number of items affected by the estimated count as a decimal string. Can support up to 5 digits after the decimal point.
	Quantity string `json:"quantity,omitempty"`
	// An RFC 3339-formatted timestamp that indicates when the most recent physical count or adjustment affecting the estimated count is received.
	CalculatedAt string `json:"calculated_at,omitempty"`
	// Whether the inventory count is for composed variation (TRUE) or not (FALSE). If true, the inventory count will not be present in the response of any of these endpoints: [BatchChangeInventory](https://developer.squareup.com/reference/square_2024-07-17/inventory-api/batch-change-inventory), [BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2024-07-17/inventory-api/batch-retrieve-inventory-changes), [BatchRetrieveInventoryCounts](https://developer.squareup.com/reference/square_2024-07-17/inventory-api/batch-retrieve-inventory-counts), and [RetrieveInventoryChanges](https://developer.squareup.com/reference/square_2024-07-17/inventory-api/retrieve-inventory-changes).
	IsEstimated bool `json:"is_estimated,omitempty"`
}

Represents Square-estimated quantity of items in a particular state at a particular seller location based on the known history of physical counts and inventory adjustments.

type InventoryPhysicalCount ¶

type InventoryPhysicalCount struct {
	// A unique Square-generated ID for the [InventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-07-17/objects/InventoryPhysicalCount).
	Id string `json:"id,omitempty"`
	// An optional ID provided by the application to tie the [InventoryPhysicalCount](https://developer.squareup.com/reference/square_2024-07-17/objects/InventoryPhysicalCount) to an external system.
	ReferenceId string `json:"reference_id,omitempty"`
	// The Square-generated ID of the [CatalogObject](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject) being tracked.
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The [type](https://developer.squareup.com/reference/square_2024-07-17/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject) being tracked.   The Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value.  In addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app.
	CatalogObjectType string `json:"catalog_object_type,omitempty"`
	// The current [inventory state](https://developer.squareup.com/reference/square_2024-07-17/enums/InventoryState) for the related quantity of items.
	State string `json:"state,omitempty"`
	// The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2024-07-17/objects/Location) where the related quantity of items is being tracked.
	LocationId string `json:"location_id,omitempty"`
	// The number of items affected by the physical count as a decimal string. The number can support up to 5 digits after the decimal point.
	Quantity string             `json:"quantity,omitempty"`
	Source   *SourceApplication `json:"source,omitempty"`
	// The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2024-07-17/objects/Employee) responsible for the physical count.
	EmployeeId string `json:"employee_id,omitempty"`
	// The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2024-07-17/objects/TeamMember) responsible for the physical count.
	TeamMemberId string `json:"team_member_id,omitempty"`
	// A client-generated RFC 3339-formatted timestamp that indicates when the physical count was examined. For physical count updates, the `occurred_at` timestamp cannot be older than 24 hours or in the future relative to the time of the request.
	OccurredAt string `json:"occurred_at,omitempty"`
	// An RFC 3339-formatted timestamp that indicates when the physical count is received.
	CreatedAt string `json:"created_at,omitempty"`
}

Represents the quantity of an item variation that is physically present at a specific location, verified by a seller or a seller's employee. For example, a physical count might come from an employee counting the item variations on hand or from syncing with an external system.

type InventoryState ¶

type InventoryState string

InventoryState : Indicates the state of a tracked item quantity in the lifecycle of goods.

const (
	CUSTOM_InventoryState                     InventoryState = "CUSTOM"
	IN_STOCK_InventoryState                   InventoryState = "IN_STOCK"
	SOLD_InventoryState                       InventoryState = "SOLD"
	RETURNED_BY_CUSTOMER_InventoryState       InventoryState = "RETURNED_BY_CUSTOMER"
	RESERVED_FOR_SALE_InventoryState          InventoryState = "RESERVED_FOR_SALE"
	SOLD_ONLINE_InventoryState                InventoryState = "SOLD_ONLINE"
	ORDERED_FROM_VENDOR_InventoryState        InventoryState = "ORDERED_FROM_VENDOR"
	RECEIVED_FROM_VENDOR_InventoryState       InventoryState = "RECEIVED_FROM_VENDOR"
	IN_TRANSIT_TO_InventoryState              InventoryState = "IN_TRANSIT_TO"
	NONE_InventoryState                       InventoryState = "NONE"
	WASTE_InventoryState                      InventoryState = "WASTE"
	UNLINKED_RETURN_InventoryState            InventoryState = "UNLINKED_RETURN"
	COMPOSED_InventoryState                   InventoryState = "COMPOSED"
	DECOMPOSED_InventoryState                 InventoryState = "DECOMPOSED"
	SUPPORTED_BY_NEWER_VERSION_InventoryState InventoryState = "SUPPORTED_BY_NEWER_VERSION"
	IN_TRANSIT_InventoryState                 InventoryState = "IN_TRANSIT"
)

List of InventoryState

type InventoryTransfer ¶

type InventoryTransfer struct {
	// A unique ID generated by Square for the `InventoryTransfer`.
	Id string `json:"id,omitempty"`
	// An optional ID provided by the application to tie the `InventoryTransfer` to an external system.
	ReferenceId string `json:"reference_id,omitempty"`
	// The [inventory state](https://developer.squareup.com/reference/square_2024-07-17/enums/InventoryState) for the quantity of items being transferred.
	State string `json:"state,omitempty"`
	// The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2024-07-17/objects/Location) where the related quantity of items was tracked before the transfer.
	FromLocationId string `json:"from_location_id,omitempty"`
	// The Square-generated ID of the [Location](https://developer.squareup.com/reference/square_2024-07-17/objects/Location) where the related quantity of items was tracked after the transfer.
	ToLocationId string `json:"to_location_id,omitempty"`
	// The Square-generated ID of the [CatalogObject](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject) being tracked.
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The [type](https://developer.squareup.com/reference/square_2024-07-17/enums/CatalogObjectType) of the [CatalogObject](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject) being tracked.   The Inventory API supports setting and reading the `\"catalog_object_type\": \"ITEM_VARIATION\"` field value.  In addition, it can also read the `\"catalog_object_type\": \"ITEM\"` field value that is set by the Square Restaurants app.
	CatalogObjectType string `json:"catalog_object_type,omitempty"`
	// The number of items affected by the transfer as a decimal string. Can support up to 5 digits after the decimal point.
	Quantity string `json:"quantity,omitempty"`
	// A client-generated RFC 3339-formatted timestamp that indicates when the transfer took place. For write actions, the `occurred_at` timestamp cannot be older than 24 hours or in the future relative to the time of the request.
	OccurredAt string `json:"occurred_at,omitempty"`
	// An RFC 3339-formatted timestamp that indicates when Square received the transfer request.
	CreatedAt string             `json:"created_at,omitempty"`
	Source    *SourceApplication `json:"source,omitempty"`
	// The Square-generated ID of the [Employee](https://developer.squareup.com/reference/square_2024-07-17/objects/Employee) responsible for the inventory transfer.
	EmployeeId string `json:"employee_id,omitempty"`
	// The Square-generated ID of the [Team Member](https://developer.squareup.com/reference/square_2024-07-17/objects/TeamMember) responsible for the inventory transfer.
	TeamMemberId string `json:"team_member_id,omitempty"`
}

Represents the transfer of a quantity of product inventory at a particular time from one location to another.

type Invoice ¶

type Invoice struct {
	// The Square-assigned ID of the invoice.
	Id string `json:"id,omitempty"`
	// The Square-assigned version number, which is incremented each time an update is committed to the invoice.
	Version int32 `json:"version,omitempty"`
	// The ID of the location that this invoice is associated with.   If specified in a `CreateInvoice` request, the value must match the `location_id` of the associated order.
	LocationId string `json:"location_id,omitempty"`
	// The ID of the [order](https://developer.squareup.com/reference/square_2024-07-17/objects/Order) for which the invoice is created.  This field is required when creating an invoice, and the order must be in the `OPEN` state.  To view the line items and other information for the associated order, call the  [RetrieveOrder](https://developer.squareup.com/reference/square_2024-07-17/orders-api/retrieve-order) endpoint using the order ID.
	OrderId          string            `json:"order_id,omitempty"`
	PrimaryRecipient *InvoiceRecipient `json:"primary_recipient,omitempty"`
	// The payment schedule for the invoice, represented by one or more payment requests that define payment settings, such as amount due and due date. An invoice supports the following payment request combinations: - One balance - One deposit with one balance - 2–12 installments  - One deposit with 2–12 installments  This field is required when creating an invoice. It must contain at least one payment request.  All payment requests for the invoice must equal the total order amount. For more information, see  [Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).  Adding `INSTALLMENT` payment requests to an invoice requires an  [Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).
	PaymentRequests []InvoicePaymentRequest `json:"payment_requests,omitempty"`
	// The delivery method that Square uses to send the invoice, reminders, and receipts to the customer. After the invoice is published, Square processes the invoice based on the delivery method and payment request settings, either immediately or on the `scheduled_at` date, if specified. For example, Square might send the invoice or receipt for an automatic payment. For invoices with automatic payments, this field must be set to `EMAIL`.  One of the following is required when creating an invoice: - (Recommended) This `delivery_method` field. To configure an automatic payment, the `automatic_payment_source` field of the payment request is also required. - The deprecated `request_method` field of the payment request. Note that `invoice` objects returned in responses do not include `request_method`.
	DeliveryMethod string `json:"delivery_method,omitempty"`
	// A user-friendly invoice number that is displayed on the invoice. The value is unique within a location. If not provided when creating an invoice, Square assigns a value. It increments from 1 and is padded with zeros making it 7 characters long (for example, 0000001 and 0000002).
	InvoiceNumber string `json:"invoice_number,omitempty"`
	// The title of the invoice, which is displayed on the invoice.
	Title string `json:"title,omitempty"`
	// The description of the invoice, which is displayed on the invoice.
	Description string `json:"description,omitempty"`
	// The timestamp when the invoice is scheduled for processing, in RFC 3339 format. After the invoice is published, Square processes the invoice on the specified date, according to the delivery method and payment request settings.  If the field is not set, Square processes the invoice immediately after it is published.
	ScheduledAt string `json:"scheduled_at,omitempty"`
	// The URL of the Square-hosted invoice page. After you publish the invoice using the `PublishInvoice` endpoint, Square hosts the invoice page and returns the page URL in the response.
	PublicUrl              string `json:"public_url,omitempty"`
	NextPaymentAmountMoney *Money `json:"next_payment_amount_money,omitempty"`
	// The status of the invoice.
	Status string `json:"status,omitempty"`
	// The time zone used to interpret calendar dates on the invoice, such as `due_date`. When an invoice is created, this field is set to the `timezone` specified for the seller location. The value cannot be changed.  For example, a payment `due_date` of 2021-03-09 with a `timezone` of America/Los\\_Angeles becomes overdue at midnight on March 9 in America/Los\\_Angeles (which equals a UTC timestamp of 2021-03-10T08:00:00Z).
	Timezone string `json:"timezone,omitempty"`
	// The timestamp when the invoice was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp when the invoice was last updated, in RFC 3339 format.
	UpdatedAt              string                         `json:"updated_at,omitempty"`
	AcceptedPaymentMethods *InvoiceAcceptedPaymentMethods `json:"accepted_payment_methods,omitempty"`
	// Additional seller-defined fields that are displayed on the invoice. For more information, see [Custom fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields).  Adding custom fields to an invoice requires an  [Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).  Max: 2 custom fields
	CustomFields []InvoiceCustomField `json:"custom_fields,omitempty"`
	// The ID of the [subscription](https://developer.squareup.com/reference/square_2024-07-17/objects/Subscription) associated with the invoice. This field is present only on subscription billing invoices.
	SubscriptionId string `json:"subscription_id,omitempty"`
	// The date of the sale or the date that the service is rendered, in `YYYY-MM-DD` format. This field can be used to specify a past or future date which is displayed on the invoice.
	SaleOrServiceDate string `json:"sale_or_service_date,omitempty"`
	// **France only.** The payment terms and conditions that are displayed on the invoice. For more information,  see [Payment conditions](https://developer.squareup.com/docs/invoices-api/overview#payment-conditions).  For countries other than France, Square returns an `INVALID_REQUEST_ERROR` with a `BAD_REQUEST` code and  \"Payment conditions are not supported for this location's country\" detail if this field is included in `CreateInvoice` or `UpdateInvoice` requests.
	PaymentConditions string `json:"payment_conditions,omitempty"`
	// Indicates whether to allow a customer to save a credit or debit card as a card on file or a bank transfer as a bank account on file. If `true`, Square displays a __Save my card on file__ or __Save my bank on file__ checkbox on the invoice payment page. Stored payment information can be used for future automatic payments. The default value is `false`.
	StorePaymentMethodEnabled bool `json:"store_payment_method_enabled,omitempty"`
	// Metadata about the attachments on the invoice. Invoice attachments are managed using the [CreateInvoiceAttachment](https://developer.squareup.com/reference/square_2024-07-17/invoices-api/create-invoice-attachment) and [DeleteInvoiceAttachment](https://developer.squareup.com/reference/square_2024-07-17/invoices-api/delete-invoice-attachment) endpoints.
	Attachments []InvoiceAttachment `json:"attachments,omitempty"`
}

Stores information about an invoice. You use the Invoices API to create and manage invoices. For more information, see [Invoices API Overview](https://developer.squareup.com/docs/invoices-api/overview).

type InvoiceAcceptedPaymentMethods ¶

type InvoiceAcceptedPaymentMethods struct {
	// Indicates whether credit card or debit card payments are accepted. The default value is `false`.
	Card bool `json:"card,omitempty"`
	// Indicates whether Square gift card payments are accepted. The default value is `false`.
	SquareGiftCard bool `json:"square_gift_card,omitempty"`
	// Indicates whether ACH bank transfer payments are accepted. The default value is `false`.
	BankAccount bool `json:"bank_account,omitempty"`
	// Indicates whether Afterpay (also known as Clearpay) payments are accepted. The default value is `false`.  This option is allowed only for invoices that have a single payment request of the `BALANCE` type. This payment method is supported if the seller account accepts Afterpay payments and the seller location is in a country where Afterpay invoice payments are supported. As a best practice, consider enabling an additional payment method when allowing `buy_now_pay_later` payments. For more information, including detailed requirements and processing limits, see [Buy Now Pay Later payments with Afterpay](https://developer.squareup.com/docs/invoices-api/overview#buy-now-pay-later).
	BuyNowPayLater bool `json:"buy_now_pay_later,omitempty"`
	// Indicates whether Cash App payments are accepted. The default value is `false`.  This payment method is supported only for seller [locations](https://developer.squareup.com/reference/square_2024-07-17/objects/Location) in the United States.
	CashAppPay bool `json:"cash_app_pay,omitempty"`
}

The payment methods that customers can use to pay an [invoice](https://developer.squareup.com/reference/square_2024-07-17/objects/Invoice) on the Square-hosted invoice payment page.

type InvoiceAttachment ¶

type InvoiceAttachment struct {
	// The Square-assigned ID of the attachment.
	Id string `json:"id,omitempty"`
	// The file name of the attachment, which is displayed on the invoice.
	Filename string `json:"filename,omitempty"`
	// The description of the attachment, which is displayed on the invoice. This field maps to the seller-defined **Message** field.
	Description string `json:"description,omitempty"`
	// The file size of the attachment in bytes.
	Filesize int32 `json:"filesize,omitempty"`
	// The MD5 hash that was generated from the file contents.
	Hash string `json:"hash,omitempty"`
	// The mime type of the attachment. The following mime types are supported:  image/gif, image/jpeg, image/png, image/tiff, image/bmp, application/pdf.
	MimeType string `json:"mime_type,omitempty"`
	// The timestamp when the attachment was uploaded, in RFC 3339 format.
	UploadedAt string `json:"uploaded_at,omitempty"`
}

Represents a file attached to an [invoice](https://developer.squareup.com/reference/square_2024-07-17/objects/Invoice).

type InvoiceAutomaticPaymentSource ¶

type InvoiceAutomaticPaymentSource string

InvoiceAutomaticPaymentSource : Indicates the automatic payment method for an [invoice payment request](https://developer.squareup.com/reference/square_2024-07-17/objects/InvoicePaymentRequest).

const (
	NONE_InvoiceAutomaticPaymentSource         InvoiceAutomaticPaymentSource = "NONE"
	CARD_ON_FILE_InvoiceAutomaticPaymentSource InvoiceAutomaticPaymentSource = "CARD_ON_FILE"
	BANK_ON_FILE_InvoiceAutomaticPaymentSource InvoiceAutomaticPaymentSource = "BANK_ON_FILE"
)

List of InvoiceAutomaticPaymentSource

type InvoiceCustomField ¶

type InvoiceCustomField struct {
	// The label or title of the custom field. This field is required for a custom field.
	Label string `json:"label,omitempty"`
	// The text of the custom field. If omitted, only the label is rendered.
	Value string `json:"value,omitempty"`
	// The location of the custom field on the invoice. This field is required for a custom field.
	Placement string `json:"placement,omitempty"`
}

An additional seller-defined and customer-facing field to include on the invoice. For more information, see [Custom fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields). Adding custom fields to an invoice requires an [Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).

type InvoiceCustomFieldPlacement ¶

type InvoiceCustomFieldPlacement string

InvoiceCustomFieldPlacement : Indicates where to render a custom field on the Square-hosted invoice page and in emailed or PDF copies of the invoice.

const (
	ABOVE_LINE_ITEMS_InvoiceCustomFieldPlacement InvoiceCustomFieldPlacement = "ABOVE_LINE_ITEMS"
	BELOW_LINE_ITEMS_InvoiceCustomFieldPlacement InvoiceCustomFieldPlacement = "BELOW_LINE_ITEMS"
)

List of InvoiceCustomFieldPlacement

type InvoiceDeliveryMethod ¶

type InvoiceDeliveryMethod string

InvoiceDeliveryMethod : Indicates how Square delivers the [invoice](https://developer.squareup.com/reference/square_2024-07-17/objects/Invoice) to the customer.

const (
	EMAIL_InvoiceDeliveryMethod          InvoiceDeliveryMethod = "EMAIL"
	SHARE_MANUALLY_InvoiceDeliveryMethod InvoiceDeliveryMethod = "SHARE_MANUALLY"
	SMS_InvoiceDeliveryMethod            InvoiceDeliveryMethod = "SMS"
)

List of InvoiceDeliveryMethod

type InvoiceFilter ¶

type InvoiceFilter struct {
	// Limits the search to the specified locations. A location is required.  In the current implementation, only one location can be specified.
	LocationIds []string `json:"location_ids"`
	// Limits the search to the specified customers, within the specified locations.  Specifying a customer is optional. In the current implementation,  a maximum of one customer can be specified.
	CustomerIds []string `json:"customer_ids,omitempty"`
}

Describes query filters to apply.

type InvoicePaymentReminder ¶

type InvoicePaymentReminder struct {
	// A Square-assigned ID that uniquely identifies the reminder within the `InvoicePaymentRequest`.
	Uid string `json:"uid,omitempty"`
	// The number of days before (a negative number) or after (a positive number) the payment request `due_date` when the reminder is sent. For example, -3 indicates that the reminder should be sent 3 days before the payment request `due_date`.
	RelativeScheduledDays int32 `json:"relative_scheduled_days,omitempty"`
	// The reminder message.
	Message string `json:"message,omitempty"`
	// The status of the reminder.
	Status string `json:"status,omitempty"`
	// If sent, the timestamp when the reminder was sent, in RFC 3339 format.
	SentAt string `json:"sent_at,omitempty"`
}

Describes a payment request reminder (automatic notification) that Square sends to the customer. You configure a reminder relative to the payment request `due_date`.

type InvoicePaymentReminderStatus ¶

type InvoicePaymentReminderStatus string

InvoicePaymentReminderStatus : The status of a payment request reminder.

const (
	PENDING_InvoicePaymentReminderStatus        InvoicePaymentReminderStatus = "PENDING"
	NOT_APPLICABLE_InvoicePaymentReminderStatus InvoicePaymentReminderStatus = "NOT_APPLICABLE"
	SENT_InvoicePaymentReminderStatus           InvoicePaymentReminderStatus = "SENT"
)

List of InvoicePaymentReminderStatus

type InvoicePaymentRequest ¶

type InvoicePaymentRequest struct {
	// The Square-generated ID of the payment request in an [invoice](https://developer.squareup.com/reference/square_2024-07-17/objects/Invoice).
	Uid string `json:"uid,omitempty"`
	// Indicates how Square processes the payment request. DEPRECATED at version 2021-01-21. Replaced by the `Invoice.delivery_method` and `InvoicePaymentRequest.automatic_payment_source` fields.  One of the following is required when creating an invoice: - (Recommended) The `delivery_method` field of the invoice. To configure an automatic payment, the `automatic_payment_source` field of the payment request is also required. - This `request_method` field. Note that `invoice` objects returned in responses do not include `request_method`.
	RequestMethod string `json:"request_method,omitempty"`
	// Identifies the payment request type. This type defines how the payment request amount is determined.  This field is required to create a payment request.
	RequestType string `json:"request_type,omitempty"`
	// The due date (in the invoice's time zone) for the payment request, in `YYYY-MM-DD` format. This field is required to create a payment request. If an `automatic_payment_source` is defined for the request, Square charges the payment source on this date.  After this date, the invoice becomes overdue. For example, a payment `due_date` of 2021-03-09 with a `timezone` of America/Los\\_Angeles becomes overdue at midnight on March 9 in America/Los\\_Angeles (which equals a UTC timestamp of 2021-03-10T08:00:00Z).
	DueDate                   string `json:"due_date,omitempty"`
	FixedAmountRequestedMoney *Money `json:"fixed_amount_requested_money,omitempty"`
	// Specifies the amount for the payment request in percentage:  - When the payment `request_type` is `DEPOSIT`, it is the percentage of the order's total amount. - When the payment `request_type` is `INSTALLMENT`, it is the percentage of the order's total less  the deposit, if requested. The sum of the `percentage_requested` in all installment  payment requests must be equal to 100.  You cannot specify this when the payment `request_type` is `BALANCE` or when the  payment request specifies the `fixed_amount_requested_money` field.
	PercentageRequested string `json:"percentage_requested,omitempty"`
	// If set to true, the Square-hosted invoice page (the `public_url` field of the invoice)  provides a place for the customer to pay a tip.   This field is allowed only on the final payment request   and the payment `request_type` must be `BALANCE` or `INSTALLMENT`.
	TippingEnabled bool `json:"tipping_enabled,omitempty"`
	// The payment method for an automatic payment.  The default value is `NONE`.
	AutomaticPaymentSource string `json:"automatic_payment_source,omitempty"`
	// The ID of the credit or debit card on file to charge for the payment request. To get the cards on file for a customer, call [ListCards](https://developer.squareup.com/reference/square_2024-07-17/cards-api/list-cards) and include the `customer_id` of the invoice recipient.
	CardId string `json:"card_id,omitempty"`
	// A list of one or more reminders to send for the payment request.
	Reminders                       []InvoicePaymentReminder `json:"reminders,omitempty"`
	ComputedAmountMoney             *Money                   `json:"computed_amount_money,omitempty"`
	TotalCompletedAmountMoney       *Money                   `json:"total_completed_amount_money,omitempty"`
	RoundingAdjustmentIncludedMoney *Money                   `json:"rounding_adjustment_included_money,omitempty"`
}

Represents a payment request for an [invoice](https://developer.squareup.com/reference/square_2024-07-17/objects/Invoice). Invoices can specify a maximum of 13 payment requests, with up to 12 `INSTALLMENT` request types. For more information, see [Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests). Adding `INSTALLMENT` payment requests to an invoice requires an [Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).

type InvoiceQuery ¶

type InvoiceQuery struct {
	Filter *InvoiceFilter `json:"filter"`
	Sort   *InvoiceSort   `json:"sort,omitempty"`
}

Describes query criteria for searching invoices.

type InvoiceRecipient ¶

type InvoiceRecipient struct {
	// The ID of the customer. This is the customer profile ID that  you provide when creating a draft invoice.
	CustomerId string `json:"customer_id,omitempty"`
	// The recipient's given (that is, first) name.
	GivenName string `json:"given_name,omitempty"`
	// The recipient's family (that is, last) name.
	FamilyName string `json:"family_name,omitempty"`
	// The recipient's email address.
	EmailAddress string   `json:"email_address,omitempty"`
	Address      *Address `json:"address,omitempty"`
	// The recipient's phone number.
	PhoneNumber string `json:"phone_number,omitempty"`
	// The name of the recipient's company.
	CompanyName string                  `json:"company_name,omitempty"`
	TaxIds      *InvoiceRecipientTaxIds `json:"tax_ids,omitempty"`
}

Represents a snapshot of customer data. This object stores customer data that is displayed on the invoice and that Square uses to deliver the invoice. When you provide a customer ID for a draft invoice, Square retrieves the associated customer profile and populates the remaining `InvoiceRecipient` fields. You cannot update these fields after the invoice is published. Square updates the customer ID in response to a merge operation, but does not update other fields.

type InvoiceRecipientTaxIds ¶

type InvoiceRecipientTaxIds struct {
	// The EU VAT identification number for the invoice recipient. For example, `IE3426675K`.
	EuVat string `json:"eu_vat,omitempty"`
}

Represents the tax IDs for an invoice recipient. The country of the seller account determines whether the corresponding `tax_ids` field is available for the customer. For more information, see [Invoice recipient tax IDs](https://developer.squareup.com/docs/invoices-api/overview#recipient-tax-ids).

type InvoiceRequestMethod ¶

type InvoiceRequestMethod string

InvoiceRequestMethod : Specifies the action for Square to take for processing the invoice. For example, email the invoice, charge a customer's card on file, or do nothing. DEPRECATED at version 2021-01-21. The corresponding `request_method` field is replaced by the `Invoice.delivery_method` and `InvoicePaymentRequest.automatic_payment_source` fields.

const (
	EMAIL_InvoiceRequestMethod                   InvoiceRequestMethod = "EMAIL"
	CHARGE_CARD_ON_FILE_InvoiceRequestMethod     InvoiceRequestMethod = "CHARGE_CARD_ON_FILE"
	SHARE_MANUALLY_InvoiceRequestMethod          InvoiceRequestMethod = "SHARE_MANUALLY"
	CHARGE_BANK_ON_FILE_InvoiceRequestMethod     InvoiceRequestMethod = "CHARGE_BANK_ON_FILE"
	SMS_InvoiceRequestMethod                     InvoiceRequestMethod = "SMS"
	SMS_CHARGE_CARD_ON_FILE_InvoiceRequestMethod InvoiceRequestMethod = "SMS_CHARGE_CARD_ON_FILE"
	SMS_CHARGE_BANK_ON_FILE_InvoiceRequestMethod InvoiceRequestMethod = "SMS_CHARGE_BANK_ON_FILE"
)

List of InvoiceRequestMethod

type InvoiceRequestType ¶

type InvoiceRequestType string

InvoiceRequestType : Indicates the type of the payment request. For more information, see [Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).

const (
	BALANCE_InvoiceRequestType     InvoiceRequestType = "BALANCE"
	DEPOSIT_InvoiceRequestType     InvoiceRequestType = "DEPOSIT"
	INSTALLMENT_InvoiceRequestType InvoiceRequestType = "INSTALLMENT"
)

List of InvoiceRequestType

type InvoiceSort ¶

type InvoiceSort struct {
	// The field to use for sorting.
	Field string `json:"field"`
	// The order to use for sorting the results.
	Order string `json:"order,omitempty"`
}

Identifies the sort field and sort order.

type InvoiceSortField ¶

type InvoiceSortField string

InvoiceSortField : The field to use for sorting.

const (
	INVOICE_SORT_DATE_InvoiceSortField InvoiceSortField = "INVOICE_SORT_DATE"
)

List of InvoiceSortField

type InvoiceStatus ¶

type InvoiceStatus string

InvoiceStatus : Indicates the status of an invoice.

const (
	DRAFT_InvoiceStatus              InvoiceStatus = "DRAFT"
	UNPAID_InvoiceStatus             InvoiceStatus = "UNPAID"
	SCHEDULED_InvoiceStatus          InvoiceStatus = "SCHEDULED"
	PARTIALLY_PAID_InvoiceStatus     InvoiceStatus = "PARTIALLY_PAID"
	PAID_InvoiceStatus               InvoiceStatus = "PAID"
	PARTIALLY_REFUNDED_InvoiceStatus InvoiceStatus = "PARTIALLY_REFUNDED"
	REFUNDED_InvoiceStatus           InvoiceStatus = "REFUNDED"
	CANCELED_InvoiceStatus           InvoiceStatus = "CANCELED"
	FAILED_InvoiceStatus             InvoiceStatus = "FAILED"
	PAYMENT_PENDING_InvoiceStatus    InvoiceStatus = "PAYMENT_PENDING"
)

List of InvoiceStatus

type InvoicesApiDeleteInvoiceOpts ¶

type InvoicesApiDeleteInvoiceOpts struct {
	Version optional.Int32
}

type InvoicesApiListInvoicesOpts ¶

type InvoicesApiListInvoicesOpts struct {
	Cursor optional.String
	Limit  optional.Int32
}

type InvoicesApiService ¶

type InvoicesApiService service

func (*InvoicesApiService) CancelInvoice ¶

func (a *InvoicesApiService) CancelInvoice(ctx context.Context, body CancelInvoiceRequest, invoiceId string) (CancelInvoiceResponse, *http.Response, error)

InvoicesApiService CancelInvoice Cancels an invoice. The seller cannot collect payments for the canceled invoice. You cannot cancel an invoice in the `DRAFT` state or in a terminal state: `PAID`, `REFUNDED`, `CANCELED`, or `FAILED`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param invoiceId The ID of the [invoice](https://developer.squareup.com/reference/square_2024-07-17/objects/Invoice) to cancel.

@return CancelInvoiceResponse

func (*InvoicesApiService) CreateInvoice ¶

func (a *InvoicesApiService) CreateInvoice(ctx context.Context, body CreateInvoiceRequest) (CreateInvoiceResponse, *http.Response, error)

InvoicesApiService CreateInvoice Creates a draft [invoice](https://developer.squareup.com/reference/square_2024-07-17/objects/Invoice) for an order created using the Orders API. A draft invoice remains in your account and no action is taken. You must publish the invoice before Square can process it (send it to the customer's email address or charge the customer’s card on file).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateInvoiceResponse

func (*InvoicesApiService) DeleteInvoice ¶

func (a *InvoicesApiService) DeleteInvoice(ctx context.Context, invoiceId string, localVarOptionals *InvoicesApiDeleteInvoiceOpts) (DeleteInvoiceResponse, *http.Response, error)

func (*InvoicesApiService) DeleteInvoiceAttachment ¶

func (a *InvoicesApiService) DeleteInvoiceAttachment(ctx context.Context, invoiceId string, attachmentId string) (DeleteInvoiceAttachmentResponse, *http.Response, error)

InvoicesApiService DeleteInvoiceAttachment Removes an attachment from an invoice and permanently deletes the file. Attachments can be removed only from invoices in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param invoiceId The ID of the [invoice](https://developer.squareup.com/reference/square_2024-07-17/objects/Invoice) to delete the attachment from.
@param attachmentId The ID of the [attachment](https://developer.squareup.com/reference/square_2024-07-17/objects/InvoiceAttachment) to delete.

@return DeleteInvoiceAttachmentResponse

func (*InvoicesApiService) GetInvoice ¶

func (a *InvoicesApiService) GetInvoice(ctx context.Context, invoiceId string) (GetInvoiceResponse, *http.Response, error)

InvoicesApiService GetInvoice Retrieves an invoice by invoice ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param invoiceId The ID of the invoice to retrieve.

@return GetInvoiceResponse

func (*InvoicesApiService) ListInvoices ¶

func (a *InvoicesApiService) ListInvoices(ctx context.Context, locationId string, localVarOptionals *InvoicesApiListInvoicesOpts) (ListInvoicesResponse, *http.Response, error)

func (*InvoicesApiService) PublishInvoice ¶

func (a *InvoicesApiService) PublishInvoice(ctx context.Context, body PublishInvoiceRequest, invoiceId string) (PublishInvoiceResponse, *http.Response, error)

InvoicesApiService PublishInvoice Publishes the specified draft invoice. After an invoice is published, Square follows up based on the invoice configuration. For example, Square sends the invoice to the customer's email address, charges the customer's card on file, or does nothing. Square also makes the invoice available on a Square-hosted invoice page. The invoice `status` also changes from `DRAFT` to a status based on the invoice configuration. For example, the status changes to `UNPAID` if Square emails the invoice or `PARTIALLY_PAID` if Square charges a card on file for a portion of the invoice amount. In addition to the required `ORDERS_WRITE` and `INVOICES_WRITE` permissions, `CUSTOMERS_READ` and `PAYMENTS_WRITE` are required when publishing invoices configured for card-on-file payments.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param invoiceId The ID of the invoice to publish.

@return PublishInvoiceResponse

func (*InvoicesApiService) SearchInvoices ¶

func (a *InvoicesApiService) SearchInvoices(ctx context.Context, body SearchInvoicesRequest) (SearchInvoicesResponse, *http.Response, error)

InvoicesApiService SearchInvoices Searches for invoices from a location specified in the filter. You can optionally specify customers in the filter for whom to retrieve invoices. In the current implementation, you can only specify one location and optionally one customer. The response is paginated. If truncated, the response includes a `cursor` that you use in a subsequent request to retrieve the next set of invoices.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return SearchInvoicesResponse

func (*InvoicesApiService) UpdateInvoice ¶

func (a *InvoicesApiService) UpdateInvoice(ctx context.Context, body UpdateInvoiceRequest, invoiceId string) (UpdateInvoiceResponse, *http.Response, error)

InvoicesApiService UpdateInvoice Updates an invoice. This endpoint supports sparse updates, so you only need to specify the fields you want to change along with the required `version` field. Some restrictions apply to updating invoices. For example, you cannot change the `order_id` or `location_id` field.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param invoiceId The ID of the invoice to update.

@return UpdateInvoiceResponse

type ItemVariationLocationOverrides ¶

type ItemVariationLocationOverrides struct {
	// The ID of the `Location`. This can include locations that are deactivated.
	LocationId string `json:"location_id,omitempty"`
	PriceMoney *Money `json:"price_money,omitempty"`
	// The pricing type (fixed or variable) for the `CatalogItemVariation` at the given `Location`.
	PricingType string `json:"pricing_type,omitempty"`
	// If `true`, inventory tracking is active for the `CatalogItemVariation` at this `Location`.
	TrackInventory bool `json:"track_inventory,omitempty"`
	// Indicates whether the `CatalogItemVariation` displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`.
	InventoryAlertType string `json:"inventory_alert_type,omitempty"`
	// If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard.  This value is always an integer.
	InventoryAlertThreshold int64 `json:"inventory_alert_threshold,omitempty"`
	// Indicates whether the overridden item variation is sold out at the specified location.  When inventory tracking is enabled on the item variation either globally or at the specified location, the item variation is automatically marked as sold out when its inventory count reaches zero. The seller can manually set the item variation as sold out even when the inventory count is greater than zero. Attempts by an application to set this attribute are ignored. Regardless how the sold-out status is set, applications should treat its inventory count as zero when this attribute value is `true`.
	SoldOut bool `json:"sold_out,omitempty"`
	// The seller-assigned timestamp, of the RFC 3339 format, to indicate when this sold-out variation becomes available again at the specified location. Attempts by an application to set this attribute are ignored. When the current time is later than this attribute value, the affected item variation is no longer sold out.
	SoldOutValidUntil string `json:"sold_out_valid_until,omitempty"`
}

Price and inventory alerting overrides for a `CatalogItemVariation` at a specific `Location`.

type JobAssignment ¶

type JobAssignment struct {
	// The title of the job.
	JobTitle string `json:"job_title"`
	// The current pay type for the job assignment used to calculate the pay amount in a pay period.
	PayType    string `json:"pay_type"`
	HourlyRate *Money `json:"hourly_rate,omitempty"`
	AnnualRate *Money `json:"annual_rate,omitempty"`
	// The planned hours per week for the job. Set if the job `PayType` is `SALARY`.
	WeeklyHours int32 `json:"weekly_hours,omitempty"`
}

An object describing a job that a team member is assigned to.

type JobAssignmentPayType ¶

type JobAssignmentPayType string

JobAssignmentPayType : Enumerates the possible pay types that a job can be assigned.

const (
	NONE_JobAssignmentPayType   JobAssignmentPayType = "NONE"
	HOURLY_JobAssignmentPayType JobAssignmentPayType = "HOURLY"
	SALARY_JobAssignmentPayType JobAssignmentPayType = "SALARY"
)

List of JobAssignmentPayType

type LaborApiListBreakTypesOpts ¶

type LaborApiListBreakTypesOpts struct {
	LocationId optional.String
	Limit      optional.Int32
	Cursor     optional.String
}

type LaborApiListEmployeeWagesOpts ¶

type LaborApiListEmployeeWagesOpts struct {
	EmployeeId optional.String
	Limit      optional.Int32
	Cursor     optional.String
}

type LaborApiListTeamMemberWagesOpts ¶

type LaborApiListTeamMemberWagesOpts struct {
	TeamMemberId optional.String
	Limit        optional.Int32
	Cursor       optional.String
}

type LaborApiListWorkweekConfigsOpts ¶

type LaborApiListWorkweekConfigsOpts struct {
	Limit  optional.Int32
	Cursor optional.String
}

type LaborApiService ¶

type LaborApiService service

func (*LaborApiService) CreateBreakType ¶

func (a *LaborApiService) CreateBreakType(ctx context.Context, body CreateBreakTypeRequest) (CreateBreakTypeResponse, *http.Response, error)

LaborApiService CreateBreakType Creates a new `BreakType`. A `BreakType` is a template for creating `Break` objects. You must provide the following values in your request to this endpoint: - `location_id` - `break_name` - `expected_duration` - `is_paid` You can only have three `BreakType` instances per location. If you attempt to add a fourth `BreakType` for a location, an `INVALID_REQUEST_ERROR` \"Exceeded limit of 3 breaks per location.\" is returned.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateBreakTypeResponse

func (*LaborApiService) CreateShift ¶

func (a *LaborApiService) CreateShift(ctx context.Context, body CreateShiftRequest) (CreateShiftResponse, *http.Response, error)

LaborApiService CreateShift Creates a new `Shift`. A `Shift` represents a complete workday for a single team member. You must provide the following values in your request to this endpoint: - `location_id` - `team_member_id` - `start_at` An attempt to create a new `Shift` can result in a `BAD_REQUEST` error when: - The `status` of the new `Shift` is `OPEN` and the team member has another shift with an `OPEN` status. - The `start_at` date is in the future. - The `start_at` or `end_at` date overlaps another shift for the same team member. - The `Break` instances are set in the request and a break `start_at` is before the `Shift.start_at`, a break `end_at` is after the `Shift.end_at`, or both.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateShiftResponse

func (*LaborApiService) DeleteBreakType ¶

func (a *LaborApiService) DeleteBreakType(ctx context.Context, id string) (DeleteBreakTypeResponse, *http.Response, error)

LaborApiService DeleteBreakType Deletes an existing `BreakType`. A `BreakType` can be deleted even if it is referenced from a `Shift`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The UUID for the `BreakType` being deleted.

@return DeleteBreakTypeResponse

func (*LaborApiService) DeleteShift ¶

func (a *LaborApiService) DeleteShift(ctx context.Context, id string) (DeleteShiftResponse, *http.Response, error)

LaborApiService DeleteShift Deletes a `Shift`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The UUID for the `Shift` being deleted.

@return DeleteShiftResponse

func (*LaborApiService) GetBreakType ¶

func (a *LaborApiService) GetBreakType(ctx context.Context, id string) (GetBreakTypeResponse, *http.Response, error)

LaborApiService GetBreakType Returns a single `BreakType` specified by `id`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The UUID for the `BreakType` being retrieved.

@return GetBreakTypeResponse

func (*LaborApiService) GetEmployeeWage ¶

func (a *LaborApiService) GetEmployeeWage(ctx context.Context, id string) (GetEmployeeWageResponse, *http.Response, error)

LaborApiService GetEmployeeWage Returns a single `EmployeeWage` specified by `id`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The UUID for the `EmployeeWage` being retrieved.

@return GetEmployeeWageResponse

func (*LaborApiService) GetShift ¶

func (a *LaborApiService) GetShift(ctx context.Context, id string) (GetShiftResponse, *http.Response, error)

LaborApiService GetShift Returns a single `Shift` specified by `id`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The UUID for the `Shift` being retrieved.

@return GetShiftResponse

func (*LaborApiService) GetTeamMemberWage ¶

func (a *LaborApiService) GetTeamMemberWage(ctx context.Context, id string) (GetTeamMemberWageResponse, *http.Response, error)

LaborApiService GetTeamMemberWage Returns a single `TeamMemberWage` specified by `id`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The UUID for the `TeamMemberWage` being retrieved.

@return GetTeamMemberWageResponse

func (*LaborApiService) ListBreakTypes ¶

func (a *LaborApiService) ListBreakTypes(ctx context.Context, localVarOptionals *LaborApiListBreakTypesOpts) (ListBreakTypesResponse, *http.Response, error)

func (*LaborApiService) ListEmployeeWages ¶

func (a *LaborApiService) ListEmployeeWages(ctx context.Context, localVarOptionals *LaborApiListEmployeeWagesOpts) (ListEmployeeWagesResponse, *http.Response, error)

func (*LaborApiService) ListTeamMemberWages ¶

func (a *LaborApiService) ListTeamMemberWages(ctx context.Context, localVarOptionals *LaborApiListTeamMemberWagesOpts) (ListTeamMemberWagesResponse, *http.Response, error)

func (*LaborApiService) ListWorkweekConfigs ¶

func (a *LaborApiService) ListWorkweekConfigs(ctx context.Context, localVarOptionals *LaborApiListWorkweekConfigsOpts) (ListWorkweekConfigsResponse, *http.Response, error)

func (*LaborApiService) SearchShifts ¶

func (a *LaborApiService) SearchShifts(ctx context.Context, body SearchShiftsRequest) (SearchShiftsResponse, *http.Response, error)

LaborApiService SearchShifts Returns a paginated list of `Shift` records for a business. The list to be returned can be filtered by: - Location IDs - Team member IDs - Shift status (`OPEN` or `CLOSED`) - Shift start - Shift end - Workday details The list can be sorted by: - `START_AT` - `END_AT` - `CREATED_AT` - `UPDATED_AT`

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return SearchShiftsResponse

func (*LaborApiService) UpdateBreakType ¶

func (a *LaborApiService) UpdateBreakType(ctx context.Context, body UpdateBreakTypeRequest, id string) (UpdateBreakTypeResponse, *http.Response, error)

LaborApiService UpdateBreakType Updates an existing `BreakType`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param id The UUID for the `BreakType` being updated.

@return UpdateBreakTypeResponse

func (*LaborApiService) UpdateShift ¶

func (a *LaborApiService) UpdateShift(ctx context.Context, body UpdateShiftRequest, id string) (UpdateShiftResponse, *http.Response, error)

LaborApiService UpdateShift Updates an existing `Shift`. When adding a `Break` to a `Shift`, any earlier `Break` instances in the `Shift` have the `end_at` property set to a valid RFC-3339 datetime string. When closing a `Shift`, all `Break` instances in the `Shift` must be complete with `end_at` set on each `Break`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param id The ID of the object being updated.

@return UpdateShiftResponse

func (*LaborApiService) UpdateWorkweekConfig ¶

func (a *LaborApiService) UpdateWorkweekConfig(ctx context.Context, body UpdateWorkweekConfigRequest, id string) (UpdateWorkweekConfigResponse, *http.Response, error)

LaborApiService UpdateWorkweekConfig Updates a `WorkweekConfig`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param id The UUID for the `WorkweekConfig` object being updated.

@return UpdateWorkweekConfigResponse

type LinkCustomerToGiftCardRequest ¶

type LinkCustomerToGiftCardRequest struct {
	// The ID of the customer to link to the gift card.
	CustomerId string `json:"customer_id"`
}

A request to link a customer to a gift card.

type LinkCustomerToGiftCardResponse ¶

type LinkCustomerToGiftCardResponse struct {
	// Any errors that occurred during the request.
	Errors   []ModelError `json:"errors,omitempty"`
	GiftCard *GiftCard    `json:"gift_card,omitempty"`
}

A response that contains the linked `GiftCard` object. If the request resulted in errors, the response contains a set of `Error` objects.

type ListBankAccountsRequest ¶

type ListBankAccountsRequest struct {
	// The pagination cursor returned by a previous call to this endpoint. Use it in the next `ListBankAccounts` request to retrieve the next set  of results.  See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.
	Cursor string `json:"cursor,omitempty"`
	// Upper limit on the number of bank accounts to return in the response.  Currently, 1000 is the largest supported limit. You can specify a limit  of up to 1000 bank accounts. This is also the default limit.
	Limit int32 `json:"limit,omitempty"`
	// Location ID. You can specify this optional filter  to retrieve only the linked bank accounts belonging to a specific location.
	LocationId string `json:"location_id,omitempty"`
}

Request object for fetching all `BankAccount` objects linked to a account.

type ListBankAccountsResponse ¶

type ListBankAccountsResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// List of BankAccounts associated with this account.
	BankAccounts []BankAccount `json:"bank_accounts,omitempty"`
	// When a response is truncated, it includes a cursor that you can  use in a subsequent request to fetch next set of bank accounts. If empty, this is the final response.  For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Response object returned by ListBankAccounts.

type ListBookingCustomAttributeDefinitionsRequest ¶

type ListBookingCustomAttributeDefinitionsRequest struct {
	// The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Limit int32 `json:"limit,omitempty"`
	// The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Represents a [ListBookingCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/list-booking-custom-attribute-definitions) request.

type ListBookingCustomAttributeDefinitionsResponse ¶

type ListBookingCustomAttributeDefinitionsResponse struct {
	// The retrieved custom attribute definitions. If no custom attribute definitions are found, Square returns an empty object (`{}`).
	CustomAttributeDefinitions []CustomAttributeDefinition `json:"custom_attribute_definitions,omitempty"`
	// The cursor to provide in your next call to this endpoint to retrieve the next page of results for your original request. This field is present only if the request succeeded and additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [ListBookingCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/list-booking-custom-attribute-definitions) response. Either `custom_attribute_definitions`, an empty object, or `errors` is present in the response. If additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.

type ListBookingCustomAttributesRequest ¶

type ListBookingCustomAttributesRequest struct {
	// The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Limit int32 `json:"limit,omitempty"`
	// The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttributeDefinition) in the `definition` field of each custom attribute. Set this parameter to `true` to get the name and description of each custom attribute, information about the data type, or other definition details. The default value is `false`.
	WithDefinitions bool `json:"with_definitions,omitempty"`
}

Represents a [ListBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/list-booking-custom-attributes) request.

type ListBookingCustomAttributesResponse ¶

type ListBookingCustomAttributesResponse struct {
	// The retrieved custom attributes. If `with_definitions` was set to `true` in the request, the custom attribute definition is returned in the `definition` field of each custom attribute.  If no custom attributes are found, Square returns an empty object (`{}`).
	CustomAttributes []CustomAttribute `json:"custom_attributes,omitempty"`
	// The cursor to use in your next call to this endpoint to retrieve the next page of results for your original request. This field is present only if the request succeeded and additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [ListBookingCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/list-booking-custom-attributes) response. Either `custom_attributes`, an empty object, or `errors` is present in the response. If additional results are available, the `cursor` field is also present along with `custom_attributes`.

type ListBookingsRequest ¶

type ListBookingsRequest struct {
	// The maximum number of results per page to return in a paged response.
	Limit int32 `json:"limit,omitempty"`
	// The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.
	Cursor string `json:"cursor,omitempty"`
	// The [customer](https://developer.squareup.com/reference/square_2024-07-17/objects/Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved.
	CustomerId string `json:"customer_id,omitempty"`
	// The team member for whom to retrieve bookings. If this is not set, bookings of all members are retrieved.
	TeamMemberId string `json:"team_member_id,omitempty"`
	// The location for which to retrieve bookings. If this is not set, all locations' bookings are retrieved.
	LocationId string `json:"location_id,omitempty"`
	// The RFC 3339 timestamp specifying the earliest of the start time. If this is not set, the current time is used.
	StartAtMin string `json:"start_at_min,omitempty"`
	// The RFC 3339 timestamp specifying the latest of the start time. If this is not set, the time of 31 days after `start_at_min` is used.
	StartAtMax string `json:"start_at_max,omitempty"`
}

type ListBookingsResponse ¶

type ListBookingsResponse struct {
	// The list of targeted bookings.
	Bookings []Booking `json:"bookings,omitempty"`
	// The pagination cursor to be used in the subsequent request to get the next page of the results. Stop retrieving the next page of the results when the cursor is not set.
	Cursor string `json:"cursor,omitempty"`
	// Errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type ListBreakTypesRequest ¶

type ListBreakTypesRequest struct {
	// Filter the returned `BreakType` results to only those that are associated with the specified location.
	LocationId string `json:"location_id,omitempty"`
	// The maximum number of `BreakType` results to return per page. The number can range between 1 and 200. The default is 200.
	Limit int32 `json:"limit,omitempty"`
	// A pointer to the next page of `BreakType` results to fetch.
	Cursor string `json:"cursor,omitempty"`
}

A request for a filtered set of `BreakType` objects.

type ListBreakTypesResponse ¶

type ListBreakTypesResponse struct {
	//  A page of `BreakType` results.
	BreakTypes []BreakType `json:"break_types,omitempty"`
	// The value supplied in the subsequent request to fetch the next page of `BreakType` results.
	Cursor string `json:"cursor,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

The response to a request for a set of `BreakType` objects. The response contains the requested `BreakType` objects and might contain a set of `Error` objects if the request resulted in errors.

type ListCardsRequest ¶

type ListCardsRequest struct {
	// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
	// Limit results to cards associated with the customer supplied. By default, all cards owned by the merchant are returned.
	CustomerId string `json:"customer_id,omitempty"`
	// Includes disabled cards. By default, all enabled cards owned by the merchant are returned.
	IncludeDisabled bool `json:"include_disabled,omitempty"`
	// Limit results to cards associated with the reference_id supplied.
	ReferenceId string `json:"reference_id,omitempty"`
	// Sorts the returned list by when the card was created with the specified order. This field defaults to ASC.
	SortOrder string `json:"sort_order,omitempty"`
}

Retrieves details for a specific Card. Accessible via HTTP requests at GET https://connect.squareup.com/v2/cards

type ListCardsResponse ¶

type ListCardsResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The requested list of `Card`s.
	Cards []Card `json:"cards,omitempty"`
	// The pagination cursor to be used in a subsequent request. If empty, this is the final response.  See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
}

Defines the fields that are included in the response body of a request to the [ListCards](https://developer.squareup.com/reference/square_2024-07-17/cards-api/list-cards) endpoint. Note: if there are errors processing the request, the card field will not be present.

type ListCashDrawerShiftEventsRequest ¶

type ListCashDrawerShiftEventsRequest struct {
	// The ID of the location to list cash drawer shifts for.
	LocationId string `json:"location_id"`
	// Number of resources to be returned in a page of results (200 by default, 1000 max).
	Limit int32 `json:"limit,omitempty"`
	// Opaque cursor for fetching the next page of results.
	Cursor string `json:"cursor,omitempty"`
}

type ListCashDrawerShiftEventsResponse ¶

type ListCashDrawerShiftEventsResponse struct {
	// Opaque cursor for fetching the next page. Cursor is not present in the last page of results.
	Cursor string `json:"cursor,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// All of the events (payments, refunds, etc.) for a cash drawer during the shift.
	CashDrawerShiftEvents []CashDrawerShiftEvent `json:"cash_drawer_shift_events,omitempty"`
}

type ListCashDrawerShiftsRequest ¶

type ListCashDrawerShiftsRequest struct {
	// The ID of the location to query for a list of cash drawer shifts.
	LocationId string `json:"location_id"`
	// The order in which cash drawer shifts are listed in the response, based on their opened_at field. Default value: ASC
	SortOrder string `json:"sort_order,omitempty"`
	// The inclusive start time of the query on opened_at, in ISO 8601 format.
	BeginTime string `json:"begin_time,omitempty"`
	// The exclusive end date of the query on opened_at, in ISO 8601 format.
	EndTime string `json:"end_time,omitempty"`
	// Number of cash drawer shift events in a page of results (200 by default, 1000 max).
	Limit int32 `json:"limit,omitempty"`
	// Opaque cursor for fetching the next page of results.
	Cursor string `json:"cursor,omitempty"`
}

type ListCashDrawerShiftsResponse ¶

type ListCashDrawerShiftsResponse struct {
	// Opaque cursor for fetching the next page of results. Cursor is not present in the last page of results.
	Cursor string `json:"cursor,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// A collection of CashDrawerShiftSummary objects for shifts that match the query.
	CashDrawerShifts []CashDrawerShiftSummary `json:"cash_drawer_shifts,omitempty"`
}

type ListCatalogRequest ¶

type ListCatalogRequest struct {
	// The pagination cursor returned in the previous response. Leave unset for an initial request. The page size is currently set to be 100. See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
	// An optional case-insensitive, comma-separated list of object types to retrieve.  The valid values are defined in the [CatalogObjectType](https://developer.squareup.com/reference/square_2024-07-17/enums/CatalogObjectType) enum, for example, `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.  If this is unspecified, the operation returns objects of all the top level types at the version of the Square API used to make the request. Object types that are nested onto other object types are not included in the defaults.  At the current API version the default object types are: ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST,  PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.
	Types string `json:"types,omitempty"`
	// The specific version of the catalog objects to be included in the response. This allows you to retrieve historical versions of objects. The specified version value is matched against the [CatalogObject](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject)s' `version` attribute.  If not included, results will be from the current version of the catalog.
	CatalogVersion int64 `json:"catalog_version,omitempty"`
}

type ListCatalogResponse ¶

type ListCatalogResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
	// The CatalogObjects returned.
	Objects []CatalogObject `json:"objects,omitempty"`
}

type ListCustomerCustomAttributeDefinitionsRequest ¶

type ListCustomerCustomAttributeDefinitionsRequest struct {
	// The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Limit int32 `json:"limit,omitempty"`
	// The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Represents a [ListCustomerCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/list-customer-custom-attribute-definitions) request.

type ListCustomerCustomAttributeDefinitionsResponse ¶

type ListCustomerCustomAttributeDefinitionsResponse struct {
	// The retrieved custom attribute definitions. If no custom attribute definitions are found, Square returns an empty object (`{}`).
	CustomAttributeDefinitions []CustomAttributeDefinition `json:"custom_attribute_definitions,omitempty"`
	// The cursor to provide in your next call to this endpoint to retrieve the next page of results for your original request. This field is present only if the request succeeded and additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [ListCustomerCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/list-customer-custom-attribute-definitions) response. Either `custom_attribute_definitions`, an empty object, or `errors` is present in the response. If additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.

type ListCustomerCustomAttributesRequest ¶

type ListCustomerCustomAttributesRequest struct {
	// The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Limit int32 `json:"limit,omitempty"`
	// The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttributeDefinition) in the `definition` field of each custom attribute. Set this parameter to `true` to get the name and description of each custom attribute, information about the data type, or other definition details. The default value is `false`.
	WithDefinitions bool `json:"with_definitions,omitempty"`
}

Represents a [ListCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/list-customer-custom-attributes) request.

type ListCustomerCustomAttributesResponse ¶

type ListCustomerCustomAttributesResponse struct {
	// The retrieved custom attributes. If `with_definitions` was set to `true` in the request, the custom attribute definition is returned in the `definition` field of each custom attribute.  If no custom attributes are found, Square returns an empty object (`{}`).
	CustomAttributes []CustomAttribute `json:"custom_attributes,omitempty"`
	// The cursor to use in your next call to this endpoint to retrieve the next page of results for your original request. This field is present only if the request succeeded and additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [ListCustomerCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/list-customer-custom-attributes) response. Either `custom_attributes`, an empty object, or `errors` is present in the response. If additional results are available, the `cursor` field is also present along with `custom_attributes`.

type ListCustomerGroupsRequest ¶

type ListCustomerGroupsRequest struct {
	// A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. If the limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Limit int32 `json:"limit,omitempty"`
}

Defines the query parameters that can be included in a request to the [ListCustomerGroups](https://developer.squareup.com/reference/square_2024-07-17/customer-groups-api/list-customer-groups) endpoint.

type ListCustomerGroupsResponse ¶

type ListCustomerGroupsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// A list of customer groups belonging to the current seller.
	Groups []CustomerGroup `json:"groups,omitempty"`
	// A pagination cursor to retrieve the next set of results for your original query to the endpoint. This value is present only if the request succeeded and additional results are available.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Defines the fields that are included in the response body of a request to the [ListCustomerGroups](https://developer.squareup.com/reference/square_2024-07-17/customer-groups-api/list-customer-groups) endpoint. Either `errors` or `groups` is present in a given response (never both).

type ListCustomerSegmentsRequest ¶

type ListCustomerSegmentsRequest struct {
	// A pagination cursor returned by previous calls to `ListCustomerSegments`. This cursor is used to retrieve the next set of query results.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. If the specified limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Limit int32 `json:"limit,omitempty"`
}

Defines the valid parameters for requests to the `ListCustomerSegments` endpoint.

type ListCustomerSegmentsResponse ¶

type ListCustomerSegmentsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The list of customer segments belonging to the associated Square account.
	Segments []CustomerSegment `json:"segments,omitempty"`
	// A pagination cursor to be used in subsequent calls to `ListCustomerSegments` to retrieve the next set of query results. The cursor is only present if the request succeeded and additional results are available.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Defines the fields that are included in the response body for requests to the `ListCustomerSegments` endpoint. Either `errors` or `segments` is present in a given response (never both).

type ListCustomersRequest ¶

type ListCustomersRequest struct {
	// A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. If the specified limit is less than 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Limit int32 `json:"limit,omitempty"`
	// Indicates how customers should be sorted.  The default value is `DEFAULT`.
	SortField string `json:"sort_field,omitempty"`
	// Indicates whether customers should be sorted in ascending (`ASC`) or descending (`DESC`) order.  The default value is `ASC`.
	SortOrder string `json:"sort_order,omitempty"`
	// Indicates whether to return the total count of customers in the `count` field of the response.  The default value is `false`.
	Count bool `json:"count,omitempty"`
}

Defines the query parameters that can be included in a request to the `ListCustomers` endpoint.

type ListCustomersResponse ¶

type ListCustomersResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The customer profiles associated with the Square account or an empty object (`{}`) if none are found. Only customer profiles with public information (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) are included in the response.
	Customers []Customer `json:"customers,omitempty"`
	// A pagination cursor to retrieve the next set of results for the original query. A cursor is only present if the request succeeded and additional results are available.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// The total count of customers associated with the Square account. Only customer profiles with public information (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) are counted. This field is present only if `count` is set to `true` in the request.
	Count int64 `json:"count,omitempty"`
}

Defines the fields that are included in the response body of a request to the `ListCustomers` endpoint. Either `errors` or `customers` is present in a given response (never both).

type ListDeviceCodesRequest ¶

type ListDeviceCodesRequest struct {
	// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
	// If specified, only returns DeviceCodes of the specified location. Returns DeviceCodes of all locations if empty.
	LocationId string `json:"location_id,omitempty"`
	// If specified, only returns DeviceCodes targeting the specified product type. Returns DeviceCodes of all product types if empty.
	ProductType string `json:"product_type,omitempty"`
	// If specified, returns DeviceCodes with the specified statuses. Returns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty.
	Status []string `json:"status,omitempty"`
}

type ListDeviceCodesResponse ¶

type ListDeviceCodesResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The queried DeviceCode.
	DeviceCodes []DeviceCode `json:"device_codes,omitempty"`
	// A pagination cursor to retrieve the next set of results for your original query to the endpoint. This value is present only if the request succeeded and additional results are available.  See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
}

type ListDevicesRequest ¶

type ListDevicesRequest struct {
	// 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. See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
	// The order in which results are listed. - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).
	SortOrder string `json:"sort_order,omitempty"`
	// The number of results to return in a single page.
	Limit int32 `json:"limit,omitempty"`
	// If present, only returns devices at the target location.
	LocationId string `json:"location_id,omitempty"`
}

type ListDevicesResponse ¶

type ListDevicesResponse struct {
	// Information about errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The requested list of `Device` objects.
	Devices []Device `json:"devices,omitempty"`
	// The pagination cursor to be used in a subsequent request. If empty, this is the final response. See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
}

type ListDisputeEvidenceRequest ¶

type ListDisputeEvidenceRequest struct {
	// 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. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Defines the parameters for a `ListDisputeEvidence` request.

type ListDisputeEvidenceResponse ¶

type ListDisputeEvidenceResponse struct {
	// The list of evidence previously uploaded to the specified dispute.
	Evidence []DisputeEvidence `json:"evidence,omitempty"`
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The pagination cursor to be used in a subsequent request. If unset, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Defines the fields in a `ListDisputeEvidence` response.

type ListDisputesRequest ¶

type ListDisputesRequest struct {
	// 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. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// The dispute states used to filter the result. If not specified, the endpoint returns all disputes.
	States []string `json:"states,omitempty"`
	// The ID of the location for which to return a list of disputes. If not specified, the endpoint returns disputes associated with all locations.
	LocationId string `json:"location_id,omitempty"`
}

Defines the request parameters for the `ListDisputes` endpoint.

type ListDisputesResponse ¶

type ListDisputesResponse struct {
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The list of disputes.
	Disputes []Dispute `json:"disputes,omitempty"`
	// The pagination cursor to be used in a subsequent request. If unset, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Defines fields in a `ListDisputes` response.

type ListEmployeeWagesRequest ¶

type ListEmployeeWagesRequest struct {
	// Filter the returned wages to only those that are associated with the specified employee.
	EmployeeId string `json:"employee_id,omitempty"`
	// The maximum number of `EmployeeWage` results to return per page. The number can range between 1 and 200. The default is 200.
	Limit int32 `json:"limit,omitempty"`
	// A pointer to the next page of `EmployeeWage` results to fetch.
	Cursor string `json:"cursor,omitempty"`
}

A request for a set of `EmployeeWage` objects.

type ListEmployeeWagesResponse ¶

type ListEmployeeWagesResponse struct {
	// A page of `EmployeeWage` results.
	EmployeeWages []EmployeeWage `json:"employee_wages,omitempty"`
	// The value supplied in the subsequent request to fetch the next page of `EmployeeWage` results.
	Cursor string `json:"cursor,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

The response to a request for a set of `EmployeeWage` objects. The response contains a set of `EmployeeWage` objects.

type ListEmployeesRequest ¶

type ListEmployeesRequest struct {
	LocationId string `json:"location_id,omitempty"`
	// Specifies the EmployeeStatus to filter the employee by.
	Status string `json:"status,omitempty"`
	// The number of employees to be returned on each page.
	Limit int32 `json:"limit,omitempty"`
	// The token required to retrieve the specified page of results.
	Cursor string `json:"cursor,omitempty"`
}

type ListEmployeesResponse ¶

type ListEmployeesResponse struct {
	Employees []Employee `json:"employees,omitempty"`
	// The token to be used to retrieve the next page of results.
	Cursor string `json:"cursor,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type ListEventTypesRequest ¶

type ListEventTypesRequest struct {
	// The API version for which to list event types. Setting this field overrides the default version used by the application.
	ApiVersion string `json:"api_version,omitempty"`
}

Lists all event types that can be subscribed to.

type ListEventTypesResponse ¶

type ListEventTypesResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The list of event types.
	EventTypes []string `json:"event_types,omitempty"`
	// Contains the metadata of an event type. For more information, see [EventTypeMetadata](https://developer.squareup.com/reference/square_2024-07-17/objects/EventTypeMetadata).
	Metadata []EventTypeMetadata `json:"metadata,omitempty"`
}

Defines the fields that are included in the response body of a request to the [ListEventTypes](https://developer.squareup.com/reference/square_2024-07-17/events-api/list-event-types) endpoint. Note: if there are errors processing the request, the event types field will not be present.

type ListGiftCardActivitiesRequest ¶

type ListGiftCardActivitiesRequest 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:"gift_card_id,omitempty"`
	// If a [type](https://developer.squareup.com/reference/square_2024-07-17/objects/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:"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:"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:"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:"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 int32 `json:"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:"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:"sort_order,omitempty"`
}

Returns a list of gift card activities. You can optionally specify a filter to retrieve a subset of activites.

type ListGiftCardActivitiesResponse ¶

type ListGiftCardActivitiesResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The requested gift card activities or an empty object if none are found.
	GiftCardActivities []GiftCardActivity `json:"gift_card_activities,omitempty"`
	// When a response is truncated, it includes a cursor that you can use in a subsequent request to retrieve the next set of activities. If a cursor is not present, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
	Cursor string `json:"cursor,omitempty"`
}

A response that contains a list of `GiftCardActivity` objects. If the request resulted in errors, the response contains a set of `Error` objects.

type ListGiftCardsRequest ¶

type ListGiftCardsRequest struct {
	// If a [type](https://developer.squareup.com/reference/square_2024-07-17/enums/GiftCardType) is provided, the endpoint returns gift cards of the specified type. Otherwise, the endpoint returns gift cards of all types.
	Type_ string `json:"type,omitempty"`
	// If a [state](https://developer.squareup.com/reference/square_2024-07-17/enums/GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state. Otherwise, the endpoint returns the gift cards of all states.
	State string `json:"state,omitempty"`
	// If a limit is provided, the endpoint returns only the specified number of results per page. The maximum value is 200. The default value is 30. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
	Limit int32 `json:"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:"cursor,omitempty"`
	// If a customer ID is provided, the endpoint returns only the gift cards linked to the specified customer.
	CustomerId string `json:"customer_id,omitempty"`
}

A request to list gift cards. You can optionally specify a filter to retrieve a subset of gift cards.

type ListGiftCardsResponse ¶

type ListGiftCardsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The requested gift cards or an empty object if none are found.
	GiftCards []GiftCard `json:"gift_cards,omitempty"`
	// When a response is truncated, it includes a cursor that you can use in a subsequent request to retrieve the next set of gift cards. If a cursor is not present, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
	Cursor string `json:"cursor,omitempty"`
}

A response that contains a list of `GiftCard` objects. If the request resulted in errors, the response contains a set of `Error` objects.

type ListInvoicesRequest ¶

type ListInvoicesRequest struct {
	// The ID of the location for which to list invoices.
	LocationId string `json:"location_id"`
	// A pagination cursor returned by a previous call to this endpoint.  Provide this cursor to retrieve the next set of results for your original query.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// The maximum number of invoices to return (200 is the maximum `limit`).  If not provided, the server uses a default limit of 100 invoices.
	Limit int32 `json:"limit,omitempty"`
}

Describes a `ListInvoice` request.

type ListInvoicesResponse ¶

type ListInvoicesResponse struct {
	// The invoices retrieved.
	Invoices []Invoice `json:"invoices,omitempty"`
	// When a response is truncated, it includes a cursor that you can use in a  subsequent request to retrieve the next set of invoices. If empty, this is the final  response.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Describes a `ListInvoice` response.

type ListLocationBookingProfilesRequest ¶

type ListLocationBookingProfilesRequest struct {
	// The maximum number of results to return in a paged response.
	Limit int32 `json:"limit,omitempty"`
	// The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.
	Cursor string `json:"cursor,omitempty"`
}

type ListLocationBookingProfilesResponse ¶

type ListLocationBookingProfilesResponse struct {
	// The list of a seller's location booking profiles.
	LocationBookingProfiles []LocationBookingProfile `json:"location_booking_profiles,omitempty"`
	// The pagination cursor to be used in the subsequent request to get the next page of the results. Stop retrieving the next page of the results when the cursor is not set.
	Cursor string `json:"cursor,omitempty"`
	// Errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type ListLocationCustomAttributeDefinitionsRequest ¶

type ListLocationCustomAttributeDefinitionsRequest struct {
	// Filters the `CustomAttributeDefinition` results by their `visibility` values.
	VisibilityFilter string `json:"visibility_filter,omitempty"`
	// The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Limit int32 `json:"limit,omitempty"`
	// The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Represents a [ListLocationCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/list-location-custom-attribute-definitions) request.

type ListLocationCustomAttributeDefinitionsResponse ¶

type ListLocationCustomAttributeDefinitionsResponse struct {
	// The retrieved custom attribute definitions. If no custom attribute definitions are found, Square returns an empty object (`{}`).
	CustomAttributeDefinitions []CustomAttributeDefinition `json:"custom_attribute_definitions,omitempty"`
	// The cursor to provide in your next call to this endpoint to retrieve the next page of results for your original request. This field is present only if the request succeeded and additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [ListLocationCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/list-location-custom-attribute-definitions) response. Either `custom_attribute_definitions`, an empty object, or `errors` is present in the response. If additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.

type ListLocationCustomAttributesRequest ¶

type ListLocationCustomAttributesRequest struct {
	// Filters the `CustomAttributeDefinition` results by their `visibility` values.
	VisibilityFilter string `json:"visibility_filter,omitempty"`
	// The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Limit int32 `json:"limit,omitempty"`
	// The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttributeDefinition) in the `definition` field of each custom attribute. Set this parameter to `true` to get the name and description of each custom attribute, information about the data type, or other definition details. The default value is `false`.
	WithDefinitions bool `json:"with_definitions,omitempty"`
}

Represents a [ListLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/list-location-custom-attributes) request.

type ListLocationCustomAttributesResponse ¶

type ListLocationCustomAttributesResponse struct {
	// The retrieved custom attributes. If `with_definitions` was set to `true` in the request, the custom attribute definition is returned in the `definition` field of each custom attribute. If no custom attributes are found, Square returns an empty object (`{}`).
	CustomAttributes []CustomAttribute `json:"custom_attributes,omitempty"`
	// The cursor to use in your next call to this endpoint to retrieve the next page of results for your original request. This field is present only if the request succeeded and additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [ListLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/list-location-custom-attributes) response. Either `custom_attributes`, an empty object, or `errors` is present in the response. If additional results are available, the `cursor` field is also present along with `custom_attributes`.

type ListLocationsRequest ¶

type ListLocationsRequest struct{}

Defines the fields that are included in requests to the [ListLocations](https://developer.squareup.com/reference/square_2024-07-17/locations-api/list-locations) endpoint.

type ListLocationsResponse ¶

type ListLocationsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The business locations.
	Locations []Location `json:"locations,omitempty"`
}

Defines the fields that are included in the response body of a request to the [ListLocations](https://developer.squareup.com/reference/square_2024-07-17/locations-api/list-locations) endpoint. Either `errors` or `locations` is present in a given response (never both).

type ListLoyaltyProgramsRequest ¶

type ListLoyaltyProgramsRequest struct{}

A request to list `LoyaltyProgram`.

type ListLoyaltyProgramsResponse ¶

type ListLoyaltyProgramsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// A list of `LoyaltyProgram` for the merchant.
	Programs []LoyaltyProgram `json:"programs,omitempty"`
}

A response that contains all loyalty programs.

type ListLoyaltyPromotionsRequest ¶

type ListLoyaltyPromotionsRequest struct {
	// The status to filter the results by. If a status is provided, only loyalty promotions with the specified status are returned. Otherwise, all loyalty promotions associated with the loyalty program are returned.
	Status string `json:"status,omitempty"`
	// The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// The maximum number of results to return in a single paged response. The minimum value is 1 and the maximum value is 30. The default value is 30. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Limit int32 `json:"limit,omitempty"`
}

Represents a [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/list-loyalty-promotions) request.

type ListLoyaltyPromotionsResponse ¶

type ListLoyaltyPromotionsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The retrieved loyalty promotions.
	LoyaltyPromotions []LoyaltyPromotion `json:"loyalty_promotions,omitempty"`
	// The cursor to use in your next call to this endpoint to retrieve the next page of results for your original request. This field is present only if the request succeeded and additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Represents a [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/list-loyalty-promotions) response. One of `loyalty_promotions`, an empty object, or `errors` is present in the response. If additional results are available, the `cursor` field is also present along with `loyalty_promotions`.

type ListMerchantCustomAttributeDefinitionsRequest ¶

type ListMerchantCustomAttributeDefinitionsRequest struct {
	// Filters the `CustomAttributeDefinition` results by their `visibility` values.
	VisibilityFilter string `json:"visibility_filter,omitempty"`
	// The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Limit int32 `json:"limit,omitempty"`
	// The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Represents a [ListMerchantCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/list-merchant-custom-attribute-definitions) request.

type ListMerchantCustomAttributeDefinitionsResponse ¶

type ListMerchantCustomAttributeDefinitionsResponse struct {
	// The retrieved custom attribute definitions. If no custom attribute definitions are found, Square returns an empty object (`{}`).
	CustomAttributeDefinitions []CustomAttributeDefinition `json:"custom_attribute_definitions,omitempty"`
	// The cursor to provide in your next call to this endpoint to retrieve the next page of results for your original request. This field is present only if the request succeeded and additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [ListMerchantCustomAttributeDefinitions](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/list-merchant-custom-attribute-definitions) response. Either `custom_attribute_definitions`, an empty object, or `errors` is present in the response. If additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.

type ListMerchantCustomAttributesRequest ¶

type ListMerchantCustomAttributesRequest struct {
	// Filters the `CustomAttributeDefinition` results by their `visibility` values.
	VisibilityFilter string `json:"visibility_filter,omitempty"`
	// The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Limit int32 `json:"limit,omitempty"`
	// The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttributeDefinition) in the `definition` field of each custom attribute. Set this parameter to `true` to get the name and description of each custom attribute, information about the data type, or other definition details. The default value is `false`.
	WithDefinitions bool `json:"with_definitions,omitempty"`
}

Represents a [ListMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/list-merchant-custom-attributes) request.

type ListMerchantCustomAttributesResponse ¶

type ListMerchantCustomAttributesResponse struct {
	// The retrieved custom attributes. If `with_definitions` was set to `true` in the request, the custom attribute definition is returned in the `definition` field of each custom attribute. If no custom attributes are found, Square returns an empty object (`{}`).
	CustomAttributes []CustomAttribute `json:"custom_attributes,omitempty"`
	// The cursor to use in your next call to this endpoint to retrieve the next page of results for your original request. This field is present only if the request succeeded and additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [ListMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/list-merchant-custom-attributes) response. Either `custom_attributes`, an empty object, or `errors` is present in the response. If additional results are available, the `cursor` field is also present along with `custom_attributes`.

type ListMerchantsRequest ¶

type ListMerchantsRequest struct {
	// The cursor generated by the previous response.
	Cursor int32 `json:"cursor,omitempty"`
}

Request object for the [ListMerchant](https://developer.squareup.com/reference/square_2024-07-17/merchants-api/list-merchants) endpoint.

type ListMerchantsResponse ¶

type ListMerchantsResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The requested `Merchant` entities.
	Merchant []Merchant `json:"merchant,omitempty"`
	// If the  response is truncated, the cursor to use in next  request to fetch next set of objects.
	Cursor int32 `json:"cursor,omitempty"`
}

The response object returned by the [ListMerchant](https://developer.squareup.com/reference/square_2024-07-17/merchants-api/list-merchants) endpoint.

type ListOrderCustomAttributeDefinitionsRequest ¶

type ListOrderCustomAttributeDefinitionsRequest struct {
	// Requests that all of the custom attributes be returned, or only those that are read-only or read-write.
	VisibilityFilter string `json:"visibility_filter,omitempty"`
	// The cursor returned in the paged response from the previous call to this endpoint.  Provide this cursor to retrieve the next page of results for your original request.  For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
	Cursor string `json:"cursor,omitempty"`
	// The maximum number of results to return in a single paged response. This limit is advisory.  The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.  The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
	Limit int32 `json:"limit,omitempty"`
}

Represents a list request for order custom attribute definitions.

type ListOrderCustomAttributeDefinitionsResponse ¶

type ListOrderCustomAttributeDefinitionsResponse struct {
	// The retrieved custom attribute definitions. If no custom attribute definitions are found, Square returns an empty object (`{}`).
	CustomAttributeDefinitions []CustomAttributeDefinition `json:"custom_attribute_definitions"`
	// The cursor to provide in your next call to this endpoint to retrieve the next page of results for your original request.  This field is present only if the request succeeded and additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response from listing order custom attribute definitions.

type ListOrderCustomAttributesRequest ¶

type ListOrderCustomAttributesRequest struct {
	// Requests that all of the custom attributes be returned, or only those that are read-only or read-write.
	VisibilityFilter string `json:"visibility_filter,omitempty"`
	// The cursor returned in the paged response from the previous call to this endpoint.  Provide this cursor to retrieve the next page of results for your original request.  For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
	Cursor string `json:"cursor,omitempty"`
	// The maximum number of results to return in a single paged response. This limit is advisory.  The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.  The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
	Limit int32 `json:"limit,omitempty"`
	// Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttributeDefinition) in the `definition` field of each custom attribute. Set this parameter to `true` to get the name and description of each custom attribute,  information about the data type, or other definition details. The default value is `false`.
	WithDefinitions bool `json:"with_definitions,omitempty"`
}

Represents a list request for order custom attributes.

type ListOrderCustomAttributesResponse ¶

type ListOrderCustomAttributesResponse struct {
	// The retrieved custom attributes. If no custom attribute are found, Square returns an empty object (`{}`).
	CustomAttributes []CustomAttribute `json:"custom_attributes,omitempty"`
	// The cursor to provide in your next call to this endpoint to retrieve the next page of results for your original request.  This field is present only if the request succeeded and additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response from listing order custom attributes.

type ListPaymentLinksRequest ¶

type ListPaymentLinksRequest struct {
	// 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/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// A limit on the number of results to return per page. The limit is advisory and the implementation might return more or less results. If the supplied limit is negative, zero, or greater than the maximum limit of 1000, it is ignored.  Default value: `100`
	Limit int32 `json:"limit,omitempty"`
}

type ListPaymentLinksResponse ¶

type ListPaymentLinksResponse struct {
	// Errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The list of payment links.
	PaymentLinks []PaymentLink `json:"payment_links,omitempty"`
	//   When a response is truncated, it includes a cursor that you can use in a subsequent request to retrieve the next set of gift cards. If a cursor is not present, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

type ListPaymentRefundsRequest ¶

type ListPaymentRefundsRequest struct {
	// Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339  format.  The range is determined using the `created_at` field for each `PaymentRefund`.   Default: The current time minus one year.
	BeginTime string `json:"begin_time,omitempty"`
	// Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339  format.  The range is determined using the `created_at` field for each `PaymentRefund`.  Default: The current time.
	EndTime string `json:"end_time,omitempty"`
	// The order in which results are listed by `PaymentRefund.created_at`: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).
	SortOrder string `json:"sort_order,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.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Limit results to the location supplied. By default, results are returned for all locations associated with the seller.
	LocationId string `json:"location_id,omitempty"`
	// If provided, only refunds with the given status are returned. For a list of refund status values, see [PaymentRefund](https://developer.squareup.com/reference/square_2024-07-17/objects/PaymentRefund).  Default: If omitted, refunds are returned regardless of their status.
	Status string `json:"status,omitempty"`
	// If provided, only returns refunds whose payments have the indicated source type. Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `CASH`, and `EXTERNAL`. For information about these payment source types, see [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments).  Default: If omitted, refunds are returned regardless of the source type.
	SourceType string `json:"source_type,omitempty"`
	// The maximum number of results to be returned in a single page.  It is possible to receive fewer results than the specified limit on a given page.  If the supplied value is greater than 100, no more than 100 results are returned.  Default: 100
	Limit int32 `json:"limit,omitempty"`
}

Describes a request to list refunds using [ListPaymentRefunds](https://developer.squareup.com/reference/square_2024-07-17/refunds-api/list-payment-refunds). The maximum results per page is 100.

type ListPaymentRefundsResponse ¶

type ListPaymentRefundsResponse struct {
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The list of requested refunds.
	Refunds []PaymentRefund `json:"refunds,omitempty"`
	// The pagination cursor to be used in a subsequent request. If empty, this is the final response.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Defines the response returned by [ListPaymentRefunds](https://developer.squareup.com/reference/square_2024-07-17/refunds-api/list-payment-refunds). Either `errors` or `refunds` is present in a given response (never both).

type ListPaymentsRequest ¶

type ListPaymentsRequest struct {
	// Indicates the start of the time range to retrieve payments for, in RFC 3339 format.   The range is determined using the `created_at` field for each Payment. Inclusive. Default: The current time minus one year.
	BeginTime string `json:"begin_time,omitempty"`
	// Indicates the end of the time range to retrieve payments for, in RFC 3339 format.  The  range is determined using the `created_at` field for each Payment.  Default: The current time.
	EndTime string `json:"end_time,omitempty"`
	// The order in which results are listed by `Payment.created_at`: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).
	SortOrder string `json:"sort_order,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.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Limit results to the location supplied. By default, results are returned for the default (main) location associated with the seller.
	LocationId string `json:"location_id,omitempty"`
	// The exact amount in the `total_money` for a payment.
	Total int64 `json:"total,omitempty"`
	// The last four digits of a payment card.
	Last4 string `json:"last_4,omitempty"`
	// The brand of the payment card (for example, VISA).
	CardBrand string `json:"card_brand,omitempty"`
	// The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page.  The default value of 100 is also the maximum allowed value. If the provided value is  greater than 100, it is ignored and the default value is used instead.  Default: `100`
	Limit int32 `json:"limit,omitempty"`
}

Describes a request to list payments using [ListPayments](https://developer.squareup.com/reference/square_2024-07-17/payments-api/list-payments). The maximum results per page is 100.

type ListPaymentsResponse ¶

type ListPaymentsResponse struct {
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The requested list of payments.
	Payments []Payment `json:"payments,omitempty"`
	// The pagination cursor to be used in a subsequent request. If empty, this is the final response.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Defines the response returned by [ListPayments](https://developer.squareup.com/reference/square_2024-07-17/payments-api/list-payments).

type ListPayoutEntriesRequest ¶

type ListPayoutEntriesRequest struct {
	// The order in which payout entries are listed.
	SortOrder string `json:"sort_order,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. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). If request parameters change between requests, subsequent results may contain duplicates or missing records.
	Cursor string `json:"cursor,omitempty"`
	// The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. The default value of 100 is also the maximum allowed value. If the provided value is greater than 100, it is ignored and the default value is used instead. Default: `100`
	Limit int32 `json:"limit,omitempty"`
}

type ListPayoutEntriesResponse ¶

type ListPayoutEntriesResponse struct {
	// The requested list of payout entries, ordered with the given or default sort order.
	PayoutEntries []PayoutEntry `json:"payout_entries,omitempty"`
	// The pagination cursor to be used in a subsequent request. If empty, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

The response to retrieve payout records entries.

type ListPayoutsRequest ¶

type ListPayoutsRequest struct {
	// The ID of the location for which to list the payouts. By default, payouts are returned for the default (main) location associated with the seller.
	LocationId string `json:"location_id,omitempty"`
	// If provided, only payouts with the given status are returned.
	Status string `json:"status,omitempty"`
	// The timestamp for the beginning of the payout creation time, in RFC 3339 format. Inclusive. Default: The current time minus one year.
	BeginTime string `json:"begin_time,omitempty"`
	// The timestamp for the end of the payout creation time, in RFC 3339 format. Default: The current time.
	EndTime string `json:"end_time,omitempty"`
	// The order in which payouts are listed.
	SortOrder string `json:"sort_order,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. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). If request parameters change between requests, subsequent results may contain duplicates or missing records.
	Cursor string `json:"cursor,omitempty"`
	// The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. The default value of 100 is also the maximum allowed value. If the provided value is greater than 100, it is ignored and the default value is used instead. Default: `100`
	Limit int32 `json:"limit,omitempty"`
}

A request to retrieve payout records.

type ListPayoutsResponse ¶

type ListPayoutsResponse struct {
	// The requested list of payouts.
	Payouts []Payout `json:"payouts,omitempty"`
	// The pagination cursor to be used in a subsequent request. If empty, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

The response to retrieve payout records entries.

type ListRefundsRequest ¶

type ListRefundsRequest struct {
	// The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity.  Default value: The current time minus one year.
	BeginTime string `json:"begin_time,omitempty"`
	// The end of the requested reporting period, in RFC 3339 format.  See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity.  Default value: The current time.
	EndTime string `json:"end_time,omitempty"`
	// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC`
	SortOrder string `json:"sort_order,omitempty"`
	// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
}

Defines the query parameters that can be included in a request to the [ListRefunds](https://developer.squareup.com/reference/square_2024-07-17/transactions-api/list-refunds) endpoint. Deprecated - recommend using [SearchOrders](https://developer.squareup.com/reference/square_2024-07-17/orders-api/search-orders)

type ListRefundsResponse ¶

type ListRefundsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// An array of refunds that match your query.
	Refunds []Refund `json:"refunds,omitempty"`
	// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint.  See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
}

Defines the fields that are included in the response body of a request to the [ListRefunds](https://developer.squareup.com/reference/square_2024-07-17/transactions-api/list-refunds) endpoint. One of `errors` or `refunds` is present in a given response (never both).

type ListSitesRequest ¶

type ListSitesRequest struct{}

Represents a `ListSites` request.

type ListSitesResponse ¶

type ListSitesResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The sites that belong to the seller.
	Sites []Site `json:"sites,omitempty"`
}

Represents a `ListSites` response. The response can include either `sites` or `errors`.

type ListSubscriptionEventsRequest ¶

type ListSubscriptionEventsRequest struct {
	// When the total number of resulting subscription events exceeds the limit of a paged response,  specify the cursor returned from a preceding response here to fetch the next set of results. If the cursor is unset, the response contains the last page of the results.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// The upper limit on the number of subscription events to return in a paged response.
	Limit int32 `json:"limit,omitempty"`
}

Defines input parameters in a request to the [ListSubscriptionEvents](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/list-subscription-events) endpoint.

type ListSubscriptionEventsResponse ¶

type ListSubscriptionEventsResponse struct {
	// Errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The retrieved subscription events.
	SubscriptionEvents []SubscriptionEvent `json:"subscription_events,omitempty"`
	// When the total number of resulting subscription events exceeds the limit of a paged response,  the response includes a cursor for you to use in a subsequent request to fetch the next set of events. If the cursor is unset, the response contains the last page of the results.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Defines output parameters in a response from the [ListSubscriptionEvents](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/list-subscription-events).

type ListTeamMemberBookingProfilesRequest ¶

type ListTeamMemberBookingProfilesRequest struct {
	// Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`).
	BookableOnly bool `json:"bookable_only,omitempty"`
	// The maximum number of results to return in a paged response.
	Limit int32 `json:"limit,omitempty"`
	// The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.
	Cursor string `json:"cursor,omitempty"`
	// Indicates whether to include only team members enabled at the given location in the returned result.
	LocationId string `json:"location_id,omitempty"`
}

type ListTeamMemberBookingProfilesResponse ¶

type ListTeamMemberBookingProfilesResponse struct {
	// The list of team member booking profiles. The results are returned in the ascending order of the time when the team member booking profiles were last updated. Multiple booking profiles updated at the same time are further sorted in the ascending order of their IDs.
	TeamMemberBookingProfiles []TeamMemberBookingProfile `json:"team_member_booking_profiles,omitempty"`
	// The pagination cursor to be used in the subsequent request to get the next page of the results. Stop retrieving the next page of the results when the cursor is not set.
	Cursor string `json:"cursor,omitempty"`
	// Errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type ListTeamMemberWagesRequest ¶

type ListTeamMemberWagesRequest struct {
	// Filter the returned wages to only those that are associated with the specified team member.
	TeamMemberId string `json:"team_member_id,omitempty"`
	// The maximum number of `TeamMemberWage` results to return per page. The number can range between 1 and 200. The default is 200.
	Limit int32 `json:"limit,omitempty"`
	// A pointer to the next page of `EmployeeWage` results to fetch.
	Cursor string `json:"cursor,omitempty"`
}

A request for a set of `TeamMemberWage` objects.

type ListTeamMemberWagesResponse ¶

type ListTeamMemberWagesResponse struct {
	// A page of `TeamMemberWage` results.
	TeamMemberWages []TeamMemberWage `json:"team_member_wages,omitempty"`
	// The value supplied in the subsequent request to fetch the next page of `TeamMemberWage` results.
	Cursor string `json:"cursor,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

The response to a request for a set of `TeamMemberWage` objects. The response contains a set of `TeamMemberWage` objects.

type ListTransactionsRequest ¶

type ListTransactionsRequest struct {
	// The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity.  Default value: The current time minus one year.
	BeginTime string `json:"begin_time,omitempty"`
	// The end of the requested reporting period, in RFC 3339 format.  See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity.  Default value: The current time.
	EndTime string `json:"end_time,omitempty"`
	// The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC`
	SortOrder string `json:"sort_order,omitempty"`
	// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
}

Defines the query parameters that can be included in a request to the [ListTransactions](https://developer.squareup.com/reference/square_2024-07-17/transactions-api/list-transactions) endpoint. Deprecated - recommend using [SearchOrders](https://developer.squareup.com/reference/square_2024-07-17/orders-api/search-orders)

type ListTransactionsResponse ¶

type ListTransactionsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// An array of transactions that match your query.
	Transactions []Transaction `json:"transactions,omitempty"`
	// A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint.  See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
}

Defines the fields that are included in the response body of a request to the [ListTransactions](https://developer.squareup.com/reference/square_2024-07-17/transactions-api/list-transactions) endpoint. One of `errors` or `transactions` is present in a given response (never both).

type ListWebhookEventTypesRequest ¶

type ListWebhookEventTypesRequest struct {
	// The API version for which to list event types. Setting this field overrides the default version used by the application.
	ApiVersion string `json:"api_version,omitempty"`
}

Lists all webhook event types that can be subscribed to.

type ListWebhookEventTypesResponse ¶

type ListWebhookEventTypesResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The list of event types.
	EventTypes []string `json:"event_types,omitempty"`
	// Contains the metadata of a webhook event type. For more information, see [EventTypeMetadata](https://developer.squareup.com/reference/square_2024-07-17/objects/EventTypeMetadata).
	Metadata []EventTypeMetadata `json:"metadata,omitempty"`
}

Defines the fields that are included in the response body of a request to the [ListWebhookEventTypes](https://developer.squareup.com/reference/square_2024-07-17/webhook-subscriptions-api/list-webhook-event-types) endpoint. Note: if there are errors processing the request, the event types field will not be present.

type ListWebhookSubscriptionsRequest ¶

type ListWebhookSubscriptionsRequest struct {
	// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Includes disabled [Subscription](https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription)s. By default, all enabled [Subscription](https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription)s are returned.
	IncludeDisabled bool `json:"include_disabled,omitempty"`
	// Sorts the returned list by when the [Subscription](https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription) was created with the specified order. This field defaults to ASC.
	SortOrder string `json:"sort_order,omitempty"`
	// The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. The default value of 100 is also the maximum allowed value.  Default: 100
	Limit int32 `json:"limit,omitempty"`
}

Lists all Subscription(https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription)s owned by your application.

type ListWebhookSubscriptionsResponse ¶

type ListWebhookSubscriptionsResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The requested list of [Subscription](https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription)s.
	Subscriptions []WebhookSubscription `json:"subscriptions,omitempty"`
	// The pagination cursor to be used in a subsequent request. If empty, this is the final response.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Defines the fields that are included in the response body of a request to the [ListWebhookSubscriptions](https://developer.squareup.com/reference/square_2024-07-17/webhook-subscriptions-api/list-webhook-subscriptions) endpoint. Note: if there are errors processing the request, the subscriptions field will not be present.

type ListWorkweekConfigsRequest ¶

type ListWorkweekConfigsRequest struct {
	// The maximum number of `WorkweekConfigs` results to return per page.
	Limit int32 `json:"limit,omitempty"`
	// A pointer to the next page of `WorkweekConfig` results to fetch.
	Cursor string `json:"cursor,omitempty"`
}

A request for a set of `WorkweekConfig` objects.

type ListWorkweekConfigsResponse ¶

type ListWorkweekConfigsResponse struct {
	// A page of `WorkweekConfig` results.
	WorkweekConfigs []WorkweekConfig `json:"workweek_configs,omitempty"`
	// The value supplied in the subsequent request to fetch the next page of `WorkweekConfig` results.
	Cursor string `json:"cursor,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

The response to a request for a set of `WorkweekConfig` objects. The response contains the requested `WorkweekConfig` objects and might contain a set of `Error` objects if the request resulted in errors.

type Location ¶

type Location struct {
	// A short generated string of letters and numbers that uniquely identifies this location instance.
	Id string `json:"id,omitempty"`
	// 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.
	Name    string   `json:"name,omitempty"`
	Address *Address `json:"address,omitempty"`
	// The [IANA time zone](https://www.iana.org/time-zones) identifier for the time zone of the location. For example, `America/Los_Angeles`.
	Timezone string `json:"timezone,omitempty"`
	// The Square features that are enabled for the location. See [LocationCapability](https://developer.squareup.com/reference/square_2024-07-17/enums/LocationCapability) for possible values.
	Capabilities []string `json:"capabilities,omitempty"`
	// The status of the location.
	Status string `json:"status,omitempty"`
	// 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).
	CreatedAt string `json:"created_at,omitempty"`
	// The ID of the merchant that owns the location.
	MerchantId string `json:"merchant_id,omitempty"`
	// The country of the location, in the two-letter format of ISO 3166. For example, `US` or `JP`.  See [Country](https://developer.squareup.com/reference/square_2024-07-17/enums/Country) for possible values.
	Country string `json:"country,omitempty"`
	// 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).
	LanguageCode string `json:"language_code,omitempty"`
	// The currency used for all transactions at this location, in ISO 4217 format. For example, the currency code for US dollars is `USD`. See [Currency](https://developer.squareup.com/reference/square_2024-07-17/enums/Currency) for possible values.
	Currency string `json:"currency,omitempty"`
	// The phone number of the location. For example, `+1 855-700-6000`.
	PhoneNumber string `json:"phone_number,omitempty"`
	// 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.
	BusinessName string `json:"business_name,omitempty"`
	// The type of the location.
	Type_ string `json:"type,omitempty"`
	// The website URL of the location.  For example, `https://squareup.com`.
	WebsiteUrl    string         `json:"website_url,omitempty"`
	BusinessHours *BusinessHours `json:"business_hours,omitempty"`
	// 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.
	BusinessEmail string `json:"business_email,omitempty"`
	// The description of the location. For example, `Main Street location`.
	Description string `json:"description,omitempty"`
	// The Twitter username of the location without the '&#64;' symbol. For example, `Square`.
	TwitterUsername string `json:"twitter_username,omitempty"`
	// The Instagram username of the location without the '&#64;' symbol. For example, `square`.
	InstagramUsername string `json:"instagram_username,omitempty"`
	// The Facebook profile URL of the location. The URL should begin with 'facebook.com/'. For example, `https://www.facebook.com/square`.
	FacebookUrl string       `json:"facebook_url,omitempty"`
	Coordinates *Coordinates `json:"coordinates,omitempty"`
	// 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.
	LogoUrl string `json:"logo_url,omitempty"`
	// The URL of the Point of Sale background image for the location.
	PosBackgroundUrl string `json:"pos_background_url,omitempty"`
	// 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.
	Mcc string `json:"mcc,omitempty"`
	// 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.
	FullFormatLogoUrl string  `json:"full_format_logo_url,omitempty"`
	TaxIds            *TaxIds `json:"tax_ids,omitempty"`
}

Represents one of a business' [locations](https://developer.squareup.com/docs/locations-api).

type LocationBookingProfile ¶

type LocationBookingProfile struct {
	// The ID of the [location](https://developer.squareup.com/reference/square_2024-07-17/objects/Location).
	LocationId string `json:"location_id,omitempty"`
	// Url for the online booking site for this location.
	BookingSiteUrl string `json:"booking_site_url,omitempty"`
	// Indicates whether the location is enabled for online booking.
	OnlineBookingEnabled bool `json:"online_booking_enabled,omitempty"`
}

The booking profile of a seller's location, including the location's ID and whether the location is enabled for online booking.

type LocationCapability ¶

type LocationCapability string

LocationCapability : The capabilities a location might have.

const (
	CREDIT_CARD_PROCESSING_LocationCapability LocationCapability = "CREDIT_CARD_PROCESSING"
	AUTOMATIC_TRANSFERS_LocationCapability    LocationCapability = "AUTOMATIC_TRANSFERS"
	UNLINKED_REFUNDS_LocationCapability       LocationCapability = "UNLINKED_REFUNDS"
)

List of LocationCapability

type LocationCustomAttributesApiListLocationCustomAttributeDefinitionsOpts ¶

type LocationCustomAttributesApiListLocationCustomAttributeDefinitionsOpts struct {
	VisibilityFilter optional.String
	Limit            optional.Int32
	Cursor           optional.String
}

type LocationCustomAttributesApiListLocationCustomAttributesOpts ¶

type LocationCustomAttributesApiListLocationCustomAttributesOpts struct {
	VisibilityFilter optional.String
	Limit            optional.Int32
	Cursor           optional.String
	WithDefinitions  optional.Bool
}

type LocationCustomAttributesApiRetrieveLocationCustomAttributeDefinitionOpts ¶

type LocationCustomAttributesApiRetrieveLocationCustomAttributeDefinitionOpts struct {
	Version optional.Int32
}

type LocationCustomAttributesApiRetrieveLocationCustomAttributeOpts ¶

type LocationCustomAttributesApiRetrieveLocationCustomAttributeOpts struct {
	WithDefinition optional.Bool
	Version        optional.Int32
}

type LocationCustomAttributesApiService ¶

type LocationCustomAttributesApiService service

func (*LocationCustomAttributesApiService) BulkDeleteLocationCustomAttributes ¶

func (a *LocationCustomAttributesApiService) BulkDeleteLocationCustomAttributes(ctx context.Context, body BulkDeleteLocationCustomAttributesRequest) (BulkDeleteLocationCustomAttributesResponse, *http.Response, error)

LocationCustomAttributesApiService BulkDeleteLocationCustomAttributes Deletes [custom attributes](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttribute) for locations as a bulk operation. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkDeleteLocationCustomAttributesResponse

func (*LocationCustomAttributesApiService) BulkUpsertLocationCustomAttributes ¶

func (a *LocationCustomAttributesApiService) BulkUpsertLocationCustomAttributes(ctx context.Context, body BulkUpsertLocationCustomAttributesRequest) (BulkUpsertLocationCustomAttributesResponse, *http.Response, error)

LocationCustomAttributesApiService BulkUpsertLocationCustomAttributes Creates or updates [custom attributes](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttribute) for locations as a bulk operation. Use this endpoint to set the value of one or more custom attributes for one or more locations. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the [CreateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/create-location-custom-attribute-definition) endpoint. This `BulkUpsertLocationCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert requests and returns a map of individual upsert responses. Each upsert request has a unique ID and provides a location ID and custom attribute. Each upsert response is returned with the ID of the corresponding request. To create or update a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkUpsertLocationCustomAttributesResponse

func (*LocationCustomAttributesApiService) CreateLocationCustomAttributeDefinition ¶

func (a *LocationCustomAttributesApiService) CreateLocationCustomAttributeDefinition(ctx context.Context, body CreateLocationCustomAttributeDefinitionRequest) (CreateLocationCustomAttributeDefinitionResponse, *http.Response, error)

LocationCustomAttributesApiService CreateLocationCustomAttributeDefinition Creates a location-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttributeDefinition) for a Square seller account. Use this endpoint to define a custom attribute that can be associated with locations. A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties for a custom attribute. After the definition is created, you can call [UpsertLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/upsert-location-custom-attribute) or [BulkUpsertLocationCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/bulk-upsert-location-custom-attributes) to set the custom attribute for locations.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateLocationCustomAttributeDefinitionResponse

func (*LocationCustomAttributesApiService) DeleteLocationCustomAttribute ¶

func (a *LocationCustomAttributesApiService) DeleteLocationCustomAttribute(ctx context.Context, locationId string, key string) (DeleteLocationCustomAttributeResponse, *http.Response, error)

LocationCustomAttributesApiService DeleteLocationCustomAttribute Deletes a [custom attribute](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttribute) associated with a location. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the target [location](https://developer.squareup.com/reference/square_2024-07-17/objects/Location).
@param key The key of the custom attribute to delete. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.

@return DeleteLocationCustomAttributeResponse

func (*LocationCustomAttributesApiService) DeleteLocationCustomAttributeDefinition ¶

func (a *LocationCustomAttributesApiService) DeleteLocationCustomAttributeDefinition(ctx context.Context, key string) (DeleteLocationCustomAttributeDefinitionResponse, *http.Response, error)

LocationCustomAttributesApiService DeleteLocationCustomAttributeDefinition Deletes a location-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttributeDefinition) from a Square seller account. Deleting a custom attribute definition also deletes the corresponding custom attribute from all locations. Only the definition owner can delete a custom attribute definition.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param key The key of the custom attribute definition to delete.

@return DeleteLocationCustomAttributeDefinitionResponse

func (*LocationCustomAttributesApiService) ListLocationCustomAttributeDefinitions ¶

func (a *LocationCustomAttributesApiService) ListLocationCustomAttributeDefinitions(ctx context.Context, localVarOptionals *LocationCustomAttributesApiListLocationCustomAttributeDefinitionsOpts) (ListLocationCustomAttributeDefinitionsResponse, *http.Response, error)

func (*LocationCustomAttributesApiService) ListLocationCustomAttributes ¶

func (a *LocationCustomAttributesApiService) ListLocationCustomAttributes(ctx context.Context, locationId string, localVarOptionals *LocationCustomAttributesApiListLocationCustomAttributesOpts) (ListLocationCustomAttributesResponse, *http.Response, error)

func (*LocationCustomAttributesApiService) RetrieveLocationCustomAttribute ¶

func (a *LocationCustomAttributesApiService) RetrieveLocationCustomAttribute(ctx context.Context, locationId string, key string, localVarOptionals *LocationCustomAttributesApiRetrieveLocationCustomAttributeOpts) (RetrieveLocationCustomAttributeResponse, *http.Response, error)

func (*LocationCustomAttributesApiService) RetrieveLocationCustomAttributeDefinition ¶

func (a *LocationCustomAttributesApiService) RetrieveLocationCustomAttributeDefinition(ctx context.Context, key string, localVarOptionals *LocationCustomAttributesApiRetrieveLocationCustomAttributeDefinitionOpts) (RetrieveLocationCustomAttributeDefinitionResponse, *http.Response, error)

func (*LocationCustomAttributesApiService) UpdateLocationCustomAttributeDefinition ¶

func (a *LocationCustomAttributesApiService) UpdateLocationCustomAttributeDefinition(ctx context.Context, body UpdateLocationCustomAttributeDefinitionRequest, key string) (UpdateLocationCustomAttributeDefinitionResponse, *http.Response, error)

LocationCustomAttributesApiService UpdateLocationCustomAttributeDefinition Updates a location-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttributeDefinition) for a Square seller account. Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the `schema` for a `Selection` data type. Only the definition owner can update a custom attribute definition.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param key The key of the custom attribute definition to update.

@return UpdateLocationCustomAttributeDefinitionResponse

func (*LocationCustomAttributesApiService) UpsertLocationCustomAttribute ¶

func (a *LocationCustomAttributesApiService) UpsertLocationCustomAttribute(ctx context.Context, body UpsertLocationCustomAttributeRequest, locationId string, key string) (UpsertLocationCustomAttributeResponse, *http.Response, error)

LocationCustomAttributesApiService UpsertLocationCustomAttribute Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttribute) for a location. Use this endpoint to set the value of a custom attribute for a specified location. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the [CreateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/create-location-custom-attribute-definition) endpoint. To create or update a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param locationId The ID of the target [location](https://developer.squareup.com/reference/square_2024-07-17/objects/Location).
@param key The key of the custom attribute to create or update. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.

@return UpsertLocationCustomAttributeResponse

type LocationStatus ¶

type LocationStatus string

LocationStatus : A location's status.

const (
	ACTIVE_LocationStatus   LocationStatus = "ACTIVE"
	INACTIVE_LocationStatus LocationStatus = "INACTIVE"
)

List of LocationStatus

type LocationType ¶

type LocationType string

LocationType : A location's type.

const (
	PHYSICAL_LocationType LocationType = "PHYSICAL"
	MOBILE_LocationType   LocationType = "MOBILE"
)

List of LocationType

type LocationsApiService ¶

type LocationsApiService service

func (*LocationsApiService) CreateLocation ¶

func (a *LocationsApiService) CreateLocation(ctx context.Context, body CreateLocationRequest) (CreateLocationResponse, *http.Response, error)

LocationsApiService CreateLocation Creates a [location](https://developer.squareup.com/docs/locations-api). Creating new locations allows for separate configuration of receipt layouts, item prices, and sales reports. Developers can use locations to separate sales activity through applications that integrate with Square from sales activity elsewhere in a seller's account. Locations created programmatically with the Locations API last forever and are visible to the seller for their own management. Therefore, ensure that each location has a sensible and unique name.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateLocationResponse

func (*LocationsApiService) ListLocations ¶

func (a *LocationsApiService) ListLocations(ctx context.Context) (ListLocationsResponse, *http.Response, error)

LocationsApiService ListLocations Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api), including those with an inactive status. Locations are listed alphabetically by `name`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ListLocationsResponse

func (*LocationsApiService) RetrieveLocation ¶

func (a *LocationsApiService) RetrieveLocation(ctx context.Context, locationId string) (RetrieveLocationResponse, *http.Response, error)

LocationsApiService RetrieveLocation Retrieves details of a single location. Specify \"main\" as the location ID to retrieve details of the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the location to retrieve. Specify the string \"main\" to return the main location.

@return RetrieveLocationResponse

func (*LocationsApiService) UpdateLocation ¶

func (a *LocationsApiService) UpdateLocation(ctx context.Context, body UpdateLocationRequest, locationId string) (UpdateLocationResponse, *http.Response, error)

LocationsApiService UpdateLocation Updates a [location](https://developer.squareup.com/docs/locations-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param locationId The ID of the location to update.

@return UpdateLocationResponse

type LoyaltyAccount ¶

type LoyaltyAccount struct {
	// The Square-assigned ID of the loyalty account.
	Id string `json:"id,omitempty"`
	// The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgram) to which the account belongs.
	ProgramId string `json:"program_id"`
	// The available point balance in the loyalty account. If points are scheduled to expire, they are listed in the `expiring_point_deadlines` field.  Your application should be able to handle loyalty accounts that have a negative point balance (`balance` is less than 0). This might occur if a seller makes a manual adjustment or as a result of a refund or exchange.
	Balance int32 `json:"balance,omitempty"`
	// The total points accrued during the lifetime of the account.
	LifetimePoints int32 `json:"lifetime_points,omitempty"`
	// The Square-assigned ID of the [customer](https://developer.squareup.com/reference/square_2024-07-17/objects/Customer) that is associated with the account.
	CustomerId string `json:"customer_id,omitempty"`
	// The timestamp when the buyer joined the loyalty program, in RFC 3339 format. This field is used to display the **Enrolled On** or **Member Since** date in first-party Square products.  If this field is not set in a `CreateLoyaltyAccount` request, Square populates it after the buyer's first action on their account  (when `AccumulateLoyaltyPoints` or `CreateLoyaltyReward` is called). In first-party flows, Square populates the field when the buyer agrees to the terms of service in Square Point of Sale.   This field is typically specified in a `CreateLoyaltyAccount` request when creating a loyalty account for a buyer who already interacted with their account.  For example, you would set this field when migrating accounts from an external system. The timestamp in the request can represent a current or previous date and time, but it cannot be set for the future.
	EnrolledAt string `json:"enrolled_at,omitempty"`
	// The timestamp when the loyalty account was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp when the loyalty account was last updated, in RFC 3339 format.
	UpdatedAt string                 `json:"updated_at,omitempty"`
	Mapping   *LoyaltyAccountMapping `json:"mapping,omitempty"`
	// The schedule for when points expire in the loyalty account balance. This field is present only if the account has points that are scheduled to expire.   The total number of points in this field equals the number of points in the `balance` field.
	ExpiringPointDeadlines []LoyaltyAccountExpiringPointDeadline `json:"expiring_point_deadlines,omitempty"`
}

Describes a loyalty account in a [loyalty program](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgram). For more information, see [Create and Retrieve Loyalty Accounts](https://developer.squareup.com/docs/loyalty-api/loyalty-accounts).

type LoyaltyAccountExpiringPointDeadline ¶

type LoyaltyAccountExpiringPointDeadline struct {
	// The number of points scheduled to expire at the `expires_at` timestamp.
	Points int32 `json:"points"`
	// The timestamp of when the points are scheduled to expire, in RFC 3339 format.
	ExpiresAt string `json:"expires_at"`
}

Represents a set of points for a loyalty account that are scheduled to expire on a specific date.

type LoyaltyAccountMapping ¶

type LoyaltyAccountMapping struct {
	// The Square-assigned ID of the mapping.
	Id string `json:"id,omitempty"`
	// The timestamp when the mapping was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The phone number of the buyer, in E.164 format. For example, \"+14155551111\".
	PhoneNumber string `json:"phone_number,omitempty"`
}

Represents the mapping that associates a loyalty account with a buyer. Currently, a loyalty account can only be mapped to a buyer by phone number. For more information, see [Loyalty Overview](https://developer.squareup.com/docs/loyalty/overview).

type LoyaltyAccountMappingType ¶

type LoyaltyAccountMappingType string

LoyaltyAccountMappingType : The type of mapping.

const (
	PHONE_LoyaltyAccountMappingType LoyaltyAccountMappingType = "PHONE"
)

List of LoyaltyAccountMappingType

type LoyaltyApiListLoyaltyPromotionsOpts ¶

type LoyaltyApiListLoyaltyPromotionsOpts struct {
	Status optional.String
	Cursor optional.String
	Limit  optional.Int32
}

type LoyaltyApiService ¶

type LoyaltyApiService service

func (*LoyaltyApiService) AccumulateLoyaltyPoints ¶

func (a *LoyaltyApiService) AccumulateLoyaltyPoints(ctx context.Context, body AccumulateLoyaltyPointsRequest, accountId string) (AccumulateLoyaltyPointsResponse, *http.Response, error)

LoyaltyApiService AccumulateLoyaltyPoints Adds points earned from a purchase to a [loyalty account](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyAccount). - If you are using the Orders API to manage orders, provide the `order_id`. Square reads the order to compute the points earned from both the base loyalty program and an associated [loyalty promotion](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyPromotion). For purchases that qualify for multiple accrual rules, Square computes points based on the accrual rule that grants the most points. For purchases that qualify for multiple promotions, Square computes points based on the most recently created promotion. A purchase must first qualify for program points to be eligible for promotion points. - If you are not using the Orders API to manage orders, provide `points` with the number of points to add. You must first perform a client-side computation of the points earned from the loyalty program and loyalty promotion. For spend-based and visit-based programs, you can call [CalculateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/calculate-loyalty-points) to compute the points earned from the base loyalty program. For information about computing points earned from a loyalty promotion, see [Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param accountId The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyAccount).

@return AccumulateLoyaltyPointsResponse

func (*LoyaltyApiService) AdjustLoyaltyPoints ¶

func (a *LoyaltyApiService) AdjustLoyaltyPoints(ctx context.Context, body AdjustLoyaltyPointsRequest, accountId string) (AdjustLoyaltyPointsResponse, *http.Response, error)

LoyaltyApiService AdjustLoyaltyPoints Adds points to or subtracts points from a buyer's account. Use this endpoint only when you need to manually adjust points. Otherwise, in your application flow, you call [AccumulateLoyaltyPoints](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/accumulate-loyalty-points) to add points when a buyer pays for the purchase.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param accountId The ID of the target [loyalty account](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyAccount).

@return AdjustLoyaltyPointsResponse

func (*LoyaltyApiService) CalculateLoyaltyPoints ¶

func (a *LoyaltyApiService) CalculateLoyaltyPoints(ctx context.Context, body CalculateLoyaltyPointsRequest, programId string) (CalculateLoyaltyPointsResponse, *http.Response, error)

LoyaltyApiService CalculateLoyaltyPoints Calculates the number of points a buyer can earn from a purchase. Applications might call this endpoint to display the points to the buyer. - If you are using the Orders API to manage orders, provide the `order_id` and (optional) `loyalty_account_id`. Square reads the order to compute the points earned from the base loyalty program and an associated [loyalty promotion](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyPromotion). - If you are not using the Orders API to manage orders, provide `transaction_amount_money` with the purchase amount. Square uses this amount to calculate the points earned from the base loyalty program, but not points earned from a loyalty promotion. For spend-based and visit-based programs, the `tax_mode` setting of the accrual rule indicates how taxes should be treated for loyalty points accrual. If the purchase qualifies for program points, call [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/list-loyalty-promotions) and perform a client-side computation to calculate whether the purchase also qualifies for promotion points. For more information, see [Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param programId The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgram), which defines the rules for accruing points.

@return CalculateLoyaltyPointsResponse

func (*LoyaltyApiService) CancelLoyaltyPromotion ¶

func (a *LoyaltyApiService) CancelLoyaltyPromotion(ctx context.Context, promotionId string, programId string) (CancelLoyaltyPromotionResponse, *http.Response, error)

LoyaltyApiService CancelLoyaltyPromotion Cancels a loyalty promotion. Use this endpoint to cancel an `ACTIVE` promotion earlier than the end date, cancel an `ACTIVE` promotion when an end date is not specified, or cancel a `SCHEDULED` promotion. Because updating a promotion is not supported, you can also use this endpoint to cancel a promotion before you create a new one. This endpoint sets the loyalty promotion to the `CANCELED` state

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param promotionId The ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyPromotion) to cancel. You can cancel a promotion that has an `ACTIVE` or `SCHEDULED` status.
@param programId The ID of the base [loyalty program](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgram).

@return CancelLoyaltyPromotionResponse

func (*LoyaltyApiService) CreateLoyaltyAccount ¶

func (a *LoyaltyApiService) CreateLoyaltyAccount(ctx context.Context, body CreateLoyaltyAccountRequest) (CreateLoyaltyAccountResponse, *http.Response, error)

LoyaltyApiService CreateLoyaltyAccount Creates a loyalty account. To create a loyalty account, you must provide the `program_id` and a `mapping` with the `phone_number` of the buyer.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateLoyaltyAccountResponse

func (*LoyaltyApiService) CreateLoyaltyPromotion ¶

func (a *LoyaltyApiService) CreateLoyaltyPromotion(ctx context.Context, body CreateLoyaltyPromotionRequest, programId string) (CreateLoyaltyPromotionResponse, *http.Response, error)

LoyaltyApiService CreateLoyaltyPromotion Creates a loyalty promotion for a [loyalty program](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgram). A loyalty promotion enables buyers to earn points in addition to those earned from the base loyalty program. This endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED` status, depending on the `available_time` setting. A loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` or `SCHEDULED` status.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param programId The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgram) to associate with the promotion. To get the program ID, call [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/retrieve-loyalty-program) using the `main` keyword.

@return CreateLoyaltyPromotionResponse

func (*LoyaltyApiService) CreateLoyaltyReward ¶

func (a *LoyaltyApiService) CreateLoyaltyReward(ctx context.Context, body CreateLoyaltyRewardRequest) (CreateLoyaltyRewardResponse, *http.Response, error)

LoyaltyApiService CreateLoyaltyReward Creates a loyalty reward. In the process, the endpoint does following: - Uses the `reward_tier_id` in the request to determine the number of points to lock for this reward. - If the request includes `order_id`, it adds the reward and related discount to the order. After a reward is created, the points are locked and not available for the buyer to redeem another reward.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateLoyaltyRewardResponse

func (*LoyaltyApiService) DeleteLoyaltyReward ¶

func (a *LoyaltyApiService) DeleteLoyaltyReward(ctx context.Context, rewardId string) (DeleteLoyaltyRewardResponse, *http.Response, error)

LoyaltyApiService DeleteLoyaltyReward Deletes a loyalty reward by doing the following: - Returns the loyalty points back to the loyalty account. - If an order ID was specified when the reward was created (see [CreateLoyaltyReward](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/create-loyalty-reward)), it updates the order by removing the reward and related discounts. You cannot delete a reward that has reached the terminal state (REDEEMED).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param rewardId The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyReward) to delete.

@return DeleteLoyaltyRewardResponse

func (*LoyaltyApiService) ListLoyaltyPrograms ¶

func (a *LoyaltyApiService) ListLoyaltyPrograms(ctx context.Context) (ListLoyaltyProgramsResponse, *http.Response, error)

LoyaltyApiService ListLoyaltyPrograms Returns a list of loyalty programs in the seller's account. Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview). Replaced with [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/retrieve-loyalty-program) when used with the keyword `main`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ListLoyaltyProgramsResponse

func (*LoyaltyApiService) ListLoyaltyPromotions ¶

func (a *LoyaltyApiService) ListLoyaltyPromotions(ctx context.Context, programId string, localVarOptionals *LoyaltyApiListLoyaltyPromotionsOpts) (ListLoyaltyPromotionsResponse, *http.Response, error)

func (*LoyaltyApiService) RedeemLoyaltyReward ¶

func (a *LoyaltyApiService) RedeemLoyaltyReward(ctx context.Context, body RedeemLoyaltyRewardRequest, rewardId string) (RedeemLoyaltyRewardResponse, *http.Response, error)

LoyaltyApiService RedeemLoyaltyReward Redeems a loyalty reward. The endpoint sets the reward to the `REDEEMED` terminal state. If you are using your own order processing system (not using the Orders API), you call this endpoint after the buyer paid for the purchase. After the reward reaches the terminal state, it cannot be deleted. In other words, points used for the reward cannot be returned to the account.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param rewardId The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyReward) to redeem.

@return RedeemLoyaltyRewardResponse

func (*LoyaltyApiService) RetrieveLoyaltyAccount ¶

func (a *LoyaltyApiService) RetrieveLoyaltyAccount(ctx context.Context, accountId string) (RetrieveLoyaltyAccountResponse, *http.Response, error)

LoyaltyApiService RetrieveLoyaltyAccount Retrieves a loyalty account.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param accountId The ID of the [loyalty account](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyAccount) to retrieve.

@return RetrieveLoyaltyAccountResponse

func (*LoyaltyApiService) RetrieveLoyaltyProgram ¶

func (a *LoyaltyApiService) RetrieveLoyaltyProgram(ctx context.Context, programId string) (RetrieveLoyaltyProgramResponse, *http.Response, error)

LoyaltyApiService RetrieveLoyaltyProgram Retrieves the loyalty program in a seller's account, specified by the program ID or the keyword `main`. Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param programId The ID of the loyalty program or the keyword `main`. Either value can be used to retrieve the single loyalty program that belongs to the seller.

@return RetrieveLoyaltyProgramResponse

func (*LoyaltyApiService) RetrieveLoyaltyPromotion ¶

func (a *LoyaltyApiService) RetrieveLoyaltyPromotion(ctx context.Context, promotionId string, programId string) (RetrieveLoyaltyPromotionResponse, *http.Response, error)

LoyaltyApiService RetrieveLoyaltyPromotion Retrieves a loyalty promotion.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param promotionId The ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyPromotion) to retrieve.
@param programId The ID of the base [loyalty program](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgram). To get the program ID, call [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/retrieve-loyalty-program) using the `main` keyword.

@return RetrieveLoyaltyPromotionResponse

func (*LoyaltyApiService) RetrieveLoyaltyReward ¶

func (a *LoyaltyApiService) RetrieveLoyaltyReward(ctx context.Context, rewardId string) (RetrieveLoyaltyRewardResponse, *http.Response, error)

LoyaltyApiService RetrieveLoyaltyReward Retrieves a loyalty reward.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param rewardId The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyReward) to retrieve.

@return RetrieveLoyaltyRewardResponse

func (*LoyaltyApiService) SearchLoyaltyAccounts ¶

func (a *LoyaltyApiService) SearchLoyaltyAccounts(ctx context.Context, body SearchLoyaltyAccountsRequest) (SearchLoyaltyAccountsResponse, *http.Response, error)

LoyaltyApiService SearchLoyaltyAccounts Searches for loyalty accounts in a loyalty program. You can search for a loyalty account using the phone number or customer ID associated with the account. To return all loyalty accounts, specify an empty `query` object or omit it entirely. Search results are sorted by `created_at` in ascending order.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return SearchLoyaltyAccountsResponse

func (*LoyaltyApiService) SearchLoyaltyEvents ¶

func (a *LoyaltyApiService) SearchLoyaltyEvents(ctx context.Context, body SearchLoyaltyEventsRequest) (SearchLoyaltyEventsResponse, *http.Response, error)

LoyaltyApiService SearchLoyaltyEvents Searches for loyalty events. A Square loyalty program maintains a ledger of events that occur during the lifetime of a buyer's loyalty account. Each change in the point balance (for example, points earned, points redeemed, and points expired) is recorded in the ledger. Using this endpoint, you can search the ledger for events. Search results are sorted by `created_at` in descending order.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return SearchLoyaltyEventsResponse

func (*LoyaltyApiService) SearchLoyaltyRewards ¶

func (a *LoyaltyApiService) SearchLoyaltyRewards(ctx context.Context, body SearchLoyaltyRewardsRequest) (SearchLoyaltyRewardsResponse, *http.Response, error)

LoyaltyApiService SearchLoyaltyRewards Searches for loyalty rewards. This endpoint accepts a request with no query filters and returns results for all loyalty accounts. If you include a `query` object, `loyalty_account_id` is required and `status` is optional. If you know a reward ID, use the [RetrieveLoyaltyReward](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/retrieve-loyalty-reward) endpoint. Search results are sorted by `updated_at` in descending order.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return SearchLoyaltyRewardsResponse

type LoyaltyEvent ¶

type LoyaltyEvent struct {
	// The Square-assigned ID of the loyalty event.
	Id string `json:"id"`
	// The type of the loyalty event.
	Type_ string `json:"type"`
	// The timestamp when the event was created, in RFC 3339 format.
	CreatedAt        string                        `json:"created_at"`
	AccumulatePoints *LoyaltyEventAccumulatePoints `json:"accumulate_points,omitempty"`
	CreateReward     *LoyaltyEventCreateReward     `json:"create_reward,omitempty"`
	RedeemReward     *LoyaltyEventRedeemReward     `json:"redeem_reward,omitempty"`
	DeleteReward     *LoyaltyEventDeleteReward     `json:"delete_reward,omitempty"`
	AdjustPoints     *LoyaltyEventAdjustPoints     `json:"adjust_points,omitempty"`
	// The ID of the [loyalty account](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyAccount) associated with the event.
	LoyaltyAccountId string `json:"loyalty_account_id"`
	// The ID of the [location](https://developer.squareup.com/reference/square_2024-07-17/objects/Location) where the event occurred.
	LocationId string `json:"location_id,omitempty"`
	// Defines whether the event was generated by the Square Point of Sale.
	Source                    string                                 `json:"source"`
	ExpirePoints              *LoyaltyEventExpirePoints              `json:"expire_points,omitempty"`
	OtherEvent                *LoyaltyEventOther                     `json:"other_event,omitempty"`
	AccumulatePromotionPoints *LoyaltyEventAccumulatePromotionPoints `json:"accumulate_promotion_points,omitempty"`
}

Provides information about a loyalty event. For more information, see [Search for Balance-Changing Loyalty Events](https://developer.squareup.com/docs/loyalty-api/loyalty-events).

type LoyaltyEventAccumulatePoints ¶

type LoyaltyEventAccumulatePoints struct {
	// The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgram).
	LoyaltyProgramId string `json:"loyalty_program_id,omitempty"`
	// The number of points accumulated by the event.
	Points int32 `json:"points,omitempty"`
	// The ID of the [order](https://developer.squareup.com/reference/square_2024-07-17/objects/Order) for which the buyer accumulated the points. This field is returned only if the Orders API is used to process orders.
	OrderId string `json:"order_id,omitempty"`
}

Provides metadata when the event `type` is `ACCUMULATE_POINTS`.

type LoyaltyEventAccumulatePromotionPoints ¶

type LoyaltyEventAccumulatePromotionPoints struct {
	// The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgram).
	LoyaltyProgramId string `json:"loyalty_program_id,omitempty"`
	// The Square-assigned ID of the [loyalty promotion](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyPromotion).
	LoyaltyPromotionId string `json:"loyalty_promotion_id,omitempty"`
	// The number of points earned by the event.
	Points int32 `json:"points"`
	// The ID of the [order](https://developer.squareup.com/reference/square_2024-07-17/objects/Order) for which the buyer earned the promotion points. Only applications that use the Orders API to process orders can trigger this event.
	OrderId string `json:"order_id"`
}

Provides metadata when the event `type` is `ACCUMULATE_PROMOTION_POINTS`.

type LoyaltyEventAdjustPoints ¶

type LoyaltyEventAdjustPoints struct {
	// The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgram).
	LoyaltyProgramId string `json:"loyalty_program_id,omitempty"`
	// The number of points added or removed.
	Points int32 `json:"points"`
	// The reason for the adjustment of points.
	Reason string `json:"reason,omitempty"`
}

Provides metadata when the event `type` is `ADJUST_POINTS`.

type LoyaltyEventCreateReward ¶

type LoyaltyEventCreateReward struct {
	// The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgram).
	LoyaltyProgramId string `json:"loyalty_program_id"`
	// The Square-assigned ID of the created [loyalty reward](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyReward). This field is returned only if the event source is `LOYALTY_API`.
	RewardId string `json:"reward_id,omitempty"`
	// The loyalty points used to create the reward.
	Points int32 `json:"points"`
}

Provides metadata when the event `type` is `CREATE_REWARD`.

type LoyaltyEventDateTimeFilter ¶

type LoyaltyEventDateTimeFilter struct {
	CreatedAt *TimeRange `json:"created_at"`
}

Filter events by date time range.

type LoyaltyEventDeleteReward ¶

type LoyaltyEventDeleteReward struct {
	// The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgram).
	LoyaltyProgramId string `json:"loyalty_program_id"`
	// The ID of the deleted [loyalty reward](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyReward). This field is returned only if the event source is `LOYALTY_API`.
	RewardId string `json:"reward_id,omitempty"`
	// The number of points returned to the loyalty account.
	Points int32 `json:"points"`
}

Provides metadata when the event `type` is `DELETE_REWARD`.

type LoyaltyEventExpirePoints ¶

type LoyaltyEventExpirePoints struct {
	// The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgram).
	LoyaltyProgramId string `json:"loyalty_program_id"`
	// The number of points expired.
	Points int32 `json:"points"`
}

Provides metadata when the event `type` is `EXPIRE_POINTS`.

type LoyaltyEventFilter ¶

type LoyaltyEventFilter struct {
	LoyaltyAccountFilter *LoyaltyEventLoyaltyAccountFilter `json:"loyalty_account_filter,omitempty"`
	TypeFilter           *LoyaltyEventTypeFilter           `json:"type_filter,omitempty"`
	DateTimeFilter       *LoyaltyEventDateTimeFilter       `json:"date_time_filter,omitempty"`
	LocationFilter       *LoyaltyEventLocationFilter       `json:"location_filter,omitempty"`
	OrderFilter          *LoyaltyEventOrderFilter          `json:"order_filter,omitempty"`
}

The filtering criteria. If the request specifies multiple filters, the endpoint uses a logical AND to evaluate them.

type LoyaltyEventLocationFilter ¶

type LoyaltyEventLocationFilter struct {
	// The [location](https://developer.squareup.com/reference/square_2024-07-17/objects/Location) IDs for loyalty events to query. If multiple values are specified, the endpoint uses  a logical OR to combine them.
	LocationIds []string `json:"location_ids"`
}

Filter events by location.

type LoyaltyEventLoyaltyAccountFilter ¶

type LoyaltyEventLoyaltyAccountFilter struct {
	// The ID of the [loyalty account](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyAccount) associated with loyalty events.
	LoyaltyAccountId string `json:"loyalty_account_id"`
}

Filter events by loyalty account.

type LoyaltyEventOrderFilter ¶

type LoyaltyEventOrderFilter struct {
	// The ID of the [order](https://developer.squareup.com/reference/square_2024-07-17/objects/Order) associated with the event.
	OrderId string `json:"order_id"`
}

Filter events by the order associated with the event.

type LoyaltyEventOther ¶

type LoyaltyEventOther struct {
	// The Square-assigned ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgram).
	LoyaltyProgramId string `json:"loyalty_program_id"`
	// The number of points added or removed.
	Points int32 `json:"points"`
}

Provides metadata when the event `type` is `OTHER`.

type LoyaltyEventQuery ¶

type LoyaltyEventQuery struct {
	Filter *LoyaltyEventFilter `json:"filter,omitempty"`
}

Represents a query used to search for loyalty events.

type LoyaltyEventRedeemReward ¶

type LoyaltyEventRedeemReward struct {
	// The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgram).
	LoyaltyProgramId string `json:"loyalty_program_id"`
	// The ID of the redeemed [loyalty reward](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyReward). This field is returned only if the event source is `LOYALTY_API`.
	RewardId string `json:"reward_id,omitempty"`
	// The ID of the [order](https://developer.squareup.com/reference/square_2024-07-17/objects/Order) that redeemed the reward. This field is returned only if the Orders API is used to process orders.
	OrderId string `json:"order_id,omitempty"`
}

Provides metadata when the event `type` is `REDEEM_REWARD`.

type LoyaltyEventSource ¶

type LoyaltyEventSource string

LoyaltyEventSource : Defines whether the event was generated by the Square Point of Sale.

const (
	SQUARE_LoyaltyEventSource      LoyaltyEventSource = "SQUARE"
	LOYALTY_API_LoyaltyEventSource LoyaltyEventSource = "LOYALTY_API"
)

List of LoyaltyEventSource

type LoyaltyEventType ¶

type LoyaltyEventType string

LoyaltyEventType : The type of the loyalty event.

const (
	ACCUMULATE_POINTS_LoyaltyEventType           LoyaltyEventType = "ACCUMULATE_POINTS"
	CREATE_REWARD_LoyaltyEventType               LoyaltyEventType = "CREATE_REWARD"
	REDEEM_REWARD_LoyaltyEventType               LoyaltyEventType = "REDEEM_REWARD"
	DELETE_REWARD_LoyaltyEventType               LoyaltyEventType = "DELETE_REWARD"
	ADJUST_POINTS_LoyaltyEventType               LoyaltyEventType = "ADJUST_POINTS"
	EXPIRE_POINTS_LoyaltyEventType               LoyaltyEventType = "EXPIRE_POINTS"
	OTHER_LoyaltyEventType                       LoyaltyEventType = "OTHER"
	ACCUMULATE_PROMOTION_POINTS_LoyaltyEventType LoyaltyEventType = "ACCUMULATE_PROMOTION_POINTS"
)

List of LoyaltyEventType

type LoyaltyEventTypeFilter ¶

type LoyaltyEventTypeFilter struct {
	// The loyalty event types used to filter the result. If multiple values are specified, the endpoint uses a  logical OR to combine them.
	Types []string `json:"types"`
}

Filter events by event type.

type LoyaltyProgram ¶

type LoyaltyProgram struct {
	// The Square-assigned ID of the loyalty program. Updates to  the loyalty program do not modify the identifier.
	Id string `json:"id,omitempty"`
	// Whether the program is currently active.
	Status string `json:"status,omitempty"`
	// The list of rewards for buyers, sorted by ascending points.
	RewardTiers      []LoyaltyProgramRewardTier      `json:"reward_tiers,omitempty"`
	ExpirationPolicy *LoyaltyProgramExpirationPolicy `json:"expiration_policy,omitempty"`
	Terminology      *LoyaltyProgramTerminology      `json:"terminology,omitempty"`
	// The [locations](https://developer.squareup.com/reference/square_2024-07-17/objects/Location) at which the program is active.
	LocationIds []string `json:"location_ids"`
	// The timestamp when the program was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp when the reward was last updated, in RFC 3339 format.
	UpdatedAt string `json:"updated_at,omitempty"`
	// Defines how buyers can earn loyalty points from the base loyalty program. To check for associated [loyalty promotions](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyPromotion) that enable buyers to earn extra points, call [ListLoyaltyPromotions](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/list-loyalty-promotions).
	AccrualRules []LoyaltyProgramAccrualRule `json:"accrual_rules,omitempty"`
}

Represents a Square loyalty program. Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).

type LoyaltyProgramAccrualRule ¶

type LoyaltyProgramAccrualRule struct {
	// The type of the accrual rule that defines how buyers can earn points.
	AccrualType string `json:"accrual_type"`
	// The number of points that  buyers earn based on the `accrual_type`.
	Points            int32                                       `json:"points,omitempty"`
	VisitData         *LoyaltyProgramAccrualRuleVisitData         `json:"visit_data,omitempty"`
	SpendData         *LoyaltyProgramAccrualRuleSpendData         `json:"spend_data,omitempty"`
	ItemVariationData *LoyaltyProgramAccrualRuleItemVariationData `json:"item_variation_data,omitempty"`
	CategoryData      *LoyaltyProgramAccrualRuleCategoryData      `json:"category_data,omitempty"`
}

Represents an accrual rule, which defines how buyers can earn points from the base [loyalty program](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgram).

type LoyaltyProgramAccrualRuleCategoryData ¶

type LoyaltyProgramAccrualRuleCategoryData struct {
	// The ID of the `CATEGORY` [catalog object](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject) that buyers can purchase to earn points.
	CategoryId string `json:"category_id"`
}

Represents additional data for rules with the `CATEGORY` accrual type.

type LoyaltyProgramAccrualRuleItemVariationData ¶

type LoyaltyProgramAccrualRuleItemVariationData struct {
	// The ID of the `ITEM_VARIATION` [catalog object](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject) that buyers can purchase to earn points.
	ItemVariationId string `json:"item_variation_id"`
}

Represents additional data for rules with the `ITEM_VARIATION` accrual type.

type LoyaltyProgramAccrualRuleSpendData ¶

type LoyaltyProgramAccrualRuleSpendData struct {
	AmountMoney *Money `json:"amount_money"`
	// The IDs of any `CATEGORY` catalog objects that are excluded from points accrual.  You can use the [BatchRetrieveCatalogObjects](https://developer.squareup.com/reference/square_2024-07-17/catalog-api/batch-retrieve-catalog-objects) endpoint to retrieve information about the excluded categories.
	ExcludedCategoryIds []string `json:"excluded_category_ids,omitempty"`
	// The IDs of any `ITEM_VARIATION` catalog objects that are excluded from points accrual.  You can use the [BatchRetrieveCatalogObjects](https://developer.squareup.com/reference/square_2024-07-17/catalog-api/batch-retrieve-catalog-objects) endpoint to retrieve information about the excluded item variations.
	ExcludedItemVariationIds []string `json:"excluded_item_variation_ids,omitempty"`
	// Indicates how taxes should be treated when calculating the purchase amount used for points accrual.
	TaxMode string `json:"tax_mode"`
}

Represents additional data for rules with the `SPEND` accrual type.

type LoyaltyProgramAccrualRuleTaxMode ¶

type LoyaltyProgramAccrualRuleTaxMode string

LoyaltyProgramAccrualRuleTaxMode : Indicates how taxes should be treated when calculating the purchase amount used for loyalty points accrual. This setting applies only to `SPEND` accrual rules or `VISIT` accrual rules that have a minimum spend requirement.

const (
	BEFORE_TAX_LoyaltyProgramAccrualRuleTaxMode LoyaltyProgramAccrualRuleTaxMode = "BEFORE_TAX"
	AFTER_TAX_LoyaltyProgramAccrualRuleTaxMode  LoyaltyProgramAccrualRuleTaxMode = "AFTER_TAX"
)

List of LoyaltyProgramAccrualRuleTaxMode

type LoyaltyProgramAccrualRuleType ¶

type LoyaltyProgramAccrualRuleType string

LoyaltyProgramAccrualRuleType : The type of the accrual rule that defines how buyers can earn points.

const (
	VISIT_LoyaltyProgramAccrualRuleType          LoyaltyProgramAccrualRuleType = "VISIT"
	SPEND_LoyaltyProgramAccrualRuleType          LoyaltyProgramAccrualRuleType = "SPEND"
	ITEM_VARIATION_LoyaltyProgramAccrualRuleType LoyaltyProgramAccrualRuleType = "ITEM_VARIATION"
	CATEGORY_LoyaltyProgramAccrualRuleType       LoyaltyProgramAccrualRuleType = "CATEGORY"
)

List of LoyaltyProgramAccrualRuleType

type LoyaltyProgramAccrualRuleVisitData ¶

type LoyaltyProgramAccrualRuleVisitData struct {
	MinimumAmountMoney *Money `json:"minimum_amount_money,omitempty"`
	// Indicates how taxes should be treated when calculating the purchase amount to determine whether the visit qualifies for points.  This setting applies only if `minimum_amount_money` is specified.
	TaxMode string `json:"tax_mode"`
}

Represents additional data for rules with the `VISIT` accrual type.

type LoyaltyProgramExpirationPolicy ¶

type LoyaltyProgramExpirationPolicy struct {
	// The number of months before points expire, in `P[n]M` RFC 3339 duration format. For example, a value of `P12M` represents a duration of 12 months.  Points are valid through the last day of the month in which they are scheduled to expire. For example, with a  `P12M` duration, points earned on July 6, 2020 expire on August 1, 2021.
	ExpirationDuration string `json:"expiration_duration"`
}

Describes when the loyalty program expires.

type LoyaltyProgramRewardDefinition ¶

type LoyaltyProgramRewardDefinition struct {
	// Indicates the scope of the reward tier. DEPRECATED at version 2020-12-16. You can find this information in the `product_set_data` field of the `PRODUCT_SET` catalog object referenced by the pricing rule. For `ORDER` scopes, `all_products` is true. For `ITEM_VARIATION` or `CATEGORY` scopes, `product_ids_any` is a list of catalog object IDs of the given type.
	Scope string `json:"scope"`
	// The type of discount the reward tier offers. DEPRECATED at version 2020-12-16. You can find this information in the `discount_data.discount_type` field of the `DISCOUNT` catalog object referenced by the pricing rule.
	DiscountType string `json:"discount_type"`
	// The fixed percentage of the discount. Present if `discount_type` is `FIXED_PERCENTAGE`. For example, a 7.25% off discount will be represented as \"7.25\". DEPRECATED at version 2020-12-16. You can find this information in the `discount_data.percentage` field of the `DISCOUNT` catalog object referenced by the pricing rule.
	PercentageDiscount string `json:"percentage_discount,omitempty"`
	// The list of catalog objects to which this reward can be applied. They are either all item-variation ids or category ids, depending on the `type` field. DEPRECATED at version 2020-12-16. You can find this information in the `product_set_data.product_ids_any` field of the `PRODUCT_SET` catalog object referenced by the pricing rule.
	CatalogObjectIds   []string `json:"catalog_object_ids,omitempty"`
	FixedDiscountMoney *Money   `json:"fixed_discount_money,omitempty"`
	MaxDiscountMoney   *Money   `json:"max_discount_money,omitempty"`
}

Provides details about the reward tier discount. DEPRECATED at version 2020-12-16. Discount details are now defined using a catalog pricing rule and other catalog objects. For more information, see [Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details).

type LoyaltyProgramRewardDefinitionScope ¶

type LoyaltyProgramRewardDefinitionScope string

LoyaltyProgramRewardDefinitionScope : Indicates the scope of the reward tier. DEPRECATED at version 2020-12-16. Discount details are now defined using a catalog pricing rule and other catalog objects. For more information, see [Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details).

const (
	ORDER_LoyaltyProgramRewardDefinitionScope          LoyaltyProgramRewardDefinitionScope = "ORDER"
	ITEM_VARIATION_LoyaltyProgramRewardDefinitionScope LoyaltyProgramRewardDefinitionScope = "ITEM_VARIATION"
	CATEGORY_LoyaltyProgramRewardDefinitionScope       LoyaltyProgramRewardDefinitionScope = "CATEGORY"
)

List of LoyaltyProgramRewardDefinitionScope

type LoyaltyProgramRewardDefinitionType ¶

type LoyaltyProgramRewardDefinitionType string

LoyaltyProgramRewardDefinitionType : The type of discount the reward tier offers. DEPRECATED at version 2020-12-16. Discount details are now defined using a catalog pricing rule and other catalog objects. For more information, see [Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details).

const (
	AMOUNT_LoyaltyProgramRewardDefinitionType     LoyaltyProgramRewardDefinitionType = "FIXED_AMOUNT"
	PERCENTAGE_LoyaltyProgramRewardDefinitionType LoyaltyProgramRewardDefinitionType = "FIXED_PERCENTAGE"
)

List of LoyaltyProgramRewardDefinitionType

type LoyaltyProgramRewardTier ¶

type LoyaltyProgramRewardTier struct {
	// The Square-assigned ID of the reward tier.
	Id string `json:"id,omitempty"`
	// The points exchanged for the reward tier.
	Points int32 `json:"points"`
	// The name of the reward tier.
	Name       string                          `json:"name,omitempty"`
	Definition *LoyaltyProgramRewardDefinition `json:"definition,omitempty"`
	// The timestamp when the reward tier was created, in RFC 3339 format.
	CreatedAt            string                  `json:"created_at,omitempty"`
	PricingRuleReference *CatalogObjectReference `json:"pricing_rule_reference"`
}

Represents a reward tier in a loyalty program. A reward tier defines how buyers can redeem points for a reward, such as the number of points required and the value and scope of the discount. A loyalty program can offer multiple reward tiers.

type LoyaltyProgramStatus ¶

type LoyaltyProgramStatus string

LoyaltyProgramStatus : Indicates whether the program is currently active.

const (
	INACTIVE_LoyaltyProgramStatus LoyaltyProgramStatus = "INACTIVE"
	ACTIVE_LoyaltyProgramStatus   LoyaltyProgramStatus = "ACTIVE"
)

List of LoyaltyProgramStatus

type LoyaltyProgramTerminology ¶

type LoyaltyProgramTerminology struct {
	// A singular unit for a point (for example, 1 point is called 1 star).
	One string `json:"one"`
	// A plural unit for point (for example, 10 points is called 10 stars).
	Other string `json:"other"`
}

Represents the naming used for loyalty points.

type LoyaltyPromotion ¶

type LoyaltyPromotion struct {
	// The Square-assigned ID of the promotion.
	Id string `json:"id,omitempty"`
	// The name of the promotion.
	Name          string                             `json:"name"`
	Incentive     *LoyaltyPromotionIncentive         `json:"incentive"`
	AvailableTime *LoyaltyPromotionAvailableTimeData `json:"available_time"`
	TriggerLimit  *LoyaltyPromotionTriggerLimit      `json:"trigger_limit,omitempty"`
	// The current status of the promotion.
	Status string `json:"status,omitempty"`
	// The timestamp of when the promotion was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp of when the promotion was canceled, in RFC 3339 format.
	CanceledAt string `json:"canceled_at,omitempty"`
	// The timestamp when the promotion was last updated, in RFC 3339 format.
	UpdatedAt string `json:"updated_at,omitempty"`
	// The ID of the [loyalty program](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgram) associated with the promotion.
	LoyaltyProgramId        string `json:"loyalty_program_id,omitempty"`
	MinimumSpendAmountMoney *Money `json:"minimum_spend_amount_money,omitempty"`
	// The IDs of any qualifying `ITEM_VARIATION` [catalog objects](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject). If specified, the purchase must include at least one of these items to qualify for the promotion.  This option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule. With `SPEND` accrual rules, make sure that qualifying promotional items are not excluded.  You can specify `qualifying_item_variation_ids` or `qualifying_category_ids` for a given promotion, but not both.
	QualifyingItemVariationIds []string `json:"qualifying_item_variation_ids"`
	// The IDs of any qualifying `CATEGORY` [catalog objects](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject). If specified, the purchase must include at least one item from one of these categories to qualify for the promotion.  This option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule. With `SPEND` accrual rules, make sure that qualifying promotional items are not excluded.  You can specify `qualifying_category_ids` or `qualifying_item_variation_ids` for a promotion, but not both.
	QualifyingCategoryIds []string `json:"qualifying_category_ids"`
}

Represents a promotion for a [loyalty program](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgram). Loyalty promotions enable buyers to earn extra points on top of those earned from the base program. A loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` or `SCHEDULED` status.

type LoyaltyPromotionAvailableTimeData ¶

type LoyaltyPromotionAvailableTimeData struct {
	// The date that the promotion starts, in `YYYY-MM-DD` format. Square populates this field based on the provided `time_periods`.
	StartDate string `json:"start_date,omitempty"`
	// The date that the promotion ends, in `YYYY-MM-DD` format. Square populates this field based on the provided `time_periods`. If an end date is not specified, an `ACTIVE` promotion remains available until it is canceled.
	EndDate string `json:"end_date,omitempty"`
	// A list of [iCalendar (RFC 5545) events](https://tools.ietf.org/html/rfc5545#section-3.6.1) (`VEVENT`). Each event represents an available time period per day or days of the week.  A day can have a maximum of one available time period.  Only `DTSTART`, `DURATION`, and `RRULE` are supported. `DTSTART` and `DURATION` are required and timestamps must be in local (unzoned) time format. Include `RRULE` to specify recurring promotions, an end date (using the `UNTIL` keyword), or both. For more information, see [Available time](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#available-time).  Note that `BEGIN:VEVENT` and `END:VEVENT` are optional in a `CreateLoyaltyPromotion` request but are always included in the response.
	TimePeriods []string `json:"time_periods"`
}

Represents scheduling information that determines when purchases can qualify to earn points from a [loyalty promotion](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyPromotion).

type LoyaltyPromotionIncentive ¶

type LoyaltyPromotionIncentive struct {
	// The type of points incentive.
	Type_                string                                         `json:"type"`
	PointsMultiplierData *LoyaltyPromotionIncentivePointsMultiplierData `json:"points_multiplier_data,omitempty"`
	PointsAdditionData   *LoyaltyPromotionIncentivePointsAdditionData   `json:"points_addition_data,omitempty"`
}

Represents how points for a [loyalty promotion](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyPromotion) are calculated, either by multiplying the points earned from the base program or by adding a specified number of points to the points earned from the base program.

type LoyaltyPromotionIncentivePointsAdditionData ¶

type LoyaltyPromotionIncentivePointsAdditionData struct {
	// The number of additional points to earn each time the promotion is triggered. For example, suppose a purchase qualifies for 5 points from the base loyalty program. If the purchase also qualifies for a `POINTS_ADDITION` promotion incentive with a `points_addition` of 3, the buyer earns a total of 8 points (5 program points + 3 promotion points = 8 points).
	PointsAddition int32 `json:"points_addition"`
}

Represents the metadata for a `POINTS_ADDITION` type of [loyalty promotion incentive](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyPromotionIncentive).

type LoyaltyPromotionIncentivePointsMultiplierData ¶

type LoyaltyPromotionIncentivePointsMultiplierData struct {
	// The multiplier used to calculate the number of points earned each time the promotion is triggered. For example, suppose a purchase qualifies for 5 points from the base loyalty program. If the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a `points_multiplier` of 3, the buyer earns a total of 15 points (5 program points x 3 promotion multiplier = 15 points).  DEPRECATED at version 2023-08-16. Replaced by the `multiplier` field.  One of the following is required when specifying a points multiplier: - (Recommended) The `multiplier` field. - This deprecated `points_multiplier` field. If provided in the request, Square also returns `multiplier` with the equivalent value.
	PointsMultiplier int32 `json:"points_multiplier,omitempty"`
	// The multiplier used to calculate the number of points earned each time the promotion is triggered, specified as a string representation of a decimal. Square supports multipliers up to 10x, with three point precision for decimal multipliers. For example, suppose a purchase qualifies for 4 points from the base loyalty program. If the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a `multiplier` of \"1.5\", the buyer earns a total of 6 points (4 program points x 1.5 promotion multiplier = 6 points). Fractional points are dropped.  One of the following is required when specifying a points multiplier: - (Recommended) This `multiplier` field. - The deprecated `points_multiplier` field. If provided in the request, Square also returns `multiplier` with the equivalent value.
	Multiplier string `json:"multiplier,omitempty"`
}

Represents the metadata for a `POINTS_MULTIPLIER` type of [loyalty promotion incentive](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyPromotionIncentive).

type LoyaltyPromotionIncentiveType ¶

type LoyaltyPromotionIncentiveType string

LoyaltyPromotionIncentiveType : Indicates the type of points incentive for a [loyalty promotion](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyPromotion), which is used to determine how buyers can earn points from the promotion.

const (
	MULTIPLIER_LoyaltyPromotionIncentiveType LoyaltyPromotionIncentiveType = "POINTS_MULTIPLIER"
	ADDITION_LoyaltyPromotionIncentiveType   LoyaltyPromotionIncentiveType = "POINTS_ADDITION"
)

List of LoyaltyPromotionIncentiveType

type LoyaltyPromotionStatus ¶

type LoyaltyPromotionStatus string

LoyaltyPromotionStatus : Indicates the status of a [loyalty promotion](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyPromotion).

const (
	ACTIVE_LoyaltyPromotionStatus    LoyaltyPromotionStatus = "ACTIVE"
	ENDED_LoyaltyPromotionStatus     LoyaltyPromotionStatus = "ENDED"
	CANCELED_LoyaltyPromotionStatus  LoyaltyPromotionStatus = "CANCELED"
	SCHEDULED_LoyaltyPromotionStatus LoyaltyPromotionStatus = "SCHEDULED"
)

List of LoyaltyPromotionStatus

type LoyaltyPromotionTriggerLimit ¶

type LoyaltyPromotionTriggerLimit struct {
	// The maximum number of times a buyer can trigger the promotion during the specified `interval`.
	Times int32 `json:"times"`
	// The time period the limit applies to.
	Interval string `json:"interval,omitempty"`
}

Represents the number of times a buyer can earn points during a [loyalty promotion](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyPromotion). If this field is not set, buyers can trigger the promotion an unlimited number of times to earn points during the time that the promotion is available. A purchase that is disqualified from earning points because of this limit might qualify for another active promotion.

type LoyaltyPromotionTriggerLimitInterval ¶

type LoyaltyPromotionTriggerLimitInterval string

LoyaltyPromotionTriggerLimitInterval : Indicates the time period that the [trigger limit](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyPromotionTriggerLimit) applies to, which is used to determine the number of times a buyer can earn points for a [loyalty promotion](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyPromotion).

const (
	ALL_TIME_LoyaltyPromotionTriggerLimitInterval LoyaltyPromotionTriggerLimitInterval = "ALL_TIME"
	DAY_LoyaltyPromotionTriggerLimitInterval      LoyaltyPromotionTriggerLimitInterval = "DAY"
)

List of LoyaltyPromotionTriggerLimitInterval

type LoyaltyReward ¶

type LoyaltyReward struct {
	// The Square-assigned ID of the loyalty reward.
	Id string `json:"id,omitempty"`
	// The status of a loyalty reward.
	Status string `json:"status,omitempty"`
	// The Square-assigned ID of the [loyalty account](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyAccount) to which the reward belongs.
	LoyaltyAccountId string `json:"loyalty_account_id"`
	// The Square-assigned ID of the [reward tier](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgramRewardTier) used to create the reward.
	RewardTierId string `json:"reward_tier_id"`
	// The number of loyalty points used for the reward.
	Points int32 `json:"points,omitempty"`
	// The Square-assigned ID of the [order](https://developer.squareup.com/reference/square_2024-07-17/objects/Order) to which the reward is attached.
	OrderId string `json:"order_id,omitempty"`
	// The timestamp when the reward was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp when the reward was last updated, in RFC 3339 format.
	UpdatedAt string `json:"updated_at,omitempty"`
	// The timestamp when the reward was redeemed, in RFC 3339 format.
	RedeemedAt string `json:"redeemed_at,omitempty"`
}

Represents a contract to redeem loyalty points for a [reward tier](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgramRewardTier) discount. Loyalty rewards can be in an ISSUED, REDEEMED, or DELETED state. For more information, see [Manage loyalty rewards](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards).

type LoyaltyRewardStatus ¶

type LoyaltyRewardStatus string

LoyaltyRewardStatus : The status of the loyalty reward.

const (
	ISSUED_LoyaltyRewardStatus   LoyaltyRewardStatus = "ISSUED"
	REDEEMED_LoyaltyRewardStatus LoyaltyRewardStatus = "REDEEMED"
	DELETED_LoyaltyRewardStatus  LoyaltyRewardStatus = "DELETED"
)

List of LoyaltyRewardStatus

type MeasurementUnit ¶

type MeasurementUnit struct {
	CustomUnit *MeasurementUnitCustom `json:"custom_unit,omitempty"`
	// Represents a standard area unit.
	AreaUnit string `json:"area_unit,omitempty"`
	// Represents a standard length unit.
	LengthUnit string `json:"length_unit,omitempty"`
	// Represents a standard volume unit.
	VolumeUnit string `json:"volume_unit,omitempty"`
	// Represents a standard unit of weight or mass.
	WeightUnit string `json:"weight_unit,omitempty"`
	// Reserved for API integrations that lack the ability to specify a real measurement unit
	GenericUnit string `json:"generic_unit,omitempty"`
	// Represents a standard unit of time.
	TimeUnit string `json:"time_unit,omitempty"`
	// Represents the type of the measurement unit.
	Type_ string `json:"type,omitempty"`
}

Represents a unit of measurement to use with a quantity, such as ounces or inches. Exactly one of the following fields are required: `custom_unit`, `area_unit`, `length_unit`, `volume_unit`, and `weight_unit`.

type MeasurementUnitArea ¶

type MeasurementUnitArea string

MeasurementUnitArea : Unit of area used to measure a quantity.

const (
	IMPERIAL_ACRE_MeasurementUnitArea            MeasurementUnitArea = "IMPERIAL_ACRE"
	IMPERIAL_SQUARE_INCH_MeasurementUnitArea     MeasurementUnitArea = "IMPERIAL_SQUARE_INCH"
	IMPERIAL_SQUARE_FOOT_MeasurementUnitArea     MeasurementUnitArea = "IMPERIAL_SQUARE_FOOT"
	IMPERIAL_SQUARE_YARD_MeasurementUnitArea     MeasurementUnitArea = "IMPERIAL_SQUARE_YARD"
	IMPERIAL_SQUARE_MILE_MeasurementUnitArea     MeasurementUnitArea = "IMPERIAL_SQUARE_MILE"
	METRIC_SQUARE_CENTIMETER_MeasurementUnitArea MeasurementUnitArea = "METRIC_SQUARE_CENTIMETER"
	METRIC_SQUARE_METER_MeasurementUnitArea      MeasurementUnitArea = "METRIC_SQUARE_METER"
	METRIC_SQUARE_KILOMETER_MeasurementUnitArea  MeasurementUnitArea = "METRIC_SQUARE_KILOMETER"
)

List of MeasurementUnitArea

type MeasurementUnitCustom ¶

type MeasurementUnitCustom struct {
	// The name of the custom unit, for example \"bushel\".
	Name string `json:"name"`
	// The abbreviation of the custom unit, such as \"bsh\" (bushel). This appears in the cart for the Point of Sale app, and in reports.
	Abbreviation string `json:"abbreviation"`
}

The information needed to define a custom unit, provided by the seller.

type MeasurementUnitGeneric ¶

type MeasurementUnitGeneric string

const (
	UNIT_MeasurementUnitGeneric MeasurementUnitGeneric = "UNIT"
)

List of MeasurementUnitGeneric

type MeasurementUnitLength ¶

type MeasurementUnitLength string

MeasurementUnitLength : The unit of length used to measure a quantity.

const (
	IMPERIAL_INCH_MeasurementUnitLength     MeasurementUnitLength = "IMPERIAL_INCH"
	IMPERIAL_FOOT_MeasurementUnitLength     MeasurementUnitLength = "IMPERIAL_FOOT"
	IMPERIAL_YARD_MeasurementUnitLength     MeasurementUnitLength = "IMPERIAL_YARD"
	IMPERIAL_MILE_MeasurementUnitLength     MeasurementUnitLength = "IMPERIAL_MILE"
	METRIC_MILLIMETER_MeasurementUnitLength MeasurementUnitLength = "METRIC_MILLIMETER"
	METRIC_CENTIMETER_MeasurementUnitLength MeasurementUnitLength = "METRIC_CENTIMETER"
	METRIC_METER_MeasurementUnitLength      MeasurementUnitLength = "METRIC_METER"
	METRIC_KILOMETER_MeasurementUnitLength  MeasurementUnitLength = "METRIC_KILOMETER"
)

List of MeasurementUnitLength

type MeasurementUnitTime ¶

type MeasurementUnitTime string

MeasurementUnitTime : Unit of time used to measure a quantity (a duration).

const (
	MILLISECOND_MeasurementUnitTime MeasurementUnitTime = "GENERIC_MILLISECOND"
	SECOND_MeasurementUnitTime      MeasurementUnitTime = "GENERIC_SECOND"
	MINUTE_MeasurementUnitTime      MeasurementUnitTime = "GENERIC_MINUTE"
	HOUR_MeasurementUnitTime        MeasurementUnitTime = "GENERIC_HOUR"
	DAY_MeasurementUnitTime         MeasurementUnitTime = "GENERIC_DAY"
)

List of MeasurementUnitTime

type MeasurementUnitUnitType ¶

type MeasurementUnitUnitType string

MeasurementUnitUnitType : Describes the type of this unit and indicates which field contains the unit information. This is an ‘open’ enum.

const (
	CUSTOM_MeasurementUnitUnitType  MeasurementUnitUnitType = "TYPE_CUSTOM"
	AREA_MeasurementUnitUnitType    MeasurementUnitUnitType = "TYPE_AREA"
	LENGTH_MeasurementUnitUnitType  MeasurementUnitUnitType = "TYPE_LENGTH"
	VOLUME_MeasurementUnitUnitType  MeasurementUnitUnitType = "TYPE_VOLUME"
	WEIGHT_MeasurementUnitUnitType  MeasurementUnitUnitType = "TYPE_WEIGHT"
	GENERIC_MeasurementUnitUnitType MeasurementUnitUnitType = "TYPE_GENERIC"
)

List of MeasurementUnitUnitType

type MeasurementUnitVolume ¶

type MeasurementUnitVolume string

MeasurementUnitVolume : The unit of volume used to measure a quantity.

const (
	GENERIC_FLUID_OUNCE_MeasurementUnitVolume MeasurementUnitVolume = "GENERIC_FLUID_OUNCE"
	GENERIC_SHOT_MeasurementUnitVolume        MeasurementUnitVolume = "GENERIC_SHOT"
	GENERIC_CUP_MeasurementUnitVolume         MeasurementUnitVolume = "GENERIC_CUP"
	GENERIC_PINT_MeasurementUnitVolume        MeasurementUnitVolume = "GENERIC_PINT"
	GENERIC_QUART_MeasurementUnitVolume       MeasurementUnitVolume = "GENERIC_QUART"
	GENERIC_GALLON_MeasurementUnitVolume      MeasurementUnitVolume = "GENERIC_GALLON"
	IMPERIAL_CUBIC_INCH_MeasurementUnitVolume MeasurementUnitVolume = "IMPERIAL_CUBIC_INCH"
	IMPERIAL_CUBIC_FOOT_MeasurementUnitVolume MeasurementUnitVolume = "IMPERIAL_CUBIC_FOOT"
	IMPERIAL_CUBIC_YARD_MeasurementUnitVolume MeasurementUnitVolume = "IMPERIAL_CUBIC_YARD"
	METRIC_MILLILITER_MeasurementUnitVolume   MeasurementUnitVolume = "METRIC_MILLILITER"
	METRIC_LITER_MeasurementUnitVolume        MeasurementUnitVolume = "METRIC_LITER"
)

List of MeasurementUnitVolume

type MeasurementUnitWeight ¶

type MeasurementUnitWeight string

MeasurementUnitWeight : Unit of weight used to measure a quantity.

const (
	IMPERIAL_WEIGHT_OUNCE_MeasurementUnitWeight MeasurementUnitWeight = "IMPERIAL_WEIGHT_OUNCE"
	IMPERIAL_POUND_MeasurementUnitWeight        MeasurementUnitWeight = "IMPERIAL_POUND"
	IMPERIAL_STONE_MeasurementUnitWeight        MeasurementUnitWeight = "IMPERIAL_STONE"
	METRIC_MILLIGRAM_MeasurementUnitWeight      MeasurementUnitWeight = "METRIC_MILLIGRAM"
	METRIC_GRAM_MeasurementUnitWeight           MeasurementUnitWeight = "METRIC_GRAM"
	METRIC_KILOGRAM_MeasurementUnitWeight       MeasurementUnitWeight = "METRIC_KILOGRAM"
)

List of MeasurementUnitWeight

type Merchant ¶

type Merchant struct {
	// The Square-issued ID of the merchant.
	Id string `json:"id,omitempty"`
	// The name of the merchant's overall business.
	BusinessName string `json:"business_name,omitempty"`
	// The country code associated with the merchant, in the two-letter format of ISO 3166. For example, `US` or `JP`.
	Country string `json:"country"`
	// The code indicating the [language preferences](https://developer.squareup.com/docs/build-basics/general-considerations/language-preferences) of the merchant, in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A). For example, `en-US` or `fr-CA`.
	LanguageCode string `json:"language_code,omitempty"`
	// The currency associated with the merchant, in ISO 4217 format. For example, the currency code for US dollars is `USD`.
	Currency string `json:"currency,omitempty"`
	// The merchant's status.
	Status string `json:"status,omitempty"`
	// The ID of the [main `Location`](https://developer.squareup.com/docs/locations-api#about-the-main-location) for this merchant.
	MainLocationId string `json:"main_location_id,omitempty"`
	// The time when the merchant was created, in RFC 3339 format.    For more information, see [Working with Dates](https://developer.squareup.com/docs/build-basics/working-with-dates).
	CreatedAt string `json:"created_at,omitempty"`
}

Represents a business that sells with Square.

type MerchantCustomAttributesApiListMerchantCustomAttributeDefinitionsOpts ¶

type MerchantCustomAttributesApiListMerchantCustomAttributeDefinitionsOpts struct {
	VisibilityFilter optional.String
	Limit            optional.Int32
	Cursor           optional.String
}

type MerchantCustomAttributesApiListMerchantCustomAttributesOpts ¶

type MerchantCustomAttributesApiListMerchantCustomAttributesOpts struct {
	VisibilityFilter optional.String
	Limit            optional.Int32
	Cursor           optional.String
	WithDefinitions  optional.Bool
}

type MerchantCustomAttributesApiRetrieveMerchantCustomAttributeDefinitionOpts ¶

type MerchantCustomAttributesApiRetrieveMerchantCustomAttributeDefinitionOpts struct {
	Version optional.Int32
}

type MerchantCustomAttributesApiRetrieveMerchantCustomAttributeOpts ¶

type MerchantCustomAttributesApiRetrieveMerchantCustomAttributeOpts struct {
	WithDefinition optional.Bool
	Version        optional.Int32
}

type MerchantCustomAttributesApiService ¶

type MerchantCustomAttributesApiService service

func (*MerchantCustomAttributesApiService) BulkDeleteMerchantCustomAttributes ¶

func (a *MerchantCustomAttributesApiService) BulkDeleteMerchantCustomAttributes(ctx context.Context, body BulkDeleteMerchantCustomAttributesRequest) (BulkDeleteMerchantCustomAttributesResponse, *http.Response, error)

MerchantCustomAttributesApiService BulkDeleteMerchantCustomAttributes Deletes [custom attributes](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttribute) for a merchant as a bulk operation. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkDeleteMerchantCustomAttributesResponse

func (*MerchantCustomAttributesApiService) BulkUpsertMerchantCustomAttributes ¶

func (a *MerchantCustomAttributesApiService) BulkUpsertMerchantCustomAttributes(ctx context.Context, body BulkUpsertMerchantCustomAttributesRequest) (BulkUpsertMerchantCustomAttributesResponse, *http.Response, error)

MerchantCustomAttributesApiService BulkUpsertMerchantCustomAttributes Creates or updates [custom attributes](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttribute) for a merchant as a bulk operation. Use this endpoint to set the value of one or more custom attributes for a merchant. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the [CreateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/create-merchant-custom-attribute-definition) endpoint. This `BulkUpsertMerchantCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert requests and returns a map of individual upsert responses. Each upsert request has a unique ID and provides a merchant ID and custom attribute. Each upsert response is returned with the ID of the corresponding request. To create or update a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkUpsertMerchantCustomAttributesResponse

func (*MerchantCustomAttributesApiService) CreateMerchantCustomAttributeDefinition ¶

func (a *MerchantCustomAttributesApiService) CreateMerchantCustomAttributeDefinition(ctx context.Context, body CreateMerchantCustomAttributeDefinitionRequest) (CreateMerchantCustomAttributeDefinitionResponse, *http.Response, error)

MerchantCustomAttributesApiService CreateMerchantCustomAttributeDefinition Creates a merchant-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttributeDefinition) for a Square seller account. Use this endpoint to define a custom attribute that can be associated with a merchant connecting to your application. A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties for a custom attribute. After the definition is created, you can call [UpsertMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/upsert-merchant-custom-attribute) or [BulkUpsertMerchantCustomAttributes](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/bulk-upsert-merchant-custom-attributes) to set the custom attribute for a merchant.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateMerchantCustomAttributeDefinitionResponse

func (*MerchantCustomAttributesApiService) DeleteMerchantCustomAttribute ¶

func (a *MerchantCustomAttributesApiService) DeleteMerchantCustomAttribute(ctx context.Context, merchantId string, key string) (DeleteMerchantCustomAttributeResponse, *http.Response, error)

MerchantCustomAttributesApiService DeleteMerchantCustomAttribute Deletes a [custom attribute](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttribute) associated with a merchant. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param merchantId The ID of the target [merchant](https://developer.squareup.com/reference/square_2024-07-17/objects/Merchant).
@param key The key of the custom attribute to delete. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.

@return DeleteMerchantCustomAttributeResponse

func (*MerchantCustomAttributesApiService) DeleteMerchantCustomAttributeDefinition ¶

func (a *MerchantCustomAttributesApiService) DeleteMerchantCustomAttributeDefinition(ctx context.Context, key string) (DeleteMerchantCustomAttributeDefinitionResponse, *http.Response, error)

MerchantCustomAttributesApiService DeleteMerchantCustomAttributeDefinition Deletes a merchant-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttributeDefinition) from a Square seller account. Deleting a custom attribute definition also deletes the corresponding custom attribute from the merchant. Only the definition owner can delete a custom attribute definition.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param key The key of the custom attribute definition to delete.

@return DeleteMerchantCustomAttributeDefinitionResponse

func (*MerchantCustomAttributesApiService) ListMerchantCustomAttributeDefinitions ¶

func (a *MerchantCustomAttributesApiService) ListMerchantCustomAttributeDefinitions(ctx context.Context, localVarOptionals *MerchantCustomAttributesApiListMerchantCustomAttributeDefinitionsOpts) (ListMerchantCustomAttributeDefinitionsResponse, *http.Response, error)

func (*MerchantCustomAttributesApiService) ListMerchantCustomAttributes ¶

func (a *MerchantCustomAttributesApiService) ListMerchantCustomAttributes(ctx context.Context, merchantId string, localVarOptionals *MerchantCustomAttributesApiListMerchantCustomAttributesOpts) (ListMerchantCustomAttributesResponse, *http.Response, error)

func (*MerchantCustomAttributesApiService) RetrieveMerchantCustomAttribute ¶

func (a *MerchantCustomAttributesApiService) RetrieveMerchantCustomAttribute(ctx context.Context, merchantId string, key string, localVarOptionals *MerchantCustomAttributesApiRetrieveMerchantCustomAttributeOpts) (RetrieveMerchantCustomAttributeResponse, *http.Response, error)

func (*MerchantCustomAttributesApiService) RetrieveMerchantCustomAttributeDefinition ¶

func (a *MerchantCustomAttributesApiService) RetrieveMerchantCustomAttributeDefinition(ctx context.Context, key string, localVarOptionals *MerchantCustomAttributesApiRetrieveMerchantCustomAttributeDefinitionOpts) (RetrieveMerchantCustomAttributeDefinitionResponse, *http.Response, error)

func (*MerchantCustomAttributesApiService) UpdateMerchantCustomAttributeDefinition ¶

func (a *MerchantCustomAttributesApiService) UpdateMerchantCustomAttributeDefinition(ctx context.Context, body UpdateMerchantCustomAttributeDefinitionRequest, key string) (UpdateMerchantCustomAttributeDefinitionResponse, *http.Response, error)

MerchantCustomAttributesApiService UpdateMerchantCustomAttributeDefinition Updates a merchant-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttributeDefinition) for a Square seller account. Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the `schema` for a `Selection` data type. Only the definition owner can update a custom attribute definition.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param key The key of the custom attribute definition to update.

@return UpdateMerchantCustomAttributeDefinitionResponse

func (*MerchantCustomAttributesApiService) UpsertMerchantCustomAttribute ¶

func (a *MerchantCustomAttributesApiService) UpsertMerchantCustomAttribute(ctx context.Context, body UpsertMerchantCustomAttributeRequest, merchantId string, key string) (UpsertMerchantCustomAttributeResponse, *http.Response, error)

MerchantCustomAttributesApiService UpsertMerchantCustomAttribute Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttribute) for a merchant. Use this endpoint to set the value of a custom attribute for a specified merchant. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the [CreateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/create-merchant-custom-attribute-definition) endpoint. To create or update a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param merchantId The ID of the target [merchant](https://developer.squareup.com/reference/square_2024-07-17/objects/Merchant).
@param key The key of the custom attribute to create or update. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.

@return UpsertMerchantCustomAttributeResponse

type MerchantStatus ¶

type MerchantStatus string

const (
	ACTIVE_MerchantStatus   MerchantStatus = "ACTIVE"
	INACTIVE_MerchantStatus MerchantStatus = "INACTIVE"
)

List of MerchantStatus

type MerchantsApiListMerchantsOpts ¶

type MerchantsApiListMerchantsOpts struct {
	Cursor optional.Int32
}

type MerchantsApiService ¶

type MerchantsApiService service

func (*MerchantsApiService) ListMerchants ¶

func (a *MerchantsApiService) ListMerchants(ctx context.Context, localVarOptionals *MerchantsApiListMerchantsOpts) (ListMerchantsResponse, *http.Response, error)

func (*MerchantsApiService) RetrieveMerchant ¶

func (a *MerchantsApiService) RetrieveMerchant(ctx context.Context, merchantId string) (RetrieveMerchantResponse, *http.Response, error)

MerchantsApiService RetrieveMerchant Retrieves the `Merchant` object for the given `merchant_id`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param merchantId The ID of the merchant to retrieve. If the string \"me\" is supplied as the ID, then retrieve the merchant that is currently accessible to this call.

@return RetrieveMerchantResponse

type MobileAuthorizationApiService ¶

type MobileAuthorizationApiService service

func (*MobileAuthorizationApiService) CreateMobileAuthorizationCode ¶

func (a *MobileAuthorizationApiService) CreateMobileAuthorizationCode(ctx context.Context, body CreateMobileAuthorizationCodeRequest) (CreateMobileAuthorizationCodeResponse, *http.Response, error)

MobileAuthorizationApiService CreateMobileAuthorizationCode Generates code to authorize a mobile application to connect to a Square card reader. Authorization codes are one-time-use codes and expire 60 minutes after being issued. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` Replace `ACCESS_TOKEN` with a [valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateMobileAuthorizationCodeResponse

type ModelBreak ¶

type ModelBreak struct {
	// The UUID for this object.
	Id string `json:"id,omitempty"`
	// RFC 3339; follows the same timezone information as `Shift`. Precision up to the minute is respected; seconds are truncated.
	StartAt string `json:"start_at"`
	// RFC 3339; follows the same timezone information as `Shift`. Precision up to the minute is respected; seconds are truncated.
	EndAt string `json:"end_at,omitempty"`
	// The `BreakType` that this `Break` was templated on.
	BreakTypeId string `json:"break_type_id"`
	// A human-readable name.
	Name string `json:"name"`
	// Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of the break.
	ExpectedDuration string `json:"expected_duration"`
	// Whether this break counts towards time worked for compensation purposes.
	IsPaid bool `json:"is_paid"`
}

A record of an employee's break during a shift.

type ModelError ¶

type ModelError struct {
	// The high-level category for the error.
	Category string `json:"category"`
	// The specific code of the error.
	Code string `json:"code"`
	// A human-readable description of the error for debugging purposes.
	Detail string `json:"detail,omitempty"`
	// The name of the field provided in the original request (if any) that the error pertains to.
	Field string `json:"field,omitempty"`
}

Represents an error encountered during a request to the Connect API. See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information.

type ModelRange ¶

type ModelRange struct {
	// The lower bound of the number range. At least one of `min` or `max` must be specified. If unspecified, the results will have no minimum value.
	Min string `json:"min,omitempty"`
	// The upper bound of the number range. At least one of `min` or `max` must be specified. If unspecified, the results will have no maximum value.
	Max string `json:"max,omitempty"`
}

The range of a number value between the specified lower and upper bounds.

type ModifierLocationOverrides ¶

type ModifierLocationOverrides struct {
	// The ID of the `Location` object representing the location. This can include a deactivated location.
	LocationId string `json:"location_id,omitempty"`
	PriceMoney *Money `json:"price_money,omitempty"`
	// Indicates whether the modifier is sold out at the specified location or not. As an example, for cheese (modifier) burger (item), when the modifier is sold out, it is the cheese, but not the burger, that is sold out. The seller can manually set this sold out status. Attempts by an application to set this attribute are ignored.
	SoldOut bool `json:"sold_out,omitempty"`
}

Location-specific overrides for specified properties of a `CatalogModifier` object.

type Money ¶

type Money struct {
	// The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific field description to determine the meaning of the sign in a particular case.
	Amount int64 `json:"amount,omitempty"`
	// The type of currency, in __ISO 4217 format__. For example, the currency code for US dollars is `USD`.  See [Currency](https://developer.squareup.com/reference/square_2024-07-17/enums/Currency) for possible values.
	Currency string `json:"currency,omitempty"`
}

Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.

type OAuthApiService ¶

type OAuthApiService service

func (*OAuthApiService) ObtainToken ¶

func (a *OAuthApiService) ObtainToken(ctx context.Context, body ObtainTokenRequest) (ObtainTokenResponse, *http.Response, error)

OAuthApiService ObtainToken Returns an OAuth access token and a refresh token unless the `short_lived` parameter is set to `true`, in which case the endpoint returns only an access token. The `grant_type` parameter specifies the type of OAuth request. If `grant_type` is `authorization_code`, you must include the authorization code you received when a seller granted you authorization. If `grant_type` is `refresh_token`, you must provide a valid refresh token. If you're using an old version of the Square APIs (prior to March 13, 2019), `grant_type` can be `migration_token` and you must provide a valid migration token. You can use the `scopes` parameter to limit the set of permissions granted to the access token and refresh token. You can use the `short_lived` parameter to create an access token that expires in 24 hours. __Note:__ OAuth tokens should be encrypted and stored on a secure server. Application clients should never interact directly with OAuth tokens.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return ObtainTokenResponse

func (*OAuthApiService) RetrieveTokenStatus ¶

func (a *OAuthApiService) RetrieveTokenStatus(ctx context.Context) (RetrieveTokenStatusResponse, *http.Response, error)

OAuthApiService RetrieveTokenStatus Returns information about an [OAuth access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-an-oauth-access-token) or an application’s [personal access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-a-personal-access-token). Add the access token to the Authorization header of the request. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Bearer ACCESS_TOKEN ``` where `ACCESS_TOKEN` is a [valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens). If the access token is expired or not a valid access token, the endpoint returns an `UNAUTHORIZED` error.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return RetrieveTokenStatusResponse

func (*OAuthApiService) RevokeToken ¶

func (a *OAuthApiService) RevokeToken(ctx context.Context, body RevokeTokenRequest) (RevokeTokenResponse, *http.Response, error)

OAuthApiService RevokeToken Revokes an access token generated with the OAuth flow. If an account has more than one OAuth access token for your application, this endpoint revokes all of them, regardless of which token you specify. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the **OAuth** page for your application in the Developer Dashboard.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return RevokeTokenResponse

type ObtainTokenRequest ¶

type ObtainTokenRequest struct {
	// The Square-issued ID of your application, which is available on the **OAuth** page in the [Developer Dashboard](https://developer.squareup.com/apps).
	ClientId string `json:"client_id"`
	// The Square-issued application secret for your application, which is available on the **OAuth** page in the [Developer Dashboard](https://developer.squareup.com/apps). This parameter is only required when  you're not using the [OAuth PKCE (Proof Key for Code Exchange) flow](https://developer.squareup.com/docs/oauth-api/overview#pkce-flow). The PKCE flow requires a `code_verifier` instead of a `client_secret` when `grant_type` is set to `authorization_code`.  If `grant_type` is set to `refresh_token` and the `refresh_token` is obtained uaing PKCE, the PKCE flow only requires `client_id`,  `grant_type`, and `refresh_token`.
	ClientSecret string `json:"client_secret,omitempty"`
	// The authorization code to exchange. This code is required if `grant_type` is set to `authorization_code` to indicate that the application wants to exchange an authorization code for an OAuth access token.
	Code string `json:"code,omitempty"`
	// The redirect URL assigned on the **OAuth** page for your application in the [Developer Dashboard](https://developer.squareup.com/apps).
	RedirectUri string `json:"redirect_uri,omitempty"`
	// Specifies the method to request an OAuth access token. Valid values are `authorization_code`, `refresh_token`, and `migration_token`.
	GrantType string `json:"grant_type"`
	// A valid refresh token for generating a new OAuth access token.  A valid refresh token is required if `grant_type` is set to `refresh_token` to indicate that the application wants a replacement for an expired OAuth access token.
	RefreshToken string `json:"refresh_token,omitempty"`
	// A legacy OAuth access token obtained using a Connect API version prior to 2019-03-13. This parameter is required if `grant_type` is set to `migration_token` to indicate that the application wants to get a replacement OAuth access token. The response also returns a refresh token. For more information, see [Migrate to Using Refresh Tokens](https://developer.squareup.com/docs/oauth-api/migrate-to-refresh-tokens).
	MigrationToken string `json:"migration_token,omitempty"`
	// A JSON list of strings representing the permissions that the application is requesting. For example, \"`[\"MERCHANT_PROFILE_READ\",\"PAYMENTS_READ\",\"BANK_ACCOUNTS_READ\"]`\".  The access token returned in the response is granted the permissions that comprise the intersection between the requested list of permissions and those that belong to the provided refresh token.
	Scopes []string `json:"scopes,omitempty"`
	// A Boolean indicating a request for a short-lived access token.  The short-lived access token returned in the response expires in 24 hours.
	ShortLived bool `json:"short_lived,omitempty"`
	// Must be provided when using the PKCE OAuth flow if `grant_type` is set to `authorization_code`. The `code_verifier` is used to verify against the `code_challenge` associated with the `authorization_code`.
	CodeVerifier string `json:"code_verifier,omitempty"`
}

type ObtainTokenResponse ¶

type ObtainTokenResponse struct {
	// A valid OAuth access token.  Provide the access token in a header with every request to Connect API endpoints. For more information, see [OAuth API: Walkthrough](https://developer.squareup.com/docs/oauth-api/walkthrough).
	AccessToken string `json:"access_token,omitempty"`
	// This value is always _bearer_.
	TokenType string `json:"token_type,omitempty"`
	// The date when the `access_token` expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format.
	ExpiresAt string `json:"expires_at,omitempty"`
	// The ID of the authorizing merchant's business.
	MerchantId string `json:"merchant_id,omitempty"`
	// __LEGACY FIELD__. The ID of a subscription plan the merchant signed up for. The ID is only present if the merchant signed up for a subscription plan during authorization.
	SubscriptionId string `json:"subscription_id,omitempty"`
	// __LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. The ID is only present if the merchant signed up for a subscription plan during authorization.
	PlanId string `json:"plan_id,omitempty"`
	// The OpenID token belonging to this person. This token is only present if the OPENID scope is included in the authorization request.
	IdToken string `json:"id_token,omitempty"`
	// A refresh token.  For more information, see [Refresh, Revoke, and Limit the Scope of OAuth Tokens](https://developer.squareup.com/docs/oauth-api/refresh-revoke-limit-scope).
	RefreshToken string `json:"refresh_token,omitempty"`
	// A Boolean indicating that the access token is a short-lived access token. The short-lived access token returned in the response expires in 24 hours.
	ShortLived bool `json:"short_lived,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The date when the `refresh_token` expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format.
	RefreshTokenExpiresAt string `json:"refresh_token_expires_at,omitempty"`
}

type Order ¶

type Order struct {
	// The order's unique ID.
	Id string `json:"id,omitempty"`
	// The ID of the seller location that this order is associated with.
	LocationId string `json:"location_id"`
	// A client-specified ID to associate an entity in another system with this order.
	ReferenceId string       `json:"reference_id,omitempty"`
	Source      *OrderSource `json:"source,omitempty"`
	// The ID of the [customer](https://developer.squareup.com/reference/square_2024-07-17/objects/Customer) associated with the order.  You should specify a `customer_id` on the order (or the payment) to ensure that transactions are reliably linked to customers. Omitting this field might result in the creation of new [instant profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles).
	CustomerId string `json:"customer_id,omitempty"`
	// The line items included in the order.
	LineItems []OrderLineItem `json:"line_items,omitempty"`
	// The list of all taxes associated with the order.  Taxes can be scoped to either `ORDER` or `LINE_ITEM`. For taxes with `LINE_ITEM` scope, an `OrderLineItemAppliedTax` must be added to each line item that the tax applies to. For taxes with `ORDER` scope, the server generates an `OrderLineItemAppliedTax` for every line item.  On reads, each tax in the list includes the total amount of that tax applied to the order.  __IMPORTANT__: If `LINE_ITEM` scope is set on any taxes in this field, using the deprecated `line_items.taxes` field results in an error. Use `line_items.applied_taxes` instead.
	Taxes []OrderLineItemTax `json:"taxes,omitempty"`
	// The list of all discounts associated with the order.  Discounts can be scoped to either `ORDER` or `LINE_ITEM`. For discounts scoped to `LINE_ITEM`, an `OrderLineItemAppliedDiscount` must be added to each line item that the discount applies to. For discounts with `ORDER` scope, the server generates an `OrderLineItemAppliedDiscount` for every line item.  __IMPORTANT__: If `LINE_ITEM` scope is set on any discounts in this field, using the deprecated `line_items.discounts` field results in an error. Use `line_items.applied_discounts` instead.
	Discounts []OrderLineItemDiscount `json:"discounts,omitempty"`
	// A list of service charges applied to the order.
	ServiceCharges []OrderServiceCharge `json:"service_charges,omitempty"`
	// Details about order fulfillment.  Orders can only be created with at most one fulfillment. However, orders returned by the API might contain multiple fulfillments.
	Fulfillments []Fulfillment `json:"fulfillments,omitempty"`
	// A collection of items from sale orders being returned in this one. Normally part of an itemized return or exchange. There is exactly one `Return` object per sale `Order` being referenced.
	Returns            []OrderReturn            `json:"returns,omitempty"`
	ReturnAmounts      *OrderMoneyAmounts       `json:"return_amounts,omitempty"`
	NetAmounts         *OrderMoneyAmounts       `json:"net_amounts,omitempty"`
	RoundingAdjustment *OrderRoundingAdjustment `json:"rounding_adjustment,omitempty"`
	// The tenders that were used to pay for the order.
	Tenders []Tender `json:"tenders,omitempty"`
	// The refunds that are part of this order.
	Refunds []Refund `json:"refunds,omitempty"`
	// Application-defined data attached to this order. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details).  Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character.  Values have a maximum length of 255 characters.  An application can have up to 10 entries per metadata field.  Entries written by applications are private and can only be read or modified by the same application.  For more information, see  [Metadata](https://developer.squareup.com/docs/build-basics/metadata).
	Metadata map[string]string `json:"metadata,omitempty"`
	// The timestamp for when the order was created, at server side, in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp for when the order was last updated, at server side, in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	UpdatedAt string `json:"updated_at,omitempty"`
	// The timestamp for when the order reached a terminal [state](https://developer.squareup.com/reference/square_2024-07-17/enums/OrderState), in RFC 3339 format (for example \"2016-09-04T23:59:33.123Z\").
	ClosedAt string `json:"closed_at,omitempty"`
	// The current state of the order.
	State string `json:"state,omitempty"`
	// The version number, which is incremented each time an update is committed to the order. Orders not created through the API do not include a version number and therefore cannot be updated.  [Read more about working with versions](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders).
	Version                 int32  `json:"version,omitempty"`
	TotalMoney              *Money `json:"total_money,omitempty"`
	TotalTaxMoney           *Money `json:"total_tax_money,omitempty"`
	TotalDiscountMoney      *Money `json:"total_discount_money,omitempty"`
	TotalTipMoney           *Money `json:"total_tip_money,omitempty"`
	TotalServiceChargeMoney *Money `json:"total_service_charge_money,omitempty"`
	// A short-term identifier for the order (such as a customer first name, table number, or auto-generated order number that resets daily).
	TicketName     string               `json:"ticket_name,omitempty"`
	PricingOptions *OrderPricingOptions `json:"pricing_options,omitempty"`
	// A set-like list of Rewards that have been added to the Order.
	Rewards           []OrderReward `json:"rewards,omitempty"`
	NetAmountDueMoney *Money        `json:"net_amount_due_money,omitempty"`
}

Contains all information related to a single order to process with Square, including line items that specify the products to purchase. `Order` objects also include information about any associated tenders, refunds, and returns. All Connect V2 Transactions have all been converted to Orders including all associated itemization data.

type OrderCreated ¶

type OrderCreated struct {
	// The order's unique ID.
	OrderId string `json:"order_id,omitempty"`
	// The version number, which is incremented each time an update is committed to the order. Orders that were not created through the API do not include a version number and therefore cannot be updated.  [Read more about working with versions.](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders)
	Version int32 `json:"version,omitempty"`
	// The ID of the seller location that this order is associated with.
	LocationId string `json:"location_id,omitempty"`
	// The state of the order.
	State string `json:"state,omitempty"`
	// The timestamp for when the order was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
}

type OrderCreatedObject ¶

type OrderCreatedObject struct {
	OrderCreated *OrderCreated `json:"order_created,omitempty"`
}

type OrderCustomAttributesApiListOrderCustomAttributeDefinitionsOpts ¶

type OrderCustomAttributesApiListOrderCustomAttributeDefinitionsOpts struct {
	VisibilityFilter optional.String
	Cursor           optional.String
	Limit            optional.Int32
}

type OrderCustomAttributesApiListOrderCustomAttributesOpts ¶

type OrderCustomAttributesApiListOrderCustomAttributesOpts struct {
	VisibilityFilter optional.String
	Cursor           optional.String
	Limit            optional.Int32
	WithDefinitions  optional.Bool
}

type OrderCustomAttributesApiRetrieveOrderCustomAttributeDefinitionOpts ¶

type OrderCustomAttributesApiRetrieveOrderCustomAttributeDefinitionOpts struct {
	Version optional.Int32
}

type OrderCustomAttributesApiRetrieveOrderCustomAttributeOpts ¶

type OrderCustomAttributesApiRetrieveOrderCustomAttributeOpts struct {
	Version        optional.Int32
	WithDefinition optional.Bool
}

type OrderCustomAttributesApiService ¶

type OrderCustomAttributesApiService service

func (*OrderCustomAttributesApiService) BulkDeleteOrderCustomAttributes ¶

func (a *OrderCustomAttributesApiService) BulkDeleteOrderCustomAttributes(ctx context.Context, body BulkDeleteOrderCustomAttributesRequest) (BulkDeleteOrderCustomAttributesResponse, *http.Response, error)

OrderCustomAttributesApiService BulkDeleteOrderCustomAttributes Deletes order [custom attributes](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttribute) as a bulk operation. Use this endpoint to delete one or more custom attributes from one or more orders. A custom attribute is based on a custom attribute definition in a Square seller account. (To create a custom attribute definition, use the [CreateOrderCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/order-custom-attributes-api/create-order-custom-attribute-definition) endpoint.) This `BulkDeleteOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual delete requests and returns a map of individual delete responses. Each delete request has a unique ID and provides an order ID and custom attribute. Each delete response is returned with the ID of the corresponding request. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkDeleteOrderCustomAttributesResponse

func (*OrderCustomAttributesApiService) BulkUpsertOrderCustomAttributes ¶

func (a *OrderCustomAttributesApiService) BulkUpsertOrderCustomAttributes(ctx context.Context, body BulkUpsertOrderCustomAttributesRequest) (BulkUpsertOrderCustomAttributesResponse, *http.Response, error)

OrderCustomAttributesApiService BulkUpsertOrderCustomAttributes Creates or updates order [custom attributes](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttribute) as a bulk operation. Use this endpoint to delete one or more custom attributes from one or more orders. A custom attribute is based on a custom attribute definition in a Square seller account. (To create a custom attribute definition, use the [CreateOrderCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/order-custom-attributes-api/create-order-custom-attribute-definition) endpoint.) This `BulkUpsertOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert requests and returns a map of individual upsert responses. Each upsert request has a unique ID and provides an order ID and custom attribute. Each upsert response is returned with the ID of the corresponding request. To create or update a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkUpsertOrderCustomAttributesResponse

func (*OrderCustomAttributesApiService) CreateOrderCustomAttributeDefinition ¶

func (a *OrderCustomAttributesApiService) CreateOrderCustomAttributeDefinition(ctx context.Context, body CreateOrderCustomAttributeDefinitionRequest) (CreateOrderCustomAttributeDefinitionResponse, *http.Response, error)

OrderCustomAttributesApiService CreateOrderCustomAttributeDefinition Creates an order-related custom attribute definition. Use this endpoint to define a custom attribute that can be associated with orders. After creating a custom attribute definition, you can set the custom attribute for orders in the Square seller account.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateOrderCustomAttributeDefinitionResponse

func (*OrderCustomAttributesApiService) DeleteOrderCustomAttribute ¶

func (a *OrderCustomAttributesApiService) DeleteOrderCustomAttribute(ctx context.Context, orderId string, customAttributeKey string) (DeleteOrderCustomAttributeResponse, *http.Response, error)

OrderCustomAttributesApiService DeleteOrderCustomAttribute Deletes a [custom attribute](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttribute) associated with a customer profile. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orderId The ID of the target [order](https://developer.squareup.com/reference/square_2024-07-17/objects/Order).
@param customAttributeKey The key of the custom attribute to delete. This key must match the key of an existing custom attribute definition.

@return DeleteOrderCustomAttributeResponse

func (*OrderCustomAttributesApiService) DeleteOrderCustomAttributeDefinition ¶

func (a *OrderCustomAttributesApiService) DeleteOrderCustomAttributeDefinition(ctx context.Context, key string) (DeleteOrderCustomAttributeDefinitionResponse, *http.Response, error)

OrderCustomAttributesApiService DeleteOrderCustomAttributeDefinition Deletes an order-related [custom attribute definition](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttributeDefinition) from a Square seller account. Only the definition owner can delete a custom attribute definition.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param key The key of the custom attribute definition to delete.

@return DeleteOrderCustomAttributeDefinitionResponse

func (*OrderCustomAttributesApiService) ListOrderCustomAttributeDefinitions ¶

func (a *OrderCustomAttributesApiService) ListOrderCustomAttributeDefinitions(ctx context.Context, localVarOptionals *OrderCustomAttributesApiListOrderCustomAttributeDefinitionsOpts) (ListOrderCustomAttributeDefinitionsResponse, *http.Response, error)

func (*OrderCustomAttributesApiService) ListOrderCustomAttributes ¶

func (a *OrderCustomAttributesApiService) ListOrderCustomAttributes(ctx context.Context, orderId string, localVarOptionals *OrderCustomAttributesApiListOrderCustomAttributesOpts) (ListOrderCustomAttributesResponse, *http.Response, error)

func (*OrderCustomAttributesApiService) RetrieveOrderCustomAttribute ¶

func (a *OrderCustomAttributesApiService) RetrieveOrderCustomAttribute(ctx context.Context, orderId string, customAttributeKey string, localVarOptionals *OrderCustomAttributesApiRetrieveOrderCustomAttributeOpts) (RetrieveOrderCustomAttributeResponse, *http.Response, error)

func (*OrderCustomAttributesApiService) RetrieveOrderCustomAttributeDefinition ¶

func (a *OrderCustomAttributesApiService) RetrieveOrderCustomAttributeDefinition(ctx context.Context, key string, localVarOptionals *OrderCustomAttributesApiRetrieveOrderCustomAttributeDefinitionOpts) (RetrieveOrderCustomAttributeDefinitionResponse, *http.Response, error)

func (*OrderCustomAttributesApiService) UpdateOrderCustomAttributeDefinition ¶

func (a *OrderCustomAttributesApiService) UpdateOrderCustomAttributeDefinition(ctx context.Context, body UpdateOrderCustomAttributeDefinitionRequest, key string) (UpdateOrderCustomAttributeDefinitionResponse, *http.Response, error)

OrderCustomAttributesApiService UpdateOrderCustomAttributeDefinition Updates an order-related custom attribute definition for a Square seller account. Only the definition owner can update a custom attribute definition. Note that sellers can view all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param key The key of the custom attribute definition to update.

@return UpdateOrderCustomAttributeDefinitionResponse

func (*OrderCustomAttributesApiService) UpsertOrderCustomAttribute ¶

func (a *OrderCustomAttributesApiService) UpsertOrderCustomAttribute(ctx context.Context, body UpsertOrderCustomAttributeRequest, orderId string, customAttributeKey string) (UpsertOrderCustomAttributeResponse, *http.Response, error)

OrderCustomAttributesApiService UpsertOrderCustomAttribute Creates or updates a [custom attribute](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttribute) for an order. Use this endpoint to set the value of a custom attribute for a specific order. A custom attribute is based on a custom attribute definition in a Square seller account. (To create a custom attribute definition, use the [CreateOrderCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/order-custom-attributes-api/create-order-custom-attribute-definition) endpoint.) To create or update a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param orderId The ID of the target [order](https://developer.squareup.com/reference/square_2024-07-17/objects/Order).
@param customAttributeKey The key of the custom attribute to create or update. This key must match the key of an existing custom attribute definition.

@return UpsertOrderCustomAttributeResponse

type OrderEntry ¶

type OrderEntry struct {
	// The ID of the order.
	OrderId string `json:"order_id,omitempty"`
	// The version number, which is incremented each time an update is committed to the order. Orders that were not created through the API do not include a version number and therefore cannot be updated.  [Read more about working with versions.](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders)
	Version int32 `json:"version,omitempty"`
	// The location ID the order belongs to.
	LocationId string `json:"location_id,omitempty"`
}

A lightweight description of an [order](https://developer.squareup.com/reference/square_2024-07-17/objects/Order) that is returned when `returned_entries` is `true` on a SearchOrdersRequest(https://developer.squareup.com/reference/square_2024-07-17/orders-api/search-orders).

type OrderFulfillment ¶

type OrderFulfillment struct {
	// A unique ID that identifies the fulfillment only within this order.
	Uid string `json:"uid,omitempty"`
	// The type of the fulfillment.
	Type_ string `json:"type,omitempty"`
	// The state of the fulfillment.
	State string `json:"state,omitempty"`
	// Describes what order line items this fulfillment applies to. It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries.
	LineItemApplication string `json:"line_item_application,omitempty"`
	// A list of entries pertaining to the fulfillment of an order. Each entry must reference a valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to fulfill. Multiple entries can reference the same line item `uid`, as long as the total quantity among all fulfillment entries referencing a single line item does not exceed the quantity of the order's line item itself. An order cannot be marked as `COMPLETED` before all fulfillments are `COMPLETED`, `CANCELED`, or `FAILED`. Fulfillments can be created and completed independently before order completion.
	Entries []OrderFulfillmentFulfillmentEntry `json:"entries,omitempty"`
	// Application-defined data attached to this fulfillment. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a maximum length of 255 characters. An application can have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).
	Metadata        map[string]string                `json:"metadata,omitempty"`
	PickupDetails   *OrderFulfillmentPickupDetails   `json:"pickup_details,omitempty"`
	ShipmentDetails *OrderFulfillmentShipmentDetails `json:"shipment_details,omitempty"`
	DeliveryDetails *OrderFulfillmentDeliveryDetails `json:"delivery_details,omitempty"`
}

Contains details about how to fulfill this order. Orders can only be created with at most one fulfillment using the API. However, orders returned by the Orders API might contain multiple fulfillments because sellers can create multiple fulfillments using Square products such as Square Online.

type OrderFulfillmentDeliveryDetails ¶

type OrderFulfillmentDeliveryDetails struct {
	Recipient *OrderFulfillmentRecipient `json:"recipient,omitempty"`
	// Indicates the fulfillment delivery schedule type. If `SCHEDULED`, then `deliver_at` is required. If `ASAP`, then `prep_time_duration` is required. The default is `SCHEDULED`.
	ScheduleType string `json:"schedule_type,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was placed. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\"). Must be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\".
	PlacedAt string `json:"placed_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) that represents the start of the delivery period. When the fulfillment `schedule_type` is `ASAP`, the field is automatically set to the current time plus the `prep_time_duration`. Otherwise, the application can set this field while the fulfillment `state` is `PROPOSED`, `RESERVED`, or `PREPARED` (any time before the terminal state such as `COMPLETED`, `CANCELED`, and `FAILED`).  The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	DeliverAt string `json:"deliver_at,omitempty"`
	// The duration of time it takes to prepare and deliver this fulfillment. The duration must be in RFC 3339 format (for example, \"P1W3D\").
	PrepTimeDuration string `json:"prep_time_duration,omitempty"`
	// The time period after `deliver_at` in which to deliver the order. Applications can set this field when the fulfillment `state` is `PROPOSED`, `RESERVED`, or `PREPARED` (any time before the terminal state such as `COMPLETED`, `CANCELED`, and `FAILED`). The duration must be in RFC 3339 format (for example, \"P1W3D\").
	DeliveryWindowDuration string `json:"delivery_window_duration,omitempty"`
	// Provides additional instructions about the delivery fulfillment. It is displayed in the Square Point of Sale application and set by the API.
	Note string `json:"note,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicates when the seller completed the fulfillment. This field is automatically set when  fulfillment `state` changes to `COMPLETED`. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	CompletedAt string `json:"completed_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicates when the seller started processing the fulfillment. This field is automatically set when the fulfillment `state` changes to `RESERVED`. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	InProgressAt string `json:"in_progress_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was rejected. This field is automatically set when the fulfillment `state` changes to `FAILED`. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	RejectedAt string `json:"rejected_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the seller marked the fulfillment as ready for courier pickup. This field is automatically set when the fulfillment `state` changes to PREPARED. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	ReadyAt string `json:"ready_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was delivered to the recipient. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	DeliveredAt string `json:"delivered_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was canceled. This field is automatically set when the fulfillment `state` changes to `CANCELED`.  The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	CanceledAt string `json:"canceled_at,omitempty"`
	// The delivery cancellation reason. Max length: 100 characters.
	CancelReason string `json:"cancel_reason,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when an order can be picked up by the courier for delivery. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	CourierPickupAt string `json:"courier_pickup_at,omitempty"`
	// The time period after `courier_pickup_at` in which the courier should pick up the order. The duration must be in RFC 3339 format (for example, \"P1W3D\").
	CourierPickupWindowDuration string `json:"courier_pickup_window_duration,omitempty"`
	// Whether the delivery is preferred to be no contact.
	IsNoContactDelivery bool `json:"is_no_contact_delivery,omitempty"`
	// A note to provide additional instructions about how to deliver the order.
	DropoffNotes string `json:"dropoff_notes,omitempty"`
	// The name of the courier provider.
	CourierProviderName string `json:"courier_provider_name,omitempty"`
	// The support phone number of the courier.
	CourierSupportPhoneNumber string `json:"courier_support_phone_number,omitempty"`
	// The identifier for the delivery created by Square.
	SquareDeliveryId string `json:"square_delivery_id,omitempty"`
	// The identifier for the delivery created by the third-party courier service.
	ExternalDeliveryId string `json:"external_delivery_id,omitempty"`
	// The flag to indicate the delivery is managed by a third party (ie DoorDash), which means we may not receive all recipient information for PII purposes.
	ManagedDelivery bool `json:"managed_delivery,omitempty"`
}

Describes delivery details of an order fulfillment.

type OrderFulfillmentDeliveryDetailsScheduleType ¶

type OrderFulfillmentDeliveryDetailsScheduleType string

OrderFulfillmentDeliveryDetailsScheduleType : The schedule type of the delivery fulfillment.

const (
	SCHEDULED_OrderFulfillmentDeliveryDetailsScheduleType OrderFulfillmentDeliveryDetailsScheduleType = "SCHEDULED"
	ASAP_OrderFulfillmentDeliveryDetailsScheduleType      OrderFulfillmentDeliveryDetailsScheduleType = "ASAP"
)

List of OrderFulfillmentDeliveryDetailsScheduleType

type OrderFulfillmentFulfillmentEntry ¶

type OrderFulfillmentFulfillmentEntry struct {
	// A unique ID that identifies the fulfillment entry only within this order.
	Uid string `json:"uid,omitempty"`
	// The `uid` from the order line item.
	LineItemUid string `json:"line_item_uid"`
	// The quantity of the line item being fulfilled, formatted as a decimal number. For example, `\"3\"`. Fulfillments for line items with a `quantity_unit` can have non-integer quantities. For example, `\"1.70000\"`.
	Quantity string `json:"quantity"`
	// Application-defined data attached to this fulfillment entry. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a maximum length of 255 characters. An application can have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).
	Metadata map[string]string `json:"metadata,omitempty"`
}

Links an order line item to a fulfillment. Each entry must reference a valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to fulfill.

type OrderFulfillmentFulfillmentLineItemApplication ¶

type OrderFulfillmentFulfillmentLineItemApplication string

OrderFulfillmentFulfillmentLineItemApplication : The `line_item_application` describes what order line items this fulfillment applies to. It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries.

const (
	ALL_OrderFulfillmentFulfillmentLineItemApplication        OrderFulfillmentFulfillmentLineItemApplication = "ALL"
	ENTRY_LIST_OrderFulfillmentFulfillmentLineItemApplication OrderFulfillmentFulfillmentLineItemApplication = "ENTRY_LIST"
)

List of OrderFulfillmentFulfillmentLineItemApplication

type OrderFulfillmentPickupDetails ¶

type OrderFulfillmentPickupDetails struct {
	Recipient *OrderFulfillmentRecipient `json:"recipient,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when this fulfillment expires if it is not marked in progress. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\"). The expiration time can only be set up to 7 days in the future. If `expires_at` is not set, any new payments attached to the order are automatically completed.
	ExpiresAt string `json:"expires_at,omitempty"`
	// The duration of time after which an in progress pickup fulfillment is automatically moved to the `COMPLETED` state. The duration must be in RFC 3339 format (for example, \"P1W3D\").  If not set, this pickup fulfillment remains in progress until it is canceled or completed.
	AutoCompleteDuration string `json:"auto_complete_duration,omitempty"`
	// The schedule type of the pickup fulfillment. Defaults to `SCHEDULED`.
	ScheduleType string `json:"schedule_type,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) that represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\". For fulfillments with the schedule type `ASAP`, this is automatically set to the current time plus the expected duration to prepare the fulfillment.
	PickupAt string `json:"pickup_at,omitempty"`
	// The window of time in which the order should be picked up after the `pickup_at` timestamp. Must be in RFC 3339 duration format, e.g., \"P1W3D\". Can be used as an informational guideline for merchants.
	PickupWindowDuration string `json:"pickup_window_duration,omitempty"`
	// The duration of time it takes to prepare this fulfillment. The duration must be in RFC 3339 format (for example, \"P1W3D\").
	PrepTimeDuration string `json:"prep_time_duration,omitempty"`
	// A note to provide additional instructions about the pickup fulfillment displayed in the Square Point of Sale application and set by the API.
	Note string `json:"note,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was placed. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	PlacedAt string `json:"placed_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was marked in progress. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	AcceptedAt string `json:"accepted_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was rejected. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	RejectedAt string `json:"rejected_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment is marked as ready for pickup. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	ReadyAt string `json:"ready_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment expired. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	ExpiredAt string `json:"expired_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was picked up by the recipient. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	PickedUpAt string `json:"picked_up_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the fulfillment was canceled. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	CanceledAt string `json:"canceled_at,omitempty"`
	// A description of why the pickup was canceled. The maximum length: 100 characters.
	CancelReason string `json:"cancel_reason,omitempty"`
	// If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup.
	IsCurbsidePickup      bool                                                `json:"is_curbside_pickup,omitempty"`
	CurbsidePickupDetails *OrderFulfillmentPickupDetailsCurbsidePickupDetails `json:"curbside_pickup_details,omitempty"`
}

Contains details necessary to fulfill a pickup order.

type OrderFulfillmentPickupDetailsCurbsidePickupDetails ¶

type OrderFulfillmentPickupDetailsCurbsidePickupDetails struct {
	// Specific details for curbside pickup, such as parking number and vehicle model.
	CurbsideDetails string `json:"curbside_details,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the buyer arrived and is waiting for pickup. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	BuyerArrivedAt string `json:"buyer_arrived_at,omitempty"`
}

Specific details for curbside pickup.

type OrderFulfillmentPickupDetailsScheduleType ¶

type OrderFulfillmentPickupDetailsScheduleType string

OrderFulfillmentPickupDetailsScheduleType : The schedule type of the pickup fulfillment.

const (
	SCHEDULED_OrderFulfillmentPickupDetailsScheduleType OrderFulfillmentPickupDetailsScheduleType = "SCHEDULED"
	ASAP_OrderFulfillmentPickupDetailsScheduleType      OrderFulfillmentPickupDetailsScheduleType = "ASAP"
)

List of OrderFulfillmentPickupDetailsScheduleType

type OrderFulfillmentRecipient ¶

type OrderFulfillmentRecipient struct {
	// The ID of the customer associated with the fulfillment. If `customer_id` is provided, the fulfillment recipient's `display_name`, `email_address`, and `phone_number` are automatically populated from the targeted customer profile. If these fields are set in the request, the request values override the information from the customer profile. If the targeted customer profile does not contain the necessary information and these fields are left unset, the request results in an error.
	CustomerId string `json:"customer_id,omitempty"`
	// The display name of the fulfillment recipient. This field is required. If provided, the display name overrides the corresponding customer profile value indicated by `customer_id`.
	DisplayName string `json:"display_name,omitempty"`
	// The email address of the fulfillment recipient. If provided, the email address overrides the corresponding customer profile value indicated by `customer_id`.
	EmailAddress string `json:"email_address,omitempty"`
	// The phone number of the fulfillment recipient. This field is required. If provided, the phone number overrides the corresponding customer profile value indicated by `customer_id`.
	PhoneNumber string   `json:"phone_number,omitempty"`
	Address     *Address `json:"address,omitempty"`
}

Information about the fulfillment recipient.

type OrderFulfillmentShipmentDetails ¶

type OrderFulfillmentShipmentDetails struct {
	Recipient *OrderFulfillmentRecipient `json:"recipient,omitempty"`
	// The shipping carrier being used to ship this fulfillment (such as UPS, FedEx, or USPS).
	Carrier string `json:"carrier,omitempty"`
	// A note with additional information for the shipping carrier.
	ShippingNote string `json:"shipping_note,omitempty"`
	// A description of the type of shipping product purchased from the carrier (such as First Class, Priority, or Express).
	ShippingType string `json:"shipping_type,omitempty"`
	// The reference number provided by the carrier to track the shipment's progress.
	TrackingNumber string `json:"tracking_number,omitempty"`
	// A link to the tracking webpage on the carrier's website.
	TrackingUrl string `json:"tracking_url,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the shipment was requested. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	PlacedAt string `json:"placed_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when this fulfillment was moved to the `RESERVED` state, which  indicates that preparation of this shipment has begun. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	InProgressAt string `json:"in_progress_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when this fulfillment was moved to the `PREPARED` state, which indicates that the fulfillment is packaged. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	PackagedAt string `json:"packaged_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the shipment is expected to be delivered to the shipping carrier. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	ExpectedShippedAt string `json:"expected_shipped_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when this fulfillment was moved to the `COMPLETED` state, which indicates that the fulfillment has been given to the shipping carrier. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	ShippedAt string `json:"shipped_at,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating the shipment was canceled. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	CanceledAt string `json:"canceled_at,omitempty"`
	// A description of why the shipment was canceled.
	CancelReason string `json:"cancel_reason,omitempty"`
	// The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) indicating when the shipment failed to be completed. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").
	FailedAt string `json:"failed_at,omitempty"`
	// A description of why the shipment failed to be completed.
	FailureReason string `json:"failure_reason,omitempty"`
}

Contains the details necessary to fulfill a shipment order.

type OrderFulfillmentState ¶

type OrderFulfillmentState string

OrderFulfillmentState : The current state of this fulfillment.

const (
	PROPOSED_OrderFulfillmentState  OrderFulfillmentState = "PROPOSED"
	RESERVED_OrderFulfillmentState  OrderFulfillmentState = "RESERVED"
	PREPARED_OrderFulfillmentState  OrderFulfillmentState = "PREPARED"
	COMPLETED_OrderFulfillmentState OrderFulfillmentState = "COMPLETED"
	CANCELED_OrderFulfillmentState  OrderFulfillmentState = "CANCELED"
	FAILED_OrderFulfillmentState    OrderFulfillmentState = "FAILED"
)

List of OrderFulfillmentState

type OrderFulfillmentType ¶

type OrderFulfillmentType string

OrderFulfillmentType : The type of fulfillment.

const (
	PICKUP_OrderFulfillmentType   OrderFulfillmentType = "PICKUP"
	SHIPMENT_OrderFulfillmentType OrderFulfillmentType = "SHIPMENT"
	DELIVERY_OrderFulfillmentType OrderFulfillmentType = "DELIVERY"
)

List of OrderFulfillmentType

type OrderFulfillmentUpdated ¶

type OrderFulfillmentUpdated struct {
	// The order's unique ID.
	OrderId string `json:"order_id,omitempty"`
	// The version number, which is incremented each time an update is committed to the order. Orders that were not created through the API do not include a version number and therefore cannot be updated.  [Read more about working with versions.](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders)
	Version int32 `json:"version,omitempty"`
	// The ID of the seller location that this order is associated with.
	LocationId string `json:"location_id,omitempty"`
	// The state of the order.
	State string `json:"state,omitempty"`
	// The timestamp for when the order was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp for when the order was last updated, in RFC 3339 format.
	UpdatedAt string `json:"updated_at,omitempty"`
	// The fulfillments that were updated with this version change.
	FulfillmentUpdate []OrderFulfillmentUpdatedUpdate `json:"fulfillment_update,omitempty"`
}

type OrderFulfillmentUpdatedObject ¶

type OrderFulfillmentUpdatedObject struct {
	OrderFulfillmentUpdated *OrderFulfillmentUpdated `json:"order_fulfillment_updated,omitempty"`
}

type OrderFulfillmentUpdatedUpdate ¶

type OrderFulfillmentUpdatedUpdate struct {
	// A unique ID that identifies the fulfillment only within this order.
	FulfillmentUid string `json:"fulfillment_uid,omitempty"`
	// The state of the fulfillment before the change. The state is not populated if the fulfillment is created with this new `Order` version.
	OldState string `json:"old_state,omitempty"`
	// The state of the fulfillment after the change. The state might be equal to `old_state` if a non-state field was changed on the fulfillment (such as the tracking number).
	NewState string `json:"new_state,omitempty"`
}

Information about fulfillment updates.

type OrderLineItem ¶

type OrderLineItem struct {
	// A unique ID that identifies the line item only within this order.
	Uid string `json:"uid,omitempty"`
	// The name of the line item.
	Name string `json:"name,omitempty"`
	// The count, or measurement, of a line item being purchased:  If `quantity` is a whole number, and `quantity_unit` is not specified, then `quantity` denotes an item count.  For example: `3` apples.  If `quantity` is a whole or decimal number, and `quantity_unit` is also specified, then `quantity` denotes a measurement.  For example: `2.25` pounds of broccoli.  For more information, see [Specify item quantity and measurement unit](https://developer.squareup.com/docs/orders-api/create-orders#specify-item-quantity-and-measurement-unit).  Line items with a quantity of `0` are automatically removed when paying for or otherwise completing the order.
	Quantity     string             `json:"quantity"`
	QuantityUnit *OrderQuantityUnit `json:"quantity_unit,omitempty"`
	// An optional note associated with the line item.
	Note string `json:"note,omitempty"`
	// The [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItemVariation) ID applied to this line item.
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The version of the catalog object that this line item references.
	CatalogVersion int64 `json:"catalog_version,omitempty"`
	// The name of the variation applied to this line item.
	VariationName string `json:"variation_name,omitempty"`
	// The type of line item: an itemized sale, a non-itemized sale (custom amount), or the activation or reloading of a gift card.
	ItemType string `json:"item_type,omitempty"`
	// Application-defined data attached to this line item. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details).  Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character.  Values have a maximum length of 255 characters.  An application can have up to 10 entries per metadata field.  Entries written by applications are private and can only be read or modified by the same application.  For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).
	Metadata map[string]string `json:"metadata,omitempty"`
	// The [CatalogModifier](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogModifier)s applied to this line item.
	Modifiers []OrderLineItemModifier `json:"modifiers,omitempty"`
	// The list of references to taxes applied to this line item. Each `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level `OrderLineItemTax` applied to the line item. On reads, the amount applied is populated.  An `OrderLineItemAppliedTax` is automatically created on every line item for all `ORDER` scoped taxes added to the order. `OrderLineItemAppliedTax` records for `LINE_ITEM` scoped taxes must be added in requests for the tax to apply to any line items.  To change the amount of a tax, modify the referenced top-level tax.
	AppliedTaxes []OrderLineItemAppliedTax `json:"applied_taxes,omitempty"`
	// The list of references to discounts applied to this line item. Each `OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level `OrderLineItemDiscounts` applied to the line item. On reads, the amount applied is populated.  An `OrderLineItemAppliedDiscount` is automatically created on every line item for all `ORDER` scoped discounts that are added to the order. `OrderLineItemAppliedDiscount` records for `LINE_ITEM` scoped discounts must be added in requests for the discount to apply to any line items.  To change the amount of a discount, modify the referenced top-level discount.
	AppliedDiscounts []OrderLineItemAppliedDiscount `json:"applied_discounts,omitempty"`
	// The list of references to service charges applied to this line item. Each `OrderLineItemAppliedServiceCharge` has a `service_charge_id` that references the `uid` of a top-level `OrderServiceCharge` applied to the line item. On reads, the amount applied is populated.  To change the amount of a service charge, modify the referenced top-level service charge.
	AppliedServiceCharges    []OrderLineItemAppliedServiceCharge `json:"applied_service_charges,omitempty"`
	BasePriceMoney           *Money                              `json:"base_price_money,omitempty"`
	VariationTotalPriceMoney *Money                              `json:"variation_total_price_money,omitempty"`
	GrossSalesMoney          *Money                              `json:"gross_sales_money,omitempty"`
	TotalTaxMoney            *Money                              `json:"total_tax_money,omitempty"`
	TotalDiscountMoney       *Money                              `json:"total_discount_money,omitempty"`
	TotalMoney               *Money                              `json:"total_money,omitempty"`
	PricingBlocklists        *OrderLineItemPricingBlocklists     `json:"pricing_blocklists,omitempty"`
	TotalServiceChargeMoney  *Money                              `json:"total_service_charge_money,omitempty"`
}

Represents a line item in an order. Each line item describes a different product to purchase, with its own quantity and price details.

type OrderLineItemAppliedDiscount ¶

type OrderLineItemAppliedDiscount struct {
	// A unique ID that identifies the applied discount only within this order.
	Uid string `json:"uid,omitempty"`
	// The `uid` of the discount that the applied discount represents. It must reference a discount present in the `order.discounts` field.  This field is immutable. To change which discounts apply to a line item, you must delete the discount and re-add it as a new `OrderLineItemAppliedDiscount`.
	DiscountUid  string `json:"discount_uid"`
	AppliedMoney *Money `json:"applied_money,omitempty"`
}

Represents an applied portion of a discount to a line item in an order. Order scoped discounts have automatically applied discounts present for each line item. Line-item scoped discounts must have applied discounts added manually for any applicable line items. The corresponding applied money is automatically computed based on participating line items.

type OrderLineItemAppliedServiceCharge ¶

type OrderLineItemAppliedServiceCharge struct {
	// A unique ID that identifies the applied service charge only within this order.
	Uid string `json:"uid,omitempty"`
	// The `uid` of the service charge that the applied service charge represents. It must reference a service charge present in the `order.service_charges` field.  This field is immutable. To change which service charges apply to a line item, delete and add a new `OrderLineItemAppliedServiceCharge`.
	ServiceChargeUid string `json:"service_charge_uid"`
	AppliedMoney     *Money `json:"applied_money,omitempty"`
}

type OrderLineItemAppliedTax ¶

type OrderLineItemAppliedTax struct {
	// A unique ID that identifies the applied tax only within this order.
	Uid string `json:"uid,omitempty"`
	// The `uid` of the tax for which this applied tax represents. It must reference a tax present in the `order.taxes` field.  This field is immutable. To change which taxes apply to a line item, delete and add a new `OrderLineItemAppliedTax`.
	TaxUid       string `json:"tax_uid"`
	AppliedMoney *Money `json:"applied_money,omitempty"`
}

Represents an applied portion of a tax to a line item in an order. Order-scoped taxes automatically include the applied taxes in each line item. Line item taxes must be referenced from any applicable line items. The corresponding applied money is automatically computed, based on the set of participating line items.

type OrderLineItemDiscount ¶

type OrderLineItemDiscount struct {
	// A unique ID that identifies the discount only within this order.
	Uid string `json:"uid,omitempty"`
	// The catalog object ID referencing [CatalogDiscount](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogDiscount).
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The version of the catalog object that this discount references.
	CatalogVersion int64 `json:"catalog_version,omitempty"`
	// The discount's name.
	Name string `json:"name,omitempty"`
	// The type of the discount.  Discounts that do not reference a catalog object ID must have a type of `FIXED_PERCENTAGE` or `FIXED_AMOUNT`.
	Type_ string `json:"type,omitempty"`
	// The percentage of the discount, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%.  `percentage` is not set for amount-based discounts.
	Percentage   string `json:"percentage,omitempty"`
	AmountMoney  *Money `json:"amount_money,omitempty"`
	AppliedMoney *Money `json:"applied_money,omitempty"`
	// Application-defined data attached to this discount. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details).  Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character.  Values have a maximum length of 255 characters.  An application can have up to 10 entries per metadata field.  Entries written by applications are private and can only be read or modified by the same application.  For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).
	Metadata map[string]string `json:"metadata,omitempty"`
	// Indicates the level at which the discount applies. For `ORDER` scoped discounts, Square generates references in `applied_discounts` on all order line items that do not have them. For `LINE_ITEM` scoped discounts, the discount only applies to line items with a discount reference in their `applied_discounts` field.  This field is immutable. To change the scope of a discount, you must delete the discount and re-add it as a new discount.
	Scope string `json:"scope,omitempty"`
	// The reward IDs corresponding to this discount. The application and specification of discounts that have `reward_ids` are completely controlled by the backing criteria corresponding to the reward tiers of the rewards that are added to the order through the Loyalty API. To manually unapply discounts that are the result of added rewards, the rewards must be removed from the order through the Loyalty API.
	RewardIds []string `json:"reward_ids,omitempty"`
	// The object ID of a [pricing rule](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogPricingRule) to be applied automatically to this discount. The specification and application of the discounts, to which a `pricing_rule_id` is assigned, are completely controlled by the corresponding pricing rule.
	PricingRuleId string `json:"pricing_rule_id,omitempty"`
}

Represents a discount that applies to one or more line items in an order. Fixed-amount, order-scoped discounts are distributed across all non-zero line item totals. The amount distributed to each line item is relative to the amount contributed by the item to the order subtotal.

type OrderLineItemDiscountScope ¶

type OrderLineItemDiscountScope string

OrderLineItemDiscountScope : Indicates whether this is a line-item or order-level discount.

const (
	OTHER_DISCOUNT_SCOPE_OrderLineItemDiscountScope OrderLineItemDiscountScope = "OTHER_DISCOUNT_SCOPE"
	LINE_ITEM_OrderLineItemDiscountScope            OrderLineItemDiscountScope = "LINE_ITEM"
	ORDER_OrderLineItemDiscountScope                OrderLineItemDiscountScope = "ORDER"
)

List of OrderLineItemDiscountScope

type OrderLineItemDiscountType ¶

type OrderLineItemDiscountType string

OrderLineItemDiscountType : Indicates how the discount is applied to the associated line item or order.

const (
	UNKNOWN_DISCOUNT_OrderLineItemDiscountType    OrderLineItemDiscountType = "UNKNOWN_DISCOUNT"
	FIXED_PERCENTAGE_OrderLineItemDiscountType    OrderLineItemDiscountType = "FIXED_PERCENTAGE"
	FIXED_AMOUNT_OrderLineItemDiscountType        OrderLineItemDiscountType = "FIXED_AMOUNT"
	VARIABLE_PERCENTAGE_OrderLineItemDiscountType OrderLineItemDiscountType = "VARIABLE_PERCENTAGE"
	VARIABLE_AMOUNT_OrderLineItemDiscountType     OrderLineItemDiscountType = "VARIABLE_AMOUNT"
)

List of OrderLineItemDiscountType

type OrderLineItemItemType ¶

type OrderLineItemItemType string

OrderLineItemItemType : Represents the line item type.

const (
	ITEM_OrderLineItemItemType          OrderLineItemItemType = "ITEM"
	CUSTOM_AMOUNT_OrderLineItemItemType OrderLineItemItemType = "CUSTOM_AMOUNT"
	GIFT_CARD_OrderLineItemItemType     OrderLineItemItemType = "GIFT_CARD"
)

List of OrderLineItemItemType

type OrderLineItemModifier ¶

type OrderLineItemModifier struct {
	// A unique ID that identifies the modifier only within this order.
	Uid string `json:"uid,omitempty"`
	// The catalog object ID referencing [CatalogModifier](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogModifier).
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The version of the catalog object that this modifier references.
	CatalogVersion int64 `json:"catalog_version,omitempty"`
	// The name of the item modifier.
	Name string `json:"name,omitempty"`
	// The quantity of the line item modifier. The modifier quantity can be 0 or more. For example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders this item, the restaurant records the purchase by creating an `Order` object with a line item for a burger. The line item includes a line item modifier: the name is cheese and the quantity is 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses the extra cheese option, the modifier quantity increases to 2. If the buyer does not want any cheese, the modifier quantity is set to 0.
	Quantity        string `json:"quantity,omitempty"`
	BasePriceMoney  *Money `json:"base_price_money,omitempty"`
	TotalPriceMoney *Money `json:"total_price_money,omitempty"`
	// Application-defined data attached to this order. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details).  Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character.  Values have a maximum length of 255 characters.  An application can have up to 10 entries per metadata field.  Entries written by applications are private and can only be read or modified by the same application.  For more information, see  [Metadata](https://developer.squareup.com/docs/build-basics/metadata).
	Metadata map[string]string `json:"metadata,omitempty"`
}

A CatalogModifier(https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogModifier).

type OrderLineItemPricingBlocklists ¶

type OrderLineItemPricingBlocklists struct {
	// A list of discounts blocked from applying to the line item. Discounts can be blocked by the `discount_uid` (for ad hoc discounts) or the `discount_catalog_object_id` (for catalog discounts).
	BlockedDiscounts []OrderLineItemPricingBlocklistsBlockedDiscount `json:"blocked_discounts,omitempty"`
	// A list of taxes blocked from applying to the line item. Taxes can be blocked by the `tax_uid` (for ad hoc taxes) or the `tax_catalog_object_id` (for catalog taxes).
	BlockedTaxes []OrderLineItemPricingBlocklistsBlockedTax `json:"blocked_taxes,omitempty"`
}

Describes pricing adjustments that are blocked from automatic application to a line item. For more information, see [Apply Taxes and Discounts](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts).

type OrderLineItemPricingBlocklistsBlockedDiscount ¶

type OrderLineItemPricingBlocklistsBlockedDiscount struct {
	// A unique ID of the `BlockedDiscount` within the order.
	Uid string `json:"uid,omitempty"`
	// The `uid` of the discount that should be blocked. Use this field to block ad hoc discounts. For catalog discounts, use the `discount_catalog_object_id` field.
	DiscountUid string `json:"discount_uid,omitempty"`
	// The `catalog_object_id` of the discount that should be blocked. Use this field to block catalog discounts. For ad hoc discounts, use the `discount_uid` field.
	DiscountCatalogObjectId string `json:"discount_catalog_object_id,omitempty"`
}

A discount to block from applying to a line item. The discount must be identified by either `discount_uid` or `discount_catalog_object_id`, but not both.

type OrderLineItemPricingBlocklistsBlockedTax ¶

type OrderLineItemPricingBlocklistsBlockedTax struct {
	// A unique ID of the `BlockedTax` within the order.
	Uid string `json:"uid,omitempty"`
	// The `uid` of the tax that should be blocked. Use this field to block ad hoc taxes. For catalog, taxes use the `tax_catalog_object_id` field.
	TaxUid string `json:"tax_uid,omitempty"`
	// The `catalog_object_id` of the tax that should be blocked. Use this field to block catalog taxes. For ad hoc taxes, use the `tax_uid` field.
	TaxCatalogObjectId string `json:"tax_catalog_object_id,omitempty"`
}

A tax to block from applying to a line item. The tax must be identified by either `tax_uid` or `tax_catalog_object_id`, but not both.

type OrderLineItemTax ¶

type OrderLineItemTax struct {
	// A unique ID that identifies the tax only within this order.
	Uid string `json:"uid,omitempty"`
	// The catalog object ID referencing [CatalogTax](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogTax).
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The version of the catalog object that this tax references.
	CatalogVersion int64 `json:"catalog_version,omitempty"`
	// The tax's name.
	Name string `json:"name,omitempty"`
	// Indicates the calculation method used to apply the tax.
	Type_ string `json:"type,omitempty"`
	// The percentage of the tax, as a string representation of a decimal number. For example, a value of `\"7.25\"` corresponds to a percentage of 7.25%.
	Percentage string `json:"percentage,omitempty"`
	// Application-defined data attached to this tax. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details).  Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character.  Values have a maximum length of 255 characters.  An application can have up to 10 entries per metadata field.  Entries written by applications are private and can only be read or modified by the same application.  For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).
	Metadata     map[string]string `json:"metadata,omitempty"`
	AppliedMoney *Money            `json:"applied_money,omitempty"`
	// Indicates the level at which the tax applies. For `ORDER` scoped taxes, Square generates references in `applied_taxes` on all order line items that do not have them. For `LINE_ITEM` scoped taxes, the tax only applies to line items with references in their `applied_taxes` field.  This field is immutable. To change the scope, you must delete the tax and re-add it as a new tax.
	Scope string `json:"scope,omitempty"`
	// Determines whether the tax was automatically applied to the order based on the catalog configuration. For an example, see [Automatically Apply Taxes to an Order](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts/auto-apply-taxes).
	AutoApplied bool `json:"auto_applied,omitempty"`
}

Represents a tax that applies to one or more line item in the order. Fixed-amount, order-scoped taxes are distributed across all non-zero line item totals. The amount distributed to each line item is relative to the amount the item contributes to the order subtotal.

type OrderLineItemTaxScope ¶

type OrderLineItemTaxScope string

OrderLineItemTaxScope : Indicates whether this is a line-item or order-level tax.

const (
	OTHER_TAX_SCOPE_OrderLineItemTaxScope OrderLineItemTaxScope = "OTHER_TAX_SCOPE"
	LINE_ITEM_OrderLineItemTaxScope       OrderLineItemTaxScope = "LINE_ITEM"
	ORDER_OrderLineItemTaxScope           OrderLineItemTaxScope = "ORDER"
)

List of OrderLineItemTaxScope

type OrderLineItemTaxType ¶

type OrderLineItemTaxType string

OrderLineItemTaxType : Indicates how the tax is applied to the associated line item or order.

const (
	UNKNOWN_TAX_OrderLineItemTaxType OrderLineItemTaxType = "UNKNOWN_TAX"
	ADDITIVE_OrderLineItemTaxType    OrderLineItemTaxType = "ADDITIVE"
	INCLUSIVE_OrderLineItemTaxType   OrderLineItemTaxType = "INCLUSIVE"
)

List of OrderLineItemTaxType

type OrderMoneyAmounts ¶

type OrderMoneyAmounts struct {
	TotalMoney         *Money `json:"total_money,omitempty"`
	TaxMoney           *Money `json:"tax_money,omitempty"`
	DiscountMoney      *Money `json:"discount_money,omitempty"`
	TipMoney           *Money `json:"tip_money,omitempty"`
	ServiceChargeMoney *Money `json:"service_charge_money,omitempty"`
}

A collection of various money amounts.

type OrderPricingOptions ¶

type OrderPricingOptions struct {
	// The option to determine whether pricing rule-based discounts are automatically applied to an order.
	AutoApplyDiscounts bool `json:"auto_apply_discounts,omitempty"`
	// The option to determine whether rule-based taxes are automatically applied to an order when the criteria of the corresponding rules are met.
	AutoApplyTaxes bool `json:"auto_apply_taxes,omitempty"`
}

Pricing options for an order. The options affect how the order's price is calculated. They can be used, for example, to apply automatic price adjustments that are based on preconfigured [pricing rules](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogPricingRule).

type OrderQuantityUnit ¶

type OrderQuantityUnit struct {
	MeasurementUnit *MeasurementUnit `json:"measurement_unit,omitempty"`
	// For non-integer quantities, represents the number of digits after the decimal point that are recorded for this quantity.  For example, a precision of 1 allows quantities such as `\"1.0\"` and `\"1.1\"`, but not `\"1.01\"`.  Min: 0. Max: 5.
	Precision int32 `json:"precision,omitempty"`
	// The catalog object ID referencing the [CatalogMeasurementUnit](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogMeasurementUnit).  This field is set when this is a catalog-backed measurement unit.
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The version of the catalog object that this measurement unit references.  This field is set when this is a catalog-backed measurement unit.
	CatalogVersion int64 `json:"catalog_version,omitempty"`
}

Contains the measurement unit for a quantity and a precision that specifies the number of digits after the decimal point for decimal quantities.

type OrderReturn ¶

type OrderReturn struct {
	// A unique ID that identifies the return only within this order.
	Uid string `json:"uid,omitempty"`
	// An order that contains the original sale of these return line items. This is unset for unlinked returns.
	SourceOrderId string `json:"source_order_id,omitempty"`
	// A collection of line items that are being returned.
	ReturnLineItems []OrderReturnLineItem `json:"return_line_items,omitempty"`
	// A collection of service charges that are being returned.
	ReturnServiceCharges []OrderReturnServiceCharge `json:"return_service_charges,omitempty"`
	// A collection of references to taxes being returned for an order, including the total applied tax amount to be returned. The taxes must reference a top-level tax ID from the source order.
	ReturnTaxes []OrderReturnTax `json:"return_taxes,omitempty"`
	// A collection of references to discounts being returned for an order, including the total applied discount amount to be returned. The discounts must reference a top-level discount ID from the source order.
	ReturnDiscounts []OrderReturnDiscount `json:"return_discounts,omitempty"`
	// A collection of references to tips being returned for an order.
	ReturnTips         []OrderReturnTip         `json:"return_tips,omitempty"`
	RoundingAdjustment *OrderRoundingAdjustment `json:"rounding_adjustment,omitempty"`
	ReturnAmounts      *OrderMoneyAmounts       `json:"return_amounts,omitempty"`
}

The set of line items, service charges, taxes, discounts, tips, and other items being returned in an order.

type OrderReturnDiscount ¶

type OrderReturnDiscount struct {
	// A unique ID that identifies the returned discount only within this order.
	Uid string `json:"uid,omitempty"`
	// The discount `uid` from the order that contains the original application of this discount.
	SourceDiscountUid string `json:"source_discount_uid,omitempty"`
	// The catalog object ID referencing [CatalogDiscount](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogDiscount).
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The version of the catalog object that this discount references.
	CatalogVersion int64 `json:"catalog_version,omitempty"`
	// The discount's name.
	Name string `json:"name,omitempty"`
	// The type of the discount. If it is created by the API, it is `FIXED_PERCENTAGE` or `FIXED_AMOUNT`.  Discounts that do not reference a catalog object ID must have a type of `FIXED_PERCENTAGE` or `FIXED_AMOUNT`.
	Type_ string `json:"type,omitempty"`
	// The percentage of the tax, as a string representation of a decimal number. A value of `\"7.25\"` corresponds to a percentage of 7.25%.  `percentage` is not set for amount-based discounts.
	Percentage   string `json:"percentage,omitempty"`
	AmountMoney  *Money `json:"amount_money,omitempty"`
	AppliedMoney *Money `json:"applied_money,omitempty"`
	// Indicates the level at which the `OrderReturnDiscount` applies. For `ORDER` scoped discounts, the server generates references in `applied_discounts` on all `OrderReturnLineItem`s. For `LINE_ITEM` scoped discounts, the discount is only applied to `OrderReturnLineItem`s with references in their `applied_discounts` field.
	Scope string `json:"scope,omitempty"`
}

Represents a discount being returned that applies to one or more return line items in an order. Fixed-amount, order-scoped discounts are distributed across all non-zero return line item totals. The amount distributed to each return line item is relative to that item’s contribution to the order subtotal.

type OrderReturnLineItem ¶

type OrderReturnLineItem struct {
	// A unique ID for this return line-item entry.
	Uid string `json:"uid,omitempty"`
	// The `uid` of the line item in the original sale order.
	SourceLineItemUid string `json:"source_line_item_uid,omitempty"`
	// The name of the line item.
	Name string `json:"name,omitempty"`
	// The quantity returned, formatted as a decimal number. For example, `\"3\"`.  Line items with a `quantity_unit` can have non-integer quantities. For example, `\"1.70000\"`.
	Quantity     string             `json:"quantity"`
	QuantityUnit *OrderQuantityUnit `json:"quantity_unit,omitempty"`
	// The note of the return line item.
	Note string `json:"note,omitempty"`
	// The [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItemVariation) ID applied to this return line item.
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The version of the catalog object that this line item references.
	CatalogVersion int64 `json:"catalog_version,omitempty"`
	// The name of the variation applied to this return line item.
	VariationName string `json:"variation_name,omitempty"`
	// The type of line item: an itemized return, a non-itemized return (custom amount), or the return of an unactivated gift card sale.
	ItemType string `json:"item_type,omitempty"`
	// The [CatalogModifier](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogModifier)s applied to this line item.
	ReturnModifiers []OrderReturnLineItemModifier `json:"return_modifiers,omitempty"`
	// The list of references to `OrderReturnTax` entities applied to the return line item. Each `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level `OrderReturnTax` applied to the return line item. On reads, the applied amount is populated.
	AppliedTaxes []OrderLineItemAppliedTax `json:"applied_taxes,omitempty"`
	// The list of references to `OrderReturnDiscount` entities applied to the return line item. Each `OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level `OrderReturnDiscount` applied to the return line item. On reads, the applied amount is populated.
	AppliedDiscounts         []OrderLineItemAppliedDiscount `json:"applied_discounts,omitempty"`
	BasePriceMoney           *Money                         `json:"base_price_money,omitempty"`
	VariationTotalPriceMoney *Money                         `json:"variation_total_price_money,omitempty"`
	GrossReturnMoney         *Money                         `json:"gross_return_money,omitempty"`
	TotalTaxMoney            *Money                         `json:"total_tax_money,omitempty"`
	TotalDiscountMoney       *Money                         `json:"total_discount_money,omitempty"`
	TotalMoney               *Money                         `json:"total_money,omitempty"`
	// The list of references to `OrderReturnServiceCharge` entities applied to the return line item. Each `OrderLineItemAppliedServiceCharge` has a `service_charge_uid` that references the `uid` of a top-level `OrderReturnServiceCharge` applied to the return line item. On reads, the applied amount is populated.
	AppliedServiceCharges   []OrderLineItemAppliedServiceCharge `json:"applied_service_charges,omitempty"`
	TotalServiceChargeMoney *Money                              `json:"total_service_charge_money,omitempty"`
}

The line item being returned in an order.

type OrderReturnLineItemModifier ¶

type OrderReturnLineItemModifier struct {
	// A unique ID that identifies the return modifier only within this order.
	Uid string `json:"uid,omitempty"`
	// The modifier `uid` from the order's line item that contains the original sale of this line item modifier.
	SourceModifierUid string `json:"source_modifier_uid,omitempty"`
	// The catalog object ID referencing [CatalogModifier](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogModifier).
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The version of the catalog object that this line item modifier references.
	CatalogVersion int64 `json:"catalog_version,omitempty"`
	// The name of the item modifier.
	Name            string `json:"name,omitempty"`
	BasePriceMoney  *Money `json:"base_price_money,omitempty"`
	TotalPriceMoney *Money `json:"total_price_money,omitempty"`
	// The quantity of the line item modifier. The modifier quantity can be 0 or more. For example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders this item, the restaurant records the purchase by creating an `Order` object with a line item for a burger. The line item includes a line item modifier: the name is cheese and the quantity is 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses the extra cheese option, the modifier quantity increases to 2. If the buyer does not want any cheese, the modifier quantity is set to 0.
	Quantity string `json:"quantity,omitempty"`
}

A line item modifier being returned.

type OrderReturnServiceCharge ¶

type OrderReturnServiceCharge struct {
	// A unique ID that identifies the return service charge only within this order.
	Uid string `json:"uid,omitempty"`
	// The service charge `uid` from the order containing the original service charge. `source_service_charge_uid` is `null` for unlinked returns.
	SourceServiceChargeUid string `json:"source_service_charge_uid,omitempty"`
	// The name of the service charge.
	Name string `json:"name,omitempty"`
	// The catalog object ID of the associated [OrderServiceCharge](https://developer.squareup.com/reference/square_2024-07-17/objects/OrderServiceCharge).
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The version of the catalog object that this service charge references.
	CatalogVersion int64 `json:"catalog_version,omitempty"`
	// The percentage of the service charge, as a string representation of a decimal number. For example, a value of `\"7.25\"` corresponds to a percentage of 7.25%.  Either `percentage` or `amount_money` should be set, but not both.
	Percentage    string `json:"percentage,omitempty"`
	AmountMoney   *Money `json:"amount_money,omitempty"`
	AppliedMoney  *Money `json:"applied_money,omitempty"`
	TotalMoney    *Money `json:"total_money,omitempty"`
	TotalTaxMoney *Money `json:"total_tax_money,omitempty"`
	// The calculation phase after which to apply the service charge.
	CalculationPhase string `json:"calculation_phase,omitempty"`
	// Indicates whether the surcharge can be taxed. Service charges calculated in the `TOTAL_PHASE` cannot be marked as taxable.
	Taxable bool `json:"taxable,omitempty"`
	// The list of references to `OrderReturnTax` entities applied to the `OrderReturnServiceCharge`. Each `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level `OrderReturnTax` that is being applied to the `OrderReturnServiceCharge`. On reads, the applied amount is populated.
	AppliedTaxes []OrderLineItemAppliedTax `json:"applied_taxes,omitempty"`
	// The treatment type of the service charge.
	TreatmentType string `json:"treatment_type,omitempty"`
	// Indicates the level at which the apportioned service charge applies. For `ORDER` scoped service charges, Square generates references in `applied_service_charges` on all order line items that do not have them. For `LINE_ITEM` scoped service charges, the service charge only applies to line items with a service charge reference in their `applied_service_charges` field.  This field is immutable. To change the scope of an apportioned service charge, you must delete the apportioned service charge and re-add it as a new apportioned service charge.
	Scope string `json:"scope,omitempty"`
}

Represents the service charge applied to the original order.

type OrderReturnTax ¶

type OrderReturnTax struct {
	// A unique ID that identifies the returned tax only within this order.
	Uid string `json:"uid,omitempty"`
	// The tax `uid` from the order that contains the original tax charge.
	SourceTaxUid string `json:"source_tax_uid,omitempty"`
	// The catalog object ID referencing [CatalogTax](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogTax).
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The version of the catalog object that this tax references.
	CatalogVersion int64 `json:"catalog_version,omitempty"`
	// The tax's name.
	Name string `json:"name,omitempty"`
	// Indicates the calculation method used to apply the tax.
	Type_ string `json:"type,omitempty"`
	// The percentage of the tax, as a string representation of a decimal number. For example, a value of `\"7.25\"` corresponds to a percentage of 7.25%.
	Percentage   string `json:"percentage,omitempty"`
	AppliedMoney *Money `json:"applied_money,omitempty"`
	// Indicates the level at which the `OrderReturnTax` applies. For `ORDER` scoped taxes, Square generates references in `applied_taxes` on all `OrderReturnLineItem`s. For `LINE_ITEM` scoped taxes, the tax is only applied to `OrderReturnLineItem`s with references in their `applied_discounts` field.
	Scope string `json:"scope,omitempty"`
}

Represents a tax being returned that applies to one or more return line items in an order. Fixed-amount, order-scoped taxes are distributed across all non-zero return line item totals. The amount distributed to each return line item is relative to that item’s contribution to the order subtotal.

type OrderReturnTip ¶

type OrderReturnTip struct {
	// A unique ID that identifies the tip only within this order.
	Uid          string `json:"uid,omitempty"`
	AppliedMoney *Money `json:"applied_money,omitempty"`
	// The tender `uid` from the order that contains the original application of this tip.
	SourceTenderUid string `json:"source_tender_uid,omitempty"`
	// The tender `id` from the order that contains the original application of this tip.
	SourceTenderId string `json:"source_tender_id,omitempty"`
}

A tip being returned.

type OrderReward ¶

type OrderReward struct {
	// The identifier of the reward.
	Id string `json:"id"`
	// The identifier of the reward tier corresponding to this reward.
	RewardTierId string `json:"reward_tier_id"`
}

Represents a reward that can be applied to an order if the necessary reward tier criteria are met. Rewards are created through the Loyalty API.

type OrderRoundingAdjustment ¶

type OrderRoundingAdjustment struct {
	// A unique ID that identifies the rounding adjustment only within this order.
	Uid string `json:"uid,omitempty"`
	// The name of the rounding adjustment from the original sale order.
	Name        string `json:"name,omitempty"`
	AmountMoney *Money `json:"amount_money,omitempty"`
}

A rounding adjustment of the money being returned. Commonly used to apply cash rounding when the minimum unit of the account is smaller than the lowest physical denomination of the currency.

type OrderServiceCharge ¶

type OrderServiceCharge struct {
	// A unique ID that identifies the service charge only within this order.
	Uid string `json:"uid,omitempty"`
	// The name of the service charge.
	Name string `json:"name,omitempty"`
	// The catalog object ID referencing the service charge [CatalogObject](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject).
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The version of the catalog object that this service charge references.
	CatalogVersion int64 `json:"catalog_version,omitempty"`
	// The service charge percentage as a string representation of a decimal number. For example, `\"7.25\"` indicates a service charge of 7.25%.  Exactly 1 of `percentage` or `amount_money` should be set.
	Percentage    string `json:"percentage,omitempty"`
	AmountMoney   *Money `json:"amount_money,omitempty"`
	AppliedMoney  *Money `json:"applied_money,omitempty"`
	TotalMoney    *Money `json:"total_money,omitempty"`
	TotalTaxMoney *Money `json:"total_tax_money,omitempty"`
	// The calculation phase at which to apply the service charge.
	CalculationPhase string `json:"calculation_phase,omitempty"`
	// Indicates whether the service charge can be taxed. If set to `true`, order-level taxes automatically apply to the service charge. Note that service charges calculated in the `TOTAL_PHASE` cannot be marked as taxable.
	Taxable bool `json:"taxable,omitempty"`
	// The list of references to the taxes applied to this service charge. Each `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level `OrderLineItemTax` that is being applied to this service charge. On reads, the amount applied is populated.  An `OrderLineItemAppliedTax` is automatically created on every taxable service charge for all `ORDER` scoped taxes that are added to the order. `OrderLineItemAppliedTax` records for `LINE_ITEM` scoped taxes must be added in requests for the tax to apply to any taxable service charge. Taxable service charges have the `taxable` field set to `true` and calculated in the `SUBTOTAL_PHASE`.  To change the amount of a tax, modify the referenced top-level tax.
	AppliedTaxes []OrderLineItemAppliedTax `json:"applied_taxes,omitempty"`
	// Application-defined data attached to this service charge. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details).  Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character.  Values have a maximum length of 255 characters.  An application can have up to 10 entries per metadata field.  Entries written by applications are private and can only be read or modified by the same application.  For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).
	Metadata map[string]string `json:"metadata,omitempty"`
	// The type of the service charge.
	Type_ string `json:"type,omitempty"`
	// The treatment type of the service charge.
	TreatmentType string `json:"treatment_type,omitempty"`
	// Indicates the level at which the apportioned service charge applies. For `ORDER` scoped service charges, Square generates references in `applied_service_charges` on all order line items that do not have them. For `LINE_ITEM` scoped service charges, the service charge only applies to line items with a service charge reference in their `applied_service_charges` field.  This field is immutable. To change the scope of an apportioned service charge, you must delete the apportioned service charge and re-add it as a new apportioned service charge.
	Scope string `json:"scope,omitempty"`
}

Represents a service charge applied to an order.

type OrderServiceChargeCalculationPhase ¶

type OrderServiceChargeCalculationPhase string

OrderServiceChargeCalculationPhase : Represents a phase in the process of calculating order totals. Service charges are applied after the indicated phase. [Read more about how order totals are calculated.](https://developer.squareup.com/docs/orders-api/how-it-works#how-totals-are-calculated)

const (
	SUBTOTAL_PHASE_OrderServiceChargeCalculationPhase               OrderServiceChargeCalculationPhase = "SUBTOTAL_PHASE"
	TOTAL_PHASE_OrderServiceChargeCalculationPhase                  OrderServiceChargeCalculationPhase = "TOTAL_PHASE"
	APPORTIONED_PERCENTAGE_PHASE_OrderServiceChargeCalculationPhase OrderServiceChargeCalculationPhase = "APPORTIONED_PERCENTAGE_PHASE"
	APPORTIONED_AMOUNT_PHASE_OrderServiceChargeCalculationPhase     OrderServiceChargeCalculationPhase = "APPORTIONED_AMOUNT_PHASE"
)

List of OrderServiceChargeCalculationPhase

type OrderServiceChargeScope ¶

type OrderServiceChargeScope string

OrderServiceChargeScope : Indicates whether this is a line-item or order-level apportioned service charge.

const (
	OTHER_SERVICE_CHARGE_SCOPE_OrderServiceChargeScope OrderServiceChargeScope = "OTHER_SERVICE_CHARGE_SCOPE"
	LINE_ITEM_OrderServiceChargeScope                  OrderServiceChargeScope = "LINE_ITEM"
	ORDER_OrderServiceChargeScope                      OrderServiceChargeScope = "ORDER"
)

List of OrderServiceChargeScope

type OrderServiceChargeTreatmentType ¶

type OrderServiceChargeTreatmentType string

OrderServiceChargeTreatmentType : Indicates whether the service charge will be treated as a value-holding line item or apportioned toward a line item.

const (
	LINE_ITEM_TREATMENT_OrderServiceChargeTreatmentType   OrderServiceChargeTreatmentType = "LINE_ITEM_TREATMENT"
	APPORTIONED_TREATMENT_OrderServiceChargeTreatmentType OrderServiceChargeTreatmentType = "APPORTIONED_TREATMENT"
)

List of OrderServiceChargeTreatmentType

type OrderServiceChargeType ¶

type OrderServiceChargeType string

const (
	AUTO_GRATUITY_OrderServiceChargeType OrderServiceChargeType = "AUTO_GRATUITY"
	CUSTOM_OrderServiceChargeType        OrderServiceChargeType = "CUSTOM"
)

List of OrderServiceChargeType

type OrderSource ¶

type OrderSource struct {
	// The name used to identify the place (physical or digital) that an order originates. If unset, the name defaults to the name of the application that created the order.
	Name string `json:"name,omitempty"`
}

Represents the origination details of an order.

type OrderState ¶

type OrderState string

OrderState : The state of the order.

const (
	OPEN_OrderState      OrderState = "OPEN"
	COMPLETED_OrderState OrderState = "COMPLETED"
	CANCELED_OrderState  OrderState = "CANCELED"
	DRAFT_OrderState     OrderState = "DRAFT"
)

List of OrderState

type OrderUpdated ¶

type OrderUpdated struct {
	// The order's unique ID.
	OrderId string `json:"order_id,omitempty"`
	// The version number, which is incremented each time an update is committed to the order. Orders that were not created through the API do not include a version number and therefore cannot be updated.  [Read more about working with versions.](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders)
	Version int32 `json:"version,omitempty"`
	// The ID of the seller location that this order is associated with.
	LocationId string `json:"location_id,omitempty"`
	// The state of the order.
	State string `json:"state,omitempty"`
	// The timestamp for when the order was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp for when the order was last updated, in RFC 3339 format.
	UpdatedAt string `json:"updated_at,omitempty"`
}

type OrderUpdatedObject ¶

type OrderUpdatedObject struct {
	OrderUpdated *OrderUpdated `json:"order_updated,omitempty"`
}

type OrdersApiService ¶

type OrdersApiService service

func (*OrdersApiService) BatchRetrieveOrders ¶

func (a *OrdersApiService) BatchRetrieveOrders(ctx context.Context, body BatchRetrieveOrdersRequest) (BatchRetrieveOrdersResponse, *http.Response, error)

OrdersApiService BatchRetrieveOrders Retrieves a set of [orders](https://developer.squareup.com/reference/square_2024-07-17/objects/Order) by their IDs. If a given order ID does not exist, the ID is ignored instead of generating an error.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BatchRetrieveOrdersResponse

func (*OrdersApiService) CalculateOrder ¶

func (a *OrdersApiService) CalculateOrder(ctx context.Context, body CalculateOrderRequest) (CalculateOrderResponse, *http.Response, error)

OrdersApiService CalculateOrder Enables applications to preview order pricing without creating an order.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CalculateOrderResponse

func (*OrdersApiService) CloneOrder ¶

func (a *OrdersApiService) CloneOrder(ctx context.Context, body CloneOrderRequest) (CloneOrderResponse, *http.Response, error)

OrdersApiService CloneOrder Creates a new order, in the `DRAFT` state, by duplicating an existing order. The newly created order has only the core fields (such as line items, taxes, and discounts) copied from the original order.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CloneOrderResponse

func (*OrdersApiService) CreateOrder ¶

func (a *OrdersApiService) CreateOrder(ctx context.Context, body CreateOrderRequest) (CreateOrderResponse, *http.Response, error)

OrdersApiService CreateOrder Creates a new [order](https://developer.squareup.com/reference/square_2024-07-17/objects/Order) that can include information about products for purchase and settings to apply to the purchase. To pay for a created order, see [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders). You can modify open orders using the [UpdateOrder](https://developer.squareup.com/reference/square_2024-07-17/orders-api/update-order) endpoint.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateOrderResponse

func (*OrdersApiService) PayOrder ¶

func (a *OrdersApiService) PayOrder(ctx context.Context, body PayOrderRequest, orderId string) (PayOrderResponse, *http.Response, error)

OrdersApiService PayOrder Pay for an [order](https://developer.squareup.com/reference/square_2024-07-17/objects/Order) using one or more approved [payments](https://developer.squareup.com/reference/square_2024-07-17/objects/Payment) or settle an order with a total of `0`. The total of the `payment_ids` listed in the request must be equal to the order total. Orders with a total amount of `0` can be marked as paid by specifying an empty array of `payment_ids` in the request. To be used with `PayOrder`, a payment must: - Reference the order by specifying the `order_id` when [creating the payment](https://developer.squareup.com/reference/square_2024-07-17/payments-api/create-payment). Any approved payments that reference the same `order_id` not specified in the `payment_ids` is canceled. - Be approved with [delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture). Using a delayed capture payment with `PayOrder` completes the approved payment.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param orderId The ID of the order being paid.

@return PayOrderResponse

func (*OrdersApiService) RetrieveOrder ¶

func (a *OrdersApiService) RetrieveOrder(ctx context.Context, orderId string) (RetrieveOrderResponse, *http.Response, error)

OrdersApiService RetrieveOrder Retrieves an Order(https://developer.squareup.com/reference/square_2024-07-17/objects/Order) by ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orderId The ID of the order to retrieve.

@return RetrieveOrderResponse

func (*OrdersApiService) SearchOrders ¶

func (a *OrdersApiService) SearchOrders(ctx context.Context, body SearchOrdersRequest) (SearchOrdersResponse, *http.Response, error)

OrdersApiService SearchOrders Search all orders for one or more locations. Orders include all sales, returns, and exchanges regardless of how or when they entered the Square ecosystem (such as Point of Sale, Invoices, and Connect APIs). `SearchOrders` requests need to specify which locations to search and define a SearchOrdersQuery(https://developer.squareup.com/reference/square_2024-07-17/objects/SearchOrdersQuery) object that controls how to sort or filter the results. Your `SearchOrdersQuery` can: Set filter criteria. Set the sort order. Determine whether to return results as complete `Order` objects or as OrderEntry(https://developer.squareup.com/reference/square_2024-07-17/objects/OrderEntry) objects. Note that details for orders processed with Square Point of Sale while in offline mode might not be transmitted to Square for up to 72 hours. Offline orders have a `created_at` value that reflects the time the order was created, not the time it was subsequently transmitted to Square.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return SearchOrdersResponse

func (*OrdersApiService) UpdateOrder ¶

func (a *OrdersApiService) UpdateOrder(ctx context.Context, body UpdateOrderRequest, orderId string) (UpdateOrderResponse, *http.Response, error)

OrdersApiService UpdateOrder Updates an open [order](https://developer.squareup.com/reference/square_2024-07-17/objects/Order) by adding, replacing, or deleting fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated. An `UpdateOrder` request requires the following: - The `order_id` in the endpoint path, identifying the order to update. - The latest `version` of the order to update. - The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects) containing only the fields to update and the version to which the update is being applied. - If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete) identifying the fields to clear. To pay for an order, see [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param orderId The ID of the order to update.

@return UpdateOrderResponse

type PaginationCursor ¶

type PaginationCursor struct {
	// The ID of the last resource in the current page. The page can be in an ascending or descending order
	OrderValue string `json:"order_value,omitempty"`
}

Used *internally* to encapsulate pagination details. The resulting proto will be base62 encoded in order to produce a cursor that can be used externally.

type PauseSubscriptionRequest ¶

type PauseSubscriptionRequest struct {
	// The `YYYY-MM-DD`-formatted date when the scheduled `PAUSE` action takes place on the subscription.  When this date is unspecified or falls within the current billing cycle, the subscription is paused on the starting date of the next billing cycle.
	PauseEffectiveDate string `json:"pause_effective_date,omitempty"`
	// The number of billing cycles the subscription will be paused before it is reactivated.   When this is set, a `RESUME` action is also scheduled to take place on the subscription at  the end of the specified pause cycle duration. In this case, neither `resume_effective_date`  nor `resume_change_timing` may be specified.
	PauseCycleDuration int64 `json:"pause_cycle_duration,omitempty"`
	// The date when the subscription is reactivated by a scheduled `RESUME` action.  This date must be at least one billing cycle ahead of `pause_effective_date`.
	ResumeEffectiveDate string `json:"resume_effective_date,omitempty"`
	// The timing whether the subscription is reactivated immediately or at the end of the billing cycle, relative to  `resume_effective_date`.
	ResumeChangeTiming string `json:"resume_change_timing,omitempty"`
	// The user-provided reason to pause the subscription.
	PauseReason string `json:"pause_reason,omitempty"`
}

Defines input parameters in a request to the [PauseSubscription](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/pause-subscription) endpoint.

type PauseSubscriptionResponse ¶

type PauseSubscriptionResponse struct {
	// Errors encountered during the request.
	Errors       []ModelError  `json:"errors,omitempty"`
	Subscription *Subscription `json:"subscription,omitempty"`
	// The list of a `PAUSE` action and a possible `RESUME` action created by the request.
	Actions []SubscriptionAction `json:"actions,omitempty"`
}

Defines output parameters in a response from the [PauseSubscription](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/pause-subscription) endpoint.

type PayOrderRequest ¶

type PayOrderRequest struct {
	// A value you specify that uniquely identifies this request among requests you have sent. If you are unsure whether a particular payment request was completed successfully, you can reattempt it with the same idempotency key without worrying about duplicate payments.  For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
	IdempotencyKey string `json:"idempotency_key"`
	// The version of the order being paid. If not supplied, the latest version will be paid.
	OrderVersion int32 `json:"order_version,omitempty"`
	// The IDs of the [payments](https://developer.squareup.com/reference/square_2024-07-17/objects/Payment) to collect. The payment total must match the order total.
	PaymentIds []string `json:"payment_ids,omitempty"`
}

Defines the fields that are included in requests to the [PayOrder](https://developer.squareup.com/reference/square_2024-07-17/orders-api/pay-order) endpoint.

type PayOrderResponse ¶

type PayOrderResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	Order  *Order       `json:"order,omitempty"`
}

Defines the fields that are included in the response body of a request to the [PayOrder](https://developer.squareup.com/reference/square_2024-07-17/orders-api/pay-order) endpoint.

type Payment ¶

type Payment struct {
	// A unique ID for the payment.
	Id string `json:"id,omitempty"`
	// The timestamp of when the payment was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp of when the payment was last updated, in RFC 3339 format.
	UpdatedAt     string `json:"updated_at,omitempty"`
	AmountMoney   *Money `json:"amount_money,omitempty"`
	TipMoney      *Money `json:"tip_money,omitempty"`
	TotalMoney    *Money `json:"total_money,omitempty"`
	AppFeeMoney   *Money `json:"app_fee_money,omitempty"`
	ApprovedMoney *Money `json:"approved_money,omitempty"`
	// The processing fees and fee adjustments assessed by Square for this payment.
	ProcessingFee []ProcessingFee `json:"processing_fee,omitempty"`
	RefundedMoney *Money          `json:"refunded_money,omitempty"`
	// Indicates whether the payment is APPROVED, PENDING, COMPLETED, CANCELED, or FAILED.
	Status string `json:"status,omitempty"`
	// The duration of time after the payment's creation when Square automatically applies the `delay_action` to the payment. This automatic `delay_action` applies only to payments that do not reach a terminal state (COMPLETED, CANCELED, or FAILED) before the `delay_duration` time period.  This field is specified as a time duration, in RFC 3339 format.  Notes: This feature is only supported for card payments.  Default:  - Card-present payments: \"PT36H\" (36 hours) from the creation time. - Card-not-present payments: \"P7D\" (7 days) from the creation time.
	DelayDuration string `json:"delay_duration,omitempty"`
	// The action to be applied to the payment when the `delay_duration` has elapsed.  Current values include `CANCEL` and `COMPLETE`.
	DelayAction string `json:"delay_action,omitempty"`
	// The read-only timestamp of when the `delay_action` is automatically applied, in RFC 3339 format.  Note that this field is calculated by summing the payment's `delay_duration` and `created_at` fields. The `created_at` field is generated by Square and might not exactly match the time on your local machine.
	DelayedUntil string `json:"delayed_until,omitempty"`
	// The source type for this payment.  Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `BUY_NOW_PAY_LATER`, `SQUARE_ACCOUNT`, `CASH` and `EXTERNAL`. For information about these payment source types, see [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments).
	SourceType            string                     `json:"source_type,omitempty"`
	CardDetails           *CardPaymentDetails        `json:"card_details,omitempty"`
	CashDetails           *CashPaymentDetails        `json:"cash_details,omitempty"`
	BankAccountDetails    *BankAccountPaymentDetails `json:"bank_account_details,omitempty"`
	ExternalDetails       *ExternalPaymentDetails    `json:"external_details,omitempty"`
	WalletDetails         *DigitalWalletDetails      `json:"wallet_details,omitempty"`
	BuyNowPayLaterDetails *BuyNowPayLaterDetails     `json:"buy_now_pay_later_details,omitempty"`
	SquareAccountDetails  *SquareAccountDetails      `json:"square_account_details,omitempty"`
	// The ID of the location associated with the payment.
	LocationId string `json:"location_id,omitempty"`
	// The ID of the order associated with the payment.
	OrderId string `json:"order_id,omitempty"`
	// An optional ID that associates the payment with an entity in another system.
	ReferenceId string `json:"reference_id,omitempty"`
	// The ID of the customer associated with the payment. If the ID is  not provided in the `CreatePayment` request that was used to create the `Payment`,  Square may use information in the request  (such as the billing and shipping address, email address, and payment source)  to identify a matching customer profile in the Customer Directory.  If found, the profile ID is used. If a profile is not found, the  API attempts to create an  [instant profile](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles).  If the API cannot create an  instant profile (either because the seller has disabled it or the  seller's region prevents creating it), this field remains unset. Note that  this process is asynchronous and it may take some time before a  customer ID is added to the payment.
	CustomerId string `json:"customer_id,omitempty"`
	// __Deprecated__: Use `Payment.team_member_id` instead.  An optional ID of the employee associated with taking the payment.
	EmployeeId string `json:"employee_id,omitempty"`
	// An optional ID of the [TeamMember](https://developer.squareup.com/reference/square_2024-07-17/objects/TeamMember) associated with taking the payment.
	TeamMemberId string `json:"team_member_id,omitempty"`
	// A list of `refund_id`s identifying refunds for the payment.
	RefundIds      []string        `json:"refund_ids,omitempty"`
	RiskEvaluation *RiskEvaluation `json:"risk_evaluation,omitempty"`
	// The buyer's email address.
	BuyerEmailAddress string   `json:"buyer_email_address,omitempty"`
	BillingAddress    *Address `json:"billing_address,omitempty"`
	ShippingAddress   *Address `json:"shipping_address,omitempty"`
	// An optional note to include when creating a payment.
	Note string `json:"note,omitempty"`
	// Additional payment information that gets added to the customer's card statement as part of the statement description.  Note that the `statement_description_identifier` might get truncated on the statement description to fit the required information including the Square identifier (SQ *) and the name of the seller taking the payment.
	StatementDescriptionIdentifier string `json:"statement_description_identifier,omitempty"`
	// Actions that can be performed on this payment: - `EDIT_AMOUNT_UP` - The payment amount can be edited up. - `EDIT_AMOUNT_DOWN` - The payment amount can be edited down. - `EDIT_TIP_AMOUNT_UP` - The tip amount can be edited up. - `EDIT_TIP_AMOUNT_DOWN` - The tip amount can be edited down. - `EDIT_DELAY_ACTION` - The delay_action can be edited.
	Capabilities []string `json:"capabilities,omitempty"`
	// The payment's receipt number. The field is missing if a payment is canceled.
	ReceiptNumber string `json:"receipt_number,omitempty"`
	// The URL for the payment's receipt. The field is only populated for COMPLETED payments.
	ReceiptUrl         string              `json:"receipt_url,omitempty"`
	DeviceDetails      *DeviceDetails      `json:"device_details,omitempty"`
	ApplicationDetails *ApplicationDetails `json:"application_details,omitempty"`
	// Whether or not this payment was taken offline.
	IsOfflinePayment bool `json:"is_offline_payment,omitempty"`
	// Used for optimistic concurrency. This opaque token identifies a specific version of the `Payment` object.
	VersionToken string `json:"version_token,omitempty"`
}

Represents a payment processed by the Square API.

type PaymentBalanceActivityAppFeeRefundDetail ¶

type PaymentBalanceActivityAppFeeRefundDetail struct {
	// The ID of the payment associated with this activity.
	PaymentId string `json:"payment_id,omitempty"`
	// The ID of the refund associated with this activity.
	RefundId string `json:"refund_id,omitempty"`
	// The ID of the location of the merchant associated with the payment refund activity
	LocationId string `json:"location_id,omitempty"`
}

type PaymentBalanceActivityAppFeeRevenueDetail ¶

type PaymentBalanceActivityAppFeeRevenueDetail struct {
	// The ID of the payment associated with this activity.
	PaymentId string `json:"payment_id,omitempty"`
	// The ID of the location of the merchant associated with the payment activity
	LocationId string `json:"location_id,omitempty"`
}

type PaymentBalanceActivityAutomaticSavingsDetail ¶

type PaymentBalanceActivityAutomaticSavingsDetail struct {
	// The ID of the payment associated with this activity.
	PaymentId string `json:"payment_id,omitempty"`
	// The ID of the payout associated with this activity.
	PayoutId string `json:"payout_id,omitempty"`
}

type PaymentBalanceActivityAutomaticSavingsReversedDetail ¶

type PaymentBalanceActivityAutomaticSavingsReversedDetail struct {
	// The ID of the payment associated with this activity.
	PaymentId string `json:"payment_id,omitempty"`
	// The ID of the payout associated with this activity.
	PayoutId string `json:"payout_id,omitempty"`
}

type PaymentBalanceActivityChargeDetail ¶

type PaymentBalanceActivityChargeDetail struct {
	// The ID of the payment associated with this activity.
	PaymentId string `json:"payment_id,omitempty"`
}

type PaymentBalanceActivityDepositFeeDetail ¶

type PaymentBalanceActivityDepositFeeDetail struct {
	// The ID of the payout that triggered this deposit fee activity.
	PayoutId string `json:"payout_id,omitempty"`
}

type PaymentBalanceActivityDisputeDetail ¶

type PaymentBalanceActivityDisputeDetail struct {
	// The ID of the payment associated with this activity.
	PaymentId string `json:"payment_id,omitempty"`
	// The ID of the dispute associated with this activity.
	DisputeId string `json:"dispute_id,omitempty"`
}

type PaymentBalanceActivityFeeDetail ¶

type PaymentBalanceActivityFeeDetail struct {
	// The ID of the payment associated with this activity This will only be populated when a principal LedgerEntryToken is also populated. If the fee is independent (there is no principal LedgerEntryToken) then this will likely not be populated.
	PaymentId string `json:"payment_id,omitempty"`
}

type PaymentBalanceActivityFreeProcessingDetail ¶

type PaymentBalanceActivityFreeProcessingDetail struct {
	// The ID of the payment associated with this activity.
	PaymentId string `json:"payment_id,omitempty"`
}

type PaymentBalanceActivityHoldAdjustmentDetail ¶

type PaymentBalanceActivityHoldAdjustmentDetail struct {
	// The ID of the payment associated with this activity.
	PaymentId string `json:"payment_id,omitempty"`
}

type PaymentBalanceActivityOpenDisputeDetail ¶

type PaymentBalanceActivityOpenDisputeDetail struct {
	// The ID of the payment associated with this activity.
	PaymentId string `json:"payment_id,omitempty"`
	// The ID of the dispute associated with this activity.
	DisputeId string `json:"dispute_id,omitempty"`
}

type PaymentBalanceActivityOtherAdjustmentDetail ¶

type PaymentBalanceActivityOtherAdjustmentDetail struct {
	// The ID of the payment associated with this activity.
	PaymentId string `json:"payment_id,omitempty"`
}

type PaymentBalanceActivityOtherDetail ¶

type PaymentBalanceActivityOtherDetail struct {
	// The ID of the payment associated with this activity.
	PaymentId string `json:"payment_id,omitempty"`
}

type PaymentBalanceActivityRefundDetail ¶

type PaymentBalanceActivityRefundDetail struct {
	// The ID of the payment associated with this activity.
	PaymentId string `json:"payment_id,omitempty"`
	// The ID of the refund associated with this activity.
	RefundId string `json:"refund_id,omitempty"`
}

type PaymentBalanceActivityReleaseAdjustmentDetail ¶

type PaymentBalanceActivityReleaseAdjustmentDetail struct {
	// The ID of the payment associated with this activity.
	PaymentId string `json:"payment_id,omitempty"`
}

type PaymentBalanceActivityReserveHoldDetail ¶

type PaymentBalanceActivityReserveHoldDetail struct {
	// The ID of the payment associated with this activity.
	PaymentId string `json:"payment_id,omitempty"`
}

type PaymentBalanceActivityReserveReleaseDetail ¶

type PaymentBalanceActivityReserveReleaseDetail struct {
	// The ID of the payment associated with this activity.
	PaymentId string `json:"payment_id,omitempty"`
}

type PaymentBalanceActivitySquareCapitalPaymentDetail ¶

type PaymentBalanceActivitySquareCapitalPaymentDetail struct {
	// The ID of the payment associated with this activity.
	PaymentId string `json:"payment_id,omitempty"`
}

type PaymentBalanceActivitySquareCapitalReversedPaymentDetail ¶

type PaymentBalanceActivitySquareCapitalReversedPaymentDetail struct {
	// The ID of the payment associated with this activity.
	PaymentId string `json:"payment_id,omitempty"`
}

type PaymentBalanceActivityTaxOnFeeDetail ¶

type PaymentBalanceActivityTaxOnFeeDetail struct {
	// The ID of the payment associated with this activity.
	PaymentId string `json:"payment_id,omitempty"`
	// The description of the tax rate being applied. For example: \"GST\", \"HST\".
	TaxRateDescription string `json:"tax_rate_description,omitempty"`
}

type PaymentBalanceActivityThirdPartyFeeDetail ¶

type PaymentBalanceActivityThirdPartyFeeDetail struct {
	// The ID of the payment associated with this activity.
	PaymentId string `json:"payment_id,omitempty"`
}

type PaymentBalanceActivityThirdPartyFeeRefundDetail ¶

type PaymentBalanceActivityThirdPartyFeeRefundDetail struct {
	// The ID of the payment associated with this activity.
	PaymentId string `json:"payment_id,omitempty"`
	// The public refund id associated with this activity.
	RefundId string `json:"refund_id,omitempty"`
}

type PaymentLink ¶

type PaymentLink struct {
	// The Square-assigned ID of the payment link.
	Id string `json:"id,omitempty"`
	// The Square-assigned version number, which is incremented each time an update is committed to the payment link.
	Version int32 `json:"version"`
	// The optional description of the `payment_link` object. It is primarily for use by your application and is not used anywhere.
	Description string `json:"description,omitempty"`
	// The ID of the order associated with the payment link.
	OrderId          string            `json:"order_id,omitempty"`
	CheckoutOptions  *CheckoutOptions  `json:"checkout_options,omitempty"`
	PrePopulatedData *PrePopulatedData `json:"pre_populated_data,omitempty"`
	// The shortened URL of the payment link.
	Url string `json:"url,omitempty"`
	// The long URL of the payment link.
	LongUrl string `json:"long_url,omitempty"`
	// The timestamp when the payment link was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp when the payment link was last updated, in RFC 3339 format.
	UpdatedAt string `json:"updated_at,omitempty"`
	// An optional note. After Square processes the payment, this note is added to the resulting `Payment`.
	PaymentNote string `json:"payment_note,omitempty"`
}

type PaymentLinkRelatedResources ¶

type PaymentLinkRelatedResources struct {
	// The order associated with the payment link.
	Orders []Order `json:"orders,omitempty"`
	// The subscription plan associated with the payment link.
	SubscriptionPlans []CatalogObject `json:"subscription_plans,omitempty"`
}

type PaymentOptions ¶

type PaymentOptions struct {
	// Indicates whether the `Payment` objects created from this `TerminalCheckout` are automatically `COMPLETED` or left in an `APPROVED` state for later modification.
	Autocomplete bool `json:"autocomplete,omitempty"`
	// The duration of time after the payment's creation when Square automatically cancels the payment. This automatic cancellation applies only to payments that do not reach a terminal state (COMPLETED or CANCELED) before the `delay_duration` time period.  This parameter should be specified as a time duration, in RFC 3339 format, with a minimum value of 1 minute.  Note: This feature is only supported for card payments. This parameter can only be set for a delayed capture payment (`autocomplete=false`). Default: - Card-present payments: \"PT36H\" (36 hours) from the creation time. - Card-not-present payments: \"P7D\" (7 days) from the creation time.
	DelayDuration string `json:"delay_duration,omitempty"`
	// If set to `true` and charging a Square Gift Card, a payment might be returned with `amount_money` equal to less than what was requested. For example, a request for $20 when charging a Square Gift Card with a balance of $5 results in an APPROVED payment of $5. You might choose to prompt the buyer for an additional payment to cover the remainder or cancel the Gift Card payment.  This field cannot be `true` when `autocomplete = true`. This field cannot be `true` when an `order_id` isn't specified.  For more information, see [Take Partial Payments](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/partial-payments-with-gift-cards).  Default: false
	AcceptPartialAuthorization bool `json:"accept_partial_authorization,omitempty"`
	// The action to be applied to the payment when the delay_duration has elapsed. The action must be CANCEL or COMPLETE.  This parameter can only be set for a delayed capture payment (when `autocomplete` is `false`).
	DelayAction string `json:"delay_action,omitempty"`
}

type PaymentOptionsDelayAction ¶

type PaymentOptionsDelayAction string

PaymentOptionsDelayAction : Describes the action to be applied to a delayed capture payment when the delay_duration has elapsed.

const (
	CANCEL_PaymentOptionsDelayAction   PaymentOptionsDelayAction = "CANCEL"
	COMPLETE_PaymentOptionsDelayAction PaymentOptionsDelayAction = "COMPLETE"
)

List of PaymentOptionsDelayAction

type PaymentRefund ¶

type PaymentRefund struct {
	// The unique ID for this refund, generated by Square.
	Id string `json:"id"`
	// The refund's status: - `PENDING` - Awaiting approval. - `COMPLETED` - Successfully completed. - `REJECTED` - The refund was rejected. - `FAILED` - An error occurred.
	Status string `json:"status,omitempty"`
	// The location ID associated with the payment this refund is attached to.
	LocationId string `json:"location_id,omitempty"`
	// Flag indicating whether or not the refund is linked to an existing payment in Square.
	Unlinked bool `json:"unlinked,omitempty"`
	// The destination type for this refund.  Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `BUY_NOW_PAY_LATER`, `CASH`, `EXTERNAL`, and `SQUARE_ACCOUNT`.
	DestinationType    string              `json:"destination_type,omitempty"`
	DestinationDetails *DestinationDetails `json:"destination_details,omitempty"`
	AmountMoney        *Money              `json:"amount_money"`
	AppFeeMoney        *Money              `json:"app_fee_money,omitempty"`
	// Processing fees and fee adjustments assessed by Square for this refund.
	ProcessingFee []ProcessingFee `json:"processing_fee,omitempty"`
	// The ID of the payment associated with this refund.
	PaymentId string `json:"payment_id,omitempty"`
	// The ID of the order associated with the refund.
	OrderId string `json:"order_id,omitempty"`
	// The reason for the refund.
	Reason string `json:"reason,omitempty"`
	// The timestamp of when the refund was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp of when the refund was last updated, in RFC 3339 format.
	UpdatedAt string `json:"updated_at,omitempty"`
	// An optional ID of the team member associated with taking the payment.
	TeamMemberId string `json:"team_member_id,omitempty"`
}

Represents a refund of a payment made using Square. Contains information about the original payment and the amount of money refunded.

type PaymentsApiListPaymentsOpts ¶

type PaymentsApiListPaymentsOpts struct {
	BeginTime  optional.String
	EndTime    optional.String
	SortOrder  optional.String
	Cursor     optional.String
	LocationId optional.String
	Total      optional.Int64
	Last4      optional.String
	CardBrand  optional.String
	Limit      optional.Int32
}

type PaymentsApiService ¶

type PaymentsApiService service

func (*PaymentsApiService) CancelPayment ¶

func (a *PaymentsApiService) CancelPayment(ctx context.Context, paymentId string) (CancelPaymentResponse, *http.Response, error)

PaymentsApiService CancelPayment Cancels (voids) a payment. You can use this endpoint to cancel a payment with the APPROVED `status`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param paymentId The ID of the payment to cancel.

@return CancelPaymentResponse

func (*PaymentsApiService) CancelPaymentByIdempotencyKey ¶

func (a *PaymentsApiService) CancelPaymentByIdempotencyKey(ctx context.Context, body CancelPaymentByIdempotencyKeyRequest) (CancelPaymentByIdempotencyKeyResponse, *http.Response, error)

PaymentsApiService CancelPaymentByIdempotencyKey Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when the status of a `CreatePayment` request is unknown (for example, after you send a `CreatePayment` request, a network error occurs and you do not get a response). In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your `CreatePayment` request that you want to cancel. After canceling the payment, you can submit your `CreatePayment` request again. Note that if no payment with the specified idempotency key is found, no action is taken and the endpoint returns successfully.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CancelPaymentByIdempotencyKeyResponse

func (*PaymentsApiService) CompletePayment ¶

func (a *PaymentsApiService) CompletePayment(ctx context.Context, body CompletePaymentRequest, paymentId string) (CompletePaymentResponse, *http.Response, error)

PaymentsApiService CompletePayment Completes (captures) a payment. By default, payments are set to complete immediately after they are created. You can use this endpoint to complete a payment with the APPROVED `status`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param paymentId The unique ID identifying the payment to be completed.

@return CompletePaymentResponse

func (*PaymentsApiService) CreatePayment ¶

func (a *PaymentsApiService) CreatePayment(ctx context.Context, body CreatePaymentRequest) (CreatePaymentResponse, *http.Response, error)

PaymentsApiService CreatePayment Creates a payment using the provided source. You can use this endpoint to charge a card (credit/debit card or Square gift card) or record a payment that the seller received outside of Square (cash payment from a buyer or a payment that an external entity processed on behalf of the seller). The endpoint creates a `Payment` object and returns it in the response.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreatePaymentResponse

func (*PaymentsApiService) GetPayment ¶

func (a *PaymentsApiService) GetPayment(ctx context.Context, paymentId string) (GetPaymentResponse, *http.Response, error)

PaymentsApiService GetPayment Retrieves details for a specific payment.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param paymentId A unique ID for the desired payment.

@return GetPaymentResponse

func (*PaymentsApiService) ListPayments ¶

func (a *PaymentsApiService) ListPayments(ctx context.Context, localVarOptionals *PaymentsApiListPaymentsOpts) (ListPaymentsResponse, *http.Response, error)

func (*PaymentsApiService) UpdatePayment ¶

func (a *PaymentsApiService) UpdatePayment(ctx context.Context, body UpdatePaymentRequest, paymentId string) (UpdatePaymentResponse, *http.Response, error)

PaymentsApiService UpdatePayment Updates a payment with the APPROVED status. You can update the `amount_money` and `tip_money` using this endpoint.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param paymentId The ID of the payment to update.

@return UpdatePaymentResponse

type Payout ¶

type Payout struct {
	// A unique ID for the payout.
	Id string `json:"id"`
	// Indicates the payout status.
	Status string `json:"status,omitempty"`
	// The ID of the location associated with the payout.
	LocationId string `json:"location_id"`
	// The timestamp of when the payout was created and submitted for deposit to the seller's banking destination, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp of when the payout was last updated, in RFC 3339 format.
	UpdatedAt   string       `json:"updated_at,omitempty"`
	AmountMoney *Money       `json:"amount_money,omitempty"`
	Destination *Destination `json:"destination,omitempty"`
	// The version number, which is incremented each time an update is made to this payout record. The version number helps developers receive event notifications or feeds out of order.
	Version int32 `json:"version,omitempty"`
	// Indicates the payout type.
	Type_ string `json:"type,omitempty"`
	// A list of transfer fees and any taxes on the fees assessed by Square for this payout.
	PayoutFee []PayoutFee `json:"payout_fee,omitempty"`
	// The calendar date, in ISO 8601 format (YYYY-MM-DD), when the payout is due to arrive in the seller’s banking destination.
	ArrivalDate string `json:"arrival_date,omitempty"`
	// A unique ID for each `Payout` object that might also appear on the seller’s bank statement. You can use this ID to automate the process of reconciling each payout with the corresponding line item on the bank statement.
	EndToEndId string `json:"end_to_end_id,omitempty"`
}

An accounting of the amount owed the seller and record of the actual transfer to their external bank account or to the Square balance.

type PayoutEntry ¶

type PayoutEntry struct {
	// A unique ID for the payout entry.
	Id string `json:"id"`
	// The ID of the payout entries’ associated payout.
	PayoutId string `json:"payout_id"`
	// The timestamp of when the payout entry affected the balance, in RFC 3339 format.
	EffectiveAt string `json:"effective_at,omitempty"`
	// The type of activity associated with this payout entry.
	Type_                                   string                                                    `json:"type,omitempty"`
	GrossAmountMoney                        *Money                                                    `json:"gross_amount_money,omitempty"`
	FeeAmountMoney                          *Money                                                    `json:"fee_amount_money,omitempty"`
	NetAmountMoney                          *Money                                                    `json:"net_amount_money,omitempty"`
	TypeAppFeeRevenueDetails                *PaymentBalanceActivityAppFeeRevenueDetail                `json:"type_app_fee_revenue_details,omitempty"`
	TypeAppFeeRefundDetails                 *PaymentBalanceActivityAppFeeRefundDetail                 `json:"type_app_fee_refund_details,omitempty"`
	TypeAutomaticSavingsDetails             *PaymentBalanceActivityAutomaticSavingsDetail             `json:"type_automatic_savings_details,omitempty"`
	TypeAutomaticSavingsReversedDetails     *PaymentBalanceActivityAutomaticSavingsReversedDetail     `json:"type_automatic_savings_reversed_details,omitempty"`
	TypeChargeDetails                       *PaymentBalanceActivityChargeDetail                       `json:"type_charge_details,omitempty"`
	TypeDepositFeeDetails                   *PaymentBalanceActivityDepositFeeDetail                   `json:"type_deposit_fee_details,omitempty"`
	TypeDisputeDetails                      *PaymentBalanceActivityDisputeDetail                      `json:"type_dispute_details,omitempty"`
	TypeFeeDetails                          *PaymentBalanceActivityFeeDetail                          `json:"type_fee_details,omitempty"`
	TypeFreeProcessingDetails               *PaymentBalanceActivityFreeProcessingDetail               `json:"type_free_processing_details,omitempty"`
	TypeHoldAdjustmentDetails               *PaymentBalanceActivityHoldAdjustmentDetail               `json:"type_hold_adjustment_details,omitempty"`
	TypeOpenDisputeDetails                  *PaymentBalanceActivityOpenDisputeDetail                  `json:"type_open_dispute_details,omitempty"`
	TypeOtherDetails                        *PaymentBalanceActivityOtherDetail                        `json:"type_other_details,omitempty"`
	TypeOtherAdjustmentDetails              *PaymentBalanceActivityOtherAdjustmentDetail              `json:"type_other_adjustment_details,omitempty"`
	TypeRefundDetails                       *PaymentBalanceActivityRefundDetail                       `json:"type_refund_details,omitempty"`
	TypeReleaseAdjustmentDetails            *PaymentBalanceActivityReleaseAdjustmentDetail            `json:"type_release_adjustment_details,omitempty"`
	TypeReserveHoldDetails                  *PaymentBalanceActivityReserveHoldDetail                  `json:"type_reserve_hold_details,omitempty"`
	TypeReserveReleaseDetails               *PaymentBalanceActivityReserveReleaseDetail               `json:"type_reserve_release_details,omitempty"`
	TypeSquareCapitalPaymentDetails         *PaymentBalanceActivitySquareCapitalPaymentDetail         `json:"type_square_capital_payment_details,omitempty"`
	TypeSquareCapitalReversedPaymentDetails *PaymentBalanceActivitySquareCapitalReversedPaymentDetail `json:"type_square_capital_reversed_payment_details,omitempty"`
	TypeTaxOnFeeDetails                     *PaymentBalanceActivityTaxOnFeeDetail                     `json:"type_tax_on_fee_details,omitempty"`
	TypeThirdPartyFeeDetails                *PaymentBalanceActivityThirdPartyFeeDetail                `json:"type_third_party_fee_details,omitempty"`
	TypeThirdPartyFeeRefundDetails          *PaymentBalanceActivityThirdPartyFeeRefundDetail          `json:"type_third_party_fee_refund_details,omitempty"`
}

One or more PayoutEntries that make up a Payout. Each one has a date, amount, and type of activity. The total amount of the payout will equal the sum of the payout entries for a batch payout

type PayoutFee ¶

type PayoutFee struct {
	AmountMoney *Money `json:"amount_money,omitempty"`
	// The timestamp of when the fee takes effect, in RFC 3339 format.
	EffectiveAt string `json:"effective_at,omitempty"`
	// The type of fee assessed as part of the payout.
	Type_ string `json:"type,omitempty"`
}

Represents a payout fee that can incur as part of a payout.

type PayoutFeeType ¶

type PayoutFeeType string

PayoutFeeType : Represents the type of payout fee that can incur as part of a payout.

const (
	TRANSFER_FEE_PayoutFeeType        PayoutFeeType = "TRANSFER_FEE"
	TAX_ON_TRANSFER_FEE_PayoutFeeType PayoutFeeType = "TAX_ON_TRANSFER_FEE"
)

List of PayoutFeeType

type PayoutStatus ¶

type PayoutStatus string

PayoutStatus : Payout status types

const (
	SENT_PayoutStatus   PayoutStatus = "SENT"
	FAILED_PayoutStatus PayoutStatus = "FAILED"
	PAID_PayoutStatus   PayoutStatus = "PAID"
)

List of PayoutStatus

type PayoutType ¶

type PayoutType string

PayoutType : The type of payout: “BATCH” or “SIMPLE”. BATCH payouts include a list of payout entries that can be considered settled. SIMPLE payouts do not have any payout entries associated with them and will show up as one of the payout entries in a future BATCH payout.

const (
	BATCH_PayoutType  PayoutType = "BATCH"
	SIMPLE_PayoutType PayoutType = "SIMPLE"
)

List of PayoutType

type PayoutsApiListPayoutEntriesOpts ¶

type PayoutsApiListPayoutEntriesOpts struct {
	SortOrder optional.String
	Cursor    optional.String
	Limit     optional.Int32
}

type PayoutsApiListPayoutsOpts ¶

type PayoutsApiListPayoutsOpts struct {
	LocationId optional.String
	Status     optional.String
	BeginTime  optional.String
	EndTime    optional.String
	SortOrder  optional.String
	Cursor     optional.String
	Limit      optional.Int32
}

type PayoutsApiService ¶

type PayoutsApiService service

func (*PayoutsApiService) GetPayout ¶

func (a *PayoutsApiService) GetPayout(ctx context.Context, payoutId string) (GetPayoutResponse, *http.Response, error)

PayoutsApiService GetPayout Retrieves details of a specific payout identified by a payout ID. To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param payoutId The ID of the payout to retrieve the information for.

@return GetPayoutResponse

func (*PayoutsApiService) ListPayoutEntries ¶

func (a *PayoutsApiService) ListPayoutEntries(ctx context.Context, payoutId string, localVarOptionals *PayoutsApiListPayoutEntriesOpts) (ListPayoutEntriesResponse, *http.Response, error)

func (*PayoutsApiService) ListPayouts ¶

func (a *PayoutsApiService) ListPayouts(ctx context.Context, localVarOptionals *PayoutsApiListPayoutsOpts) (ListPayoutsResponse, *http.Response, error)

type Phase ¶

type Phase struct {
	// id of subscription phase
	Uid string `json:"uid,omitempty"`
	// index of phase in total subscription plan
	Ordinal int64 `json:"ordinal,omitempty"`
	// id of order to be used in billing
	OrderTemplateId string `json:"order_template_id,omitempty"`
	// the uid from the plan's phase in catalog
	PlanPhaseUid string `json:"plan_phase_uid,omitempty"`
}

Represents a phase, which can override subscription phases as defined by plan_id

type PhaseInput ¶

type PhaseInput struct {
	// index of phase in total subscription plan
	Ordinal int64 `json:"ordinal"`
	// id of order to be used in billing
	OrderTemplateId string `json:"order_template_id,omitempty"`
}

Represents the arguments used to construct a new phase.

type PrePopulatedData ¶

type PrePopulatedData struct {
	// The buyer email to prepopulate in the payment form.
	BuyerEmail string `json:"buyer_email,omitempty"`
	// The buyer phone number to prepopulate in the payment form.
	BuyerPhoneNumber string   `json:"buyer_phone_number,omitempty"`
	BuyerAddress     *Address `json:"buyer_address,omitempty"`
}

Describes buyer data to prepopulate in the payment form. For more information, see [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations).

type ProcessingFee ¶

type ProcessingFee struct {
	// The timestamp of when the fee takes effect, in RFC 3339 format.
	EffectiveAt string `json:"effective_at,omitempty"`
	// The type of fee assessed or adjusted. The fee type can be `INITIAL` or `ADJUSTMENT`.
	Type_       string `json:"type,omitempty"`
	AmountMoney *Money `json:"amount_money,omitempty"`
}

Represents the Square processing fee.

type Product ¶

type Product string

Product : Indicates the Square product used to generate a change.

const (
	SQUARE_POS_Product          Product = "SQUARE_POS"
	EXTERNAL_API_Product        Product = "EXTERNAL_API"
	BILLING_Product             Product = "BILLING"
	APPOINTMENTS_Product        Product = "APPOINTMENTS"
	INVOICES_Product            Product = "INVOICES"
	ONLINE_STORE_Product        Product = "ONLINE_STORE"
	PAYROLL_Product             Product = "PAYROLL"
	DASHBOARD_Product           Product = "DASHBOARD"
	ITEM_LIBRARY_IMPORT_Product Product = "ITEM_LIBRARY_IMPORT"
	OTHER_Product               Product = "OTHER"
)

List of Product

type ProductType ¶

type ProductType string

const (
	TERMINAL_API_ProductType ProductType = "TERMINAL_API"
)

List of ProductType

type PublishInvoiceRequest ¶

type PublishInvoiceRequest struct {
	// The version of the [invoice](https://developer.squareup.com/reference/square_2024-07-17/objects/Invoice) to publish. This must match the current version of the invoice; otherwise, the request is rejected.
	Version int32 `json:"version"`
	// A unique string that identifies the `PublishInvoice` request. If you do not  provide `idempotency_key` (or provide an empty string as the value), the endpoint  treats each request as independent.  For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Describes a `PublishInvoice` request.

type PublishInvoiceResponse ¶

type PublishInvoiceResponse struct {
	Invoice *Invoice `json:"invoice,omitempty"`
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Describes a `PublishInvoice` response.

type QrCodeOptions ¶

type QrCodeOptions struct {
	// The title text to display in the QR code flow on the Terminal.
	Title string `json:"title"`
	// The body text to display in the QR code flow on the Terminal.
	Body string `json:"body"`
	// The text representation of the data to show in the QR code as UTF8-encoded data.
	BarcodeContents string `json:"barcode_contents"`
}

Fields to describe the action that displays QR-Codes.

type QuantityRatio ¶

type QuantityRatio struct {
	// The whole or fractional quantity as the numerator.
	Quantity int32 `json:"quantity,omitempty"`
	// The whole or fractional quantity as the denominator. With fractional quantity this field is the denominator and quantity is the numerator. The default value is `1`. For example, when `quantity=3` and `quantity_denominator` is unspecified, the quantity ratio is `3` or `3/1`.
	QuantityDenominator int32 `json:"quantity_denominator,omitempty"`
}

A whole number or unreduced fractional ratio.

type QuickPay ¶

type QuickPay struct {
	// The ad hoc item name. In the resulting `Order`, this name appears as the line item name.
	Name       string `json:"name"`
	PriceMoney *Money `json:"price_money"`
	// The ID of the business location the checkout is associated with.
	LocationId string `json:"location_id"`
}

Describes an ad hoc item and price to generate a quick pay checkout link. For more information, see [Quick Pay Checkout](https://developer.squareup.com/docs/checkout-api/quick-pay-checkout).

type ReceiptOptions ¶

type ReceiptOptions struct {
	// The reference to the Square payment ID for the receipt.
	PaymentId string `json:"payment_id"`
	// Instructs the device to print the receipt without displaying the receipt selection screen. Requires `printer_enabled` set to true. Defaults to false.
	PrintOnly bool `json:"print_only,omitempty"`
	// Identify the receipt as a reprint rather than an original receipt. Defaults to false.
	IsDuplicate bool `json:"is_duplicate,omitempty"`
}

Describes receipt action fields.

type RedeemLoyaltyRewardRequest ¶

type RedeemLoyaltyRewardRequest struct {
	// A unique string that identifies this `RedeemLoyaltyReward` request.  Keys can be any valid string, but must be unique for every request.
	IdempotencyKey string `json:"idempotency_key"`
	// The ID of the [location](https://developer.squareup.com/reference/square_2024-07-17/objects/Location) where the reward is redeemed.
	LocationId string `json:"location_id"`
}

A request to redeem a loyalty reward.

type RedeemLoyaltyRewardResponse ¶

type RedeemLoyaltyRewardResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError  `json:"errors,omitempty"`
	Event  *LoyaltyEvent `json:"event,omitempty"`
}

A response that includes the `LoyaltyEvent` published for redeeming the reward.

type Refund ¶

type Refund struct {
	// The refund's unique ID.
	Id string `json:"id"`
	// The ID of the refund's associated location.
	LocationId string `json:"location_id"`
	// The ID of the transaction that the refunded tender is part of.
	TransactionId string `json:"transaction_id,omitempty"`
	// The ID of the refunded tender.
	TenderId string `json:"tender_id"`
	// The timestamp for when the refund was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The reason for the refund being issued.
	Reason      string `json:"reason"`
	AmountMoney *Money `json:"amount_money"`
	// The current status of the refund (`PENDING`, `APPROVED`, `REJECTED`, or `FAILED`).
	Status             string `json:"status"`
	ProcessingFeeMoney *Money `json:"processing_fee_money,omitempty"`
	// Additional recipients (other than the merchant) receiving a portion of this refund. For example, fees assessed on a refund of a purchase by a third party integration.
	AdditionalRecipients []AdditionalRecipient `json:"additional_recipients,omitempty"`
}

Represents a refund processed for a Square transaction.

type RefundPaymentRequest ¶

type RefundPaymentRequest struct {
	//  A unique string that identifies this `RefundPayment` request. The key can be any valid string but must be unique for every `RefundPayment` request.  Keys are limited to a max of 45 characters - however, the number of allowed characters might be less than 45, if multi-byte characters are used.  For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
	IdempotencyKey string `json:"idempotency_key"`
	AmountMoney    *Money `json:"amount_money"`
	AppFeeMoney    *Money `json:"app_fee_money,omitempty"`
	// The unique ID of the payment being refunded. Required when unlinked=false, otherwise must not be set.
	PaymentId string `json:"payment_id,omitempty"`
	// The ID indicating where funds will be refunded to, if this is an unlinked refund. This can be any of the following: A token generated by Web Payments SDK; a card-on-file identifier. Required for requests specifying unlinked=true. Otherwise, if included when `unlinked=false`, will throw an error.
	DestinationId string `json:"destination_id,omitempty"`
	// Indicates that the refund is not linked to a Square payment. If set to true, `destination_id` and `location_id` must be supplied while `payment_id` must not be provided.
	Unlinked bool `json:"unlinked,omitempty"`
	// The location ID associated with the unlinked refund. Required for requests specifying `unlinked=true`. Otherwise, if included when `unlinked=false`, will throw an error.
	LocationId string `json:"location_id,omitempty"`
	// The [Customer](https://developer.squareup.com/reference/square_2024-07-17/objects/Customer) ID of the customer associated with the refund. This is required if the `destination_id` refers to a card on file created using the Cards API. Only allowed when `unlinked=true`.
	CustomerId string `json:"customer_id,omitempty"`
	// A description of the reason for the refund.
	Reason string `json:"reason,omitempty"`
	//  Used for optimistic concurrency. This opaque token identifies the current `Payment` version that the caller expects. If the server has a different version of the Payment, the update fails and a response with a VERSION_MISMATCH error is returned. If the versions match, or the field is not provided, the refund proceeds as normal.
	PaymentVersionToken string `json:"payment_version_token,omitempty"`
	// An optional [TeamMember](https://developer.squareup.com/reference/square_2024-07-17/objects/TeamMember) ID to associate with this refund.
	TeamMemberId string `json:"team_member_id,omitempty"`
}

Describes a request to refund a payment using [RefundPayment](https://developer.squareup.com/reference/square_2024-07-17/refunds-api/refund-payment).

type RefundPaymentResponse ¶

type RefundPaymentResponse struct {
	// Information about errors encountered during the request.
	Errors []ModelError   `json:"errors,omitempty"`
	Refund *PaymentRefund `json:"refund,omitempty"`
}

Defines the response returned by [RefundPayment](https://developer.squareup.com/reference/square_2024-07-17/refunds-api/refund-payment). If there are errors processing the request, the `refund` field might not be present, or it might be present with a status of `FAILED`.

type RefundStatus ¶

type RefundStatus string

RefundStatus : Indicates a refund's current status.

const (
	PENDING_RefundStatus  RefundStatus = "PENDING"
	APPROVED_RefundStatus RefundStatus = "APPROVED"
	REJECTED_RefundStatus RefundStatus = "REJECTED"
	FAILED_RefundStatus   RefundStatus = "FAILED"
)

List of RefundStatus

type RefundsApiListPaymentRefundsOpts ¶

type RefundsApiListPaymentRefundsOpts struct {
	BeginTime  optional.String
	EndTime    optional.String
	SortOrder  optional.String
	Cursor     optional.String
	LocationId optional.String
	Status     optional.String
	SourceType optional.String
	Limit      optional.Int32
}

type RefundsApiService ¶

type RefundsApiService service

func (*RefundsApiService) GetPaymentRefund ¶

func (a *RefundsApiService) GetPaymentRefund(ctx context.Context, refundId string) (GetPaymentRefundResponse, *http.Response, error)

RefundsApiService GetPaymentRefund Retrieves a specific refund using the `refund_id`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param refundId The unique ID for the desired `PaymentRefund`.

@return GetPaymentRefundResponse

func (*RefundsApiService) ListPaymentRefunds ¶

func (a *RefundsApiService) ListPaymentRefunds(ctx context.Context, localVarOptionals *RefundsApiListPaymentRefundsOpts) (ListPaymentRefundsResponse, *http.Response, error)

func (*RefundsApiService) RefundPayment ¶

func (a *RefundsApiService) RefundPayment(ctx context.Context, body RefundPaymentRequest) (RefundPaymentResponse, *http.Response, error)

RefundsApiService RefundPayment Refunds a payment. You can refund the entire payment amount or a portion of it. You can use this endpoint to refund a card payment or record a refund of a cash or external payment. For more information, see [Refund Payment](https://developer.squareup.com/docs/payments-api/refund-payments).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return RefundPaymentResponse

type RegisterDomainRequest ¶

type RegisterDomainRequest struct {
	// A domain name as described in RFC-1034 that will be registered with ApplePay.
	DomainName string `json:"domain_name"`
}

Defines the parameters that can be included in the body of a request to the [RegisterDomain](https://developer.squareup.com/reference/square_2024-07-17/apple-pay-api/register-domain) endpoint.

type RegisterDomainResponse ¶

type RegisterDomainResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The status of the domain registration.  See [RegisterDomainResponseStatus](https://developer.squareup.com/reference/square_2024-07-17/enums/RegisterDomainResponseStatus) for possible values.
	Status string `json:"status,omitempty"`
}

Defines the fields that are included in the response body of a request to the [RegisterDomain](https://developer.squareup.com/reference/square_2024-07-17/apple-pay-api/register-domain) endpoint. Either `errors` or `status` are present in a given response (never both).

type RegisterDomainResponseStatus ¶

type RegisterDomainResponseStatus string

RegisterDomainResponseStatus : The status of the domain registration.

const (
	PENDING_RegisterDomainResponseStatus  RegisterDomainResponseStatus = "PENDING"
	VERIFIED_RegisterDomainResponseStatus RegisterDomainResponseStatus = "VERIFIED"
)

List of RegisterDomainResponseStatus

type RemoveGroupFromCustomerRequest ¶

type RemoveGroupFromCustomerRequest struct{}

Defines the fields that are included in the request body of a request to the [RemoveGroupFromCustomer](https://developer.squareup.com/reference/square_2024-07-17/customers-api/remove-group-from-customer) endpoint.

type RemoveGroupFromCustomerResponse ¶

type RemoveGroupFromCustomerResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields that are included in the response body of a request to the [RemoveGroupFromCustomer](https://developer.squareup.com/reference/square_2024-07-17/customers-api/remove-group-from-customer) endpoint.

type ResumeSubscriptionRequest ¶

type ResumeSubscriptionRequest struct {
	// The `YYYY-MM-DD`-formatted date when the subscription reactivated.
	ResumeEffectiveDate string `json:"resume_effective_date,omitempty"`
	// The timing to resume a subscription, relative to the specified `resume_effective_date` attribute value.
	ResumeChangeTiming string `json:"resume_change_timing,omitempty"`
}

Defines input parameters in a request to the [ResumeSubscription](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/resume-subscription) endpoint.

type ResumeSubscriptionResponse ¶

type ResumeSubscriptionResponse struct {
	// Errors encountered during the request.
	Errors       []ModelError  `json:"errors,omitempty"`
	Subscription *Subscription `json:"subscription,omitempty"`
	// A list of `RESUME` actions created by the request and scheduled for the subscription.
	Actions []SubscriptionAction `json:"actions,omitempty"`
}

Defines output parameters in a response from the [ResumeSubscription](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/resume-subscription) endpoint.

type RetrieveBookingCustomAttributeDefinitionRequest ¶

type RetrieveBookingCustomAttributeDefinitionRequest struct {
	// The current version of the custom attribute definition, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. When included in the request, Square returns the specified version or a higher version if one exists. If the specified version is higher than the current version, Square returns a `BAD_REQUEST` error.
	Version int32 `json:"version,omitempty"`
}

Represents a [RetrieveBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/retrieve-booking-custom-attribute-definition) request.

type RetrieveBookingCustomAttributeDefinitionResponse ¶

type RetrieveBookingCustomAttributeDefinitionResponse struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [RetrieveBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/retrieve-booking-custom-attribute-definition) response. Either `custom_attribute_definition` or `errors` is present in the response.

type RetrieveBookingCustomAttributeRequest ¶

type RetrieveBookingCustomAttributeRequest struct {
	// Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttributeDefinition) in the `definition` field of the custom attribute. Set this parameter to `true` to get the name and description of the custom attribute, information about the data type, or other definition details. The default value is `false`.
	WithDefinition bool `json:"with_definition,omitempty"`
	// The current version of the custom attribute, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. When included in the request, Square returns the specified version or a higher version if one exists. If the specified version is higher than the current version, Square returns a `BAD_REQUEST` error.
	Version int32 `json:"version,omitempty"`
}

Represents a [RetrieveBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/retrieve-booking-custom-attribute) request.

type RetrieveBookingCustomAttributeResponse ¶

type RetrieveBookingCustomAttributeResponse struct {
	CustomAttribute *CustomAttribute `json:"custom_attribute,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [RetrieveBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/retrieve-booking-custom-attribute) response. Either `custom_attribute_definition` or `errors` is present in the response.

type RetrieveBookingRequest ¶

type RetrieveBookingRequest struct{}

type RetrieveBookingResponse ¶

type RetrieveBookingResponse struct {
	Booking *Booking `json:"booking,omitempty"`
	// Errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type RetrieveBusinessBookingProfileRequest ¶

type RetrieveBusinessBookingProfileRequest struct{}

type RetrieveBusinessBookingProfileResponse ¶

type RetrieveBusinessBookingProfileResponse struct {
	BusinessBookingProfile *BusinessBookingProfile `json:"business_booking_profile,omitempty"`
	// Errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type RetrieveCardRequest ¶

type RetrieveCardRequest struct{}

Retrieves details for a specific Card. Accessible via HTTP requests at GET https://connect.squareup.com/v2/cards/{card_id}

type RetrieveCardResponse ¶

type RetrieveCardResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	Card   *Card        `json:"card,omitempty"`
}

Defines the fields that are included in the response body of a request to the [RetrieveCard](https://developer.squareup.com/reference/square_2024-07-17/cards-api/retrieve-card) endpoint. Note: if there are errors processing the request, the card field will not be present.

type RetrieveCashDrawerShiftRequest ¶

type RetrieveCashDrawerShiftRequest struct {
	// The ID of the location to retrieve cash drawer shifts from.
	LocationId string `json:"location_id"`
}

type RetrieveCashDrawerShiftResponse ¶

type RetrieveCashDrawerShiftResponse struct {
	CashDrawerShift *CashDrawerShift `json:"cash_drawer_shift,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type RetrieveCatalogObjectRequest ¶

type RetrieveCatalogObjectRequest struct {
	// If `true`, the response will include additional objects that are related to the requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field of the response. These objects are put in the `related_objects` field. Setting this to `true` is helpful when the objects are needed for immediate display to a user. This process only goes one level deep. Objects referenced by the related objects will not be included. For example,  if the `objects` field of the response contains a CatalogItem, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response.  Default value: `false`
	IncludeRelatedObjects bool `json:"include_related_objects,omitempty"`
	// Requests objects as of a specific version of the catalog. This allows you to retrieve historical versions of objects. The value to retrieve a specific version of an object can be found in the version field of [CatalogObject](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogObject)s. If not included, results will be from the current version of the catalog.
	CatalogVersion int64 `json:"catalog_version,omitempty"`
	// Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned in the response payload.
	IncludeCategoryPathToRoot bool `json:"include_category_path_to_root,omitempty"`
}

type RetrieveCatalogObjectResponse ¶

type RetrieveCatalogObjectResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError   `json:"errors,omitempty"`
	Object *CatalogObject `json:"object,omitempty"`
	// A list of `CatalogObject`s referenced by the object in the `object` field.
	RelatedObjects []CatalogObject `json:"related_objects,omitempty"`
}

type RetrieveCustomerCustomAttributeDefinitionRequest ¶

type RetrieveCustomerCustomAttributeDefinitionRequest struct {
	// The current version of the custom attribute definition, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. When included in the request, Square returns the specified version or a higher version if one exists. If the specified version is higher than the current version, Square returns a `BAD_REQUEST` error.
	Version int32 `json:"version,omitempty"`
}

Represents a [RetrieveCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/retrieve-customer-custom-attributeDefinition) request.

type RetrieveCustomerCustomAttributeDefinitionResponse ¶

type RetrieveCustomerCustomAttributeDefinitionResponse struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [RetrieveCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/retrieve-customer-custom-attributeDefinition) response. Either `custom_attribute_definition` or `errors` is present in the response.

type RetrieveCustomerCustomAttributeRequest ¶

type RetrieveCustomerCustomAttributeRequest struct {
	// Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttributeDefinition) in the `definition` field of the custom attribute. Set this parameter to `true` to get the name and description of the custom attribute, information about the data type, or other definition details. The default value is `false`.
	WithDefinition bool `json:"with_definition,omitempty"`
	// The current version of the custom attribute, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. When included in the request, Square returns the specified version or a higher version if one exists. If the specified version is higher than the current version, Square returns a `BAD_REQUEST` error.
	Version int32 `json:"version,omitempty"`
}

Represents a [RetrieveCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/retrieve-customer-custom-attribute) request.

type RetrieveCustomerCustomAttributeResponse ¶

type RetrieveCustomerCustomAttributeResponse struct {
	CustomAttribute *CustomAttribute `json:"custom_attribute,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [RetrieveCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/retrieve-customer-custom-attribute) response. Either `custom_attribute_definition` or `errors` is present in the response.

type RetrieveCustomerGroupRequest ¶

type RetrieveCustomerGroupRequest struct{}

Defines the fields that can be included in a request to the [RetrieveCustomerGroup](https://developer.squareup.com/reference/square_2024-07-17/customer-groups-api/retrieve-customer-group) endpoint.

type RetrieveCustomerGroupResponse ¶

type RetrieveCustomerGroupResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError   `json:"errors,omitempty"`
	Group  *CustomerGroup `json:"group,omitempty"`
}

Defines the fields that are included in the response body of a request to the [RetrieveCustomerGroup](https://developer.squareup.com/reference/square_2024-07-17/customer-groups-api/retrieve-customer-group) endpoint. Either `errors` or `group` is present in a given response (never both).

type RetrieveCustomerRequest ¶

type RetrieveCustomerRequest struct{}

Defines the fields that are included in requests to the `RetrieveCustomer` endpoint.

type RetrieveCustomerResponse ¶

type RetrieveCustomerResponse struct {
	// Any errors that occurred during the request.
	Errors   []ModelError `json:"errors,omitempty"`
	Customer *Customer    `json:"customer,omitempty"`
}

Defines the fields that are included in the response body of a request to the `RetrieveCustomer` endpoint. Either `errors` or `customer` is present in a given response (never both).

type RetrieveCustomerSegmentRequest ¶

type RetrieveCustomerSegmentRequest struct{}

Defines the valid parameters for requests to the `RetrieveCustomerSegmentRequest` endpoint.

type RetrieveCustomerSegmentResponse ¶

type RetrieveCustomerSegmentResponse struct {
	// Any errors that occurred during the request.
	Errors  []ModelError     `json:"errors,omitempty"`
	Segment *CustomerSegment `json:"segment,omitempty"`
}

Defines the fields that are included in the response body for requests to the `RetrieveCustomerSegment` endpoint. Either `errors` or `segment` is present in a given response (never both).

type RetrieveDisputeEvidenceRequest ¶

type RetrieveDisputeEvidenceRequest struct{}

Defines the parameters for a `RetrieveDisputeEvidence` request.

type RetrieveDisputeEvidenceResponse ¶

type RetrieveDisputeEvidenceResponse struct {
	// Any errors that occurred during the request.
	Errors   []ModelError     `json:"errors,omitempty"`
	Evidence *DisputeEvidence `json:"evidence,omitempty"`
}

Defines the fields in a `RetrieveDisputeEvidence` response.

type RetrieveDisputeRequest ¶

type RetrieveDisputeRequest struct{}

Defines the request parameters for the `RetrieveDispute` endpoint.

type RetrieveDisputeResponse ¶

type RetrieveDisputeResponse struct {
	// Information about errors encountered during the request.
	Errors  []ModelError `json:"errors,omitempty"`
	Dispute *Dispute     `json:"dispute,omitempty"`
}

Defines fields in a `RetrieveDispute` response.

type RetrieveEmployeeRequest ¶

type RetrieveEmployeeRequest struct{}

type RetrieveEmployeeResponse ¶

type RetrieveEmployeeResponse struct {
	Employee *Employee `json:"employee,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type RetrieveGiftCardFromGanRequest ¶

type RetrieveGiftCardFromGanRequest struct {
	// The gift card account number (GAN) of the gift card to retrieve. The maximum length of a GAN is 255 digits to account for third-party GANs that have been imported. Square-issued gift cards have 16-digit GANs.
	Gan string `json:"gan"`
}

A request to retrieve gift cards by their GANs.

type RetrieveGiftCardFromGanResponse ¶

type RetrieveGiftCardFromGanResponse struct {
	// Any errors that occurred during the request.
	Errors   []ModelError `json:"errors,omitempty"`
	GiftCard *GiftCard    `json:"gift_card,omitempty"`
}

A response that contains a `GiftCard`. This response might contain a set of `Error` objects if the request resulted in errors.

type RetrieveGiftCardFromNonceRequest ¶

type RetrieveGiftCardFromNonceRequest struct {
	// The payment token of the gift card to retrieve. Payment tokens are generated by the  Web Payments SDK or In-App Payments SDK.
	Nonce string `json:"nonce"`
}

A request to retrieve a gift card by using a payment token.

type RetrieveGiftCardFromNonceResponse ¶

type RetrieveGiftCardFromNonceResponse struct {
	// Any errors that occurred during the request.
	Errors   []ModelError `json:"errors,omitempty"`
	GiftCard *GiftCard    `json:"gift_card,omitempty"`
}

A response that contains a `GiftCard` object. If the request resulted in errors, the response contains a set of `Error` objects.

type RetrieveGiftCardRequest ¶

type RetrieveGiftCardRequest struct{}

A request to retrieve digital gift cards.

type RetrieveGiftCardResponse ¶

type RetrieveGiftCardResponse struct {
	// Any errors that occurred during the request.
	Errors   []ModelError `json:"errors,omitempty"`
	GiftCard *GiftCard    `json:"gift_card,omitempty"`
}

A response that contains a `GiftCard`. The response might contain a set of `Error` objects if the request resulted in errors.

type RetrieveInventoryAdjustmentRequest ¶

type RetrieveInventoryAdjustmentRequest struct{}

type RetrieveInventoryAdjustmentResponse ¶

type RetrieveInventoryAdjustmentResponse struct {
	// Any errors that occurred during the request.
	Errors     []ModelError         `json:"errors,omitempty"`
	Adjustment *InventoryAdjustment `json:"adjustment,omitempty"`
}

type RetrieveInventoryChangesRequest ¶

type RetrieveInventoryChangesRequest struct {
	// The [Location](https://developer.squareup.com/reference/square_2024-07-17/objects/Location) IDs to look up as a comma-separated list. An empty list queries all locations.
	LocationIds string `json:"location_ids,omitempty"`
	// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.  See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.
	Cursor string `json:"cursor,omitempty"`
}

type RetrieveInventoryChangesResponse ¶

type RetrieveInventoryChangesResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The set of inventory changes for the requested object and locations.
	Changes []InventoryChange `json:"changes,omitempty"`
	// The pagination cursor to be used in a subsequent request. If unset, this is the final response.  See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.
	Cursor string `json:"cursor,omitempty"`
}

type RetrieveInventoryCountRequest ¶

type RetrieveInventoryCountRequest struct {
	// The [Location](https://developer.squareup.com/reference/square_2024-07-17/objects/Location) IDs to look up as a comma-separated list. An empty list queries all locations.
	LocationIds string `json:"location_ids,omitempty"`
	// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.  See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.
	Cursor string `json:"cursor,omitempty"`
}

type RetrieveInventoryCountResponse ¶

type RetrieveInventoryCountResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The current calculated inventory counts for the requested object and locations.
	Counts []InventoryCount `json:"counts,omitempty"`
	// The pagination cursor to be used in a subsequent request. If unset, this is the final response.  See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.
	Cursor string `json:"cursor,omitempty"`
}

type RetrieveInventoryPhysicalCountRequest ¶

type RetrieveInventoryPhysicalCountRequest struct{}

type RetrieveInventoryPhysicalCountResponse ¶

type RetrieveInventoryPhysicalCountResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError            `json:"errors,omitempty"`
	Count  *InventoryPhysicalCount `json:"count,omitempty"`
}

type RetrieveInventoryTransferRequest ¶

type RetrieveInventoryTransferRequest struct{}

type RetrieveInventoryTransferResponse ¶

type RetrieveInventoryTransferResponse struct {
	// Any errors that occurred during the request.
	Errors   []ModelError       `json:"errors,omitempty"`
	Transfer *InventoryTransfer `json:"transfer,omitempty"`
}

type RetrieveLocationBookingProfileRequest ¶

type RetrieveLocationBookingProfileRequest struct{}

type RetrieveLocationBookingProfileResponse ¶

type RetrieveLocationBookingProfileResponse struct {
	LocationBookingProfile *LocationBookingProfile `json:"location_booking_profile,omitempty"`
	// Errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type RetrieveLocationCustomAttributeDefinitionRequest ¶

type RetrieveLocationCustomAttributeDefinitionRequest struct {
	// The current version of the custom attribute definition, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. When included in the request, Square returns the specified version or a higher version if one exists. If the specified version is higher than the current version, Square returns a `BAD_REQUEST` error.
	Version int32 `json:"version,omitempty"`
}

Represents a [RetrieveLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/retrieve-location-custom-attributeDefinition) request.

type RetrieveLocationCustomAttributeDefinitionResponse ¶

type RetrieveLocationCustomAttributeDefinitionResponse struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [RetrieveLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/retrieve-location-custom-attributeDefinition) response. Either `custom_attribute_definition` or `errors` is present in the response.

type RetrieveLocationCustomAttributeRequest ¶

type RetrieveLocationCustomAttributeRequest struct {
	// Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttributeDefinition) in the `definition` field of the custom attribute. Set this parameter to `true` to get the name and description of the custom attribute, information about the data type, or other definition details. The default value is `false`.
	WithDefinition bool `json:"with_definition,omitempty"`
	// The current version of the custom attribute, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. When included in the request, Square returns the specified version or a higher version if one exists. If the specified version is higher than the current version, Square returns a `BAD_REQUEST` error.
	Version int32 `json:"version,omitempty"`
}

Represents a [RetrieveLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/retrieve-location-custom-attribute) request.

type RetrieveLocationCustomAttributeResponse ¶

type RetrieveLocationCustomAttributeResponse struct {
	CustomAttribute *CustomAttribute `json:"custom_attribute,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [RetrieveLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/retrieve-location-custom-attribute) response. Either `custom_attribute_definition` or `errors` is present in the response.

type RetrieveLocationRequest ¶

type RetrieveLocationRequest struct{}

Defines the fields that are included in the request body for the [RetrieveLocation](https://developer.squareup.com/reference/square_2024-07-17/locations-api/retrieve-location) endpoint.

type RetrieveLocationResponse ¶

type RetrieveLocationResponse struct {
	// Information about errors encountered during the request.
	Errors   []ModelError `json:"errors,omitempty"`
	Location *Location    `json:"location,omitempty"`
}

Defines the fields that the [RetrieveLocation](https://developer.squareup.com/reference/square_2024-07-17/locations-api/retrieve-location) endpoint returns in a response.

type RetrieveLocationSettingsRequest ¶

type RetrieveLocationSettingsRequest struct{}

type RetrieveLocationSettingsResponse ¶

type RetrieveLocationSettingsResponse struct {
	// Any errors that occurred during the request.
	Errors           []ModelError              `json:"errors,omitempty"`
	LocationSettings *CheckoutLocationSettings `json:"location_settings,omitempty"`
}

type RetrieveLoyaltyAccountRequest ¶

type RetrieveLoyaltyAccountRequest struct{}

A request to retrieve a loyalty account.

type RetrieveLoyaltyAccountResponse ¶

type RetrieveLoyaltyAccountResponse struct {
	// Any errors that occurred during the request.
	Errors         []ModelError    `json:"errors,omitempty"`
	LoyaltyAccount *LoyaltyAccount `json:"loyalty_account,omitempty"`
}

A response that includes the loyalty account.

type RetrieveLoyaltyProgramRequest ¶

type RetrieveLoyaltyProgramRequest struct{}

A request to retrieve the [loyalty program](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyProgram) that belongs to a seller. A seller can have only one loyalty program.

type RetrieveLoyaltyProgramResponse ¶

type RetrieveLoyaltyProgramResponse struct {
	// Any errors that occurred during the request.
	Errors  []ModelError    `json:"errors,omitempty"`
	Program *LoyaltyProgram `json:"program,omitempty"`
}

A response that contains the loyalty program.

type RetrieveLoyaltyPromotionRequest ¶

type RetrieveLoyaltyPromotionRequest struct{}

Represents a [RetrieveLoyaltyPromotionPromotions](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/retrieve-loyalty-promotion) request.

type RetrieveLoyaltyPromotionResponse ¶

type RetrieveLoyaltyPromotionResponse struct {
	// Any errors that occurred during the request.
	Errors           []ModelError      `json:"errors,omitempty"`
	LoyaltyPromotion *LoyaltyPromotion `json:"loyalty_promotion,omitempty"`
}

Represents a [RetrieveLoyaltyPromotionPromotions](https://developer.squareup.com/reference/square_2024-07-17/loyalty-api/retrieve-loyalty-promotion) response.

type RetrieveLoyaltyRewardRequest ¶

type RetrieveLoyaltyRewardRequest struct{}

A request to retrieve a loyalty reward.

type RetrieveLoyaltyRewardResponse ¶

type RetrieveLoyaltyRewardResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError   `json:"errors,omitempty"`
	Reward *LoyaltyReward `json:"reward,omitempty"`
}

A response that includes the loyalty reward.

type RetrieveMerchantCustomAttributeDefinitionRequest ¶

type RetrieveMerchantCustomAttributeDefinitionRequest struct {
	// The current version of the custom attribute definition, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. When included in the request, Square returns the specified version or a higher version if one exists. If the specified version is higher than the current version, Square returns a `BAD_REQUEST` error.
	Version int32 `json:"version,omitempty"`
}

Represents a [RetrieveMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/retrieve-merchant-custom-attributeDefinition) request.

type RetrieveMerchantCustomAttributeDefinitionResponse ¶

type RetrieveMerchantCustomAttributeDefinitionResponse struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [RetrieveMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/retrieve-merchant-custom-attributeDefinition) response. Either `custom_attribute_definition` or `errors` is present in the response.

type RetrieveMerchantCustomAttributeRequest ¶

type RetrieveMerchantCustomAttributeRequest struct {
	// Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttributeDefinition) in the `definition` field of the custom attribute. Set this parameter to `true` to get the name and description of the custom attribute, information about the data type, or other definition details. The default value is `false`.
	WithDefinition bool `json:"with_definition,omitempty"`
	// The current version of the custom attribute, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. When included in the request, Square returns the specified version or a higher version if one exists. If the specified version is higher than the current version, Square returns a `BAD_REQUEST` error.
	Version int32 `json:"version,omitempty"`
}

Represents a [RetrieveMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/retrieve-merchant-custom-attribute) request.

type RetrieveMerchantCustomAttributeResponse ¶

type RetrieveMerchantCustomAttributeResponse struct {
	CustomAttribute *CustomAttribute `json:"custom_attribute,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a [RetrieveMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/retrieve-merchant-custom-attribute) response. Either `custom_attribute_definition` or `errors` is present in the response.

type RetrieveMerchantRequest ¶

type RetrieveMerchantRequest struct{}

Request object for the [RetrieveMerchant](https://developer.squareup.com/reference/square_2024-07-17/merchants-api/retrieve-merchant) endpoint.

type RetrieveMerchantResponse ¶

type RetrieveMerchantResponse struct {
	// Information on errors encountered during the request.
	Errors   []ModelError `json:"errors,omitempty"`
	Merchant *Merchant    `json:"merchant,omitempty"`
}

The response object returned by the [RetrieveMerchant](https://developer.squareup.com/reference/square_2024-07-17/merchants-api/retrieve-merchant) endpoint.

type RetrieveMerchantSettingsRequest ¶

type RetrieveMerchantSettingsRequest struct{}

type RetrieveMerchantSettingsResponse ¶

type RetrieveMerchantSettingsResponse struct {
	// Any errors that occurred during the request.
	Errors           []ModelError              `json:"errors,omitempty"`
	MerchantSettings *CheckoutMerchantSettings `json:"merchant_settings,omitempty"`
}

type RetrieveOrderCustomAttributeDefinitionRequest ¶

type RetrieveOrderCustomAttributeDefinitionRequest struct {
	// To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control, include this optional field and specify the current version of the custom attribute.
	Version int32 `json:"version,omitempty"`
}

Represents a get request for an order custom attribute definition.

type RetrieveOrderCustomAttributeDefinitionResponse ¶

type RetrieveOrderCustomAttributeDefinitionResponse struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response from getting an order custom attribute definition.

type RetrieveOrderCustomAttributeRequest ¶

type RetrieveOrderCustomAttributeRequest struct {
	// To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control, include this optional field and specify the current version of the custom attribute.
	Version int32 `json:"version,omitempty"`
	// Indicates whether to return the [custom attribute definition](https://developer.squareup.com/reference/square_2024-07-17/objects/CustomAttributeDefinition) in the `definition` field of each  custom attribute. Set this parameter to `true` to get the name and description of each custom attribute,  information about the data type, or other definition details. The default value is `false`.
	WithDefinition bool `json:"with_definition,omitempty"`
}

Represents a get request for an order custom attribute.

type RetrieveOrderCustomAttributeResponse ¶

type RetrieveOrderCustomAttributeResponse struct {
	CustomAttribute *CustomAttribute `json:"custom_attribute,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response from getting an order custom attribute.

type RetrieveOrderRequest ¶

type RetrieveOrderRequest struct{}

type RetrieveOrderResponse ¶

type RetrieveOrderResponse struct {
	Order *Order `json:"order,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type RetrievePaymentLinkRequest ¶

type RetrievePaymentLinkRequest struct{}

type RetrievePaymentLinkResponse ¶

type RetrievePaymentLinkResponse struct {
	// Any errors that occurred during the request.
	Errors      []ModelError `json:"errors,omitempty"`
	PaymentLink *PaymentLink `json:"payment_link,omitempty"`
}

type RetrieveSnippetRequest ¶

type RetrieveSnippetRequest struct{}

Represents a `RetrieveSnippet` request.

type RetrieveSnippetResponse ¶

type RetrieveSnippetResponse struct {
	// Any errors that occurred during the request.
	Errors  []ModelError `json:"errors,omitempty"`
	Snippet *Snippet     `json:"snippet,omitempty"`
}

Represents a `RetrieveSnippet` response. The response can include either `snippet` or `errors`.

type RetrieveSubscriptionRequest ¶

type RetrieveSubscriptionRequest struct {
	// A query parameter to specify related information to be included in the response.   The supported query parameter values are:   - `actions`: to include scheduled actions on the targeted subscription.
	Include string `json:"include,omitempty"`
}

Defines input parameters in a request to the [RetrieveSubscription](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/retrieve-subscription) endpoint.

type RetrieveSubscriptionResponse ¶

type RetrieveSubscriptionResponse struct {
	// Errors encountered during the request.
	Errors       []ModelError  `json:"errors,omitempty"`
	Subscription *Subscription `json:"subscription,omitempty"`
}

Defines output parameters in a response from the [RetrieveSubscription](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/retrieve-subscription) endpoint.

type RetrieveTeamMemberBookingProfileRequest ¶

type RetrieveTeamMemberBookingProfileRequest struct{}

type RetrieveTeamMemberBookingProfileResponse ¶

type RetrieveTeamMemberBookingProfileResponse struct {
	TeamMemberBookingProfile *TeamMemberBookingProfile `json:"team_member_booking_profile,omitempty"`
	// Errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type RetrieveTeamMemberRequest ¶

type RetrieveTeamMemberRequest struct{}

Represents a retrieve request for a `TeamMember` object.

type RetrieveTeamMemberResponse ¶

type RetrieveTeamMemberResponse struct {
	TeamMember *TeamMember `json:"team_member,omitempty"`
	// The errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response from a retrieve request containing a `TeamMember` object or error messages.

type RetrieveTokenStatusRequest ¶

type RetrieveTokenStatusRequest struct{}

Request object for [RetrieveTokenStatus] endpoint.

type RetrieveTokenStatusResponse ¶

type RetrieveTokenStatusResponse struct {
	// The list of scopes associated with an access token.
	Scopes []string `json:"scopes,omitempty"`
	// The date and time when the `access_token` expires, in RFC 3339 format. Empty if the token never expires.
	ExpiresAt string `json:"expires_at,omitempty"`
	// The Square-issued application ID associated with the access token. This is the same application ID used to obtain the token.
	ClientId string `json:"client_id,omitempty"`
	// The ID of the authorizing merchant's business.
	MerchantId string `json:"merchant_id,omitempty"`
	//  Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields that are included in the response body of a request to the `RetrieveTokenStatus` endpoint.

type RetrieveTransactionRequest ¶

type RetrieveTransactionRequest struct{}

type RetrieveTransactionResponse ¶

type RetrieveTransactionResponse struct {
	// Any errors that occurred during the request.
	Errors      []ModelError `json:"errors,omitempty"`
	Transaction *Transaction `json:"transaction,omitempty"`
}

Defines the fields that are included in the response body of a request to the [RetrieveTransaction](https://developer.squareup.com/reference/square_2024-07-17/transactions-api/retrieve-transaction) endpoint. One of `errors` or `transaction` is present in a given response (never both).

type RetrieveVendorRequest ¶

type RetrieveVendorRequest struct{}

Represents an input to a call to [RetrieveVendor](https://developer.squareup.com/reference/square_2024-07-17/vendors-api/retrieve-vendor).

type RetrieveVendorResponse ¶

type RetrieveVendorResponse struct {
	// Errors encountered when the request fails.
	Errors []ModelError `json:"errors,omitempty"`
	Vendor *Vendor      `json:"vendor,omitempty"`
}

Represents an output from a call to [RetrieveVendor](https://developer.squareup.com/reference/square_2024-07-17/vendors-api/retrieve-vendor).

type RetrieveWageSettingRequest ¶

type RetrieveWageSettingRequest struct{}

Represents a retrieve request for the wage setting of a team member.

type RetrieveWageSettingResponse ¶

type RetrieveWageSettingResponse struct {
	WageSetting *WageSetting `json:"wage_setting,omitempty"`
	// The errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response from a retrieve request containing the specified `WageSetting` object or error messages.

type RetrieveWebhookSubscriptionRequest ¶

type RetrieveWebhookSubscriptionRequest struct{}

Retrieves a Subscription(https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription) using its id.

type RetrieveWebhookSubscriptionResponse ¶

type RetrieveWebhookSubscriptionResponse struct {
	// Information on errors encountered during the request.
	Errors       []ModelError         `json:"errors,omitempty"`
	Subscription *WebhookSubscription `json:"subscription,omitempty"`
}

Defines the fields that are included in the response body of a request to the [RetrieveWebhookSubscription](https://developer.squareup.com/reference/square_2024-07-17/webhook-subscriptions-api/retrieve-webhook-subscription) endpoint. Note: if there are errors processing the request, the Subscription(https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription) will not be present.

type RevokeTokenRequest ¶

type RevokeTokenRequest struct {
	// The Square-issued ID for your application, which is available on the **OAuth** page in the [Developer Dashboard](https://developer.squareup.com/apps).
	ClientId string `json:"client_id,omitempty"`
	// The access token of the merchant whose token you want to revoke. Do not provide a value for `merchant_id` if you provide this parameter.
	AccessToken string `json:"access_token,omitempty"`
	// The ID of the merchant whose token you want to revoke. Do not provide a value for `access_token` if you provide this parameter.
	MerchantId string `json:"merchant_id,omitempty"`
	// If `true`, terminate the given single access token, but do not terminate the entire authorization. Default: `false`
	RevokeOnlyAccessToken bool `json:"revoke_only_access_token,omitempty"`
}

type RevokeTokenResponse ¶

type RevokeTokenResponse struct {
	// If the request is successful, this is `true`.
	Success bool `json:"success,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type RiskEvaluation ¶

type RiskEvaluation struct {
	// The timestamp when payment risk was evaluated, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The risk level associated with the payment
	RiskLevel string `json:"risk_level,omitempty"`
}

Represents fraud risk information for the associated payment. When you take a payment through Square's Payments API (using the `CreatePayment` endpoint), Square evaluates it and assigns a risk level to the payment. Sellers can use this information to determine the course of action (for example, provide the goods/services or refund the payment).

type RiskEvaluationRiskLevel ¶

type RiskEvaluationRiskLevel string

const (
	PENDING_RiskEvaluationRiskLevel  RiskEvaluationRiskLevel = "PENDING"
	NORMAL_RiskEvaluationRiskLevel   RiskEvaluationRiskLevel = "NORMAL"
	MODERATE_RiskEvaluationRiskLevel RiskEvaluationRiskLevel = "MODERATE"
	HIGH_RiskEvaluationRiskLevel     RiskEvaluationRiskLevel = "HIGH"
)

List of RiskEvaluationRiskLevel

type SaveCardOptions ¶

type SaveCardOptions struct {
	// The square-assigned ID of the customer linked to the saved card.
	CustomerId string `json:"customer_id"`
	// The id of the created card-on-file.
	CardId string `json:"card_id,omitempty"`
	// An optional user-defined reference ID that can be used to associate this `Card` to another entity in an external system. For example, a customer ID generated by a third-party system.
	ReferenceId string `json:"reference_id,omitempty"`
}

Describes save-card action fields.

type SearchAvailabilityFilter ¶

type SearchAvailabilityFilter struct {
	StartAtRange *TimeRange `json:"start_at_range"`
	// The query expression to search for buyer-accessible availabilities with their location IDs matching the specified location ID. This query expression cannot be set if `booking_id` is set.
	LocationId string `json:"location_id,omitempty"`
	// The query expression to search for buyer-accessible availabilities matching the specified list of segment filters. If the size of the `segment_filters` list is `n`, the search returns availabilities with `n` segments per availability.  This query expression cannot be set if `booking_id` is set.
	SegmentFilters []SegmentFilter `json:"segment_filters,omitempty"`
	// The query expression to search for buyer-accessible availabilities for an existing booking by matching the specified `booking_id` value. This is commonly used to reschedule an appointment. If this expression is set, the `location_id` and `segment_filters` expressions cannot be set.
	BookingId string `json:"booking_id,omitempty"`
}

A query filter to search for buyer-accessible availabilities by.

type SearchAvailabilityQuery ¶

type SearchAvailabilityQuery struct {
	Filter *SearchAvailabilityFilter `json:"filter"`
}

The query used to search for buyer-accessible availabilities of bookings.

type SearchAvailabilityRequest ¶

type SearchAvailabilityRequest struct {
	Query *SearchAvailabilityQuery `json:"query"`
}

type SearchAvailabilityResponse ¶

type SearchAvailabilityResponse struct {
	// List of appointment slots available for booking.
	Availabilities []Availability `json:"availabilities,omitempty"`
	// Errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type SearchCatalogItemsRequest ¶

type SearchCatalogItemsRequest struct {
	// The text filter expression to return items or item variations containing specified text in the `name`, `description`, or `abbreviation` attribute value of an item, or in the `name`, `sku`, or `upc` attribute value of an item variation.
	TextFilter string `json:"text_filter,omitempty"`
	// The category id query expression to return items containing the specified category IDs.
	CategoryIds []string `json:"category_ids,omitempty"`
	// The stock-level query expression to return item variations with the specified stock levels.
	StockLevels []string `json:"stock_levels,omitempty"`
	// The enabled-location query expression to return items and item variations having specified enabled locations.
	EnabledLocationIds []string `json:"enabled_location_ids,omitempty"`
	// The pagination token, returned in the previous response, used to fetch the next batch of pending results.
	Cursor string `json:"cursor,omitempty"`
	// The maximum number of results to return per page. The default value is 100.
	Limit int32 `json:"limit,omitempty"`
	// The order to sort the results by item names. The default sort order is ascending (`ASC`).
	SortOrder string `json:"sort_order,omitempty"`
	// The product types query expression to return items or item variations having the specified product types.
	ProductTypes []string `json:"product_types,omitempty"`
	// The customer-attribute filter to return items or item variations matching the specified custom attribute expressions. A maximum number of 10 custom attribute expressions are supported in a single call to the [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-07-17/catalog-api/search-catalog-items) endpoint.
	CustomAttributeFilters []CustomAttributeFilter `json:"custom_attribute_filters,omitempty"`
	// The query filter to return not archived (`ARCHIVED_STATE_NOT_ARCHIVED`), archived (`ARCHIVED_STATE_ARCHIVED`), or either type (`ARCHIVED_STATE_ALL`) of items.
	ArchivedState string `json:"archived_state,omitempty"`
}

Defines the request body for the [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-07-17/catalog-api/search-catalog-items) endpoint.

type SearchCatalogItemsRequestStockLevel ¶

type SearchCatalogItemsRequestStockLevel string

SearchCatalogItemsRequestStockLevel : Defines supported stock levels of the item inventory.

const (
	OUT_SearchCatalogItemsRequestStockLevel SearchCatalogItemsRequestStockLevel = "OUT"
	LOW_SearchCatalogItemsRequestStockLevel SearchCatalogItemsRequestStockLevel = "LOW"
)

List of SearchCatalogItemsRequestStockLevel

type SearchCatalogItemsResponse ¶

type SearchCatalogItemsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// Returned items matching the specified query expressions.
	Items []CatalogObject `json:"items,omitempty"`
	// Pagination token used in the next request to return more of the search result.
	Cursor string `json:"cursor,omitempty"`
	// Ids of returned item variations matching the specified query expression.
	MatchedVariationIds []string `json:"matched_variation_ids,omitempty"`
}

Defines the response body returned from the [SearchCatalogItems](https://developer.squareup.com/reference/square_2024-07-17/catalog-api/search-catalog-items) endpoint.

type SearchCatalogObjectsRequest ¶

type SearchCatalogObjectsRequest struct {
	// The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
	// The desired set of object types to appear in the search results.  If this is unspecified, the operation returns objects of all the top level types at the version of the Square API used to make the request. Object types that are nested onto other object types are not included in the defaults.  At the current API version the default object types are: ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST,  PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.  Note that if you wish for the query to return objects belonging to nested types (i.e., COMPONENT, IMAGE, ITEM_OPTION_VAL, ITEM_VARIATION, or MODIFIER), you must explicitly include all the types of interest in this field.
	ObjectTypes []string `json:"object_types,omitempty"`
	// If `true`, deleted objects will be included in the results. Deleted objects will have their `is_deleted` field set to `true`.
	IncludeDeletedObjects bool `json:"include_deleted_objects,omitempty"`
	// If `true`, the response will include additional objects that are related to the requested objects. Related objects are objects that are referenced by object ID by the objects in the response. This is helpful if the objects are being fetched for immediate display to a user. This process only goes one level deep. Objects referenced by the related objects will not be included. For example:  If the `objects` field of the response contains a CatalogItem, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response.  Default value: `false`
	IncludeRelatedObjects bool `json:"include_related_objects,omitempty"`
	// Return objects modified after this [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. The timestamp is exclusive - objects with a timestamp equal to `begin_time` will not be included in the response.
	BeginTime string        `json:"begin_time,omitempty"`
	Query     *CatalogQuery `json:"query,omitempty"`
	// A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored.
	Limit int32 `json:"limit,omitempty"`
	// Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned in the response payload.
	IncludeCategoryPathToRoot bool `json:"include_category_path_to_root,omitempty"`
}

type SearchCatalogObjectsResponse ¶

type SearchCatalogObjectsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
	// The CatalogObjects returned.
	Objects []CatalogObject `json:"objects,omitempty"`
	// A list of CatalogObjects referenced by the objects in the `objects` field.
	RelatedObjects []CatalogObject `json:"related_objects,omitempty"`
	// When the associated product catalog was last updated. Will match the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request.
	LatestTime string `json:"latest_time,omitempty"`
}

type SearchCustomersRequest ¶

type SearchCustomersRequest struct {
	// Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. If the specified limit is invalid, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Limit int64          `json:"limit,omitempty"`
	Query *CustomerQuery `json:"query,omitempty"`
	// Indicates whether to return the total count of matching customers in the `count` field of the response.  The default value is `false`.
	Count bool `json:"count,omitempty"`
}

Defines the fields that are included in the request body of a request to the `SearchCustomers` endpoint.

type SearchCustomersResponse ¶

type SearchCustomersResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The customer profiles that match the search query. If any search condition is not met, the result is an empty object (`{}`). Only customer profiles with public information (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) are included in the response.
	Customers []Customer `json:"customers,omitempty"`
	// A pagination cursor that can be used during subsequent calls to `SearchCustomers` to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// The total count of customers associated with the Square account that match the search query. Only customer profiles with public information (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) are counted. This field is present only if `count` is set to `true` in the request.
	Count int64 `json:"count,omitempty"`
}

Defines the fields that are included in the response body of a request to the `SearchCustomers` endpoint. Either `errors` or `customers` is present in a given response (never both).

type SearchEventsFilter ¶

type SearchEventsFilter struct {
	// Filter events by event types.
	EventTypes []string `json:"event_types,omitempty"`
	// Filter events by merchant.
	MerchantIds []string `json:"merchant_ids,omitempty"`
	// Filter events by location.
	LocationIds []string   `json:"location_ids,omitempty"`
	CreatedAt   *TimeRange `json:"created_at,omitempty"`
}

Criteria to filter events by.

type SearchEventsQuery ¶

type SearchEventsQuery struct {
	Filter *SearchEventsFilter `json:"filter,omitempty"`
	Sort   *SearchEventsSort   `json:"sort,omitempty"`
}

Contains query criteria for the search.

type SearchEventsRequest ¶

type SearchEventsRequest struct {
	// A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of events for your original query.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// The maximum number of events to return in a single page. The response might contain fewer events. The default value is 100, which is also the maximum allowed value.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).  Default: 100
	Limit int32              `json:"limit,omitempty"`
	Query *SearchEventsQuery `json:"query,omitempty"`
}

Searches Event(https://developer.squareup.com/reference/square_2024-07-17/objects/Event)s for your application.

type SearchEventsResponse ¶

type SearchEventsResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The list of [Event](https://developer.squareup.com/reference/square_2024-07-17/objects/Event)s returned by the search.
	Events []Event `json:"events,omitempty"`
	// Contains the metadata of an event. For more information, see [Event](https://developer.squareup.com/reference/square_2024-07-17/objects/Event).
	Metadata []EventMetadata `json:"metadata,omitempty"`
	// When a response is truncated, it includes a cursor that you can use in a subsequent request to fetch the next set of events. If empty, this is the final response.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Defines the fields that are included in the response body of a request to the [SearchEvents](https://developer.squareup.com/reference/square_2024-07-17/events-api/search-events) endpoint. Note: if there are errors processing the request, the events field will not be present.

type SearchEventsSort ¶

type SearchEventsSort struct {
	// Sort events by event types.
	Field string `json:"field,omitempty"`
	// The order to use for sorting the events.
	Order string `json:"order,omitempty"`
}

Criteria to sort events by.

type SearchEventsSortField ¶

type SearchEventsSortField string

SearchEventsSortField : Specifies the sort key for events returned from a search.

const (
	DEFAULT__SearchEventsSortField SearchEventsSortField = "DEFAULT"
)

List of SearchEventsSortField

type SearchInvoicesRequest ¶

type SearchInvoicesRequest struct {
	Query *InvoiceQuery `json:"query"`
	// The maximum number of invoices to return (200 is the maximum `limit`).  If not provided, the server uses a default limit of 100 invoices.
	Limit int32 `json:"limit,omitempty"`
	// A pagination cursor returned by a previous call to this endpoint.  Provide this cursor to retrieve the next set of results for your original query.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Describes a `SearchInvoices` request.

type SearchInvoicesResponse ¶

type SearchInvoicesResponse struct {
	// The list of invoices returned by the search.
	Invoices []Invoice `json:"invoices,omitempty"`
	// When a response is truncated, it includes a cursor that you can use in a  subsequent request to fetch the next set of invoices. If empty, this is the final  response.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Describes a `SearchInvoices` response.

type SearchLoyaltyAccountsRequest ¶

type SearchLoyaltyAccountsRequest struct {
	Query *SearchLoyaltyAccountsRequestLoyaltyAccountQuery `json:"query,omitempty"`
	// The maximum number of results to include in the response. The default value is 30.
	Limit int32 `json:"limit,omitempty"`
	// A pagination cursor returned by a previous call to  this endpoint. Provide this to retrieve the next set of  results for the original query.  For more information,  see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

A request to search for loyalty accounts.

type SearchLoyaltyAccountsRequestLoyaltyAccountQuery ¶

type SearchLoyaltyAccountsRequestLoyaltyAccountQuery struct {
	// The set of mappings to use in the loyalty account search.    This cannot be combined with `customer_ids`.    Max: 30 mappings
	Mappings []LoyaltyAccountMapping `json:"mappings,omitempty"`
	// The set of customer IDs to use in the loyalty account search.    This cannot be combined with `mappings`.    Max: 30 customer IDs
	CustomerIds []string `json:"customer_ids,omitempty"`
}

The search criteria for the loyalty accounts.

type SearchLoyaltyAccountsResponse ¶

type SearchLoyaltyAccountsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The loyalty accounts that met the search criteria,   in order of creation date.
	LoyaltyAccounts []LoyaltyAccount `json:"loyalty_accounts,omitempty"`
	// The pagination cursor to use in a subsequent  request. If empty, this is the final response. For more information,  see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

A response that includes loyalty accounts that satisfy the search criteria.

type SearchLoyaltyEventsRequest ¶

type SearchLoyaltyEventsRequest struct {
	Query *LoyaltyEventQuery `json:"query,omitempty"`
	// The maximum number of results to include in the response.  The last page might contain fewer events.  The default is 30 events.
	Limit int32 `json:"limit,omitempty"`
	// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

A request to search for loyalty events.

type SearchLoyaltyEventsResponse ¶

type SearchLoyaltyEventsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The loyalty events that satisfy the search criteria.
	Events []LoyaltyEvent `json:"events,omitempty"`
	// The pagination cursor to be used in a subsequent  request. If empty, this is the final response.  For more information,  see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

A response that contains loyalty events that satisfy the search criteria, in order by the `created_at` date.

type SearchLoyaltyRewardsRequest ¶

type SearchLoyaltyRewardsRequest struct {
	Query *SearchLoyaltyRewardsRequestLoyaltyRewardQuery `json:"query,omitempty"`
	// The maximum number of results to return in the response. The default value is 30.
	Limit int32 `json:"limit,omitempty"`
	// A pagination cursor returned by a previous call to  this endpoint. Provide this to retrieve the next set of  results for the original query. For more information,  see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

A request to search for loyalty rewards.

type SearchLoyaltyRewardsRequestLoyaltyRewardQuery ¶

type SearchLoyaltyRewardsRequestLoyaltyRewardQuery struct {
	// The ID of the [loyalty account](https://developer.squareup.com/reference/square_2024-07-17/objects/LoyaltyAccount) to which the loyalty reward belongs.
	LoyaltyAccountId string `json:"loyalty_account_id"`
	// The status of the loyalty reward.
	Status string `json:"status,omitempty"`
}

The set of search requirements.

type SearchLoyaltyRewardsResponse ¶

type SearchLoyaltyRewardsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The loyalty rewards that satisfy the search criteria. These are returned in descending order by `updated_at`.
	Rewards []LoyaltyReward `json:"rewards,omitempty"`
	// The pagination cursor to be used in a subsequent  request. If empty, this is the final response.
	Cursor string `json:"cursor,omitempty"`
}

A response that includes the loyalty rewards satisfying the search criteria.

type SearchOrdersCustomerFilter ¶

type SearchOrdersCustomerFilter struct {
	// A list of customer IDs to filter by.  Max: 10 customer ids.
	CustomerIds []string `json:"customer_ids,omitempty"`
}

A filter based on the order `customer_id` and any tender `customer_id` associated with the order. It does not filter based on the FulfillmentRecipient(https://developer.squareup.com/reference/square_2024-07-17/objects/FulfillmentRecipient) `customer_id`.

type SearchOrdersDateTimeFilter ¶

type SearchOrdersDateTimeFilter struct {
	CreatedAt *TimeRange `json:"created_at,omitempty"`
	UpdatedAt *TimeRange `json:"updated_at,omitempty"`
	ClosedAt  *TimeRange `json:"closed_at,omitempty"`
}

Filter for `Order` objects based on whether their `CREATED_AT`, `CLOSED_AT`, or `UPDATED_AT` timestamps fall within a specified time range. You can specify the time range and which timestamp to filter for. You can filter for only one time range at a time. For each time range, the start time and end time are inclusive. If the end time is absent, it defaults to the time of the first request for the cursor. __Important:__ If you use the `DateTimeFilter` in a `SearchOrders` query, you must set the `sort_field` in [OrdersSort](https://developer.squareup.com/reference/square_2024-07-17/objects/SearchOrdersSort) to the same field you filter for. For example, if you set the `CLOSED_AT` field in `DateTimeFilter`, you must set the `sort_field` in `SearchOrdersSort` to `CLOSED_AT`. Otherwise, `SearchOrders` throws an error. [Learn more about filtering orders by time range.](https://developer.squareup.com/docs/orders-api/manage-orders/search-orders#important-note-about-filtering-orders-by-time-range)

type SearchOrdersFilter ¶

type SearchOrdersFilter struct {
	StateFilter       *SearchOrdersStateFilter       `json:"state_filter,omitempty"`
	DateTimeFilter    *SearchOrdersDateTimeFilter    `json:"date_time_filter,omitempty"`
	FulfillmentFilter *SearchOrdersFulfillmentFilter `json:"fulfillment_filter,omitempty"`
	SourceFilter      *SearchOrdersSourceFilter      `json:"source_filter,omitempty"`
	CustomerFilter    *SearchOrdersCustomerFilter    `json:"customer_filter,omitempty"`
}

Filtering criteria to use for a `SearchOrders` request. Multiple filters are ANDed together.

type SearchOrdersFulfillmentFilter ¶

type SearchOrdersFulfillmentFilter struct {
	// A list of [fulfillment types](https://developer.squareup.com/reference/square_2024-07-17/enums/FulfillmentType) to filter for. The list returns orders if any of its fulfillments match any of the fulfillment types listed in this field.
	FulfillmentTypes []string `json:"fulfillment_types,omitempty"`
	// A list of [fulfillment states](https://developer.squareup.com/reference/square_2024-07-17/enums/FulfillmentState) to filter for. The list returns orders if any of its fulfillments match any of the fulfillment states listed in this field.
	FulfillmentStates []string `json:"fulfillment_states,omitempty"`
}

Filter based on [order fulfillment](https://developer.squareup.com/reference/square_2024-07-17/objects/Fulfillment) information.

type SearchOrdersQuery ¶

type SearchOrdersQuery struct {
	Filter *SearchOrdersFilter `json:"filter,omitempty"`
	Sort   *SearchOrdersSort   `json:"sort,omitempty"`
}

Contains query criteria for the search.

type SearchOrdersRequest ¶

type SearchOrdersRequest struct {
	// The location IDs for the orders to query. All locations must belong to the same merchant.  Max: 10 location IDs.
	LocationIds []string `json:"location_ids,omitempty"`
	// A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string             `json:"cursor,omitempty"`
	Query  *SearchOrdersQuery `json:"query,omitempty"`
	// The maximum number of results to be returned in a single page.  Default: `500` Max: `1000`
	Limit int32 `json:"limit,omitempty"`
	// A Boolean that controls the format of the search results. If `true`, `SearchOrders` returns [OrderEntry](https://developer.squareup.com/reference/square_2024-07-17/objects/OrderEntry) objects. If `false`, `SearchOrders` returns complete order objects.  Default: `false`.
	ReturnEntries bool `json:"return_entries,omitempty"`
}

type SearchOrdersResponse ¶

type SearchOrdersResponse struct {
	// A list of [OrderEntries](https://developer.squareup.com/reference/square_2024-07-17/objects/OrderEntry) that fit the query conditions. The list is populated only if `return_entries` is set to `true` in the request.
	OrderEntries []OrderEntry `json:"order_entries,omitempty"`
	// A list of [Order](https://developer.squareup.com/reference/square_2024-07-17/objects/Order) objects that match the query conditions. The list is populated only if `return_entries` is set to `false` in the request.
	Orders []Order `json:"orders,omitempty"`
	// The pagination cursor to be used in a subsequent request. If unset, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// [Errors](https://developer.squareup.com/reference/square_2024-07-17/objects/Error) encountered during the search.
	Errors []ModelError `json:"errors,omitempty"`
}

Either the `order_entries` or `orders` field is set, depending on whether `return_entries` is set on the SearchOrdersRequest(https://developer.squareup.com/reference/square_2024-07-17/orders-api/search-orders).

type SearchOrdersSort ¶

type SearchOrdersSort struct {
	// The field to sort by.  __Important:__ When using a [DateTimeFilter](https://developer.squareup.com/reference/square_2024-07-17/objects/SearchOrdersFilter), `sort_field` must match the timestamp field that the `DateTimeFilter` uses to filter. For example, if you set your `sort_field` to `CLOSED_AT` and you use a `DateTimeFilter`, your `DateTimeFilter` must filter for orders by their `CLOSED_AT` date. If this field does not match the timestamp field in `DateTimeFilter`, `SearchOrders` returns an error.  Default: `CREATED_AT`.
	SortField string `json:"sort_field"`
	// The chronological order in which results are returned. Defaults to `DESC`.
	SortOrder string `json:"sort_order,omitempty"`
}

Sorting criteria for a `SearchOrders` request. Results can only be sorted by a timestamp field.

type SearchOrdersSortField ¶

type SearchOrdersSortField string

SearchOrdersSortField : Specifies which timestamp to use to sort `SearchOrder` results.

const (
	CREATED_AT_SearchOrdersSortField SearchOrdersSortField = "CREATED_AT"
	UPDATED_AT_SearchOrdersSortField SearchOrdersSortField = "UPDATED_AT"
	CLOSED_AT_SearchOrdersSortField  SearchOrdersSortField = "CLOSED_AT"
)

List of SearchOrdersSortField

type SearchOrdersSourceFilter ¶

type SearchOrdersSourceFilter struct {
	// Filters by the [Source](https://developer.squareup.com/reference/square_2024-07-17/objects/OrderSource) `name`. The filter returns any orders with a `source.name` that matches any of the listed source names.  Max: 10 source names.
	SourceNames []string `json:"source_names,omitempty"`
}

A filter based on order `source` information.

type SearchOrdersStateFilter ¶

type SearchOrdersStateFilter struct {
	// States to filter for.
	States []string `json:"states"`
}

Filter by the current order `state`.

type SearchShiftsRequest ¶

type SearchShiftsRequest struct {
	Query *ShiftQuery `json:"query,omitempty"`
	// The number of resources in a page (200 by default).
	Limit int32 `json:"limit,omitempty"`
	// An opaque cursor for fetching the next page.
	Cursor string `json:"cursor,omitempty"`
}

A request for a filtered and sorted set of `Shift` objects.

type SearchShiftsResponse ¶

type SearchShiftsResponse struct {
	// Shifts.
	Shifts []Shift `json:"shifts,omitempty"`
	// An opaque cursor for fetching the next page.
	Cursor string `json:"cursor,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

The response to a request for `Shift` objects. The response contains the requested `Shift` objects and might contain a set of `Error` objects if the request resulted in errors.

type SearchSubscriptionsFilter ¶

type SearchSubscriptionsFilter struct {
	// A filter to select subscriptions based on the subscribing customer IDs.
	CustomerIds []string `json:"customer_ids,omitempty"`
	// A filter to select subscriptions based on the location.
	LocationIds []string `json:"location_ids,omitempty"`
	// A filter to select subscriptions based on the source application.
	SourceNames []string `json:"source_names,omitempty"`
}

Represents a set of query expressions (filters) to narrow the scope of targeted subscriptions returned by the [SearchSubscriptions](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/search-subscriptions) endpoint.

type SearchSubscriptionsQuery ¶

type SearchSubscriptionsQuery struct {
	Filter *SearchSubscriptionsFilter `json:"filter,omitempty"`
}

Represents a query, consisting of specified query expressions, used to search for subscriptions.

type SearchSubscriptionsRequest ¶

type SearchSubscriptionsRequest struct {
	// When the total number of resulting subscriptions exceeds the limit of a paged response,  specify the cursor returned from a preceding response here to fetch the next set of results. If the cursor is unset, the response contains the last page of the results.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
	// The upper limit on the number of subscriptions to return in a paged response.
	Limit int32                     `json:"limit,omitempty"`
	Query *SearchSubscriptionsQuery `json:"query,omitempty"`
	// An option to include related information in the response.   The supported values are:   - `actions`: to include scheduled actions on the targeted subscriptions.
	Include []string `json:"include,omitempty"`
}

Defines input parameters in a request to the [SearchSubscriptions](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/search-subscriptions) endpoint.

type SearchSubscriptionsResponse ¶

type SearchSubscriptionsResponse struct {
	// Errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The subscriptions matching the specified query expressions.
	Subscriptions []Subscription `json:"subscriptions,omitempty"`
	// When the total number of resulting subscription exceeds the limit of a paged response,  the response includes a cursor for you to use in a subsequent request to fetch the next set of results. If the cursor is unset, the response contains the last page of the results.  For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Defines output parameters in a response from the [SearchSubscriptions](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/search-subscriptions) endpoint.

type SearchTeamMembersFilter ¶

type SearchTeamMembersFilter struct {
	// When present, filters by team members assigned to the specified locations. When empty, includes team members assigned to any location.
	LocationIds []string `json:"location_ids,omitempty"`
	// When present, filters by team members who match the given status. When empty, includes team members of all statuses.
	Status string `json:"status,omitempty"`
	// When present and set to true, returns the team member who is the owner of the Square account.
	IsOwner bool `json:"is_owner,omitempty"`
}

Represents a filter used in a search for `TeamMember` objects. `AND` logic is applied between the individual fields, and `OR` logic is applied within list-based fields. For example, setting this filter value: ``` filter = (locations_ids = [\"A\", \"B\"], status = ACTIVE) ``` returns only active team members assigned to either location \"A\" or \"B\".

type SearchTeamMembersQuery ¶

type SearchTeamMembersQuery struct {
	Filter *SearchTeamMembersFilter `json:"filter,omitempty"`
}

Represents the parameters in a search for `TeamMember` objects.

type SearchTeamMembersRequest ¶

type SearchTeamMembersRequest struct {
	Query *SearchTeamMembersQuery `json:"query,omitempty"`
	// The maximum number of `TeamMember` objects in a page (100 by default).
	Limit int32 `json:"limit,omitempty"`
	// The opaque cursor for fetching the next page. For more information, see [pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Represents a search request for a filtered list of `TeamMember` objects.

type SearchTeamMembersResponse ¶

type SearchTeamMembersResponse struct {
	// The filtered list of `TeamMember` objects.
	TeamMembers []TeamMember `json:"team_members,omitempty"`
	// The opaque cursor for fetching the next page. For more information, see [pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
	Cursor string `json:"cursor,omitempty"`
	// The errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response from a search request containing a filtered list of `TeamMember` objects.

type SearchTerminalActionsRequest ¶

type SearchTerminalActionsRequest struct {
	Query *TerminalActionQuery `json:"query,omitempty"`
	// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
	// Limit the number of results returned for a single request.
	Limit int32 `json:"limit,omitempty"`
}

type SearchTerminalActionsResponse ¶

type SearchTerminalActionsResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The requested search result of `TerminalAction`s.
	Action []TerminalAction `json:"action,omitempty"`
	// The pagination cursor to be used in a subsequent request. If empty, this is the final response.  See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
}

type SearchTerminalCheckoutsRequest ¶

type SearchTerminalCheckoutsRequest struct {
	Query *TerminalCheckoutQuery `json:"query,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. See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
	// Limits the number of results returned for a single request.
	Limit int32 `json:"limit,omitempty"`
}

type SearchTerminalCheckoutsResponse ¶

type SearchTerminalCheckoutsResponse struct {
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The requested search result of `TerminalCheckout` objects.
	Checkouts []TerminalCheckout `json:"checkouts,omitempty"`
	// The pagination cursor to be used in a subsequent request. If empty, this is the final response.  See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
}

type SearchTerminalRefundsRequest ¶

type SearchTerminalRefundsRequest struct {
	Query *TerminalRefundQuery `json:"query,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.
	Cursor string `json:"cursor,omitempty"`
	// Limits the number of results returned for a single request.
	Limit int32 `json:"limit,omitempty"`
}

type SearchTerminalRefundsResponse ¶

type SearchTerminalRefundsResponse struct {
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The requested search result of `TerminalRefund` objects.
	Refunds []TerminalRefund `json:"refunds,omitempty"`
	// The pagination cursor to be used in a subsequent request. If empty, this is the final response.  See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
}

type SearchVendorsRequest ¶

type SearchVendorsRequest struct {
	Filter json.RawMessage `json:"filter,omitempty"`
	Sort   json.RawMessage `json:"sort,omitempty"`
	// A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.  See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.
	Cursor string `json:"cursor,omitempty"`
}

Represents an input into a call to [SearchVendors](https://developer.squareup.com/reference/square_2024-07-17/vendors-api/search-vendors).

type SearchVendorsRequestFilter ¶

type SearchVendorsRequestFilter struct {
	// The names of the [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) objects to retrieve.
	Name []string `json:"name,omitempty"`
	// The statuses of the [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) objects to retrieve.
	Status []string `json:"status,omitempty"`
}

Defines supported query expressions to search for vendors by.

type SearchVendorsRequestSort ¶

type SearchVendorsRequestSort struct {
	// Specifies the sort key to sort the returned vendors.
	Field string `json:"field,omitempty"`
	// Specifies the sort order for the returned vendors.
	Order string `json:"order,omitempty"`
}

Defines a sorter used to sort results from [SearchVendors](https://developer.squareup.com/reference/square_2024-07-17/vendors-api/search-vendors).

type SearchVendorsRequestSortField ¶

type SearchVendorsRequestSortField string

SearchVendorsRequestSortField : The field to sort the returned Vendor(https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) objects by.

const (
	NAME_SearchVendorsRequestSortField       SearchVendorsRequestSortField = "NAME"
	CREATED_AT_SearchVendorsRequestSortField SearchVendorsRequestSortField = "CREATED_AT"
)

List of SearchVendorsRequestSortField

type SearchVendorsResponse ¶

type SearchVendorsResponse struct {
	// Errors encountered when the request fails.
	Errors []ModelError `json:"errors,omitempty"`
	// The [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) objects matching the specified search filter.
	Vendors []Vendor `json:"vendors,omitempty"`
	// The pagination cursor to be used in a subsequent request. If unset, this is the final response.  See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.
	Cursor string `json:"cursor,omitempty"`
}

Represents an output from a call to [SearchVendors](https://developer.squareup.com/reference/square_2024-07-17/vendors-api/search-vendors).

type SegmentFilter ¶

type SegmentFilter struct {
	// The ID of the [CatalogItemVariation](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogItemVariation) object representing the service booked in this segment.
	ServiceVariationId string       `json:"service_variation_id"`
	TeamMemberIdFilter *FilterValue `json:"team_member_id_filter,omitempty"`
}

A query filter to search for buyer-accessible appointment segments by.

type SelectOption ¶

type SelectOption struct {
	// The reference id for the option.
	ReferenceId string `json:"reference_id"`
	// The title text that displays in the select option button.
	Title string `json:"title"`
}

type SelectOptions ¶

type SelectOptions struct {
	// The title text to display in the select flow on the Terminal.
	Title string `json:"title"`
	// The body text to display in the select flow on the Terminal.
	Body string `json:"body"`
	// Represents the buttons/options that should be displayed in the select flow on the Terminal.
	Options        []SelectOption `json:"options"`
	SelectedOption *SelectOption  `json:"selected_option,omitempty"`
}

type Shift ¶

type Shift struct {
	// The UUID for this object.
	Id string `json:"id,omitempty"`
	// The ID of the employee this shift belongs to. DEPRECATED at version 2020-08-26. Use `team_member_id` instead.
	EmployeeId string `json:"employee_id,omitempty"`
	// The ID of the location this shift occurred at. The location should be based on where the employee clocked in.
	LocationId string `json:"location_id"`
	// The read-only convenience value that is calculated from the location based on the `location_id`. Format: the IANA timezone database identifier for the location timezone.
	Timezone string `json:"timezone,omitempty"`
	// RFC 3339; shifted to the location timezone + offset. Precision up to the minute is respected; seconds are truncated.
	StartAt string `json:"start_at"`
	// RFC 3339; shifted to the timezone + offset. Precision up to the minute is respected; seconds are truncated.
	EndAt string     `json:"end_at,omitempty"`
	Wage  *ShiftWage `json:"wage,omitempty"`
	// A list of all the paid or unpaid breaks that were taken during this shift.
	Breaks []ModelBreak `json:"breaks,omitempty"`
	// Describes the working state of the current `Shift`.
	Status string `json:"status,omitempty"`
	// Used for resolving concurrency issues. The request fails if the version provided does not match the server version at the time of the request. If not provided, Square executes a blind write; potentially overwriting data from another write.
	Version int32 `json:"version,omitempty"`
	// A read-only timestamp in RFC 3339 format; presented in UTC.
	CreatedAt string `json:"created_at,omitempty"`
	// A read-only timestamp in RFC 3339 format; presented in UTC.
	UpdatedAt string `json:"updated_at,omitempty"`
	// The ID of the team member this shift belongs to. Replaced `employee_id` at version \"2020-08-26\".
	TeamMemberId         string `json:"team_member_id,omitempty"`
	DeclaredCashTipMoney *Money `json:"declared_cash_tip_money,omitempty"`
}

A record of the hourly rate, start, and end times for a single work shift for an employee. This might include a record of the start and end times for breaks taken during the shift.

type ShiftFilter ¶

type ShiftFilter struct {
	// Fetch shifts for the specified location.
	LocationIds []string `json:"location_ids"`
	// Fetch shifts for the specified employees. DEPRECATED at version 2020-08-26. Use `team_member_ids` instead.
	EmployeeIds []string `json:"employee_ids,omitempty"`
	// Fetch a `Shift` instance by `Shift.status`.
	Status  string        `json:"status,omitempty"`
	Start   *TimeRange    `json:"start,omitempty"`
	End     *TimeRange    `json:"end,omitempty"`
	Workday *ShiftWorkday `json:"workday,omitempty"`
	// Fetch shifts for the specified team members. Replaced `employee_ids` at version \"2020-08-26\".
	TeamMemberIds []string `json:"team_member_ids"`
}

Defines a filter used in a search for `Shift` records. `AND` logic is used by Square's servers to apply each filter property specified.

type ShiftFilterStatus ¶

type ShiftFilterStatus string

ShiftFilterStatus : Specifies the `status` of `Shift` records to be returned.

const (
	OPEN_ShiftFilterStatus   ShiftFilterStatus = "OPEN"
	CLOSED_ShiftFilterStatus ShiftFilterStatus = "CLOSED"
)

List of ShiftFilterStatus

type ShiftQuery ¶

type ShiftQuery struct {
	Filter *ShiftFilter `json:"filter,omitempty"`
	Sort   *ShiftSort   `json:"sort,omitempty"`
}

The parameters of a `Shift` search query, which includes filter and sort options.

type ShiftSort ¶

type ShiftSort struct {
	// The field to sort on.
	Field string `json:"field,omitempty"`
	// The order in which results are returned. Defaults to DESC.
	Order string `json:"order,omitempty"`
}

Sets the sort order of search results.

type ShiftSortField ¶

type ShiftSortField string

ShiftSortField : Enumerates the `Shift` fields to sort on.

const (
	START_AT_ShiftSortField   ShiftSortField = "START_AT"
	END_AT_ShiftSortField     ShiftSortField = "END_AT"
	CREATED_AT_ShiftSortField ShiftSortField = "CREATED_AT"
	UPDATED_AT_ShiftSortField ShiftSortField = "UPDATED_AT"
)

List of ShiftSortField

type ShiftStatus ¶

type ShiftStatus string

ShiftStatus : Enumerates the possible status of a `Shift`.

const (
	OPEN_ShiftStatus   ShiftStatus = "OPEN"
	CLOSED_ShiftStatus ShiftStatus = "CLOSED"
)

List of ShiftStatus

type ShiftWage ¶

type ShiftWage struct {
	// The name of the job performed during this shift.
	Title      string `json:"title,omitempty"`
	HourlyRate *Money `json:"hourly_rate,omitempty"`
	// The id of the job performed during this shift. Square labor-reporting UIs might group shifts together by id. This cannot be used to retrieve the job.
	JobId string `json:"job_id,omitempty"`
	// Whether team members are eligible for tips when working this job.
	TipEligible bool `json:"tip_eligible,omitempty"`
}

The hourly wage rate used to compensate an employee for this shift.

type ShiftWorkday ¶

type ShiftWorkday struct {
	DateRange *DateRange `json:"date_range,omitempty"`
	// The strategy on which the dates are applied.
	MatchShiftsBy string `json:"match_shifts_by,omitempty"`
	// Location-specific timezones convert workdays to datetime filters. Every location included in the query must have a timezone or this field must be provided as a fallback. Format: the IANA timezone database identifier for the relevant timezone.
	DefaultTimezone string `json:"default_timezone,omitempty"`
}

A `Shift` search query filter parameter that sets a range of days that a `Shift` must start or end in before passing the filter condition.

type ShiftWorkdayMatcher ¶

type ShiftWorkdayMatcher string

ShiftWorkdayMatcher : Defines the logic used to apply a workday filter.

const (
	START_AT_ShiftWorkdayMatcher     ShiftWorkdayMatcher = "START_AT"
	END_AT_ShiftWorkdayMatcher       ShiftWorkdayMatcher = "END_AT"
	INTERSECTION_ShiftWorkdayMatcher ShiftWorkdayMatcher = "INTERSECTION"
)

List of ShiftWorkdayMatcher

type ShippingFee ¶

type ShippingFee struct {
	// The name for the shipping fee.
	Name   string `json:"name,omitempty"`
	Charge *Money `json:"charge"`
}

type SignatureImage ¶

type SignatureImage struct {
	// The mime/type of the image data. Use `image/png;base64` for png.
	ImageType string `json:"image_type,omitempty"`
	// The base64 representation of the image.
	Data string `json:"data,omitempty"`
}

type SignatureOptions ¶

type SignatureOptions struct {
	// The title text to display in the signature capture flow on the Terminal.
	Title string `json:"title"`
	// The body text to display in the signature capture flow on the Terminal.
	Body string `json:"body"`
	// An image representation of the collected signature.
	Signature []SignatureImage `json:"signature,omitempty"`
}

type Site ¶

type Site struct {
	// The Square-assigned ID of the site.
	Id string `json:"id,omitempty"`
	// The title of the site.
	SiteTitle string `json:"site_title,omitempty"`
	// The domain of the site (without the protocol). For example, `mysite1.square.site`.
	Domain string `json:"domain,omitempty"`
	// Indicates whether the site is published.
	IsPublished bool `json:"is_published,omitempty"`
	// The timestamp of when the site was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp of when the site was last updated, in RFC 3339 format.
	UpdatedAt string `json:"updated_at,omitempty"`
}

Represents a Square Online site, which is an online store for a Square seller.

type SitesApiService ¶

type SitesApiService service

func (*SitesApiService) ListSites ¶

func (a *SitesApiService) ListSites(ctx context.Context) (ListSitesResponse, *http.Response, error)

SitesApiService ListSites Lists the Square Online sites that belong to a seller. Sites are listed in descending order by the `created_at` date. __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ListSitesResponse

type Snippet ¶

type Snippet struct {
	// The Square-assigned ID for the snippet.
	Id string `json:"id,omitempty"`
	// The ID of the site that contains the snippet.
	SiteId string `json:"site_id,omitempty"`
	// The snippet code, which can contain valid HTML, JavaScript, or both.
	Content string `json:"content"`
	// The timestamp of when the snippet was initially added to the site, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp of when the snippet was last updated on the site, in RFC 3339 format.
	UpdatedAt string `json:"updated_at,omitempty"`
}

Represents the snippet that is added to a Square Online site. The snippet code is injected into the `head` element of all pages on the site, except for checkout pages.

type SnippetResponse ¶

type SnippetResponse struct {
	// Any errors that occurred during the request.
	Errors  []ModelError `json:"errors,omitempty"`
	Snippet *Snippet     `json:"snippet,omitempty"`
}

type SnippetsApiService ¶

type SnippetsApiService service

func (*SnippetsApiService) DeleteSnippet ¶

func (a *SnippetsApiService) DeleteSnippet(ctx context.Context, siteId string) (DeleteSnippetResponse, *http.Response, error)

SnippetsApiService DeleteSnippet Removes your snippet from a Square Online site. You can call [ListSites](https://developer.squareup.com/reference/square_2024-07-17/sites-api/list-sites) to get the IDs of the sites that belong to a seller. __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param siteId The ID of the site that contains the snippet.

@return DeleteSnippetResponse

func (*SnippetsApiService) RetrieveSnippet ¶

func (a *SnippetsApiService) RetrieveSnippet(ctx context.Context, siteId string) (RetrieveSnippetResponse, *http.Response, error)

SnippetsApiService RetrieveSnippet Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application. You can call [ListSites](https://developer.squareup.com/reference/square_2024-07-17/sites-api/list-sites) to get the IDs of the sites that belong to a seller. __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param siteId The ID of the site that contains the snippet.

@return RetrieveSnippetResponse

func (*SnippetsApiService) UpsertSnippet ¶

func (a *SnippetsApiService) UpsertSnippet(ctx context.Context, body UpsertSnippetRequest, siteId string) (UpsertSnippetResponse, *http.Response, error)

SnippetsApiService UpsertSnippet Adds a snippet to a Square Online site or updates the existing snippet on the site. The snippet code is appended to the end of the `head` element on every page of the site, except checkout pages. A snippet application can add one snippet to a given site. You can call [ListSites](https://developer.squareup.com/reference/square_2024-07-17/sites-api/list-sites) to get the IDs of the sites that belong to a seller. __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param siteId The ID of the site where you want to add or update the snippet.

@return UpsertSnippetResponse

type SortOrder ¶

type SortOrder string

SortOrder : The order (e.g., chronological or alphabetical) in which results from a request are returned.

const (
	DESC_SortOrder SortOrder = "DESC"
	ASC_SortOrder  SortOrder = "ASC"
)

List of SortOrder

type SourceApplication ¶

type SourceApplication struct {
	// __Read only__ The [product](https://developer.squareup.com/reference/square_2024-07-17/enums/Product) type of the application.
	Product string `json:"product,omitempty"`
	// __Read only__ The Square-assigned ID of the application. This field is used only if the [product](https://developer.squareup.com/reference/square_2024-07-17/enums/Product) type is `EXTERNAL_API`.
	ApplicationId string `json:"application_id,omitempty"`
	// __Read only__ The display name of the application (for example, `\"Custom Application\"` or `\"Square POS 4.74 for Android\"`).
	Name string `json:"name,omitempty"`
}

Represents information about the application used to generate a change.

type SquareAccountDetails ¶

type SquareAccountDetails struct {
	// Unique identifier for the payment source used for this payment.
	PaymentSourceToken string `json:"payment_source_token,omitempty"`
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Additional details about Square Account payments.

type StandardUnitDescription ¶

type StandardUnitDescription struct {
	Unit *MeasurementUnit `json:"unit,omitempty"`
	// UI display name of the measurement unit. For example, 'Pound'.
	Name string `json:"name,omitempty"`
	// UI display abbreviation for the measurement unit. For example, 'lb'.
	Abbreviation string `json:"abbreviation,omitempty"`
}

Contains the name and abbreviation for standard measurement unit.

type StandardUnitDescriptionGroup ¶

type StandardUnitDescriptionGroup struct {
	// List of standard (non-custom) measurement units in this description group.
	StandardUnitDescriptions []StandardUnitDescription `json:"standard_unit_descriptions,omitempty"`
	// IETF language tag.
	LanguageCode string `json:"language_code,omitempty"`
}

Group of standard measurement units.

type SubmitEvidenceRequest ¶

type SubmitEvidenceRequest struct{}

Defines the parameters for a `SubmitEvidence` request.

type SubmitEvidenceResponse ¶

type SubmitEvidenceResponse struct {
	// Information about errors encountered during the request.
	Errors  []ModelError `json:"errors,omitempty"`
	Dispute *Dispute     `json:"dispute,omitempty"`
}

Defines the fields in a `SubmitEvidence` response.

type Subscription ¶

type Subscription struct {
	// The Square-assigned ID of the subscription.
	Id string `json:"id,omitempty"`
	// The ID of the location associated with the subscription.
	LocationId string `json:"location_id,omitempty"`
	// The ID of the subscribed-to [subscription plan variation](https://developer.squareup.com/reference/square_2024-07-17/objects/CatalogSubscriptionPlanVariation).
	PlanVariationId string `json:"plan_variation_id,omitempty"`
	// The ID of the subscribing [customer](https://developer.squareup.com/reference/square_2024-07-17/objects/Customer) profile.
	CustomerId string `json:"customer_id,omitempty"`
	// The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) to start the subscription.
	StartDate string `json:"start_date,omitempty"`
	// The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) to cancel the subscription,  when the subscription status changes to `CANCELED` and the subscription billing stops.  If this field is not set, the subscription ends according its subscription plan.  This field cannot be updated, other than being cleared.
	CanceledDate string `json:"canceled_date,omitempty"`
	// The `YYYY-MM-DD`-formatted date up to when the subscriber is invoiced for the subscription.  After the invoice is sent for a given billing period, this date will be the last day of the billing period. For example, suppose for the month of May a subscriber gets an invoice (or charged the card) on May 1. For the monthly billing scenario, this date is then set to May 31.
	ChargedThroughDate string `json:"charged_through_date,omitempty"`
	// The current status of the subscription.
	Status string `json:"status,omitempty"`
	// The tax amount applied when billing the subscription. The percentage is expressed in decimal form, using a `'.'` as the decimal separator and without a `'%'` sign. For example, a value of `7.5` corresponds to 7.5%.
	TaxPercentage string `json:"tax_percentage,omitempty"`
	// The IDs of the [invoices](https://developer.squareup.com/reference/square_2024-07-17/objects/Invoice) created for the subscription, listed in order when the invoices were created (newest invoices appear first).
	InvoiceIds         []string `json:"invoice_ids,omitempty"`
	PriceOverrideMoney *Money   `json:"price_override_money,omitempty"`
	// The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting.
	Version int64 `json:"version,omitempty"`
	// The timestamp when the subscription was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The ID of the [subscriber's](https://developer.squareup.com/reference/square_2024-07-17/objects/Customer) [card](https://developer.squareup.com/reference/square_2024-07-17/objects/Card) used to charge for the subscription.
	CardId string `json:"card_id,omitempty"`
	// Timezone that will be used in date calculations for the subscription. Defaults to the timezone of the location based on `location_id`. Format: the IANA Timezone Database identifier for the location timezone (for example, `America/Los_Angeles`).
	Timezone string              `json:"timezone,omitempty"`
	Source   *SubscriptionSource `json:"source,omitempty"`
	// The list of scheduled actions on this subscription. It is set only in the response from   [RetrieveSubscription](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/retrieve-subscription) with the query parameter of `include=actions` or from  [SearchSubscriptions](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/search-subscriptions) with the input parameter  of `include:[\"actions\"]`.
	Actions []SubscriptionAction `json:"actions,omitempty"`
	// The day of the month on which the subscription will issue invoices and publish orders.
	MonthlyBillingAnchorDate int32 `json:"monthly_billing_anchor_date,omitempty"`
	// array of phases for this subscription
	Phases []Phase `json:"phases,omitempty"`
}

Represents a subscription purchased by a customer. For more information, see [Manage Subscriptions](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions).

type SubscriptionAction ¶

type SubscriptionAction struct {
	// The ID of an action scoped to a subscription.
	Id string `json:"id,omitempty"`
	// The type of the action.
	Type_ string `json:"type,omitempty"`
	// The `YYYY-MM-DD`-formatted date when the action occurs on the subscription.
	EffectiveDate string `json:"effective_date,omitempty"`
	// The new billing anchor day value, for a `CHANGE_BILLING_ANCHOR_DATE` action.
	MonthlyBillingAnchorDate int32 `json:"monthly_billing_anchor_date,omitempty"`
	// A list of Phases, to pass phase-specific information used in the swap.
	Phases []Phase `json:"phases,omitempty"`
	// The target subscription plan variation that a subscription switches to, for a `SWAP_PLAN` action.
	NewPlanVariationId string `json:"new_plan_variation_id,omitempty"`
}

Represents an action as a pending change to a subscription.

type SubscriptionActionType ¶

type SubscriptionActionType string

SubscriptionActionType : Supported types of an action as a pending change to a subscription.

const (
	CANCEL_SubscriptionActionType                     SubscriptionActionType = "CANCEL"
	PAUSE_SubscriptionActionType                      SubscriptionActionType = "PAUSE"
	RESUME_SubscriptionActionType                     SubscriptionActionType = "RESUME"
	SWAP_PLAN_SubscriptionActionType                  SubscriptionActionType = "SWAP_PLAN"
	CHANGE_BILLING_ANCHOR_DATE_SubscriptionActionType SubscriptionActionType = "CHANGE_BILLING_ANCHOR_DATE"
)

List of SubscriptionActionType

type SubscriptionCadence ¶

type SubscriptionCadence string

SubscriptionCadence : Determines the billing cadence of a Subscription(https://developer.squareup.com/reference/square_2024-07-17/objects/Subscription)

const (
	DAILY_SubscriptionCadence             SubscriptionCadence = "DAILY"
	WEEKLY_SubscriptionCadence            SubscriptionCadence = "WEEKLY"
	EVERY_TWO_WEEKS_SubscriptionCadence   SubscriptionCadence = "EVERY_TWO_WEEKS"
	THIRTY_DAYS_SubscriptionCadence       SubscriptionCadence = "THIRTY_DAYS"
	SIXTY_DAYS_SubscriptionCadence        SubscriptionCadence = "SIXTY_DAYS"
	NINETY_DAYS_SubscriptionCadence       SubscriptionCadence = "NINETY_DAYS"
	MONTHLY_SubscriptionCadence           SubscriptionCadence = "MONTHLY"
	EVERY_TWO_MONTHS_SubscriptionCadence  SubscriptionCadence = "EVERY_TWO_MONTHS"
	QUARTERLY_SubscriptionCadence         SubscriptionCadence = "QUARTERLY"
	EVERY_FOUR_MONTHS_SubscriptionCadence SubscriptionCadence = "EVERY_FOUR_MONTHS"
	EVERY_SIX_MONTHS_SubscriptionCadence  SubscriptionCadence = "EVERY_SIX_MONTHS"
	ANNUAL_SubscriptionCadence            SubscriptionCadence = "ANNUAL"
	EVERY_TWO_YEARS_SubscriptionCadence   SubscriptionCadence = "EVERY_TWO_YEARS"
)

List of SubscriptionCadence

type SubscriptionEvent ¶

type SubscriptionEvent struct {
	// The ID of the subscription event.
	Id string `json:"id"`
	// Type of the subscription event.
	SubscriptionEventType string `json:"subscription_event_type"`
	// The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) when the subscription event occurred.
	EffectiveDate string `json:"effective_date"`
	// The day-of-the-month the billing anchor date was changed to, if applicable.
	MonthlyBillingAnchorDate int32           `json:"monthly_billing_anchor_date,omitempty"`
	Info                     json.RawMessage `json:"info,omitempty"`
	// A list of Phases, to pass phase-specific information used in the swap.
	Phases []Phase `json:"phases,omitempty"`
	// The ID of the subscription plan variation associated with the subscription.
	PlanVariationId string `json:"plan_variation_id"`
}

Describes changes to a subscription and the subscription status.

type SubscriptionEventInfo ¶

type SubscriptionEventInfo struct {
	// A human-readable explanation for the event.
	Detail string          `json:"detail,omitempty"`
	Code   json.RawMessage `json:"code,omitempty"`
}

Provides information about the subscription event.

type SubscriptionEventInfoCode ¶

type SubscriptionEventInfoCode string

SubscriptionEventInfoCode : Supported info codes of a subscription event.

const (
	LOCATION_NOT_ACTIVE_SubscriptionEventInfoCode            SubscriptionEventInfoCode = "LOCATION_NOT_ACTIVE"
	LOCATION_CANNOT_ACCEPT_PAYMENT_SubscriptionEventInfoCode SubscriptionEventInfoCode = "LOCATION_CANNOT_ACCEPT_PAYMENT"
	CUSTOMER_DELETED_SubscriptionEventInfoCode               SubscriptionEventInfoCode = "CUSTOMER_DELETED"
	CUSTOMER_NO_EMAIL_SubscriptionEventInfoCode              SubscriptionEventInfoCode = "CUSTOMER_NO_EMAIL"
	CUSTOMER_NO_NAME_SubscriptionEventInfoCode               SubscriptionEventInfoCode = "CUSTOMER_NO_NAME"
	USER_PROVIDED_SubscriptionEventInfoCode                  SubscriptionEventInfoCode = "USER_PROVIDED"
)

List of SubscriptionEventInfoCode

type SubscriptionEventSubscriptionEventType ¶

type SubscriptionEventSubscriptionEventType string

SubscriptionEventSubscriptionEventType : Supported types of an event occurred to a subscription.

const (
	START_SUBSCRIPTION_SubscriptionEventSubscriptionEventType          SubscriptionEventSubscriptionEventType = "START_SUBSCRIPTION"
	PLAN_CHANGE_SubscriptionEventSubscriptionEventType                 SubscriptionEventSubscriptionEventType = "PLAN_CHANGE"
	STOP_SUBSCRIPTION_SubscriptionEventSubscriptionEventType           SubscriptionEventSubscriptionEventType = "STOP_SUBSCRIPTION"
	DEACTIVATE_SUBSCRIPTION_SubscriptionEventSubscriptionEventType     SubscriptionEventSubscriptionEventType = "DEACTIVATE_SUBSCRIPTION"
	RESUME_SUBSCRIPTION_SubscriptionEventSubscriptionEventType         SubscriptionEventSubscriptionEventType = "RESUME_SUBSCRIPTION"
	PAUSE_SUBSCRIPTION_SubscriptionEventSubscriptionEventType          SubscriptionEventSubscriptionEventType = "PAUSE_SUBSCRIPTION"
	BILLING_ANCHOR_DATE_CHANGED_SubscriptionEventSubscriptionEventType SubscriptionEventSubscriptionEventType = "BILLING_ANCHOR_DATE_CHANGED"
)

List of SubscriptionEventSubscriptionEventType

type SubscriptionPhase ¶

type SubscriptionPhase struct {
	// The Square-assigned ID of the subscription phase. This field cannot be changed after a `SubscriptionPhase` is created.
	Uid string `json:"uid,omitempty"`
	// The billing cadence of the phase. For example, weekly or monthly. This field cannot be changed after a `SubscriptionPhase` is created.
	Cadence string `json:"cadence"`
	// The number of `cadence`s the phase lasts. If not set, the phase never ends. Only the last phase can be indefinite. This field cannot be changed after a `SubscriptionPhase` is created.
	Periods             int32  `json:"periods,omitempty"`
	RecurringPriceMoney *Money `json:"recurring_price_money,omitempty"`
	// The position this phase appears in the sequence of phases defined for the plan, indexed from 0. This field cannot be changed after a `SubscriptionPhase` is created.
	Ordinal int64                `json:"ordinal,omitempty"`
	Pricing *SubscriptionPricing `json:"pricing,omitempty"`
}

Describes a phase in a subscription plan variation. For more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations).

type SubscriptionPricing ¶

type SubscriptionPricing struct {
	// RELATIVE or STATIC
	Type_ string `json:"type,omitempty"`
	// The ids of the discount catalog objects
	DiscountIds []string `json:"discount_ids,omitempty"`
	PriceMoney  *Money   `json:"price_money,omitempty"`
}

Describes the pricing for the subscription.

type SubscriptionPricingType ¶

type SubscriptionPricingType string

SubscriptionPricingType : Determines the pricing of a Subscription(https://developer.squareup.com/reference/square_2024-07-17/objects/Subscription)

const (
	STATIC_SubscriptionPricingType   SubscriptionPricingType = "STATIC"
	RELATIVE_SubscriptionPricingType SubscriptionPricingType = "RELATIVE"
)

List of SubscriptionPricingType

type SubscriptionSource ¶

type SubscriptionSource struct {
	// The name used to identify the place (physical or digital) that a subscription originates. If unset, the name defaults to the name of the application that created the subscription.
	Name string `json:"name,omitempty"`
}

The origination details of the subscription.

type SubscriptionStatus ¶

type SubscriptionStatus string

SubscriptionStatus : Supported subscription statuses.

const (
	PENDING_SubscriptionStatus     SubscriptionStatus = "PENDING"
	ACTIVE_SubscriptionStatus      SubscriptionStatus = "ACTIVE"
	CANCELED_SubscriptionStatus    SubscriptionStatus = "CANCELED"
	DEACTIVATED_SubscriptionStatus SubscriptionStatus = "DEACTIVATED"
	PAUSED_SubscriptionStatus      SubscriptionStatus = "PAUSED"
)

List of SubscriptionStatus

type SubscriptionTestResult ¶

type SubscriptionTestResult struct {
	// A Square-generated unique ID for the subscription test result.
	Id string `json:"id,omitempty"`
	// The status code returned by the subscription notification URL.
	StatusCode int32 `json:"status_code,omitempty"`
	// An object containing the payload of the test event. For example, a `payment.created` event.
	Payload string `json:"payload,omitempty"`
	// The timestamp of when the subscription was created, in RFC 3339 format.  For example, \"2016-09-04T23:59:33.123Z\".
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp of when the subscription was updated, in RFC 3339 format. For example, \"2016-09-04T23:59:33.123Z\". Because a subscription test result is unique, this field is the same as the `created_at` field.
	UpdatedAt string `json:"updated_at,omitempty"`
}

Represents the details of a webhook subscription, including notification URL, event types, and signature key.

type SubscriptionsApiListSubscriptionEventsOpts ¶

type SubscriptionsApiListSubscriptionEventsOpts struct {
	Cursor optional.String
	Limit  optional.Int32
}

type SubscriptionsApiRetrieveSubscriptionOpts ¶

type SubscriptionsApiRetrieveSubscriptionOpts struct {
	Include optional.String
}

type SubscriptionsApiService ¶

type SubscriptionsApiService service

func (*SubscriptionsApiService) BulkSwapPlan ¶

func (a *SubscriptionsApiService) BulkSwapPlan(ctx context.Context, body BulkSwapPlanRequest) (BulkSwapPlanResponse, *http.Response, error)

SubscriptionsApiService BulkSwapPlan Schedules a plan variation change for all active subscriptions under a given plan variation. For more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkSwapPlanResponse

func (*SubscriptionsApiService) CancelSubscription ¶

func (a *SubscriptionsApiService) CancelSubscription(ctx context.Context, subscriptionId string) (CancelSubscriptionResponse, *http.Response, error)

SubscriptionsApiService CancelSubscription Schedules a `CANCEL` action to cancel an active subscription. This sets the `canceled_date` field to the end of the active billing period. After this date, the subscription status changes from ACTIVE to CANCELED.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param subscriptionId The ID of the subscription to cancel.

@return CancelSubscriptionResponse

func (*SubscriptionsApiService) ChangeBillingAnchorDate ¶

func (a *SubscriptionsApiService) ChangeBillingAnchorDate(ctx context.Context, body ChangeBillingAnchorDateRequest, subscriptionId string) (ChangeBillingAnchorDateResponse, *http.Response, error)

SubscriptionsApiService ChangeBillingAnchorDate Changes the [billing anchor date](https://developer.squareup.com/docs/subscriptions-api/subscription-billing#billing-dates) for a subscription.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param subscriptionId The ID of the subscription to update the billing anchor date.

@return ChangeBillingAnchorDateResponse

func (*SubscriptionsApiService) CreateSubscription ¶

func (a *SubscriptionsApiService) CreateSubscription(ctx context.Context, body CreateSubscriptionRequest) (CreateSubscriptionResponse, *http.Response, error)

SubscriptionsApiService CreateSubscription Enrolls a customer in a subscription. If you provide a card on file in the request, Square charges the card for the subscription. Otherwise, Square sends an invoice to the customer's email address. The subscription starts immediately, unless the request includes the optional `start_date`. Each individual subscription is associated with a particular location. For more information, see [Create a subscription](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#create-a-subscription).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateSubscriptionResponse

func (*SubscriptionsApiService) DeleteSubscriptionAction ¶

func (a *SubscriptionsApiService) DeleteSubscriptionAction(ctx context.Context, subscriptionId string, actionId string) (DeleteSubscriptionActionResponse, *http.Response, error)

SubscriptionsApiService DeleteSubscriptionAction Deletes a scheduled action for a subscription.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param subscriptionId The ID of the subscription the targeted action is to act upon.
@param actionId The ID of the targeted action to be deleted.

@return DeleteSubscriptionActionResponse

func (*SubscriptionsApiService) ListSubscriptionEvents ¶

func (a *SubscriptionsApiService) ListSubscriptionEvents(ctx context.Context, subscriptionId string, localVarOptionals *SubscriptionsApiListSubscriptionEventsOpts) (ListSubscriptionEventsResponse, *http.Response, error)

func (*SubscriptionsApiService) PauseSubscription ¶

func (a *SubscriptionsApiService) PauseSubscription(ctx context.Context, body PauseSubscriptionRequest, subscriptionId string) (PauseSubscriptionResponse, *http.Response, error)

SubscriptionsApiService PauseSubscription Schedules a `PAUSE` action to pause an active subscription.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param subscriptionId The ID of the subscription to pause.

@return PauseSubscriptionResponse

func (*SubscriptionsApiService) ResumeSubscription ¶

func (a *SubscriptionsApiService) ResumeSubscription(ctx context.Context, body ResumeSubscriptionRequest, subscriptionId string) (ResumeSubscriptionResponse, *http.Response, error)

SubscriptionsApiService ResumeSubscription Schedules a `RESUME` action to resume a paused or a deactivated subscription.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param subscriptionId The ID of the subscription to resume.

@return ResumeSubscriptionResponse

func (*SubscriptionsApiService) RetrieveSubscription ¶

func (a *SubscriptionsApiService) RetrieveSubscription(ctx context.Context, subscriptionId string, localVarOptionals *SubscriptionsApiRetrieveSubscriptionOpts) (RetrieveSubscriptionResponse, *http.Response, error)

func (*SubscriptionsApiService) SearchSubscriptions ¶

func (a *SubscriptionsApiService) SearchSubscriptions(ctx context.Context, body SearchSubscriptionsRequest) (SearchSubscriptionsResponse, *http.Response, error)

SubscriptionsApiService SearchSubscriptions Searches for subscriptions. Results are ordered chronologically by subscription creation date. If the request specifies more than one location ID, the endpoint orders the result by location ID, and then by creation date within each location. If no locations are given in the query, all locations are searched. You can also optionally specify `customer_ids` to search by customer. If left unset, all customers associated with the specified locations are returned. If the request specifies customer IDs, the endpoint orders results first by location, within location by customer ID, and within customer by subscription creation date.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return SearchSubscriptionsResponse

func (*SubscriptionsApiService) SwapPlan ¶

func (a *SubscriptionsApiService) SwapPlan(ctx context.Context, body SwapPlanRequest, subscriptionId string) (SwapPlanResponse, *http.Response, error)

SubscriptionsApiService SwapPlan Schedules a `SWAP_PLAN` action to swap a subscription plan variation in an existing subscription. For more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param subscriptionId The ID of the subscription to swap the subscription plan for.

@return SwapPlanResponse

func (*SubscriptionsApiService) UpdateSubscription ¶

func (a *SubscriptionsApiService) UpdateSubscription(ctx context.Context, body UpdateSubscriptionRequest, subscriptionId string) (UpdateSubscriptionResponse, *http.Response, error)

SubscriptionsApiService UpdateSubscription Updates a subscription by modifying or clearing `subscription` field values. To clear a field, set its value to `null`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param subscriptionId The ID of the subscription to update.

@return UpdateSubscriptionResponse

type SwapPlanRequest ¶

type SwapPlanRequest struct {
	// The ID of the new subscription plan variation.  This field is required.
	NewPlanVariationId string `json:"new_plan_variation_id,omitempty"`
	// A list of PhaseInputs, to pass phase-specific information used in the swap.
	Phases []PhaseInput `json:"phases,omitempty"`
}

Defines input parameters in a call to the [SwapPlan](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/swap-plan) endpoint.

type SwapPlanResponse ¶

type SwapPlanResponse struct {
	// Errors encountered during the request.
	Errors       []ModelError  `json:"errors,omitempty"`
	Subscription *Subscription `json:"subscription,omitempty"`
	// A list of a `SWAP_PLAN` action created by the request.
	Actions []SubscriptionAction `json:"actions,omitempty"`
}

Defines output parameters in a response of the [SwapPlan](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/swap-plan) endpoint.

type TaxCalculationPhase ¶

type TaxCalculationPhase string

TaxCalculationPhase : When to calculate the taxes due on a cart.

const (
	SUBTOTAL_PHASE_TaxCalculationPhase TaxCalculationPhase = "TAX_SUBTOTAL_PHASE"
	TOTAL_PHASE_TaxCalculationPhase    TaxCalculationPhase = "TAX_TOTAL_PHASE"
)

List of TaxCalculationPhase

type TaxIds ¶

type TaxIds struct {
	// The EU VAT number for this location. For example, `IE3426675K`. If the EU VAT number is present, it is well-formed and has been validated with VIES, the VAT Information Exchange System.
	EuVat string `json:"eu_vat,omitempty"`
	// The SIRET (Système d'Identification du Répertoire des Entreprises et de leurs Etablissements) number is a 14-digit code issued by the French INSEE. For example, `39922799000021`.
	FrSiret string `json:"fr_siret,omitempty"`
	// The French government uses the NAF (Nomenclature des Activités Françaises) to display and track economic statistical data. This is also called the APE (Activite Principale de l’Entreprise) code. For example, `6910Z`.
	FrNaf string `json:"fr_naf,omitempty"`
	// The NIF (Numero de Identificacion Fiscal) number is a nine-character tax identifier used in Spain. If it is present, it has been validated. For example, `73628495A`.
	EsNif string `json:"es_nif,omitempty"`
	// The QII (Qualified Invoice Issuer) number is a 14-character tax identifier used in Japan. For example, `T1234567890123`.
	JpQii string `json:"jp_qii,omitempty"`
}

Identifiers for the location used by various governments for tax purposes.

type TaxInclusionType ¶

type TaxInclusionType string

TaxInclusionType : Whether to the tax amount should be additional to or included in the CatalogItem price.

const (
	ADDITIVE_TaxInclusionType  TaxInclusionType = "ADDITIVE"
	INCLUSIVE_TaxInclusionType TaxInclusionType = "INCLUSIVE"
)

List of TaxInclusionType

type TeamApiService ¶

type TeamApiService service

func (*TeamApiService) BulkCreateTeamMembers ¶

func (a *TeamApiService) BulkCreateTeamMembers(ctx context.Context, body BulkCreateTeamMembersRequest) (BulkCreateTeamMembersResponse, *http.Response, error)

TeamApiService BulkCreateTeamMembers Creates multiple `TeamMember` objects. The created `TeamMember` objects are returned on successful creates. This process is non-transactional and processes as much of the request as possible. If one of the creates in the request cannot be successfully processed, the request is not marked as failed, but the body of the response contains explicit error information for the failed create. Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#bulk-create-team-members).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkCreateTeamMembersResponse

func (*TeamApiService) BulkUpdateTeamMembers ¶

func (a *TeamApiService) BulkUpdateTeamMembers(ctx context.Context, body BulkUpdateTeamMembersRequest) (BulkUpdateTeamMembersResponse, *http.Response, error)

TeamApiService BulkUpdateTeamMembers Updates multiple `TeamMember` objects. The updated `TeamMember` objects are returned on successful updates. This process is non-transactional and processes as much of the request as possible. If one of the updates in the request cannot be successfully processed, the request is not marked as failed, but the body of the response contains explicit error information for the failed update. Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#bulk-update-team-members).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkUpdateTeamMembersResponse

func (*TeamApiService) CreateTeamMember ¶

func (a *TeamApiService) CreateTeamMember(ctx context.Context, body CreateTeamMemberRequest) (CreateTeamMemberResponse, *http.Response, error)

TeamApiService CreateTeamMember Creates a single `TeamMember` object. The `TeamMember` object is returned on successful creates. You must provide the following values in your request to this endpoint: - `given_name` - `family_name` Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#createteammember).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateTeamMemberResponse

func (*TeamApiService) RetrieveTeamMember ¶

func (a *TeamApiService) RetrieveTeamMember(ctx context.Context, teamMemberId string) (RetrieveTeamMemberResponse, *http.Response, error)

TeamApiService RetrieveTeamMember Retrieves a `TeamMember` object for the given `TeamMember.id`. Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrieve-a-team-member).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param teamMemberId The ID of the team member to retrieve.

@return RetrieveTeamMemberResponse

func (*TeamApiService) RetrieveWageSetting ¶

func (a *TeamApiService) RetrieveWageSetting(ctx context.Context, teamMemberId string) (RetrieveWageSettingResponse, *http.Response, error)

TeamApiService RetrieveWageSetting Retrieves a `WageSetting` object for a team member specified by `TeamMember.id`. Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrievewagesetting).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param teamMemberId The ID of the team member for which to retrieve the wage setting.

@return RetrieveWageSettingResponse

func (*TeamApiService) SearchTeamMembers ¶

func (a *TeamApiService) SearchTeamMembers(ctx context.Context, body SearchTeamMembersRequest) (SearchTeamMembersResponse, *http.Response, error)

TeamApiService SearchTeamMembers Returns a paginated list of `TeamMember` objects for a business. The list can be filtered by the following: - location IDs - `status`

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return SearchTeamMembersResponse

func (*TeamApiService) UpdateTeamMember ¶

func (a *TeamApiService) UpdateTeamMember(ctx context.Context, body UpdateTeamMemberRequest, teamMemberId string) (UpdateTeamMemberResponse, *http.Response, error)

TeamApiService UpdateTeamMember Updates a single `TeamMember` object. The `TeamMember` object is returned on successful updates. Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#update-a-team-member).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param teamMemberId The ID of the team member to update.

@return UpdateTeamMemberResponse

func (*TeamApiService) UpdateWageSetting ¶

func (a *TeamApiService) UpdateWageSetting(ctx context.Context, body UpdateWageSettingRequest, teamMemberId string) (UpdateWageSettingResponse, *http.Response, error)

TeamApiService UpdateWageSetting Creates or updates a `WageSetting` object. The object is created if a `WageSetting` with the specified `team_member_id` does not exist. Otherwise, it fully replaces the `WageSetting` object for the team member. The `WageSetting` is returned on a successful update. Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#create-or-update-a-wage-setting).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param teamMemberId The ID of the team member for which to update the `WageSetting` object.

@return UpdateWageSettingResponse

type TeamMember ¶

type TeamMember struct {
	// The unique ID for the team member.
	Id string `json:"id,omitempty"`
	// A second ID used to associate the team member with an entity in another system.
	ReferenceId string `json:"reference_id,omitempty"`
	// Whether the team member is the owner of the Square account.
	IsOwner bool `json:"is_owner,omitempty"`
	// Describes the status of the team member.
	Status string `json:"status,omitempty"`
	// The given name (that is, the first name) associated with the team member.
	GivenName string `json:"given_name,omitempty"`
	// The family name (that is, the last name) associated with the team member.
	FamilyName string `json:"family_name,omitempty"`
	// The email address associated with the team member.
	EmailAddress string `json:"email_address,omitempty"`
	// The team member's phone number, in E.164 format. For example: +14155552671 - the country code is 1 for US +551155256325 - the country code is 55 for BR
	PhoneNumber string `json:"phone_number,omitempty"`
	// The timestamp, in RFC 3339 format, describing when the team member was created. For example, \"2018-10-04T04:00:00-07:00\" or \"2019-02-05T12:00:00Z\".
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp, in RFC 3339 format, describing when the team member was last updated. For example, \"2018-10-04T04:00:00-07:00\" or \"2019-02-05T12:00:00Z\".
	UpdatedAt         string                       `json:"updated_at,omitempty"`
	AssignedLocations *TeamMemberAssignedLocations `json:"assigned_locations,omitempty"`
}

A record representing an individual team member for a business.

type TeamMemberAssignedLocations ¶

type TeamMemberAssignedLocations struct {
	// The current assignment type of the team member.
	AssignmentType string `json:"assignment_type,omitempty"`
	// The explicit locations that the team member is assigned to.
	LocationIds []string `json:"location_ids,omitempty"`
}

An object that represents a team member's assignment to locations.

type TeamMemberAssignedLocationsAssignmentType ¶

type TeamMemberAssignedLocationsAssignmentType string

TeamMemberAssignedLocationsAssignmentType : Enumerates the possible assignment types that the team member can have.

const (
	ALL_CURRENT_AND_FUTURE_LOCATIONS_TeamMemberAssignedLocationsAssignmentType TeamMemberAssignedLocationsAssignmentType = "ALL_CURRENT_AND_FUTURE_LOCATIONS"
	EXPLICIT_LOCATIONS_TeamMemberAssignedLocationsAssignmentType               TeamMemberAssignedLocationsAssignmentType = "EXPLICIT_LOCATIONS"
)

List of TeamMemberAssignedLocationsAssignmentType

type TeamMemberBookingProfile ¶

type TeamMemberBookingProfile struct {
	// The ID of the [TeamMember](https://developer.squareup.com/reference/square_2024-07-17/objects/TeamMember) object for the team member associated with the booking profile.
	TeamMemberId string `json:"team_member_id,omitempty"`
	// The description of the team member.
	Description string `json:"description,omitempty"`
	// The display name of the team member.
	DisplayName string `json:"display_name,omitempty"`
	// Indicates whether the team member can be booked through the Bookings API or the seller's online booking channel or site (`true`) or not (`false`).
	IsBookable bool `json:"is_bookable,omitempty"`
	// The URL of the team member's image for the bookings profile.
	ProfileImageUrl string `json:"profile_image_url,omitempty"`
}

The booking profile of a seller's team member, including the team member's ID, display name, description and whether the team member can be booked as a service provider.

type TeamMemberInvitationStatus ¶

type TeamMemberInvitationStatus string

TeamMemberInvitationStatus : Enumerates the possible invitation statuses the team member can have within a business.

const (
	UNINVITED_TeamMemberInvitationStatus TeamMemberInvitationStatus = "UNINVITED"
	PENDING_TeamMemberInvitationStatus   TeamMemberInvitationStatus = "PENDING"
	ACCEPTED_TeamMemberInvitationStatus  TeamMemberInvitationStatus = "ACCEPTED"
)

List of TeamMemberInvitationStatus

type TeamMemberStatus ¶

type TeamMemberStatus string

TeamMemberStatus : Enumerates the possible statuses the team member can have within a business.

const (
	ACTIVE_TeamMemberStatus   TeamMemberStatus = "ACTIVE"
	INACTIVE_TeamMemberStatus TeamMemberStatus = "INACTIVE"
)

List of TeamMemberStatus

type TeamMemberWage ¶

type TeamMemberWage struct {
	// The UUID for this object.
	Id string `json:"id,omitempty"`
	// The `TeamMember` that this wage is assigned to.
	TeamMemberId string `json:"team_member_id,omitempty"`
	// The job title that this wage relates to.
	Title      string `json:"title,omitempty"`
	HourlyRate *Money `json:"hourly_rate,omitempty"`
	// An identifier for the job that this wage relates to. This cannot be used to retrieve the job.
	JobId string `json:"job_id,omitempty"`
	// Whether team members are eligible for tips when working this job.
	TipEligible bool `json:"tip_eligible,omitempty"`
}

The hourly wage rate that a team member earns on a `Shift` for doing the job specified by the `title` property of this object.

type Tender ¶

type Tender struct {
	// The tender's unique ID. It is the associated payment ID.
	Id string `json:"id,omitempty"`
	// The ID of the transaction's associated location.
	LocationId string `json:"location_id,omitempty"`
	// The ID of the tender's associated transaction.
	TransactionId string `json:"transaction_id,omitempty"`
	// The timestamp for when the tender was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// An optional note associated with the tender at the time of payment.
	Note               string `json:"note,omitempty"`
	AmountMoney        *Money `json:"amount_money,omitempty"`
	TipMoney           *Money `json:"tip_money,omitempty"`
	ProcessingFeeMoney *Money `json:"processing_fee_money,omitempty"`
	// If the tender is associated with a customer or represents a customer's card on file, this is the ID of the associated customer.
	CustomerId string `json:"customer_id,omitempty"`
	// The type of tender, such as `CARD` or `CASH`.
	Type_                 string                       `json:"type"`
	CardDetails           *TenderCardDetails           `json:"card_details,omitempty"`
	CashDetails           *TenderCashDetails           `json:"cash_details,omitempty"`
	BankAccountDetails    *TenderBankAccountDetails    `json:"bank_account_details,omitempty"`
	BuyNowPayLaterDetails *TenderBuyNowPayLaterDetails `json:"buy_now_pay_later_details,omitempty"`
	SquareAccountDetails  *TenderSquareAccountDetails  `json:"square_account_details,omitempty"`
	// Additional recipients (other than the merchant) receiving a portion of this tender. For example, fees assessed on the purchase by a third party integration.
	AdditionalRecipients []AdditionalRecipient `json:"additional_recipients,omitempty"`
	// The ID of the [Payment](https://developer.squareup.com/reference/square_2024-07-17/objects/Payment) that corresponds to this tender. This value is only present for payments created with the v2 Payments API.
	PaymentId string `json:"payment_id,omitempty"`
}

Represents a tender (i.e., a method of payment) used in a Square transaction.

type TenderBankAccountDetails ¶

type TenderBankAccountDetails struct {
	// The bank account payment's current state.  See [TenderBankAccountPaymentDetailsStatus](https://developer.squareup.com/reference/square_2024-07-17/enums/TenderBankAccountDetailsStatus) for possible values.
	Status string `json:"status,omitempty"`
}

Represents the details of a tender with `type` `BANK_ACCOUNT`. See BankAccountPaymentDetails(https://developer.squareup.com/reference/square_2024-07-17/objects/BankAccountPaymentDetails) for more exposed details of a bank account payment.

type TenderBankAccountDetailsStatus ¶

type TenderBankAccountDetailsStatus string

TenderBankAccountDetailsStatus : Indicates the bank account payment's current status.

const (
	PENDING_TenderBankAccountDetailsStatus   TenderBankAccountDetailsStatus = "PENDING"
	COMPLETED_TenderBankAccountDetailsStatus TenderBankAccountDetailsStatus = "COMPLETED"
	FAILED_TenderBankAccountDetailsStatus    TenderBankAccountDetailsStatus = "FAILED"
)

List of TenderBankAccountDetailsStatus

type TenderBuyNowPayLaterDetails ¶

type TenderBuyNowPayLaterDetails struct {
	// The Buy Now Pay Later brand.
	BuyNowPayLaterBrand string `json:"buy_now_pay_later_brand,omitempty"`
	// The buy now pay later payment's current state (such as `AUTHORIZED` or `CAPTURED`). See [TenderBuyNowPayLaterDetailsStatus](https://developer.squareup.com/reference/square_2024-07-17/enums/TenderBuyNowPayLaterDetailsStatus) for possible values.
	Status string `json:"status,omitempty"`
}

Represents the details of a tender with `type` `BUY_NOW_PAY_LATER`.

type TenderBuyNowPayLaterDetailsBrand ¶

type TenderBuyNowPayLaterDetailsBrand string

const (
	OTHER_BRAND_TenderBuyNowPayLaterDetailsBrand TenderBuyNowPayLaterDetailsBrand = "OTHER_BRAND"
	AFTERPAY_TenderBuyNowPayLaterDetailsBrand    TenderBuyNowPayLaterDetailsBrand = "AFTERPAY"
)

List of TenderBuyNowPayLaterDetailsBrand

type TenderBuyNowPayLaterDetailsStatus ¶

type TenderBuyNowPayLaterDetailsStatus string

const (
	AUTHORIZED_TenderBuyNowPayLaterDetailsStatus TenderBuyNowPayLaterDetailsStatus = "AUTHORIZED"
	CAPTURED_TenderBuyNowPayLaterDetailsStatus   TenderBuyNowPayLaterDetailsStatus = "CAPTURED"
	VOIDED_TenderBuyNowPayLaterDetailsStatus     TenderBuyNowPayLaterDetailsStatus = "VOIDED"
	FAILED_TenderBuyNowPayLaterDetailsStatus     TenderBuyNowPayLaterDetailsStatus = "FAILED"
)

List of TenderBuyNowPayLaterDetailsStatus

type TenderCardDetails ¶

type TenderCardDetails struct {
	// The credit card payment's current state (such as `AUTHORIZED` or `CAPTURED`). See [TenderCardDetailsStatus](https://developer.squareup.com/reference/square_2024-07-17/enums/TenderCardDetailsStatus) for possible values.
	Status string `json:"status,omitempty"`
	Card   *Card  `json:"card,omitempty"`
	// The method used to enter the card's details for the transaction.
	EntryMethod string `json:"entry_method,omitempty"`
}

Represents additional details of a tender with `type` `CARD` or `SQUARE_GIFT_CARD`

type TenderCardDetailsEntryMethod ¶

type TenderCardDetailsEntryMethod string

TenderCardDetailsEntryMethod : Indicates the method used to enter the card's details.

const (
	SWIPED_TenderCardDetailsEntryMethod      TenderCardDetailsEntryMethod = "SWIPED"
	KEYED_TenderCardDetailsEntryMethod       TenderCardDetailsEntryMethod = "KEYED"
	EMV_TenderCardDetailsEntryMethod         TenderCardDetailsEntryMethod = "EMV"
	ON_FILE_TenderCardDetailsEntryMethod     TenderCardDetailsEntryMethod = "ON_FILE"
	CONTACTLESS_TenderCardDetailsEntryMethod TenderCardDetailsEntryMethod = "CONTACTLESS"
)

List of TenderCardDetailsEntryMethod

type TenderCardDetailsStatus ¶

type TenderCardDetailsStatus string

TenderCardDetailsStatus : Indicates the card transaction's current status.

const (
	AUTHORIZED_TenderCardDetailsStatus TenderCardDetailsStatus = "AUTHORIZED"
	CAPTURED_TenderCardDetailsStatus   TenderCardDetailsStatus = "CAPTURED"
	VOIDED_TenderCardDetailsStatus     TenderCardDetailsStatus = "VOIDED"
	FAILED_TenderCardDetailsStatus     TenderCardDetailsStatus = "FAILED"
)

List of TenderCardDetailsStatus

type TenderCashDetails ¶

type TenderCashDetails struct {
	BuyerTenderedMoney *Money `json:"buyer_tendered_money,omitempty"`
	ChangeBackMoney    *Money `json:"change_back_money,omitempty"`
}

Represents the details of a tender with `type` `CASH`.

type TenderSquareAccountDetails ¶

type TenderSquareAccountDetails struct {
	// The Square Account payment's current state (such as `AUTHORIZED` or `CAPTURED`). See [TenderSquareAccountDetailsStatus](https://developer.squareup.com/reference/square_2024-07-17/enums/TenderSquareAccountDetailsStatus) for possible values.
	Status string `json:"status,omitempty"`
}

Represents the details of a tender with `type` `SQUARE_ACCOUNT`.

type TenderSquareAccountDetailsStatus ¶

type TenderSquareAccountDetailsStatus string

const (
	AUTHORIZED_TenderSquareAccountDetailsStatus TenderSquareAccountDetailsStatus = "AUTHORIZED"
	CAPTURED_TenderSquareAccountDetailsStatus   TenderSquareAccountDetailsStatus = "CAPTURED"
	VOIDED_TenderSquareAccountDetailsStatus     TenderSquareAccountDetailsStatus = "VOIDED"
	FAILED_TenderSquareAccountDetailsStatus     TenderSquareAccountDetailsStatus = "FAILED"
)

List of TenderSquareAccountDetailsStatus

type TenderType ¶

type TenderType string

TenderType : Indicates a tender's type.

const (
	CARD_TenderType              TenderType = "CARD"
	CASH_TenderType              TenderType = "CASH"
	THIRD_PARTY_CARD_TenderType  TenderType = "THIRD_PARTY_CARD"
	SQUARE_GIFT_CARD_TenderType  TenderType = "SQUARE_GIFT_CARD"
	NO_SALE_TenderType           TenderType = "NO_SALE"
	BANK_ACCOUNT_TenderType      TenderType = "BANK_ACCOUNT"
	WALLET_TenderType            TenderType = "WALLET"
	BUY_NOW_PAY_LATER_TenderType TenderType = "BUY_NOW_PAY_LATER"
	SQUARE_ACCOUNT_TenderType    TenderType = "SQUARE_ACCOUNT"
	OTHER_TenderType             TenderType = "OTHER"
)

List of TenderType

type TerminalAction ¶

type TerminalAction struct {
	// A unique ID for this `TerminalAction`.
	Id string `json:"id,omitempty"`
	// The unique Id of the device intended for this `TerminalAction`. The Id can be retrieved from /v2/devices api.
	DeviceId string `json:"device_id,omitempty"`
	// The duration as an RFC 3339 duration, after which the action will be automatically canceled. TerminalActions that are `PENDING` will be automatically `CANCELED` and have a cancellation reason of `TIMED_OUT`  Default: 5 minutes from creation  Maximum: 5 minutes
	DeadlineDuration string `json:"deadline_duration,omitempty"`
	// The status of the `TerminalAction`. Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`
	Status string `json:"status,omitempty"`
	// The reason why `TerminalAction` is canceled. Present if the status is `CANCELED`.
	CancelReason string `json:"cancel_reason,omitempty"`
	// The time when the `TerminalAction` was created as an RFC 3339 timestamp.
	CreatedAt string `json:"created_at,omitempty"`
	// The time when the `TerminalAction` was last updated as an RFC 3339 timestamp.
	UpdatedAt string `json:"updated_at,omitempty"`
	// The ID of the application that created the action.
	AppId string `json:"app_id,omitempty"`
	// The location id the action is attached to, if a link can be made.
	LocationId string `json:"location_id,omitempty"`
	// Represents the type of the action.
	Type_                 string                 `json:"type,omitempty"`
	QrCodeOptions         *QrCodeOptions         `json:"qr_code_options,omitempty"`
	SaveCardOptions       *SaveCardOptions       `json:"save_card_options,omitempty"`
	SignatureOptions      *SignatureOptions      `json:"signature_options,omitempty"`
	ConfirmationOptions   *ConfirmationOptions   `json:"confirmation_options,omitempty"`
	ReceiptOptions        *ReceiptOptions        `json:"receipt_options,omitempty"`
	DataCollectionOptions *DataCollectionOptions `json:"data_collection_options,omitempty"`
	SelectOptions         *SelectOptions         `json:"select_options,omitempty"`
	DeviceMetadata        *DeviceMetadata        `json:"device_metadata,omitempty"`
	// Indicates the action will be linked to another action and requires a waiting dialog to be displayed instead of returning to the idle screen on completion of the action.  Only supported on SIGNATURE, CONFIRMATION, DATA_COLLECTION, and SELECT types.
	AwaitNextAction bool `json:"await_next_action,omitempty"`
	// The timeout duration of the waiting dialog as an RFC 3339 duration, after which the waiting dialog will no longer be displayed and the Terminal will return to the idle screen.  Default: 5 minutes from when the waiting dialog is displayed  Maximum: 5 minutes
	AwaitNextActionDuration string `json:"await_next_action_duration,omitempty"`
}

Represents an action processed by the Square Terminal.

type TerminalActionActionType ¶

type TerminalActionActionType string

TerminalActionActionType : Describes the type of this unit and indicates which field contains the unit information. This is an ‘open’ enum.

const (
	QR_CODE_TerminalActionActionType         TerminalActionActionType = "QR_CODE"
	PING_TerminalActionActionType            TerminalActionActionType = "PING"
	SAVE_CARD_TerminalActionActionType       TerminalActionActionType = "SAVE_CARD"
	SIGNATURE_TerminalActionActionType       TerminalActionActionType = "SIGNATURE"
	CONFIRMATION_TerminalActionActionType    TerminalActionActionType = "CONFIRMATION"
	RECEIPT_TerminalActionActionType         TerminalActionActionType = "RECEIPT"
	DATA_COLLECTION_TerminalActionActionType TerminalActionActionType = "DATA_COLLECTION"
	SELECT__TerminalActionActionType         TerminalActionActionType = "SELECT"
)

List of TerminalActionActionType

type TerminalActionQuery ¶

type TerminalActionQuery struct {
	Filter *TerminalActionQueryFilter `json:"filter,omitempty"`
	Sort   *TerminalActionQuerySort   `json:"sort,omitempty"`
}

type TerminalActionQueryFilter ¶

type TerminalActionQueryFilter struct {
	// `TerminalAction`s associated with a specific device. If no device is specified then all `TerminalAction`s for the merchant will be displayed.
	DeviceId  string     `json:"device_id,omitempty"`
	CreatedAt *TimeRange `json:"created_at,omitempty"`
	// Filter results with the desired status of the `TerminalAction` Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`
	Status string `json:"status,omitempty"`
	// Filter results with the requested ActionType.
	Type_ string `json:"type,omitempty"`
}

type TerminalActionQuerySort ¶

type TerminalActionQuerySort struct {
	// The order in which results are listed. - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).
	SortOrder string `json:"sort_order,omitempty"`
}

type TerminalApiService ¶

type TerminalApiService service

func (*TerminalApiService) CancelTerminalAction ¶

func (a *TerminalApiService) CancelTerminalAction(ctx context.Context, actionId string) (CancelTerminalActionResponse, *http.Response, error)

TerminalApiService CancelTerminalAction Cancels a Terminal action request if the status of the request permits it.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param actionId Unique ID for the desired `TerminalAction`.

@return CancelTerminalActionResponse

func (*TerminalApiService) CancelTerminalCheckout ¶

func (a *TerminalApiService) CancelTerminalCheckout(ctx context.Context, checkoutId string) (CancelTerminalCheckoutResponse, *http.Response, error)

TerminalApiService CancelTerminalCheckout Cancels a Terminal checkout request if the status of the request permits it.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param checkoutId The unique ID for the desired `TerminalCheckout`.

@return CancelTerminalCheckoutResponse

func (*TerminalApiService) CancelTerminalRefund ¶

func (a *TerminalApiService) CancelTerminalRefund(ctx context.Context, terminalRefundId string) (CancelTerminalRefundResponse, *http.Response, error)

TerminalApiService CancelTerminalRefund Cancels an Interac Terminal refund request by refund request ID if the status of the request permits it.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param terminalRefundId The unique ID for the desired `TerminalRefund`.

@return CancelTerminalRefundResponse

func (*TerminalApiService) CreateTerminalAction ¶

func (a *TerminalApiService) CreateTerminalAction(ctx context.Context, body CreateTerminalActionRequest) (CreateTerminalActionResponse, *http.Response, error)

TerminalApiService CreateTerminalAction Creates a Terminal action request and sends it to the specified device.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateTerminalActionResponse

func (*TerminalApiService) CreateTerminalCheckout ¶

func (a *TerminalApiService) CreateTerminalCheckout(ctx context.Context, body CreateTerminalCheckoutRequest) (CreateTerminalCheckoutResponse, *http.Response, error)

TerminalApiService CreateTerminalCheckout Creates a Terminal checkout request and sends it to the specified device to take a payment for the requested amount.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateTerminalCheckoutResponse

func (*TerminalApiService) CreateTerminalRefund ¶

func (a *TerminalApiService) CreateTerminalRefund(ctx context.Context, body CreateTerminalRefundRequest) (CreateTerminalRefundResponse, *http.Response, error)

TerminalApiService CreateTerminalRefund Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see [Refunds API](https://developer.squareup.com/reference/square_2024-07-17/refunds-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateTerminalRefundResponse

func (*TerminalApiService) DismissTerminalAction ¶

func (a *TerminalApiService) DismissTerminalAction(ctx context.Context, actionId string) (DismissTerminalActionResponse, *http.Response, error)

TerminalApiService DismissTerminalAction Dismisses a Terminal action request if the status and type of the request permits it. See [Link and Dismiss Actions](https://developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/link-and-dismiss-actions) for more details.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param actionId Unique ID for the `TerminalAction` associated with the action to be dismissed.

@return DismissTerminalActionResponse

func (*TerminalApiService) DismissTerminalCheckout ¶

func (a *TerminalApiService) DismissTerminalCheckout(ctx context.Context, checkoutId string) (DismissTerminalCheckoutResponse, *http.Response, error)

TerminalApiService DismissTerminalCheckout Dismisses a Terminal checkout request if the status and type of the request permits it.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param checkoutId Unique ID for the `TerminalCheckout` associated with the checkout to be dismissed.

@return DismissTerminalCheckoutResponse

func (*TerminalApiService) DismissTerminalRefund ¶

func (a *TerminalApiService) DismissTerminalRefund(ctx context.Context, terminalRefundId string) (DismissTerminalRefundResponse, *http.Response, error)

TerminalApiService DismissTerminalRefund Dismisses a Terminal refund request if the status and type of the request permits it.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param terminalRefundId Unique ID for the `TerminalRefund` associated with the refund to be dismissed.

@return DismissTerminalRefundResponse

func (*TerminalApiService) GetTerminalAction ¶

func (a *TerminalApiService) GetTerminalAction(ctx context.Context, actionId string) (GetTerminalActionResponse, *http.Response, error)

TerminalApiService GetTerminalAction Retrieves a Terminal action request by `action_id`. Terminal action requests are available for 30 days.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param actionId Unique ID for the desired `TerminalAction`.

@return GetTerminalActionResponse

func (*TerminalApiService) GetTerminalCheckout ¶

func (a *TerminalApiService) GetTerminalCheckout(ctx context.Context, checkoutId string) (GetTerminalCheckoutResponse, *http.Response, error)

TerminalApiService GetTerminalCheckout Retrieves a Terminal checkout request by `checkout_id`. Terminal checkout requests are available for 30 days.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param checkoutId The unique ID for the desired `TerminalCheckout`.

@return GetTerminalCheckoutResponse

func (*TerminalApiService) GetTerminalRefund ¶

func (a *TerminalApiService) GetTerminalRefund(ctx context.Context, terminalRefundId string) (GetTerminalRefundResponse, *http.Response, error)

TerminalApiService GetTerminalRefund Retrieves an Interac Terminal refund object by ID. Terminal refund objects are available for 30 days.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param terminalRefundId The unique ID for the desired `TerminalRefund`.

@return GetTerminalRefundResponse

func (*TerminalApiService) SearchTerminalActions ¶

func (a *TerminalApiService) SearchTerminalActions(ctx context.Context, body SearchTerminalActionsRequest) (SearchTerminalActionsResponse, *http.Response, error)

TerminalApiService SearchTerminalActions Retrieves a filtered list of Terminal action requests created by the account making the request. Terminal action requests are available for 30 days.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return SearchTerminalActionsResponse

func (*TerminalApiService) SearchTerminalCheckouts ¶

func (a *TerminalApiService) SearchTerminalCheckouts(ctx context.Context, body SearchTerminalCheckoutsRequest) (SearchTerminalCheckoutsResponse, *http.Response, error)

TerminalApiService SearchTerminalCheckouts Returns a filtered list of Terminal checkout requests created by the application making the request. Only Terminal checkout requests created for the merchant scoped to the OAuth token are returned. Terminal checkout requests are available for 30 days.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return SearchTerminalCheckoutsResponse

func (*TerminalApiService) SearchTerminalRefunds ¶

func (a *TerminalApiService) SearchTerminalRefunds(ctx context.Context, body SearchTerminalRefundsRequest) (SearchTerminalRefundsResponse, *http.Response, error)

TerminalApiService SearchTerminalRefunds Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request. Terminal refund requests are available for 30 days.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return SearchTerminalRefundsResponse

type TerminalCheckout ¶

type TerminalCheckout struct {
	// A unique ID for this `TerminalCheckout`.
	Id          string `json:"id,omitempty"`
	AmountMoney *Money `json:"amount_money"`
	// An optional user-defined reference ID that can be used to associate this `TerminalCheckout` to another entity in an external system. For example, an order ID generated by a third-party shopping cart. The ID is also associated with any payments used to complete the checkout.
	ReferenceId string `json:"reference_id,omitempty"`
	// An optional note to associate with the checkout, as well as with any payments used to complete the checkout. Note: maximum 500 characters
	Note string `json:"note,omitempty"`
	// The reference to the Square order ID for the checkout request. Supported only in the US.
	OrderId        string                 `json:"order_id,omitempty"`
	PaymentOptions *PaymentOptions        `json:"payment_options,omitempty"`
	DeviceOptions  *DeviceCheckoutOptions `json:"device_options"`
	// An RFC 3339 duration, after which the checkout is automatically canceled. A `TerminalCheckout` that is `PENDING` is automatically `CANCELED` and has a cancellation reason of `TIMED_OUT`.  Default: 5 minutes from creation  Maximum: 5 minutes
	DeadlineDuration string `json:"deadline_duration,omitempty"`
	// The status of the `TerminalCheckout`. Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`
	Status string `json:"status,omitempty"`
	// The reason why `TerminalCheckout` is canceled. Present if the status is `CANCELED`.
	CancelReason string `json:"cancel_reason,omitempty"`
	// A list of IDs for payments created by this `TerminalCheckout`.
	PaymentIds []string `json:"payment_ids,omitempty"`
	// The time when the `TerminalCheckout` was created, as an RFC 3339 timestamp.
	CreatedAt string `json:"created_at,omitempty"`
	// The time when the `TerminalCheckout` was last updated, as an RFC 3339 timestamp.
	UpdatedAt string `json:"updated_at,omitempty"`
	// The ID of the application that created the checkout.
	AppId string `json:"app_id,omitempty"`
	// The location of the device where the `TerminalCheckout` was directed.
	LocationId string `json:"location_id,omitempty"`
	// The type of payment the terminal should attempt to capture from. Defaults to `CARD_PRESENT`.
	PaymentType string `json:"payment_type,omitempty"`
	// An optional ID of the team member associated with creating the checkout.
	TeamMemberId string `json:"team_member_id,omitempty"`
	// An optional ID of the customer associated with the checkout.
	CustomerId  string `json:"customer_id,omitempty"`
	AppFeeMoney *Money `json:"app_fee_money,omitempty"`
	// Optional additional payment information to include on the customer's card statement as part of the statement description. This can be, for example, an invoice number, ticket number, or short description that uniquely identifies the purchase. Supported only in the US.
	StatementDescriptionIdentifier string `json:"statement_description_identifier,omitempty"`
	TipMoney                       *Money `json:"tip_money,omitempty"`
}

Represents a checkout processed by the Square Terminal.

type TerminalCheckoutQuery ¶

type TerminalCheckoutQuery struct {
	Filter *TerminalCheckoutQueryFilter `json:"filter,omitempty"`
	Sort   *TerminalCheckoutQuerySort   `json:"sort,omitempty"`
}

type TerminalCheckoutQueryFilter ¶

type TerminalCheckoutQueryFilter struct {
	// The `TerminalCheckout` objects associated with a specific device. If no device is specified, then all `TerminalCheckout` objects for the merchant are displayed.
	DeviceId  string     `json:"device_id,omitempty"`
	CreatedAt *TimeRange `json:"created_at,omitempty"`
	// Filtered results with the desired status of the `TerminalCheckout`. Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`
	Status string `json:"status,omitempty"`
}

type TerminalCheckoutQuerySort ¶

type TerminalCheckoutQuerySort struct {
	// The order in which results are listed. Default: `DESC`
	SortOrder string `json:"sort_order,omitempty"`
}

type TerminalRefund ¶

type TerminalRefund struct {
	// A unique ID for this `TerminalRefund`.
	Id string `json:"id,omitempty"`
	// The reference to the payment refund created by completing this `TerminalRefund`.
	RefundId string `json:"refund_id,omitempty"`
	// The unique ID of the payment being refunded.
	PaymentId string `json:"payment_id"`
	// The reference to the Square order ID for the payment identified by the `payment_id`.
	OrderId     string `json:"order_id,omitempty"`
	AmountMoney *Money `json:"amount_money"`
	// A description of the reason for the refund.
	Reason string `json:"reason"`
	// The unique ID of the device intended for this `TerminalRefund`. The Id can be retrieved from /v2/devices api.
	DeviceId string `json:"device_id"`
	// The RFC 3339 duration, after which the refund is automatically canceled. A `TerminalRefund` that is `PENDING` is automatically `CANCELED` and has a cancellation reason of `TIMED_OUT`.  Default: 5 minutes from creation.  Maximum: 5 minutes
	DeadlineDuration string `json:"deadline_duration,omitempty"`
	// The status of the `TerminalRefund`. Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, or `COMPLETED`.
	Status string `json:"status,omitempty"`
	// Present if the status is `CANCELED`.
	CancelReason string `json:"cancel_reason,omitempty"`
	// The time when the `TerminalRefund` was created, as an RFC 3339 timestamp.
	CreatedAt string `json:"created_at,omitempty"`
	// The time when the `TerminalRefund` was last updated, as an RFC 3339 timestamp.
	UpdatedAt string `json:"updated_at,omitempty"`
	// The ID of the application that created the refund.
	AppId string `json:"app_id,omitempty"`
	// The location of the device where the `TerminalRefund` was directed.
	LocationId string `json:"location_id,omitempty"`
}

Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds.

type TerminalRefundQuery ¶

type TerminalRefundQuery struct {
	Filter *TerminalRefundQueryFilter `json:"filter,omitempty"`
	Sort   *TerminalRefundQuerySort   `json:"sort,omitempty"`
}

type TerminalRefundQueryFilter ¶

type TerminalRefundQueryFilter struct {
	// `TerminalRefund` objects associated with a specific device. If no device is specified, then all `TerminalRefund` objects for the signed-in account are displayed.
	DeviceId  string     `json:"device_id,omitempty"`
	CreatedAt *TimeRange `json:"created_at,omitempty"`
	// Filtered results with the desired status of the `TerminalRefund`. Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, or `COMPLETED`.
	Status string `json:"status,omitempty"`
}

type TerminalRefundQuerySort ¶

type TerminalRefundQuerySort struct {
	// The order in which results are listed. - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).
	SortOrder string `json:"sort_order,omitempty"`
}

type TestWebhookSubscriptionRequest ¶

type TestWebhookSubscriptionRequest struct {
	// The event type that will be used to test the [Subscription](https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription). The event type must be contained in the list of event types in the [Subscription](https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription).
	EventType string `json:"event_type,omitempty"`
}

Tests a Subscription(https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription) by sending a test event to its notification URL.

type TestWebhookSubscriptionResponse ¶

type TestWebhookSubscriptionResponse struct {
	// Information on errors encountered during the request.
	Errors                 []ModelError            `json:"errors,omitempty"`
	SubscriptionTestResult *SubscriptionTestResult `json:"subscription_test_result,omitempty"`
}

Defines the fields that are included in the response body of a request to the [TestWebhookSubscription](https://developer.squareup.com/reference/square_2024-07-17/webhook-subscriptions-api/test-webhook-subscription) endpoint. Note: If there are errors processing the request, the SubscriptionTestResult(https://developer.squareup.com/reference/square_2024-07-17/objects/SubscriptionTestResult) field is not present.

type TimeRange ¶

type TimeRange struct {
	// A datetime value in RFC 3339 format indicating when the time range starts.
	StartAt string `json:"start_at,omitempty"`
	// A datetime value in RFC 3339 format indicating when the time range ends.
	EndAt string `json:"end_at,omitempty"`
}

Represents a generic time range. The start and end values are represented in RFC 3339 format. Time ranges are customized to be inclusive or exclusive based on the needs of a particular endpoint. Refer to the relevant endpoint-specific documentation to determine how time ranges are handled.

type TipSettings ¶

type TipSettings struct {
	// Indicates whether tipping is enabled for this checkout. Defaults to false.
	AllowTipping bool `json:"allow_tipping,omitempty"`
	// Indicates whether tip options should be presented on the screen before presenting the signature screen during card payment. Defaults to false.
	SeparateTipScreen bool `json:"separate_tip_screen,omitempty"`
	// Indicates whether custom tip amounts are allowed during the checkout flow. Defaults to false.
	CustomTipField bool `json:"custom_tip_field,omitempty"`
	// A list of tip percentages that should be presented during the checkout flow, specified as up to 3 non-negative integers from 0 to 100 (inclusive). Defaults to 15, 20, and 25.
	TipPercentages []int32 `json:"tip_percentages,omitempty"`
	// Enables the \"Smart Tip Amounts\" behavior. Exact tipping options depend on the region in which the Square seller is active.  For payments under 10.00, in the Australia, Canada, Ireland, United Kingdom, and United States, tipping options are presented as no tip, .50, 1.00 or 2.00.  For payment amounts of 10.00 or greater, tipping options are presented as the following percentages: 0%, 5%, 10%, 15%.  If set to true, the `tip_percentages` settings is ignored. Defaults to false.  To learn more about smart tipping, see [Accept Tips with the Square App](https://squareup.com/help/us/en/article/5069-accept-tips-with-the-square-app).
	SmartTipping bool `json:"smart_tipping,omitempty"`
}

type Transaction ¶

type Transaction struct {
	// The transaction's unique ID, issued by Square payments servers.
	Id string `json:"id,omitempty"`
	// The ID of the transaction's associated location.
	LocationId string `json:"location_id,omitempty"`
	// The timestamp for when the transaction was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The tenders used to pay in the transaction.
	Tenders []Tender `json:"tenders,omitempty"`
	// Refunds that have been applied to any tender in the transaction.
	Refunds []Refund `json:"refunds,omitempty"`
	// If the transaction was created with the [Charge](https://developer.squareup.com/reference/square_2024-07-17/transactions-api/charge) endpoint, this value is the same as the value provided for the `reference_id` parameter in the request to that endpoint. Otherwise, it is not set.
	ReferenceId string `json:"reference_id,omitempty"`
	// The Square product that processed the transaction.
	Product string `json:"product,omitempty"`
	// If the transaction was created in the Square Point of Sale app, this value is the ID generated for the transaction by Square Point of Sale.  This ID has no relationship to the transaction's canonical `id`, which is generated by Square's backend servers. This value is generated for bookkeeping purposes, in case the transaction cannot immediately be completed (for example, if the transaction is processed in offline mode).  It is not currently possible with the Connect API to perform a transaction lookup by this value.
	ClientId        string   `json:"client_id,omitempty"`
	ShippingAddress *Address `json:"shipping_address,omitempty"`
	// The order_id is an identifier for the order associated with this transaction, if any.
	OrderId string `json:"order_id,omitempty"`
}

Represents a transaction processed with Square, either with the Connect API or with Square Point of Sale. The `tenders` field of this object lists all methods of payment used to pay in the transaction.

type TransactionProduct ¶

type TransactionProduct string

TransactionProduct : Indicates the Square product used to process a transaction.

const (
	REGISTER_TransactionProduct     TransactionProduct = "REGISTER"
	EXTERNAL_API_TransactionProduct TransactionProduct = "EXTERNAL_API"
	BILLING_TransactionProduct      TransactionProduct = "BILLING"
	APPOINTMENTS_TransactionProduct TransactionProduct = "APPOINTMENTS"
	INVOICES_TransactionProduct     TransactionProduct = "INVOICES"
	ONLINE_STORE_TransactionProduct TransactionProduct = "ONLINE_STORE"
	PAYROLL_TransactionProduct      TransactionProduct = "PAYROLL"
	OTHER_TransactionProduct        TransactionProduct = "OTHER"
)

List of TransactionProduct

type TransactionType ¶

type TransactionType string

TransactionType : The transaction type used in the disputed payment.

const (
	DEBIT_TransactionType  TransactionType = "DEBIT"
	CREDIT_TransactionType TransactionType = "CREDIT"
)

List of TransactionType

type TransactionsApiListTransactionsOpts ¶

type TransactionsApiListTransactionsOpts struct {
	BeginTime optional.String
	EndTime   optional.String
	SortOrder optional.String
	Cursor    optional.String
}

type TransactionsApiService ¶

type TransactionsApiService service

func (*TransactionsApiService) CaptureTransaction ¶

func (a *TransactionsApiService) CaptureTransaction(ctx context.Context, locationId string, transactionId string) (CaptureTransactionResponse, *http.Response, error)

TransactionsApiService CaptureTransaction Captures a transaction that was created with the [Charge](https://developer.squareup.com/reference/square_2024-07-17/transactions-api/charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture) for more information.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId
@param transactionId

@return CaptureTransactionResponse

func (*TransactionsApiService) ListTransactions ¶

func (a *TransactionsApiService) ListTransactions(ctx context.Context, locationId string, localVarOptionals *TransactionsApiListTransactionsOpts) (ListTransactionsResponse, *http.Response, error)

func (*TransactionsApiService) RetrieveTransaction ¶

func (a *TransactionsApiService) RetrieveTransaction(ctx context.Context, locationId string, transactionId string) (RetrieveTransactionResponse, *http.Response, error)

TransactionsApiService RetrieveTransaction Retrieves details for a single transaction.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the transaction's associated location.
@param transactionId The ID of the transaction to retrieve.

@return RetrieveTransactionResponse

func (*TransactionsApiService) VoidTransaction ¶

func (a *TransactionsApiService) VoidTransaction(ctx context.Context, locationId string, transactionId string) (VoidTransactionResponse, *http.Response, error)

TransactionsApiService VoidTransaction Cancels a transaction that was created with the [Charge](https://developer.squareup.com/reference/square_2024-07-17/transactions-api/charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture) for more information.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId
@param transactionId

@return VoidTransactionResponse

type UnlinkCustomerFromGiftCardRequest ¶

type UnlinkCustomerFromGiftCardRequest struct {
	// The ID of the customer to unlink from the gift card.
	CustomerId string `json:"customer_id"`
}

A request to unlink a customer from a gift card.

type UnlinkCustomerFromGiftCardResponse ¶

type UnlinkCustomerFromGiftCardResponse struct {
	// Any errors that occurred during the request.
	Errors   []ModelError `json:"errors,omitempty"`
	GiftCard *GiftCard    `json:"gift_card,omitempty"`
}

A response that contains the unlinked `GiftCard` object. If the request resulted in errors, the response contains a set of `Error` objects.

type UpdateBookingCustomAttributeDefinitionRequest ¶

type UpdateBookingCustomAttributeDefinitionRequest struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition"`
	// 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).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Represents an [UpdateBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/update-booking-custom-attribute-definition) request.

type UpdateBookingCustomAttributeDefinitionResponse ¶

type UpdateBookingCustomAttributeDefinitionResponse struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents an [UpdateBookingCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/update-booking-custom-attribute-definition) response. Either `custom_attribute_definition` or `errors` is present in the response.

type UpdateBookingRequest ¶

type UpdateBookingRequest struct {
	// A unique key to make this request an idempotent operation.
	IdempotencyKey string   `json:"idempotency_key,omitempty"`
	Booking        *Booking `json:"booking"`
}

type UpdateBookingResponse ¶

type UpdateBookingResponse struct {
	Booking *Booking `json:"booking,omitempty"`
	// Errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type UpdateBreakTypeRequest ¶

type UpdateBreakTypeRequest struct {
	BreakType *BreakType `json:"break_type"`
}

A request to update a `BreakType`.

type UpdateBreakTypeResponse ¶

type UpdateBreakTypeResponse struct {
	BreakType *BreakType `json:"break_type,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

A response to a request to update a `BreakType`. The response contains the requested `BreakType` objects and might contain a set of `Error` objects if the request resulted in errors.

type UpdateCustomerCustomAttributeDefinitionRequest ¶

type UpdateCustomerCustomAttributeDefinitionRequest struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition"`
	// 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).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Represents an [UpdateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/update-customer-custom-attribute-definition) request.

type UpdateCustomerCustomAttributeDefinitionResponse ¶

type UpdateCustomerCustomAttributeDefinitionResponse struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents an [UpdateCustomerCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/update-customer-custom-attribute-definition) response. Either `custom_attribute_definition` or `errors` is present in the response.

type UpdateCustomerGroupRequest ¶

type UpdateCustomerGroupRequest struct {
	Group *CustomerGroup `json:"group"`
}

Defines the body parameters that can be included in a request to the [UpdateCustomerGroup](https://developer.squareup.com/reference/square_2024-07-17/customer-groups-api/update-customer-group) endpoint.

type UpdateCustomerGroupResponse ¶

type UpdateCustomerGroupResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError   `json:"errors,omitempty"`
	Group  *CustomerGroup `json:"group,omitempty"`
}

Defines the fields that are included in the response body of a request to the [UpdateCustomerGroup](https://developer.squareup.com/reference/square_2024-07-17/customer-groups-api/update-customer-group) endpoint. Either `errors` or `group` is present in a given response (never both).

type UpdateCustomerRequest ¶

type UpdateCustomerRequest struct {
	// The given name (that is, the first name) associated with the customer profile.  The maximum length for this value is 300 characters.
	GivenName string `json:"given_name,omitempty"`
	// The family name (that is, the last name) associated with the customer profile.  The maximum length for this value is 300 characters.
	FamilyName string `json:"family_name,omitempty"`
	// A business name associated with the customer profile.  The maximum length for this value is 500 characters.
	CompanyName string `json:"company_name,omitempty"`
	// A nickname for the customer profile.  The maximum length for this value is 100 characters.
	Nickname string `json:"nickname,omitempty"`
	// The email address associated with the customer profile.  The maximum length for this value is 254 characters.
	EmailAddress string   `json:"email_address,omitempty"`
	Address      *Address `json:"address,omitempty"`
	// The phone number associated with the customer profile. The phone number must be valid and can contain 9–16 digits, with an optional `+` prefix and country code. For more information, see [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number).
	PhoneNumber string `json:"phone_number,omitempty"`
	// An optional second ID used to associate the customer profile with an entity in another system.  The maximum length for this value is 100 characters.
	ReferenceId string `json:"reference_id,omitempty"`
	// A custom note associated with the customer profile.
	Note string `json:"note,omitempty"`
	// The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example, specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD` format, where `YYYY` is the specified birth year or `0000` if a birth year is not specified.
	Birthday string `json:"birthday,omitempty"`
	// The current version of the customer profile.  As a best practice, you should include this field to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Update a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#update-a-customer-profile).
	Version int64           `json:"version,omitempty"`
	TaxIds  *CustomerTaxIds `json:"tax_ids,omitempty"`
}

Defines the body parameters that can be included in a request to the `UpdateCustomer` endpoint.

type UpdateCustomerResponse ¶

type UpdateCustomerResponse struct {
	// Any errors that occurred during the request.
	Errors   []ModelError `json:"errors,omitempty"`
	Customer *Customer    `json:"customer,omitempty"`
}

Defines the fields that are included in the response body of a request to the [UpdateCustomer](https://developer.squareup.com/reference/square_2024-07-17/customers-api/update-customer) or [BulkUpdateCustomers](https://developer.squareup.com/reference/square_2024-07-17/customers-api/bulk-update-customers) endpoint. Either `errors` or `customer` is present in a given response (never both).

type UpdateInvoiceRequest ¶

type UpdateInvoiceRequest struct {
	Invoice *Invoice `json:"invoice"`
	// A unique string that identifies the `UpdateInvoice` request. If you do not provide `idempotency_key` (or provide an empty string as the value), the endpoint treats each request as independent.  For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
	// The list of fields to clear. Although this field is currently supported, we recommend using null values or the `remove` field when possible. For examples, see [Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices).
	FieldsToClear []string `json:"fields_to_clear"`
}

Describes a `UpdateInvoice` request.

type UpdateInvoiceResponse ¶

type UpdateInvoiceResponse struct {
	Invoice *Invoice `json:"invoice,omitempty"`
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Describes a `UpdateInvoice` response.

type UpdateItemModifierListsRequest ¶

type UpdateItemModifierListsRequest struct {
	// The IDs of the catalog items associated with the CatalogModifierList objects being updated.
	ItemIds []string `json:"item_ids"`
	// The IDs of the CatalogModifierList objects to enable for the CatalogItem. At least one of `modifier_lists_to_enable` or `modifier_lists_to_disable` must be specified.
	ModifierListsToEnable []string `json:"modifier_lists_to_enable,omitempty"`
	// The IDs of the CatalogModifierList objects to disable for the CatalogItem. At least one of `modifier_lists_to_enable` or `modifier_lists_to_disable` must be specified.
	ModifierListsToDisable []string `json:"modifier_lists_to_disable,omitempty"`
}

type UpdateItemModifierListsResponse ¶

type UpdateItemModifierListsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The database [timestamp](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-dates) of this update in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`.
	UpdatedAt string `json:"updated_at,omitempty"`
}

type UpdateItemTaxesRequest ¶

type UpdateItemTaxesRequest struct {
	// IDs for the CatalogItems associated with the CatalogTax objects being updated. No more than 1,000 IDs may be provided.
	ItemIds []string `json:"item_ids"`
	// IDs of the CatalogTax objects to enable. At least one of `taxes_to_enable` or `taxes_to_disable` must be specified.
	TaxesToEnable []string `json:"taxes_to_enable,omitempty"`
	// IDs of the CatalogTax objects to disable. At least one of `taxes_to_enable` or `taxes_to_disable` must be specified.
	TaxesToDisable []string `json:"taxes_to_disable,omitempty"`
}

type UpdateItemTaxesResponse ¶

type UpdateItemTaxesResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this update in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`.
	UpdatedAt string `json:"updated_at,omitempty"`
}

type UpdateLocationCustomAttributeDefinitionRequest ¶

type UpdateLocationCustomAttributeDefinitionRequest struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition"`
	// 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).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Represents an [UpdateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/update-location-custom-attribute-definition) request.

type UpdateLocationCustomAttributeDefinitionResponse ¶

type UpdateLocationCustomAttributeDefinitionResponse struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents an [UpdateLocationCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/update-location-custom-attribute-definition) response. Either `custom_attribute_definition` or `errors` is present in the response.

type UpdateLocationRequest ¶

type UpdateLocationRequest struct {
	Location *Location `json:"location,omitempty"`
}

The request object for the [UpdateLocation](https://developer.squareup.com/reference/square_2024-07-17/locations-api/update-location) endpoint.

type UpdateLocationResponse ¶

type UpdateLocationResponse struct {
	// Information about errors encountered during the request.
	Errors   []ModelError `json:"errors,omitempty"`
	Location *Location    `json:"location,omitempty"`
}

The response object returned by the [UpdateLocation](https://developer.squareup.com/reference/square_2024-07-17/locations-api/update-location) endpoint.

type UpdateLocationSettingsRequest ¶

type UpdateLocationSettingsRequest struct {
	LocationSettings *CheckoutLocationSettings `json:"location_settings"`
}

type UpdateLocationSettingsResponse ¶

type UpdateLocationSettingsResponse struct {
	// Any errors that occurred when updating the location settings.
	Errors           []ModelError              `json:"errors,omitempty"`
	LocationSettings *CheckoutLocationSettings `json:"location_settings,omitempty"`
}

type UpdateMerchantCustomAttributeDefinitionRequest ¶

type UpdateMerchantCustomAttributeDefinitionRequest struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition"`
	// 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).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Represents an [UpdateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/update-merchant-custom-attribute-definition) request.

type UpdateMerchantCustomAttributeDefinitionResponse ¶

type UpdateMerchantCustomAttributeDefinitionResponse struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents an [UpdateMerchantCustomAttributeDefinition](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/update-merchant-custom-attribute-definition) response. Either `custom_attribute_definition` or `errors` is present in the response.

type UpdateMerchantSettingsRequest ¶

type UpdateMerchantSettingsRequest struct {
	MerchantSettings *CheckoutMerchantSettings `json:"merchant_settings"`
}

type UpdateMerchantSettingsResponse ¶

type UpdateMerchantSettingsResponse struct {
	// Any errors that occurred when updating the merchant settings.
	Errors           []ModelError              `json:"errors,omitempty"`
	MerchantSettings *CheckoutMerchantSettings `json:"merchant_settings,omitempty"`
}

type UpdateOrderCustomAttributeDefinitionRequest ¶

type UpdateOrderCustomAttributeDefinitionRequest struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition"`
	// 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).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Represents an update request for an order custom attribute definition.

type UpdateOrderCustomAttributeDefinitionResponse ¶

type UpdateOrderCustomAttributeDefinitionResponse struct {
	CustomAttributeDefinition *CustomAttributeDefinition `json:"custom_attribute_definition,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response from updating an order custom attribute definition.

type UpdateOrderRequest ¶

type UpdateOrderRequest struct {
	Order *Order `json:"order,omitempty"`
	// The [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete) fields to clear. For example, `line_items[uid].note`. For more information, see [Deleting fields](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#deleting-fields).
	FieldsToClear []string `json:"fields_to_clear,omitempty"`
	// A value you specify that uniquely identifies this update request.  If you are unsure whether a particular update was applied to an order successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate updates to the order. The latest order version is returned.  For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Defines the fields that are included in requests to the [UpdateOrder](https://developer.squareup.com/reference/square_2024-07-17/orders-api/update-order) endpoint.

type UpdateOrderResponse ¶

type UpdateOrderResponse struct {
	Order *Order `json:"order,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields that are included in the response body of a request to the [UpdateOrder](https://developer.squareup.com/reference/square_2024-07-17/orders-api/update-order) endpoint.

type UpdatePaymentLinkRequest ¶

type UpdatePaymentLinkRequest struct {
	PaymentLink *PaymentLink `json:"payment_link"`
}

type UpdatePaymentLinkResponse ¶

type UpdatePaymentLinkResponse struct {
	// Any errors that occurred when updating the payment link.
	Errors      []ModelError `json:"errors,omitempty"`
	PaymentLink *PaymentLink `json:"payment_link,omitempty"`
}

type UpdatePaymentRequest ¶

type UpdatePaymentRequest struct {
	Payment *Payment `json:"payment,omitempty"`
	// A unique string that identifies this `UpdatePayment` request. Keys can be any valid string but must be unique for every `UpdatePayment` request.  For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
	IdempotencyKey string `json:"idempotency_key"`
}

Describes a request to update a payment using [UpdatePayment](https://developer.squareup.com/reference/square_2024-07-17/payments-api/update-payment).

type UpdatePaymentResponse ¶

type UpdatePaymentResponse struct {
	// Any errors that occurred during the request.
	Errors  []ModelError `json:"errors,omitempty"`
	Payment *Payment     `json:"payment,omitempty"`
}

Defines the response returned by [UpdatePayment](https://developer.squareup.com/reference/square_2024-07-17/payments-api/update-payment).

type UpdateShiftRequest ¶

type UpdateShiftRequest struct {
	Shift *Shift `json:"shift"`
}

A request to update a `Shift` object.

type UpdateShiftResponse ¶

type UpdateShiftResponse struct {
	Shift *Shift `json:"shift,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

The response to a request to update a `Shift`. The response contains the updated `Shift` object and might contain a set of `Error` objects if the request resulted in errors.

type UpdateSubscriptionRequest ¶

type UpdateSubscriptionRequest struct {
	Subscription *Subscription `json:"subscription,omitempty"`
}

Defines input parameters in a request to the [UpdateSubscription](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/update-subscription) endpoint.

type UpdateSubscriptionResponse ¶

type UpdateSubscriptionResponse struct {
	// Errors encountered during the request.
	Errors       []ModelError  `json:"errors,omitempty"`
	Subscription *Subscription `json:"subscription,omitempty"`
}

Defines output parameters in a response from the [UpdateSubscription](https://developer.squareup.com/reference/square_2024-07-17/subscriptions-api/update-subscription) endpoint.

type UpdateTeamMemberRequest ¶

type UpdateTeamMemberRequest struct {
	TeamMember *TeamMember `json:"team_member,omitempty"`
}

Represents an update request for a `TeamMember` object.

type UpdateTeamMemberResponse ¶

type UpdateTeamMemberResponse struct {
	TeamMember *TeamMember `json:"team_member,omitempty"`
	// The errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response from an update request containing the updated `TeamMember` object or error messages.

type UpdateVendorRequest ¶

type UpdateVendorRequest struct {
	// A client-supplied, universally unique identifier (UUID) for the request.  See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more information.
	IdempotencyKey string  `json:"idempotency_key,omitempty"`
	Vendor         *Vendor `json:"vendor"`
}

Represents an input to a call to [UpdateVendor](https://developer.squareup.com/reference/square_2024-07-17/vendors-api/update-vendor).

type UpdateVendorResponse ¶

type UpdateVendorResponse struct {
	// Errors occurred when the request fails.
	Errors []ModelError `json:"errors,omitempty"`
	Vendor *Vendor      `json:"vendor,omitempty"`
}

Represents an output from a call to [UpdateVendor](https://developer.squareup.com/reference/square_2024-07-17/vendors-api/update-vendor).

type UpdateWageSettingRequest ¶

type UpdateWageSettingRequest struct {
	WageSetting *WageSetting `json:"wage_setting"`
}

Represents an update request for the `WageSetting` object describing a `TeamMember`.

type UpdateWageSettingResponse ¶

type UpdateWageSettingResponse struct {
	WageSetting *WageSetting `json:"wage_setting,omitempty"`
	// The errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response from an update request containing the updated `WageSetting` object or error messages.

type UpdateWebhookSubscriptionRequest ¶

type UpdateWebhookSubscriptionRequest struct {
	Subscription *WebhookSubscription `json:"subscription,omitempty"`
}

Updates a Subscription(https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription).

type UpdateWebhookSubscriptionResponse ¶

type UpdateWebhookSubscriptionResponse struct {
	// Information on errors encountered during the request.
	Errors       []ModelError         `json:"errors,omitempty"`
	Subscription *WebhookSubscription `json:"subscription,omitempty"`
}

Defines the fields that are included in the response body of a request to the [UpdateWebhookSubscription](https://developer.squareup.com/reference/square_2024-07-17/webhook-subscriptions-api/update-webhook-subscription) endpoint. Note: If there are errors processing the request, the Subscription(https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription) is not present.

type UpdateWebhookSubscriptionSignatureKeyRequest ¶

type UpdateWebhookSubscriptionSignatureKeyRequest struct {
	// A unique string that identifies the [UpdateWebhookSubscriptionSignatureKey](https://developer.squareup.com/reference/square_2024-07-17/webhook-subscriptions-api/update-webhook-subscriptionSignatureKey) request.
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Updates a Subscription(https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription) by replacing the existing signature key with a new one.

type UpdateWebhookSubscriptionSignatureKeyResponse ¶

type UpdateWebhookSubscriptionSignatureKeyResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The new Square-generated signature key used to validate the origin of the webhook event.
	SignatureKey string `json:"signature_key,omitempty"`
}

Defines the fields that are included in the response body of a request to the [UpdateWebhookSubscriptionSignatureKey](https://developer.squareup.com/reference/square_2024-07-17/webhook-subscriptions-api/update-webhook-subscriptionSignatureKey) endpoint. Note: If there are errors processing the request, the Subscription(https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription) is not present.

type UpdateWorkweekConfigRequest ¶

type UpdateWorkweekConfigRequest struct {
	WorkweekConfig *WorkweekConfig `json:"workweek_config"`
}

A request to update a `WorkweekConfig` object.

type UpdateWorkweekConfigResponse ¶

type UpdateWorkweekConfigResponse struct {
	WorkweekConfig *WorkweekConfig `json:"workweek_config,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

The response to a request to update a `WorkweekConfig` object. The response contains the updated `WorkweekConfig` object and might contain a set of `Error` objects if the request resulted in errors.

type UpsertBookingCustomAttributeRequest ¶

type UpsertBookingCustomAttributeRequest struct {
	CustomAttribute *CustomAttribute `json:"custom_attribute"`
	// 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).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Represents an [UpsertBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/upsert-booking-custom-attribute) request.

type UpsertBookingCustomAttributeResponse ¶

type UpsertBookingCustomAttributeResponse struct {
	CustomAttribute *CustomAttribute `json:"custom_attribute,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents an [UpsertBookingCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/booking-custom-attributes-api/upsert-booking-custom-attribute) response. Either `custom_attribute_definition` or `errors` is present in the response.

type UpsertCatalogObjectRequest ¶

type UpsertCatalogObjectRequest struct {
	// A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID).  If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects.  See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.
	IdempotencyKey string         `json:"idempotency_key"`
	Object         *CatalogObject `json:"object"`
}

type UpsertCatalogObjectResponse ¶

type UpsertCatalogObjectResponse struct {
	// Any errors that occurred during the request.
	Errors        []ModelError   `json:"errors,omitempty"`
	CatalogObject *CatalogObject `json:"catalog_object,omitempty"`
	// The mapping between client and server IDs for this upsert.
	IdMappings []CatalogIdMapping `json:"id_mappings,omitempty"`
}

type UpsertCustomerCustomAttributeRequest ¶

type UpsertCustomerCustomAttributeRequest struct {
	CustomAttribute *CustomAttribute `json:"custom_attribute"`
	// 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).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Represents an [UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/upsert-customer-custom-attribute) request.

type UpsertCustomerCustomAttributeResponse ¶

type UpsertCustomerCustomAttributeResponse struct {
	CustomAttribute *CustomAttribute `json:"custom_attribute,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents an [UpsertCustomerCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/customer-custom-attributes-api/upsert-customer-custom-attribute) response. Either `custom_attribute_definition` or `errors` is present in the response.

type UpsertLocationCustomAttributeRequest ¶

type UpsertLocationCustomAttributeRequest struct {
	CustomAttribute *CustomAttribute `json:"custom_attribute"`
	// 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).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Represents an [UpsertLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/upsert-location-custom-attribute) request.

type UpsertLocationCustomAttributeResponse ¶

type UpsertLocationCustomAttributeResponse struct {
	CustomAttribute *CustomAttribute `json:"custom_attribute,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents an [UpsertLocationCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/location-custom-attributes-api/upsert-location-custom-attribute) response. Either `custom_attribute_definition` or `errors` is present in the response.

type UpsertMerchantCustomAttributeRequest ¶

type UpsertMerchantCustomAttributeRequest struct {
	CustomAttribute *CustomAttribute `json:"custom_attribute"`
	// 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).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Represents an [UpsertMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/upsert-merchant-custom-attribute) request.

type UpsertMerchantCustomAttributeResponse ¶

type UpsertMerchantCustomAttributeResponse struct {
	CustomAttribute *CustomAttribute `json:"custom_attribute,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents an [UpsertMerchantCustomAttribute](https://developer.squareup.com/reference/square_2024-07-17/merchant-custom-attributes-api/upsert-merchant-custom-attribute) response. Either `custom_attribute_definition` or `errors` is present in the response.

type UpsertOrderCustomAttributeRequest ¶

type UpsertOrderCustomAttributeRequest struct {
	CustomAttribute *CustomAttribute `json:"custom_attribute"`
	// 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).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Represents an upsert request for an order custom attribute.

type UpsertOrderCustomAttributeResponse ¶

type UpsertOrderCustomAttributeResponse struct {
	CustomAttribute *CustomAttribute `json:"custom_attribute,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Represents a response from upserting order custom attribute definitions.

type UpsertSnippetRequest ¶

type UpsertSnippetRequest struct {
	Snippet *Snippet `json:"snippet"`
}

Represents an `UpsertSnippet` request.

type UpsertSnippetResponse ¶

type UpsertSnippetResponse struct {
	// Any errors that occurred during the request.
	Errors  []ModelError `json:"errors,omitempty"`
	Snippet *Snippet     `json:"snippet,omitempty"`
}

Represents an `UpsertSnippet` response. The response can include either `snippet` or `errors`.

type V1Device ¶

type V1Device struct {
	// The device's Square-issued ID.
	Id string `json:"id,omitempty"`
	// The device's merchant-specified name.
	Name string `json:"name,omitempty"`
}

type V1ListOrdersRequest ¶

type V1ListOrdersRequest struct {
	// The order in which payments are listed in the response.
	Order string `json:"order,omitempty"`
	// The maximum number of payments to return in a single response. This value cannot exceed 200.
	Limit int32 `json:"limit,omitempty"`
	// A pagination cursor to retrieve the next set of results for your original query to the endpoint.
	BatchToken string `json:"batch_token,omitempty"`
}

type V1ListOrdersResponse ¶

type V1ListOrdersResponse struct {
	Items []V1Order `json:"items,omitempty"`
}

type V1Money ¶

type V1Money struct {
	// Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept).
	Amount       int32  `json:"amount,omitempty"`
	CurrencyCode string `json:"currency_code,omitempty"`
}

type V1Order ¶

type V1Order struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The order's unique identifier.
	Id string `json:"id,omitempty"`
	// The email address of the order's buyer.
	BuyerEmail string `json:"buyer_email,omitempty"`
	// The name of the order's buyer.
	RecipientName string `json:"recipient_name,omitempty"`
	// The phone number to use for the order's delivery.
	RecipientPhoneNumber string `json:"recipient_phone_number,omitempty"`
	// Whether the tax is an ADDITIVE tax or an INCLUSIVE tax.
	State              string   `json:"state,omitempty"`
	ShippingAddress    *Address `json:"shipping_address,omitempty"`
	SubtotalMoney      *V1Money `json:"subtotal_money,omitempty"`
	TotalShippingMoney *V1Money `json:"total_shipping_money,omitempty"`
	TotalTaxMoney      *V1Money `json:"total_tax_money,omitempty"`
	TotalPriceMoney    *V1Money `json:"total_price_money,omitempty"`
	TotalDiscountMoney *V1Money `json:"total_discount_money,omitempty"`
	// The time when the order was created, in ISO 8601 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The time when the order was last modified, in ISO 8601 format.
	UpdatedAt string `json:"updated_at,omitempty"`
	// The time when the order expires if no action is taken, in ISO 8601 format.
	ExpiresAt string `json:"expires_at,omitempty"`
	// The unique identifier of the payment associated with the order.
	PaymentId string `json:"payment_id,omitempty"`
	// A note provided by the buyer when the order was created, if any.
	BuyerNote string `json:"buyer_note,omitempty"`
	// A note provided by the merchant when the order's state was set to COMPLETED, if any
	CompletedNote string `json:"completed_note,omitempty"`
	// A note provided by the merchant when the order's state was set to REFUNDED, if any.
	RefundedNote string `json:"refunded_note,omitempty"`
	// A note provided by the merchant when the order's state was set to CANCELED, if any.
	CanceledNote string    `json:"canceled_note,omitempty"`
	Tender       *V1Tender `json:"tender,omitempty"`
	// The history of actions associated with the order.
	OrderHistory []V1OrderHistoryEntry `json:"order_history,omitempty"`
	// The promo code provided by the buyer, if any.
	PromoCode string `json:"promo_code,omitempty"`
	// For Bitcoin transactions, the address that the buyer sent Bitcoin to.
	BtcReceiveAddress string `json:"btc_receive_address,omitempty"`
	// For Bitcoin transactions, the price of the buyer's order in satoshi (100 million satoshi equals 1 BTC).
	BtcPriceSatoshi float64 `json:"btc_price_satoshi,omitempty"`
}

V1Order

type V1OrderHistoryEntry ¶

type V1OrderHistoryEntry struct {
	// The type of action performed on the order.
	Action string `json:"action,omitempty"`
	// The time when the action was performed, in ISO 8601 format.
	CreatedAt string `json:"created_at,omitempty"`
}

V1OrderHistoryEntry

type V1OrderHistoryEntryAction ¶

type V1OrderHistoryEntryAction string

const (
	ORDER_PLACED_V1OrderHistoryEntryAction     V1OrderHistoryEntryAction = "ORDER_PLACED"
	DECLINED_V1OrderHistoryEntryAction         V1OrderHistoryEntryAction = "DECLINED"
	PAYMENT_RECEIVED_V1OrderHistoryEntryAction V1OrderHistoryEntryAction = "PAYMENT_RECEIVED"
	CANCELED_V1OrderHistoryEntryAction         V1OrderHistoryEntryAction = "CANCELED"
	COMPLETED_V1OrderHistoryEntryAction        V1OrderHistoryEntryAction = "COMPLETED"
	REFUNDED_V1OrderHistoryEntryAction         V1OrderHistoryEntryAction = "REFUNDED"
	EXPIRED_V1OrderHistoryEntryAction          V1OrderHistoryEntryAction = "EXPIRED"
)

List of V1OrderHistoryEntryAction

type V1OrderState ¶

type V1OrderState string

const (
	PENDING_V1OrderState   V1OrderState = "PENDING"
	OPEN_V1OrderState      V1OrderState = "OPEN"
	COMPLETED_V1OrderState V1OrderState = "COMPLETED"
	CANCELED_V1OrderState  V1OrderState = "CANCELED"
	REFUNDED_V1OrderState  V1OrderState = "REFUNDED"
	REJECTED_V1OrderState  V1OrderState = "REJECTED"
)

List of V1OrderState

type V1PhoneNumber ¶

type V1PhoneNumber struct {
	// The phone number's international calling code. For US phone numbers, this value is +1.
	CallingCode string `json:"calling_code"`
	// The phone number.
	Number string `json:"number"`
}

Represents a phone number.

type V1RetrieveOrderRequest ¶

type V1RetrieveOrderRequest struct{}

type V1Tender ¶

type V1Tender struct {
	// The tender's unique ID.
	Id string `json:"id,omitempty"`
	// The type of tender.
	Type_ string `json:"type,omitempty"`
	// A human-readable description of the tender.
	Name string `json:"name,omitempty"`
	// The ID of the employee that processed the tender.
	EmployeeId string `json:"employee_id,omitempty"`
	// The URL of the receipt for the tender.
	ReceiptUrl string `json:"receipt_url,omitempty"`
	// The brand of credit card provided.
	CardBrand string `json:"card_brand,omitempty"`
	// The last four digits of the provided credit card's account number.
	PanSuffix string `json:"pan_suffix,omitempty"`
	// The tender's unique ID.
	EntryMethod string `json:"entry_method,omitempty"`
	// Notes entered by the merchant about the tender at the time of payment, if any. Typically only present for tender with the type: OTHER.
	PaymentNote   string   `json:"payment_note,omitempty"`
	TotalMoney    *V1Money `json:"total_money,omitempty"`
	TenderedMoney *V1Money `json:"tendered_money,omitempty"`
	// The time when the tender was created, in ISO 8601 format.
	TenderedAt string `json:"tendered_at,omitempty"`
	// The time when the tender was settled, in ISO 8601 format.
	SettledAt       string   `json:"settled_at,omitempty"`
	ChangeBackMoney *V1Money `json:"change_back_money,omitempty"`
	RefundedMoney   *V1Money `json:"refunded_money,omitempty"`
	// Indicates whether or not the tender is associated with an exchange. If is_exchange is true, the tender represents the value of goods returned in an exchange not the actual money paid. The exchange value reduces the tender amounts needed to pay for items purchased in the exchange.
	IsExchange bool `json:"is_exchange,omitempty"`
}

A tender represents a discrete monetary exchange. Square represents this exchange as a money object with a specific currency and amount, where the amount is given in the smallest denomination of the given currency. Square POS can accept more than one form of tender for a single payment (such as by splitting a bill between a credit card and a gift card). The `tender` field of the Payment object lists all forms of tender used for the payment. Split tender payments behave slightly differently from single tender payments: The receipt_url for a split tender corresponds only to the first tender listed in the tender field. To get the receipt URLs for the remaining tenders, use the receipt_url fields of the corresponding Tender objects. *A note on gift cards**: when a customer purchases a Square gift card from a merchant, the merchant receives the full amount of the gift card in the associated payment. When that gift card is used as a tender, the balance of the gift card is reduced and the merchant receives no funds. A `Tender` object with a type of `SQUARE_GIFT_CARD` indicates a gift card was used for some or all of the associated payment.

type V1TenderCardBrand ¶

type V1TenderCardBrand string

V1TenderCardBrand : The brand of a credit card.

const (
	OTHER_BRAND_V1TenderCardBrand      V1TenderCardBrand = "OTHER_BRAND"
	VISA_V1TenderCardBrand             V1TenderCardBrand = "VISA"
	MASTER_CARD_V1TenderCardBrand      V1TenderCardBrand = "MASTER_CARD"
	AMERICAN_EXPRESS_V1TenderCardBrand V1TenderCardBrand = "AMERICAN_EXPRESS"
	DISCOVER_V1TenderCardBrand         V1TenderCardBrand = "DISCOVER"
	DISCOVER_DINERS_V1TenderCardBrand  V1TenderCardBrand = "DISCOVER_DINERS"
	JCB_V1TenderCardBrand              V1TenderCardBrand = "JCB"
	CHINA_UNIONPAY_V1TenderCardBrand   V1TenderCardBrand = "CHINA_UNIONPAY"
	SQUARE_GIFT_CARD_V1TenderCardBrand V1TenderCardBrand = "SQUARE_GIFT_CARD"
)

List of V1TenderCardBrand

type V1TenderEntryMethod ¶

type V1TenderEntryMethod string

const (
	MANUAL_V1TenderEntryMethod        V1TenderEntryMethod = "MANUAL"
	SCANNED_V1TenderEntryMethod       V1TenderEntryMethod = "SCANNED"
	SQUARE_CASH_V1TenderEntryMethod   V1TenderEntryMethod = "SQUARE_CASH"
	SQUARE_WALLET_V1TenderEntryMethod V1TenderEntryMethod = "SQUARE_WALLET"
	SWIPED_V1TenderEntryMethod        V1TenderEntryMethod = "SWIPED"
	WEB_FORM_V1TenderEntryMethod      V1TenderEntryMethod = "WEB_FORM"
	OTHER_V1TenderEntryMethod         V1TenderEntryMethod = "OTHER"
)

List of V1TenderEntryMethod

type V1TenderType ¶

type V1TenderType string

const (
	CREDIT_CARD_V1TenderType      V1TenderType = "CREDIT_CARD"
	CASH_V1TenderType             V1TenderType = "CASH"
	THIRD_PARTY_CARD_V1TenderType V1TenderType = "THIRD_PARTY_CARD"
	NO_SALE_V1TenderType          V1TenderType = "NO_SALE"
	SQUARE_WALLET_V1TenderType    V1TenderType = "SQUARE_WALLET"
	SQUARE_GIFT_CARD_V1TenderType V1TenderType = "SQUARE_GIFT_CARD"
	UNKNOWN_V1TenderType          V1TenderType = "UNKNOWN"
	OTHER_V1TenderType            V1TenderType = "OTHER"
)

List of V1TenderType

type V1TransactionsApiService ¶

type V1TransactionsApiService service

func (*V1TransactionsApiService) V1ListOrders ¶

func (a *V1TransactionsApiService) V1ListOrders(ctx context.Context, locationId string, localVarOptionals *V1TransactionsApiV1ListOrdersOpts) ([]V1Order, *http.Response, error)

func (*V1TransactionsApiService) V1RetrieveOrder ¶

func (a *V1TransactionsApiService) V1RetrieveOrder(ctx context.Context, locationId string, orderId string) (V1Order, *http.Response, error)

V1TransactionsApiService V1RetrieveOrder Provides comprehensive information for a single online store order, including the order's history.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the order's associated location.
@param orderId The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint

@return V1Order

func (*V1TransactionsApiService) V1UpdateOrder ¶

func (a *V1TransactionsApiService) V1UpdateOrder(ctx context.Context, body V1UpdateOrderRequest, locationId string, orderId string) (V1Order, *http.Response, error)

V1TransactionsApiService V1UpdateOrder Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param locationId The ID of the order's associated location.
@param orderId The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint

@return V1Order

type V1TransactionsApiV1ListOrdersOpts ¶

type V1TransactionsApiV1ListOrdersOpts struct {
	Order      optional.String
	Limit      optional.Int32
	BatchToken optional.String
}

type V1UpdateOrderRequest ¶

type V1UpdateOrderRequest struct {
	// The action to perform on the order (COMPLETE, CANCEL, or REFUND).
	Action string `json:"action"`
	// The tracking number of the shipment associated with the order. Only valid if action is COMPLETE.
	ShippedTrackingNumber string `json:"shipped_tracking_number,omitempty"`
	// A merchant-specified note about the completion of the order. Only valid if action is COMPLETE.
	CompletedNote string `json:"completed_note,omitempty"`
	// A merchant-specified note about the refunding of the order. Only valid if action is REFUND.
	RefundedNote string `json:"refunded_note,omitempty"`
	// A merchant-specified note about the canceling of the order. Only valid if action is CANCEL.
	CanceledNote string `json:"canceled_note,omitempty"`
}

V1UpdateOrderRequest

type V1UpdateOrderRequestAction ¶

type V1UpdateOrderRequestAction string

const (
	COMPLETE_V1UpdateOrderRequestAction V1UpdateOrderRequestAction = "COMPLETE"
	CANCEL_V1UpdateOrderRequestAction   V1UpdateOrderRequestAction = "CANCEL"
	REFUND_V1UpdateOrderRequestAction   V1UpdateOrderRequestAction = "REFUND"
)

List of V1UpdateOrderRequestAction

type Vendor ¶

type Vendor struct {
	// A unique Square-generated ID for the [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor). This field is required when attempting to update a [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor).
	Id string `json:"id,omitempty"`
	// An RFC 3339-formatted timestamp that indicates when the [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) was created.
	CreatedAt string `json:"created_at,omitempty"`
	// An RFC 3339-formatted timestamp that indicates when the [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) was last updated.
	UpdatedAt string `json:"updated_at,omitempty"`
	// The name of the [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor). This field is required when attempting to create or update a [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor).
	Name    string   `json:"name,omitempty"`
	Address *Address `json:"address,omitempty"`
	// The contacts of the [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor).
	Contacts []VendorContact `json:"contacts,omitempty"`
	// The account number of the [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor).
	AccountNumber string `json:"account_number,omitempty"`
	// A note detailing information about the [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor).
	Note string `json:"note,omitempty"`
	// The version of the [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor).
	Version int32 `json:"version,omitempty"`
	// The status of the [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor).
	Status string `json:"status,omitempty"`
}

Represents a supplier to a seller.

type VendorContact ¶

type VendorContact struct {
	// A unique Square-generated ID for the [VendorContact](https://developer.squareup.com/reference/square_2024-07-17/objects/VendorContact). This field is required when attempting to update a [VendorContact](https://developer.squareup.com/reference/square_2024-07-17/objects/VendorContact).
	Id string `json:"id,omitempty"`
	// The name of the [VendorContact](https://developer.squareup.com/reference/square_2024-07-17/objects/VendorContact). This field is required when attempting to create a [Vendor](https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor).
	Name string `json:"name,omitempty"`
	// The email address of the [VendorContact](https://developer.squareup.com/reference/square_2024-07-17/objects/VendorContact).
	EmailAddress string `json:"email_address,omitempty"`
	// The phone number of the [VendorContact](https://developer.squareup.com/reference/square_2024-07-17/objects/VendorContact).
	PhoneNumber string `json:"phone_number,omitempty"`
	// The state of the [VendorContact](https://developer.squareup.com/reference/square_2024-07-17/objects/VendorContact).
	Removed bool `json:"removed,omitempty"`
	// The ordinal of the [VendorContact](https://developer.squareup.com/reference/square_2024-07-17/objects/VendorContact).
	Ordinal int32 `json:"ordinal"`
}

Represents a contact of a Vendor(https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor).

type VendorStatus ¶

type VendorStatus string

VendorStatus : The status of the Vendor(https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor), whether a Vendor(https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) is active or inactive.

const (
	ACTIVE_VendorStatus   VendorStatus = "ACTIVE"
	INACTIVE_VendorStatus VendorStatus = "INACTIVE"
)

List of VendorStatus

type VendorsApiService ¶

type VendorsApiService service

func (*VendorsApiService) BulkCreateVendors ¶

func (a *VendorsApiService) BulkCreateVendors(ctx context.Context, body BulkCreateVendorsRequest) (BulkCreateVendorsResponse, *http.Response, error)

VendorsApiService BulkCreateVendors Creates one or more Vendor(https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) objects to represent suppliers to a seller.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkCreateVendorsResponse

func (*VendorsApiService) BulkRetrieveVendors ¶

func (a *VendorsApiService) BulkRetrieveVendors(ctx context.Context, body BulkRetrieveVendorsRequest) (BulkRetrieveVendorsResponse, *http.Response, error)

VendorsApiService BulkRetrieveVendors Retrieves one or more vendors of specified Vendor(https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) IDs.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkRetrieveVendorsResponse

func (*VendorsApiService) BulkUpdateVendors ¶

func (a *VendorsApiService) BulkUpdateVendors(ctx context.Context, body BulkUpdateVendorsRequest) (BulkUpdateVendorsResponse, *http.Response, error)

VendorsApiService BulkUpdateVendors Updates one or more of existing Vendor(https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) objects as suppliers to a seller.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return BulkUpdateVendorsResponse

func (*VendorsApiService) CreateVendor ¶

func (a *VendorsApiService) CreateVendor(ctx context.Context, body CreateVendorRequest) (CreateVendorResponse, *http.Response, error)

VendorsApiService CreateVendor Creates a single Vendor(https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) object to represent a supplier to a seller.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateVendorResponse

func (*VendorsApiService) RetrieveVendor ¶

func (a *VendorsApiService) RetrieveVendor(ctx context.Context, vendorId string) (RetrieveVendorResponse, *http.Response, error)

VendorsApiService RetrieveVendor Retrieves the vendor of a specified Vendor(https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param vendorId ID of the Vendor(https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) to retrieve.

@return RetrieveVendorResponse

func (*VendorsApiService) SearchVendors ¶

func (a *VendorsApiService) SearchVendors(ctx context.Context, body SearchVendorsRequest) (SearchVendorsResponse, *http.Response, error)

VendorsApiService SearchVendors Searches for vendors using a filter against supported Vendor(https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) properties and a supported sorter.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return SearchVendorsResponse

func (*VendorsApiService) UpdateVendor ¶

func (a *VendorsApiService) UpdateVendor(ctx context.Context, body UpdateVendorRequest, vendorId string) (UpdateVendorResponse, *http.Response, error)

VendorsApiService UpdateVendor Updates an existing Vendor(https://developer.squareup.com/reference/square_2024-07-17/objects/Vendor) object as a supplier to a seller.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param vendorId

@return UpdateVendorResponse

type VisibilityFilter ¶

type VisibilityFilter string

VisibilityFilter : Enumeration of visibility-filter values used to set the ability to view custom attributes or custom attribute definitions.

const (
	ALL_VisibilityFilter        VisibilityFilter = "ALL"
	READ_VisibilityFilter       VisibilityFilter = "READ"
	READ_WRITE_VisibilityFilter VisibilityFilter = "READ_WRITE"
)

List of VisibilityFilter

type VoidTransactionRequest ¶

type VoidTransactionRequest struct{}

type VoidTransactionResponse ¶

type VoidTransactionResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Defines the fields that are included in the response body of a request to the [VoidTransaction](https://developer.squareup.com/reference/square_2024-07-17/transactions-api/void-transaction) endpoint.

type WageSetting ¶

type WageSetting struct {
	// The unique ID of the `TeamMember` whom this wage setting describes.
	TeamMemberId string `json:"team_member_id,omitempty"`
	// Required. The ordered list of jobs that the team member is assigned to. The first job assignment is considered the team member's primary job.  The minimum length is 1 and the maximum length is 12.
	JobAssignments []JobAssignment `json:"job_assignments,omitempty"`
	// Whether the team member is exempt from the overtime rules of the seller's country.
	IsOvertimeExempt bool `json:"is_overtime_exempt,omitempty"`
	// Used for resolving concurrency issues. The request fails if the version provided does not match the server version at the time of the request. If not provided, Square executes a blind write, potentially overwriting data from another write. For more information, see [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency).
	Version int32 `json:"version,omitempty"`
	// The timestamp, in RFC 3339 format, describing when the wage setting object was created. For example, \"2018-10-04T04:00:00-07:00\" or \"2019-02-05T12:00:00Z\".
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp, in RFC 3339 format, describing when the wage setting object was last updated. For example, \"2018-10-04T04:00:00-07:00\" or \"2019-02-05T12:00:00Z\".
	UpdatedAt string `json:"updated_at,omitempty"`
}

An object representing a team member's wage information.

type WebhookSubscription ¶

type WebhookSubscription struct {
	// A Square-generated unique ID for the subscription.
	Id string `json:"id,omitempty"`
	// The name of this subscription.
	Name string `json:"name,omitempty"`
	// Indicates whether the subscription is enabled (`true`) or not (`false`).
	Enabled bool `json:"enabled,omitempty"`
	// The event types associated with this subscription.
	EventTypes []string `json:"event_types,omitempty"`
	// The URL to which webhooks are sent.
	NotificationUrl string `json:"notification_url,omitempty"`
	// The API version of the subscription. This field is optional for `CreateWebhookSubscription`.  The value defaults to the API version used by the application.
	ApiVersion string `json:"api_version,omitempty"`
	// The Square-generated signature key used to validate the origin of the webhook event.
	SignatureKey string `json:"signature_key,omitempty"`
	// The timestamp of when the subscription was created, in RFC 3339 format. For example, \"2016-09-04T23:59:33.123Z\".
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp of when the subscription was last updated, in RFC 3339 format. For example, \"2016-09-04T23:59:33.123Z\".
	UpdatedAt string `json:"updated_at,omitempty"`
}

Represents the details of a webhook subscription, including notification URL, event types, and signature key.

type WebhookSubscriptionsApiListWebhookEventTypesOpts ¶

type WebhookSubscriptionsApiListWebhookEventTypesOpts struct {
	ApiVersion optional.String
}

type WebhookSubscriptionsApiListWebhookSubscriptionsOpts ¶

type WebhookSubscriptionsApiListWebhookSubscriptionsOpts struct {
	Cursor          optional.String
	IncludeDisabled optional.Bool
	SortOrder       optional.String
	Limit           optional.Int32
}

type WebhookSubscriptionsApiService ¶

type WebhookSubscriptionsApiService service

func (*WebhookSubscriptionsApiService) CreateWebhookSubscription ¶

func (a *WebhookSubscriptionsApiService) CreateWebhookSubscription(ctx context.Context, body CreateWebhookSubscriptionRequest) (CreateWebhookSubscriptionResponse, *http.Response, error)

WebhookSubscriptionsApiService CreateWebhookSubscription Creates a webhook subscription.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details. @return CreateWebhookSubscriptionResponse

func (*WebhookSubscriptionsApiService) DeleteWebhookSubscription ¶

func (a *WebhookSubscriptionsApiService) DeleteWebhookSubscription(ctx context.Context, subscriptionId string) (DeleteWebhookSubscriptionResponse, *http.Response, error)

WebhookSubscriptionsApiService DeleteWebhookSubscription Deletes a webhook subscription.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param subscriptionId [REQUIRED] The ID of the Subscription(https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription) to delete.

@return DeleteWebhookSubscriptionResponse

func (*WebhookSubscriptionsApiService) ListWebhookEventTypes ¶

func (a *WebhookSubscriptionsApiService) ListWebhookEventTypes(ctx context.Context, localVarOptionals *WebhookSubscriptionsApiListWebhookEventTypesOpts) (ListWebhookEventTypesResponse, *http.Response, error)

func (*WebhookSubscriptionsApiService) ListWebhookSubscriptions ¶

func (a *WebhookSubscriptionsApiService) ListWebhookSubscriptions(ctx context.Context, localVarOptionals *WebhookSubscriptionsApiListWebhookSubscriptionsOpts) (ListWebhookSubscriptionsResponse, *http.Response, error)

func (*WebhookSubscriptionsApiService) RetrieveWebhookSubscription ¶

func (a *WebhookSubscriptionsApiService) RetrieveWebhookSubscription(ctx context.Context, subscriptionId string) (RetrieveWebhookSubscriptionResponse, *http.Response, error)

WebhookSubscriptionsApiService RetrieveWebhookSubscription Retrieves a webhook subscription identified by its ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param subscriptionId [REQUIRED] The ID of the Subscription(https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription) to retrieve.

@return RetrieveWebhookSubscriptionResponse

func (*WebhookSubscriptionsApiService) TestWebhookSubscription ¶

func (a *WebhookSubscriptionsApiService) TestWebhookSubscription(ctx context.Context, body TestWebhookSubscriptionRequest, subscriptionId string) (TestWebhookSubscriptionResponse, *http.Response, error)

WebhookSubscriptionsApiService TestWebhookSubscription Tests a webhook subscription by sending a test event to the notification URL.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param subscriptionId [REQUIRED] The ID of the Subscription(https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription) to test.

@return TestWebhookSubscriptionResponse

func (*WebhookSubscriptionsApiService) UpdateWebhookSubscription ¶

func (a *WebhookSubscriptionsApiService) UpdateWebhookSubscription(ctx context.Context, body UpdateWebhookSubscriptionRequest, subscriptionId string) (UpdateWebhookSubscriptionResponse, *http.Response, error)

WebhookSubscriptionsApiService UpdateWebhookSubscription Updates a webhook subscription.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param subscriptionId [REQUIRED] The ID of the Subscription(https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription) to update.

@return UpdateWebhookSubscriptionResponse

func (*WebhookSubscriptionsApiService) UpdateWebhookSubscriptionSignatureKey ¶

func (a *WebhookSubscriptionsApiService) UpdateWebhookSubscriptionSignatureKey(ctx context.Context, body UpdateWebhookSubscriptionSignatureKeyRequest, subscriptionId string) (UpdateWebhookSubscriptionSignatureKeyResponse, *http.Response, error)

WebhookSubscriptionsApiService UpdateWebhookSubscriptionSignatureKey Updates a webhook subscription by replacing the existing signature key with a new one.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An object containing the fields to POST for the request.

See the corresponding object definition for field details.

@param subscriptionId [REQUIRED] The ID of the Subscription(https://developer.squareup.com/reference/square_2024-07-17/objects/WebhookSubscription) to update.

@return UpdateWebhookSubscriptionSignatureKeyResponse

type Weekday ¶

type Weekday string

Weekday : The days of the week.

const (
	MON_Weekday Weekday = "MON"
	TUE_Weekday Weekday = "TUE"
	WED_Weekday Weekday = "WED"
	THU_Weekday Weekday = "THU"
	FRI_Weekday Weekday = "FRI"
	SAT_Weekday Weekday = "SAT"
	SUN_Weekday Weekday = "SUN"
)

List of Weekday

type WorkweekConfig ¶

type WorkweekConfig struct {
	// The UUID for this object.
	Id string `json:"id,omitempty"`
	// The day of the week on which a business week starts for compensation purposes.
	StartOfWeek string `json:"start_of_week"`
	// The local time at which a business week starts. Represented as a string in `HH:MM` format (`HH:MM:SS` is also accepted, but seconds are truncated).
	StartOfDayLocalTime string `json:"start_of_day_local_time"`
	// Used for resolving concurrency issues. The request fails if the version provided does not match the server version at the time of the request. If not provided, Square executes a blind write; potentially overwriting data from another write.
	Version int32 `json:"version,omitempty"`
	// A read-only timestamp in RFC 3339 format; presented in UTC.
	CreatedAt string `json:"created_at,omitempty"`
	// A read-only timestamp in RFC 3339 format; presented in UTC.
	UpdatedAt string `json:"updated_at,omitempty"`
}

Sets the day of the week and hour of the day that a business starts a workweek. This is used to calculate overtime pay.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL