square

package

v0.0.0-...-60b6b9d Latest Latest Go to latest Published: Feb 22, 2021 License: MIT Imports: 21 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/jefflinse/square-connect-go-sdk

Links

Open Source Insights

README ¶

Go API client for square

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.20210121.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"

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
BookingsApi	CancelBooking	Post /v2/bookings/{booking_id}/cancel	CancelBooking
BookingsApi	CreateBooking	Post /v2/bookings	CreateBooking
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	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
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
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	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	GetDeviceCode	Get /v2/devices/codes/{id}	GetDeviceCode
DevicesApi	ListDeviceCodes	Get /v2/devices/codes	ListDeviceCodes
DisputesApi	AcceptDispute	Post /v2/disputes/{dispute_id}/accept	AcceptDispute
DisputesApi	CreateDisputeEvidenceText	Post /v2/disputes/{dispute_id}/evidence_text	CreateDisputeEvidenceText
DisputesApi	ListDisputeEvidence	Get /v2/disputes/{dispute_id}/evidence	ListDisputeEvidence
DisputesApi	ListDisputes	Get /v2/disputes	ListDisputes
DisputesApi	RemoveDisputeEvidence	Delete /v2/disputes/{dispute_id}/evidence/{evidence_id}	RemoveDisputeEvidence
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
InventoryApi	BatchChangeInventory	Post /v2/inventory/batch-change	BatchChangeInventory
InventoryApi	BatchRetrieveInventoryChanges	Post /v2/inventory/batch-retrieve-changes	BatchRetrieveInventoryChanges
InventoryApi	BatchRetrieveInventoryCounts	Post /v2/inventory/batch-retrieve-counts	BatchRetrieveInventoryCounts
InventoryApi	RetrieveInventoryAdjustment	Get /v2/inventory/adjustment/{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-count/{physical_count_id}	RetrieveInventoryPhysicalCount
InvoicesApi	CancelInvoice	Post /v2/invoices/{invoice_id}/cancel	CancelInvoice
InvoicesApi	CreateInvoice	Post /v2/invoices	CreateInvoice
InvoicesApi	DeleteInvoice	Delete /v2/invoices/{invoice_id}	DeleteInvoice
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
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	CreateLoyaltyAccount	Post /v2/loyalty/accounts	CreateLoyaltyAccount
LoyaltyApi	CreateLoyaltyReward	Post /v2/loyalty/rewards	CreateLoyaltyReward
LoyaltyApi	DeleteLoyaltyReward	Delete /v2/loyalty/rewards/{reward_id}	DeleteLoyaltyReward
LoyaltyApi	ListLoyaltyPrograms	Get /v2/loyalty/programs	ListLoyaltyPrograms
LoyaltyApi	RedeemLoyaltyReward	Post /v2/loyalty/rewards/{reward_id}/redeem	RedeemLoyaltyReward
LoyaltyApi	RetrieveLoyaltyAccount	Get /v2/loyalty/accounts/{account_id}	RetrieveLoyaltyAccount
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
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	RenewToken	Post /oauth2/clients/{client_id}/access-token/renew	RenewToken
OAuthApi	RevokeToken	Post /oauth2/revoke	RevokeToken
OrdersApi	BatchRetrieveOrders	Post /v2/orders/batch-retrieve	BatchRetrieveOrders
OrdersApi	CalculateOrder	Post /v2/orders/calculate	CalculateOrder
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
RefundsApi	GetPaymentRefund	Get /v2/refunds/{refund_id}	GetPaymentRefund
RefundsApi	ListPaymentRefunds	Get /v2/refunds	ListPaymentRefunds
RefundsApi	RefundPayment	Post /v2/refunds	RefundPayment
SubscriptionsApi	CancelSubscription	Post /v2/subscriptions/{subscription_id}/cancel	CancelSubscription
SubscriptionsApi	CreateSubscription	Post /v2/subscriptions	CreateSubscription
SubscriptionsApi	ListSubscriptionEvents	Get /v2/subscriptions/{subscription_id}/events	ListSubscriptionEvents
SubscriptionsApi	RetrieveSubscription	Get /v2/subscriptions/{subscription_id}	RetrieveSubscription
SubscriptionsApi	SearchSubscriptions	Post /v2/subscriptions/search	SearchSubscriptions
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	CancelTerminalCheckout	Post /v2/terminals/checkouts/{checkout_id}/cancel	CancelTerminalCheckout
TerminalApi	CancelTerminalRefund	Post /v2/terminals/refunds/{terminal_refund_id}/cancel	CancelTerminalRefund
TerminalApi	CreateTerminalCheckout	Post /v2/terminals/checkouts	CreateTerminalCheckout
TerminalApi	CreateTerminalRefund	Post /v2/terminals/refunds	CreateTerminalRefund
TerminalApi	GetTerminalCheckout	Get /v2/terminals/checkouts/{checkout_id}	GetTerminalCheckout
TerminalApi	GetTerminalRefund	Get /v2/terminals/refunds/{terminal_refund_id}	GetTerminalRefund
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	Charge	Post /v2/locations/{location_id}/transactions	Charge
TransactionsApi	CreateRefund	Post /v2/locations/{location_id}/transactions/{transaction_id}/refund	CreateRefund
TransactionsApi	ListRefunds	Get /v2/locations/{location_id}/refunds	ListRefunds
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
V1EmployeesApi	CreateEmployee	Post /v1/me/employees	CreateEmployee
V1EmployeesApi	CreateEmployeeRole	Post /v1/me/roles	CreateEmployeeRole
V1EmployeesApi	CreateTimecard	Post /v1/me/timecards	CreateTimecard
V1EmployeesApi	DeleteTimecard	Delete /v1/me/timecards/{timecard_id}	DeleteTimecard
V1EmployeesApi	ListCashDrawerShifts	Get /v1/{location_id}/cash-drawer-shifts	ListCashDrawerShifts
V1EmployeesApi	ListEmployeeRoles	Get /v1/me/roles	ListEmployeeRoles
V1EmployeesApi	ListEmployees	Get /v1/me/employees	ListEmployees
V1EmployeesApi	ListTimecardEvents	Get /v1/me/timecards/{timecard_id}/events	ListTimecardEvents
V1EmployeesApi	ListTimecards	Get /v1/me/timecards	ListTimecards
V1EmployeesApi	RetrieveCashDrawerShift	Get /v1/{location_id}/cash-drawer-shifts/{shift_id}	RetrieveCashDrawerShift
V1EmployeesApi	RetrieveEmployee	Get /v1/me/employees/{employee_id}	RetrieveEmployee
V1EmployeesApi	RetrieveEmployeeRole	Get /v1/me/roles/{role_id}	RetrieveEmployeeRole
V1EmployeesApi	RetrieveTimecard	Get /v1/me/timecards/{timecard_id}	RetrieveTimecard
V1EmployeesApi	UpdateEmployee	Put /v1/me/employees/{employee_id}	UpdateEmployee
V1EmployeesApi	UpdateEmployeeRole	Put /v1/me/roles/{role_id}	UpdateEmployeeRole
V1EmployeesApi	UpdateTimecard	Put /v1/me/timecards/{timecard_id}	UpdateTimecard
V1ItemsApi	AdjustInventory	Post /v1/{location_id}/inventory/{variation_id}	AdjustInventory
V1ItemsApi	ApplyFee	Put /v1/{location_id}/items/{item_id}/fees/{fee_id}	ApplyFee
V1ItemsApi	ApplyModifierList	Put /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id}	ApplyModifierList
V1ItemsApi	CreateCategory	Post /v1/{location_id}/categories	CreateCategory
V1ItemsApi	CreateDiscount	Post /v1/{location_id}/discounts	CreateDiscount
V1ItemsApi	CreateFee	Post /v1/{location_id}/fees	CreateFee
V1ItemsApi	CreateItem	Post /v1/{location_id}/items	CreateItem
V1ItemsApi	CreateModifierList	Post /v1/{location_id}/modifier-lists	CreateModifierList
V1ItemsApi	CreateModifierOption	Post /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options	CreateModifierOption
V1ItemsApi	CreatePage	Post /v1/{location_id}/pages	CreatePage
V1ItemsApi	CreateVariation	Post /v1/{location_id}/items/{item_id}/variations	CreateVariation
V1ItemsApi	DeleteCategory	Delete /v1/{location_id}/categories/{category_id}	DeleteCategory
V1ItemsApi	DeleteDiscount	Delete /v1/{location_id}/discounts/{discount_id}	DeleteDiscount
V1ItemsApi	DeleteFee	Delete /v1/{location_id}/fees/{fee_id}	DeleteFee
V1ItemsApi	DeleteItem	Delete /v1/{location_id}/items/{item_id}	DeleteItem
V1ItemsApi	DeleteModifierList	Delete /v1/{location_id}/modifier-lists/{modifier_list_id}	DeleteModifierList
V1ItemsApi	DeleteModifierOption	Delete /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id}	DeleteModifierOption
V1ItemsApi	DeletePage	Delete /v1/{location_id}/pages/{page_id}	DeletePage
V1ItemsApi	DeletePageCell	Delete /v1/{location_id}/pages/{page_id}/cells	DeletePageCell
V1ItemsApi	DeleteVariation	Delete /v1/{location_id}/items/{item_id}/variations/{variation_id}	DeleteVariation
V1ItemsApi	ListCategories	Get /v1/{location_id}/categories	ListCategories
V1ItemsApi	ListDiscounts	Get /v1/{location_id}/discounts	ListDiscounts
V1ItemsApi	ListFees	Get /v1/{location_id}/fees	ListFees
V1ItemsApi	ListInventory	Get /v1/{location_id}/inventory	ListInventory
V1ItemsApi	ListItems	Get /v1/{location_id}/items	ListItems
V1ItemsApi	ListModifierLists	Get /v1/{location_id}/modifier-lists	ListModifierLists
V1ItemsApi	ListPages	Get /v1/{location_id}/pages	ListPages
V1ItemsApi	RemoveFee	Delete /v1/{location_id}/items/{item_id}/fees/{fee_id}	RemoveFee
V1ItemsApi	RemoveModifierList	Delete /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id}	RemoveModifierList
V1ItemsApi	RetrieveItem	Get /v1/{location_id}/items/{item_id}	RetrieveItem
V1ItemsApi	RetrieveModifierList	Get /v1/{location_id}/modifier-lists/{modifier_list_id}	RetrieveModifierList
V1ItemsApi	UpdateCategory	Put /v1/{location_id}/categories/{category_id}	UpdateCategory
V1ItemsApi	UpdateDiscount	Put /v1/{location_id}/discounts/{discount_id}	UpdateDiscount
V1ItemsApi	UpdateFee	Put /v1/{location_id}/fees/{fee_id}	UpdateFee
V1ItemsApi	UpdateItem	Put /v1/{location_id}/items/{item_id}	UpdateItem
V1ItemsApi	UpdateModifierList	Put /v1/{location_id}/modifier-lists/{modifier_list_id}	UpdateModifierList
V1ItemsApi	UpdateModifierOption	Put /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id}	UpdateModifierOption
V1ItemsApi	UpdatePage	Put /v1/{location_id}/pages/{page_id}	UpdatePage
V1ItemsApi	UpdatePageCell	Put /v1/{location_id}/pages/{page_id}/cells	UpdatePageCell
V1ItemsApi	UpdateVariation	Put /v1/{location_id}/items/{item_id}/variations/{variation_id}	UpdateVariation
V1TransactionsApi	CreateRefund	Post /v1/{location_id}/refunds	CreateRefund
V1TransactionsApi	ListBankAccounts	Get /v1/{location_id}/bank-accounts	ListBankAccounts
V1TransactionsApi	ListOrders	Get /v1/{location_id}/orders	ListOrders
V1TransactionsApi	ListPayments	Get /v1/{location_id}/payments	ListPayments
V1TransactionsApi	ListRefunds	Get /v1/{location_id}/refunds	ListRefunds
V1TransactionsApi	ListSettlements	Get /v1/{location_id}/settlements	ListSettlements
V1TransactionsApi	RetrieveBankAccount	Get /v1/{location_id}/bank-accounts/{bank_account_id}	RetrieveBankAccount
V1TransactionsApi	RetrieveOrder	Get /v1/{location_id}/orders/{order_id}	RetrieveOrder
V1TransactionsApi	RetrievePayment	Get /v1/{location_id}/payments/{payment_id}	RetrievePayment
V1TransactionsApi	RetrieveSettlement	Get /v1/{location_id}/settlements/{settlement_id}	RetrieveSettlement
V1TransactionsApi	UpdateOrder	Put /v1/{location_id}/orders/{order_id}	UpdateOrder

Documentation For Models

Documentation For Authorization

oauth2

Type: OAuth
Flow: accessCode
Authorization URL: https://connect.squareup.com/oauth2/authorize
Scopes:
****:

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 AccumulateLoyaltyPointsRequest
type AccumulateLoyaltyPointsResponse
type ActionCancelReason
type AddGroupToCustomerRequest
type AddGroupToCustomerResponse
type AdditionalRecipient
type Address
type AdjustLoyaltyPointsRequest
type AdjustLoyaltyPointsResponse
type ApplePayApiService
- func (a *ApplePayApiService) RegisterDomain(ctx context.Context, body RegisterDomainRequest) (RegisterDomainResponse, *http.Response, error)
type AppointmentSegment
type Availability
type BalancePaymentDetails
type BankAccount
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 BookingStatus
type BookingsApiListTeamMemberBookingProfilesOpts
type BookingsApiService
- 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) 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) 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 BulkCreateTeamMembersRequest
type BulkCreateTeamMembersResponse
type BulkUpdateTeamMembersRequest
type BulkUpdateTeamMembersResponse
type BusinessAppointmentSettings
type BusinessAppointmentSettingsAlignmentTime
type BusinessAppointmentSettingsBookingLocationType
type BusinessAppointmentSettingsCancellationPolicy
type BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType
type BusinessBookingProfile
type BusinessBookingProfileBookingPolicy
type BusinessBookingProfileCustomerTimezoneChoice
type BusinessHours
type BusinessHoursPeriod
type CalculateLoyaltyPointsRequest
type CalculateLoyaltyPointsResponse
type CalculateOrderRequest
type CalculateOrderResponse
type CancelBookingRequest
type CancelBookingResponse
type CancelInvoiceRequest
type CancelInvoiceResponse
type CancelPaymentByIdempotencyKeyRequest
type CancelPaymentByIdempotencyKeyResponse
type CancelPaymentRequest
type CancelPaymentResponse
type CancelSubscriptionRequest
type CancelSubscriptionResponse
type CancelTerminalCheckoutRequest
type CancelTerminalCheckoutResponse
type CancelTerminalRefundRequest
type CancelTerminalRefundResponse
type CaptureTransactionRequest
type CaptureTransactionResponse
type Card
type CardBrand
type CardPaymentDetails
type CardPrepaidType
type CardSquareProduct
type CardType
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 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 CatalogCategory
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 CatalogIdMapping
type CatalogImage
type CatalogInfoRequest
type CatalogInfoResponse
type CatalogInfoResponseLimits
type CatalogItem
type CatalogItemModifierListInfo
type CatalogItemOption
type CatalogItemOptionForItem
type CatalogItemOptionValue
type CatalogItemOptionValueForItemVariation
type CatalogItemProductType
type CatalogItemVariation
type CatalogMeasurementUnit
type CatalogModifier
type CatalogModifierList
type CatalogModifierListSelectionType
type CatalogModifierOverride
type CatalogObject
type CatalogObjectBatch
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 CatalogSubscriptionPlan
type CatalogTax
type CatalogTimePeriod
type CatalogV1Id
type ChargeRequest
type ChargeRequestAdditionalRecipient
type ChargeResponse
type CheckAppointmentsOnboardedRequest
type CheckAppointmentsOnboardedResponse
type Checkout
type CheckoutApiService
- func (a *CheckoutApiService) CreateCheckout(ctx context.Context, body CreateCheckoutRequest, locationId string) (CreateCheckoutResponse, *http.Response, error)
type CompletePaymentRequest
type CompletePaymentResponse
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type Coordinates
type Country
type CreateBookingRequest
type CreateBookingResponse
type CreateBreakTypeRequest
type CreateBreakTypeResponse
type CreateCheckoutRequest
type CreateCheckoutResponse
type CreateCustomerCardRequest
type CreateCustomerCardResponse
type CreateCustomerGroupRequest
type CreateCustomerGroupResponse
type CreateCustomerRequest
type CreateCustomerResponse
type CreateDeviceCodeRequest
type CreateDeviceCodeResponse
type CreateDisputeEvidenceTextRequest
type CreateDisputeEvidenceTextResponse
type CreateInvoiceRequest
type CreateInvoiceResponse
type CreateLocationRequest
type CreateLocationResponse
type CreateLoyaltyAccountRequest
type CreateLoyaltyAccountResponse
type CreateLoyaltyRewardRequest
type CreateLoyaltyRewardResponse
type CreateMobileAuthorizationCodeRequest
type CreateMobileAuthorizationCodeResponse
type CreateOrderRequest
type CreateOrderResponse
type CreatePaymentRequest
type CreatePaymentResponse
type CreateRefundRequest
type CreateRefundResponse
type CreateShiftRequest
type CreateShiftResponse
type CreateSubscriptionRequest
type CreateSubscriptionResponse
type CreateTeamMemberRequest
type CreateTeamMemberResponse
type CreateTerminalCheckoutRequest
type CreateTerminalCheckoutResponse
type CreateTerminalRefundRequest
type CreateTerminalRefundResponse
type Currency
type CustomAttributeFilter
type Customer
type CustomerCreationSource
type CustomerCreationSourceFilter
type CustomerFilter
type CustomerGroup
type CustomerGroupInfo
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 CustomerTextFilter
type CustomersApiListCustomersOpts
type CustomersApiService
- func (a *CustomersApiService) AddGroupToCustomer(ctx context.Context, customerId string, groupId string) (AddGroupToCustomerResponse, *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 DateRange
type DayOfWeek
type DeleteBreakTypeRequest
type DeleteBreakTypeResponse
type DeleteCatalogObjectRequest
type DeleteCatalogObjectResponse
type DeleteCustomerCardRequest
type DeleteCustomerCardResponse
type DeleteCustomerGroupRequest
type DeleteCustomerGroupResponse
type DeleteCustomerRequest
type DeleteCustomerResponse
type DeleteInvoiceRequest
type DeleteInvoiceResponse
type DeleteLoyaltyRewardRequest
type DeleteLoyaltyRewardResponse
type DeleteShiftRequest
type DeleteShiftResponse
type Device
type DeviceCheckoutOptions
type DeviceCode
type DeviceCodeStatus
type DeviceDetails
type DevicesApiListDeviceCodesOpts
type DevicesApiService
- func (a *DevicesApiService) CreateDeviceCode(ctx context.Context, body CreateDeviceCodeRequest) (CreateDeviceCodeResponse, *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)
type Dispute
type DisputeEvidence
type DisputeEvidenceFile
type DisputeEvidenceType
type DisputeReason
type DisputeState
type DisputedPayment
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) 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) RemoveDisputeEvidence(ctx context.Context, disputeId string, evidenceId string) (RemoveDisputeEvidenceResponse, *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 ErrorCategory
type ErrorCode
type ExcludeStrategy
type FilterValue
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 GetEmployeeWageRequest
type GetEmployeeWageResponse
type GetInvoiceRequest
type GetInvoiceResponse
type GetPaymentRefundRequest
type GetPaymentRefundResponse
type GetPaymentRequest
type GetPaymentResponse
type GetShiftRequest
type GetShiftResponse
type GetTeamMemberWageRequest
type GetTeamMemberWageResponse
type GetTerminalCheckoutRequest
type GetTerminalCheckoutResponse
type GetTerminalRefundRequest
type GetTerminalRefundResponse
type InlineTypes
type InventoryAdjustment
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) 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)
type InventoryChange
type InventoryChangeType
type InventoryCount
type InventoryPhysicalCount
type InventoryState
type InventoryTransfer
type Invoice
type InvoiceAutomaticPaymentSource
type InvoiceCustomField
type InvoiceCustomFieldPlacement
type InvoiceDeliveryMethod
type InvoiceFilter
type InvoicePaymentReminder
type InvoicePaymentReminderStatus
type InvoicePaymentRequest
type InvoiceQuery
type InvoiceRecipient
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) 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 ListBankAccountsRequest
type ListBankAccountsResponse
type ListBreakTypesRequest
type ListBreakTypesResponse
type ListCashDrawerShiftEventsRequest
type ListCashDrawerShiftEventsResponse
type ListCashDrawerShiftsRequest
type ListCashDrawerShiftsResponse
type ListCatalogRequest
type ListCatalogResponse
type ListCustomerGroupsRequest
type ListCustomerGroupsResponse
type ListCustomerSegmentsRequest
type ListCustomerSegmentsResponse
type ListCustomersRequest
type ListCustomersResponse
type ListDeviceCodesRequest
type ListDeviceCodesResponse
type ListDisputeEvidenceRequest
type ListDisputeEvidenceResponse
type ListDisputesRequest
type ListDisputesResponse
type ListEmployeeWagesRequest
type ListEmployeeWagesResponse
type ListEmployeesRequest
type ListEmployeesResponse
type ListInvoicesRequest
type ListInvoicesResponse
type ListLocationsRequest
type ListLocationsResponse
type ListLoyaltyProgramsRequest
type ListLoyaltyProgramsResponse
type ListMerchantsRequest
type ListMerchantsResponse
type ListPaymentRefundsRequest
type ListPaymentRefundsResponse
type ListPaymentsRequest
type ListPaymentsResponse
type ListRefundsRequest
type ListRefundsResponse
type ListSubscriptionEventsRequest
type ListSubscriptionEventsResponse
type ListTeamMemberBookingProfilesRequest
type ListTeamMemberBookingProfilesResponse
type ListTeamMemberWagesRequest
type ListTeamMemberWagesResponse
type ListTransactionsRequest
type ListTransactionsResponse
type ListWorkweekConfigsRequest
type ListWorkweekConfigsResponse
type Location
type LocationCapability
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 LoyaltyAccountMapping
type LoyaltyAccountMappingType
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) CreateLoyaltyAccount(ctx context.Context, body CreateLoyaltyAccountRequest) (CreateLoyaltyAccountResponse, *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) 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) 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 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 LoyaltyProgramAccrualRuleType
type LoyaltyProgramExpirationPolicy
type LoyaltyProgramRewardDefinition
type LoyaltyProgramRewardDefinitionScope
type LoyaltyProgramRewardDefinitionType
type LoyaltyProgramRewardTier
type LoyaltyProgramStatus
type LoyaltyProgramTerminology
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 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 Money
type OAuthApiService
- func (a *OAuthApiService) ObtainToken(ctx context.Context, body ObtainTokenRequest) (ObtainTokenResponse, *http.Response, error)
- func (a *OAuthApiService) RenewToken(ctx context.Context, body RenewTokenRequest, clientId string) (RenewTokenResponse, *http.Response, error)
- func (a *OAuthApiService) RevokeToken(ctx context.Context, body RevokeTokenRequest) (RevokeTokenResponse, *http.Response, error)
type ObtainTokenRequest
type ObtainTokenResponse
type OnboardAppointmentsRequest
type OnboardAppointmentsResponse
type Order
type OrderCreated
type OrderCreatedObject
type OrderEntry
type OrderFulfillment
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 OrderLineItemAppliedTax
type OrderLineItemDiscount
type OrderLineItemDiscountScope
type OrderLineItemDiscountType
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 OrderReward
type OrderRoundingAdjustment
type OrderServiceCharge
type OrderServiceChargeCalculationPhase
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) 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 PayOrderRequest
type PayOrderResponse
type Payment
type PaymentOptions
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, 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)
type ProcessingFee
type Product
type ProductType
type PublishInvoiceRequest
type PublishInvoiceResponse
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 RemoveDisputeEvidenceRequest
type RemoveDisputeEvidenceResponse
type RemoveGroupFromCustomerRequest
type RemoveGroupFromCustomerResponse
type RenewTokenRequest
type RenewTokenResponse
type RetrieveBookingRequest
type RetrieveBookingResponse
type RetrieveBusinessBookingProfileRequest
type RetrieveBusinessBookingProfileResponse
type RetrieveCashDrawerShiftRequest
type RetrieveCashDrawerShiftResponse
type RetrieveCatalogObjectRequest
type RetrieveCatalogObjectResponse
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 RetrieveInventoryAdjustmentRequest
type RetrieveInventoryAdjustmentResponse
type RetrieveInventoryChangesRequest
type RetrieveInventoryChangesResponse
type RetrieveInventoryCountRequest
type RetrieveInventoryCountResponse
type RetrieveInventoryPhysicalCountRequest
type RetrieveInventoryPhysicalCountResponse
type RetrieveLocationRequest
type RetrieveLocationResponse
type RetrieveLoyaltyAccountRequest
type RetrieveLoyaltyAccountResponse
type RetrieveLoyaltyRewardRequest
type RetrieveLoyaltyRewardResponse
type RetrieveMerchantRequest
type RetrieveMerchantResponse
type RetrieveObsMigrationProfileRequest
type RetrieveObsMigrationProfileResponse
type RetrieveOrderRequest
type RetrieveOrderResponse
type RetrieveSubscriptionRequest
type RetrieveSubscriptionResponse
type RetrieveTeamMemberBookingProfileRequest
type RetrieveTeamMemberBookingProfileResponse
type RetrieveTeamMemberRequest
type RetrieveTeamMemberResponse
type RetrieveTransactionRequest
type RetrieveTransactionResponse
type RetrieveWageSettingRequest
type RetrieveWageSettingResponse
type RevokeTokenRequest
type RevokeTokenResponse
type RiskEvaluation
type RiskEvaluationRiskLevel
type SearchAvailabilityFilter
type SearchAvailabilityQuery
type SearchAvailabilityRequest
type SearchAvailabilityResponse
type SearchCatalogItemsRequest
type SearchCatalogItemsRequestStockLevel
type SearchCatalogItemsResponse
type SearchCatalogObjectsRequest
type SearchCatalogObjectsResponse
type SearchCustomersRequest
type SearchCustomersResponse
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 SearchTerminalCheckoutsRequest
type SearchTerminalCheckoutsResponse
type SearchTerminalRefundsRequest
type SearchTerminalRefundsResponse
type SegmentFilter
type Shift
type ShiftFilter
type ShiftFilterStatus
type ShiftQuery
type ShiftSort
type ShiftSortField
type ShiftStatus
type ShiftWage
type ShiftWorkday
type ShiftWorkdayMatcher
type SortOrder
type SourceApplication
type StandardUnitDescription
type StandardUnitDescriptionGroup
type SubmitEvidenceRequest
type SubmitEvidenceResponse
type Subscription
type SubscriptionCadence
type SubscriptionEvent
type SubscriptionEventSubscriptionEventType
type SubscriptionPhase
type SubscriptionStatus
type SubscriptionsApiListSubscriptionEventsOpts
type SubscriptionsApiService
- func (a *SubscriptionsApiService) CancelSubscription(ctx context.Context, subscriptionId string) (CancelSubscriptionResponse, *http.Response, error)
- func (a *SubscriptionsApiService) CreateSubscription(ctx context.Context, body CreateSubscriptionRequest) (CreateSubscriptionResponse, *http.Response, error)
- func (a *SubscriptionsApiService) ListSubscriptionEvents(ctx context.Context, subscriptionId string, ...) (ListSubscriptionEventsResponse, *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) UpdateSubscription(ctx context.Context, body UpdateSubscriptionRequest, subscriptionId string) (UpdateSubscriptionResponse, *http.Response, error)
type TaxCalculationPhase
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 TeamMemberStatus
type TeamMemberWage
type Tender
type TenderCardDetails
type TenderCardDetailsEntryMethod
type TenderCardDetailsStatus
type TenderCashDetails
type TenderType
type TerminalApiService
- 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) 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) 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) 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 TimeRange
type TipSettings
type Transaction
type TransactionProduct
type TransactionType
type TransactionsApiListRefundsOpts
type TransactionsApiListTransactionsOpts
type TransactionsApiService
- func (a *TransactionsApiService) CaptureTransaction(ctx context.Context, locationId string, transactionId string) (CaptureTransactionResponse, *http.Response, error)
- func (a *TransactionsApiService) Charge(ctx context.Context, body ChargeRequest, locationId string) (ChargeResponse, *http.Response, error)
- func (a *TransactionsApiService) CreateRefund(ctx context.Context, body CreateRefundRequest, locationId string, ...) (CreateRefundResponse, *http.Response, error)
- func (a *TransactionsApiService) ListRefunds(ctx context.Context, locationId string, ...) (ListRefundsResponse, *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 UpdateBookingRequest
type UpdateBookingResponse
type UpdateBreakTypeRequest
type UpdateBreakTypeResponse
type UpdateCustomerGroupRequest
type UpdateCustomerGroupResponse
type UpdateCustomerRequest
type UpdateCustomerResponse
type UpdateInvoiceRequest
type UpdateInvoiceResponse
type UpdateItemModifierListsRequest
type UpdateItemModifierListsResponse
type UpdateItemTaxesRequest
type UpdateItemTaxesResponse
type UpdateLocationRequest
type UpdateLocationResponse
type UpdateOrderRequest
type UpdateOrderResponse
type UpdateShiftRequest
type UpdateShiftResponse
type UpdateSubscriptionRequest
type UpdateSubscriptionResponse
type UpdateTeamMemberRequest
type UpdateTeamMemberResponse
type UpdateWageSettingRequest
type UpdateWageSettingResponse
type UpdateWorkweekConfigRequest
type UpdateWorkweekConfigResponse
type UpsertCatalogObjectRequest
type UpsertCatalogObjectResponse
type V1AdjustInventoryRequest
type V1AdjustInventoryRequestAdjustmentType
type V1ApplyFeeRequest
type V1ApplyModifierListRequest
type V1BankAccount
type V1BankAccountType
type V1CashDrawerEvent
type V1CashDrawerEventEventType
type V1CashDrawerShift
type V1CashDrawerShiftEventType
type V1Category
type V1CreateCategoryRequest
type V1CreateDiscountRequest
type V1CreateEmployeeRoleRequest
type V1CreateFeeRequest
type V1CreateItemRequest
type V1CreateModifierListRequest
type V1CreateModifierOptionRequest
type V1CreatePageRequest
type V1CreateRefundRequest
type V1CreateRefundRequestType
type V1CreateVariationRequest
type V1DeleteCategoryRequest
type V1DeleteDiscountRequest
type V1DeleteFeeRequest
type V1DeleteItemRequest
type V1DeleteModifierListRequest
type V1DeleteModifierOptionRequest
type V1DeletePageCellRequest
type V1DeletePageRequest
type V1DeleteTimecardRequest
type V1DeleteTimecardResponse
type V1DeleteVariationRequest
type V1Discount
type V1DiscountDiscountType
type V1Employee
type V1EmployeeRole
type V1EmployeeRolePermissions
type V1EmployeeStatus
type V1EmployeesApiListCashDrawerShiftsOpts
type V1EmployeesApiListEmployeeRolesOpts
type V1EmployeesApiListEmployeesOpts
type V1EmployeesApiListTimecardsOpts
type V1EmployeesApiService
- func (a *V1EmployeesApiService) CreateEmployee(ctx context.Context, body V1Employee) (V1Employee, *http.Response, error)
- func (a *V1EmployeesApiService) CreateEmployeeRole(ctx context.Context, body V1EmployeeRole) (V1EmployeeRole, *http.Response, error)
- func (a *V1EmployeesApiService) CreateTimecard(ctx context.Context, body V1Timecard) (V1Timecard, *http.Response, error)
- func (a *V1EmployeesApiService) DeleteTimecard(ctx context.Context, timecardId string) (interface{}, *http.Response, error)
- func (a *V1EmployeesApiService) ListCashDrawerShifts(ctx context.Context, locationId string, ...) ([]V1CashDrawerShift, *http.Response, error)
- func (a *V1EmployeesApiService) ListEmployeeRoles(ctx context.Context, localVarOptionals *V1EmployeesApiListEmployeeRolesOpts) ([]V1EmployeeRole, *http.Response, error)
- func (a *V1EmployeesApiService) ListEmployees(ctx context.Context, localVarOptionals *V1EmployeesApiListEmployeesOpts) ([]V1Employee, *http.Response, error)
- func (a *V1EmployeesApiService) ListTimecardEvents(ctx context.Context, timecardId string) ([]V1TimecardEvent, *http.Response, error)
- func (a *V1EmployeesApiService) ListTimecards(ctx context.Context, localVarOptionals *V1EmployeesApiListTimecardsOpts) ([]V1Timecard, *http.Response, error)
- func (a *V1EmployeesApiService) RetrieveCashDrawerShift(ctx context.Context, locationId string, shiftId string) (V1CashDrawerShift, *http.Response, error)
- func (a *V1EmployeesApiService) RetrieveEmployee(ctx context.Context, employeeId string) (V1Employee, *http.Response, error)
- func (a *V1EmployeesApiService) RetrieveEmployeeRole(ctx context.Context, roleId string) (V1EmployeeRole, *http.Response, error)
- func (a *V1EmployeesApiService) RetrieveTimecard(ctx context.Context, timecardId string) (V1Timecard, *http.Response, error)
- func (a *V1EmployeesApiService) UpdateEmployee(ctx context.Context, body V1Employee, employeeId string) (V1Employee, *http.Response, error)
- func (a *V1EmployeesApiService) UpdateEmployeeRole(ctx context.Context, body V1EmployeeRole, roleId string) (V1EmployeeRole, *http.Response, error)
- func (a *V1EmployeesApiService) UpdateTimecard(ctx context.Context, body V1Timecard, timecardId string) (V1Timecard, *http.Response, error)
type V1Fee
type V1FeeAdjustmentType
type V1FeeCalculationPhase
type V1FeeInclusionType
type V1FeeType
type V1InventoryEntry
type V1Item
type V1ItemImage
type V1ItemType
type V1ItemVisibility
type V1ItemsApiDeletePageCellOpts
type V1ItemsApiListInventoryOpts
type V1ItemsApiListItemsOpts
type V1ItemsApiService
- func (a *V1ItemsApiService) AdjustInventory(ctx context.Context, body V1AdjustInventoryRequest, locationId string, ...) (V1InventoryEntry, *http.Response, error)
- func (a *V1ItemsApiService) ApplyFee(ctx context.Context, locationId string, itemId string, feeId string) (V1Item, *http.Response, error)
- func (a *V1ItemsApiService) ApplyModifierList(ctx context.Context, locationId string, modifierListId string, itemId string) (V1Item, *http.Response, error)
- func (a *V1ItemsApiService) CreateCategory(ctx context.Context, body V1Category, locationId string) (V1Category, *http.Response, error)
- func (a *V1ItemsApiService) CreateDiscount(ctx context.Context, body V1Discount, locationId string) (V1Discount, *http.Response, error)
- func (a *V1ItemsApiService) CreateFee(ctx context.Context, body V1Fee, locationId string) (V1Fee, *http.Response, error)
- func (a *V1ItemsApiService) CreateItem(ctx context.Context, body V1Item, locationId string) (V1Item, *http.Response, error)
- func (a *V1ItemsApiService) CreateModifierList(ctx context.Context, body V1ModifierList, locationId string) (V1ModifierList, *http.Response, error)
- func (a *V1ItemsApiService) CreateModifierOption(ctx context.Context, body V1ModifierOption, locationId string, ...) (V1ModifierOption, *http.Response, error)
- func (a *V1ItemsApiService) CreatePage(ctx context.Context, body V1Page, locationId string) (V1Page, *http.Response, error)
- func (a *V1ItemsApiService) CreateVariation(ctx context.Context, body V1Variation, locationId string, itemId string) (V1Variation, *http.Response, error)
- func (a *V1ItemsApiService) DeleteCategory(ctx context.Context, locationId string, categoryId string) (V1Category, *http.Response, error)
- func (a *V1ItemsApiService) DeleteDiscount(ctx context.Context, locationId string, discountId string) (V1Discount, *http.Response, error)
- func (a *V1ItemsApiService) DeleteFee(ctx context.Context, locationId string, feeId string) (V1Fee, *http.Response, error)
- func (a *V1ItemsApiService) DeleteItem(ctx context.Context, locationId string, itemId string) (V1Item, *http.Response, error)
- func (a *V1ItemsApiService) DeleteModifierList(ctx context.Context, locationId string, modifierListId string) (V1ModifierList, *http.Response, error)
- func (a *V1ItemsApiService) DeleteModifierOption(ctx context.Context, locationId string, modifierListId string, ...) (V1ModifierOption, *http.Response, error)
- func (a *V1ItemsApiService) DeletePage(ctx context.Context, locationId string, pageId string) (V1Page, *http.Response, error)
- func (a *V1ItemsApiService) DeletePageCell(ctx context.Context, locationId string, pageId string, ...) (V1Page, *http.Response, error)
- func (a *V1ItemsApiService) DeleteVariation(ctx context.Context, locationId string, itemId string, variationId string) (V1Variation, *http.Response, error)
- func (a *V1ItemsApiService) ListCategories(ctx context.Context, locationId string) ([]V1Category, *http.Response, error)
- func (a *V1ItemsApiService) ListDiscounts(ctx context.Context, locationId string) ([]V1Discount, *http.Response, error)
- func (a *V1ItemsApiService) ListFees(ctx context.Context, locationId string) ([]V1Fee, *http.Response, error)
- func (a *V1ItemsApiService) ListInventory(ctx context.Context, locationId string, ...) ([]V1InventoryEntry, *http.Response, error)
- func (a *V1ItemsApiService) ListItems(ctx context.Context, locationId string, ...) ([]V1Item, *http.Response, error)
- func (a *V1ItemsApiService) ListModifierLists(ctx context.Context, locationId string) ([]V1ModifierList, *http.Response, error)
- func (a *V1ItemsApiService) ListPages(ctx context.Context, locationId string) ([]V1Page, *http.Response, error)
- func (a *V1ItemsApiService) RemoveFee(ctx context.Context, locationId string, itemId string, feeId string) (V1Item, *http.Response, error)
- func (a *V1ItemsApiService) RemoveModifierList(ctx context.Context, locationId string, modifierListId string, itemId string) (V1Item, *http.Response, error)
- func (a *V1ItemsApiService) RetrieveItem(ctx context.Context, locationId string, itemId string) (V1Item, *http.Response, error)
- func (a *V1ItemsApiService) RetrieveModifierList(ctx context.Context, locationId string, modifierListId string) (V1ModifierList, *http.Response, error)
- func (a *V1ItemsApiService) UpdateCategory(ctx context.Context, body V1Category, locationId string, categoryId string) (V1Category, *http.Response, error)
- func (a *V1ItemsApiService) UpdateDiscount(ctx context.Context, body V1Discount, locationId string, discountId string) (V1Discount, *http.Response, error)
- func (a *V1ItemsApiService) UpdateFee(ctx context.Context, body V1Fee, locationId string, feeId string) (V1Fee, *http.Response, error)
- func (a *V1ItemsApiService) UpdateItem(ctx context.Context, body V1Item, locationId string, itemId string) (V1Item, *http.Response, error)
- func (a *V1ItemsApiService) UpdateModifierList(ctx context.Context, body V1UpdateModifierListRequest, locationId string, ...) (V1ModifierList, *http.Response, error)
- func (a *V1ItemsApiService) UpdateModifierOption(ctx context.Context, body V1ModifierOption, locationId string, ...) (V1ModifierOption, *http.Response, error)
- func (a *V1ItemsApiService) UpdatePage(ctx context.Context, body V1Page, locationId string, pageId string) (V1Page, *http.Response, error)
- func (a *V1ItemsApiService) UpdatePageCell(ctx context.Context, body V1PageCell, locationId string, pageId string) (V1Page, *http.Response, error)
- func (a *V1ItemsApiService) UpdateVariation(ctx context.Context, body V1Variation, locationId string, itemId string, ...) (V1Variation, *http.Response, error)
type V1ListBankAccountsRequest
type V1ListBankAccountsResponse
type V1ListCashDrawerShiftsRequest
type V1ListCashDrawerShiftsResponse
type V1ListCategoriesRequest
type V1ListCategoriesResponse
type V1ListDiscountsRequest
type V1ListDiscountsResponse
type V1ListEmployeeRolesRequest
type V1ListEmployeeRolesResponse
type V1ListEmployeesRequest
type V1ListEmployeesRequestStatus
type V1ListEmployeesResponse
type V1ListFeesRequest
type V1ListFeesResponse
type V1ListInventoryRequest
type V1ListInventoryResponse
type V1ListItemsRequest
type V1ListItemsResponse
type V1ListModifierListsRequest
type V1ListModifierListsResponse
type V1ListOrdersRequest
type V1ListOrdersResponse
type V1ListPagesRequest
type V1ListPagesResponse
type V1ListPaymentsRequest
type V1ListPaymentsResponse
type V1ListRefundsRequest
type V1ListRefundsResponse
type V1ListSettlementsRequest
type V1ListSettlementsRequestStatus
type V1ListSettlementsResponse
type V1ListTimecardEventsRequest
type V1ListTimecardEventsResponse
type V1ListTimecardsRequest
type V1ListTimecardsResponse
type V1ModifierList
type V1ModifierListSelectionType
type V1ModifierOption
type V1Money
type V1Order
type V1OrderHistoryEntry
type V1OrderHistoryEntryAction
type V1OrderState
type V1Page
type V1PageCell
type V1PageCellObjectType
type V1PageCellPlaceholderType
type V1Payment
type V1PaymentDiscount
type V1PaymentItemDetail
type V1PaymentItemization
type V1PaymentItemizationItemizationType
type V1PaymentModifier
type V1PaymentSurcharge
type V1PaymentSurchargeType
type V1PaymentTax
type V1PaymentTaxInclusionType
type V1PhoneNumber
type V1Refund
type V1RefundType
type V1RemoveFeeRequest
type V1RemoveModifierListRequest
type V1RetrieveBankAccountRequest
type V1RetrieveCashDrawerShiftRequest
type V1RetrieveEmployeeRequest
type V1RetrieveEmployeeRoleRequest
type V1RetrieveItemRequest
type V1RetrieveModifierListRequest
type V1RetrieveOrderRequest
type V1RetrievePaymentRequest
type V1RetrieveSettlementRequest
type V1RetrieveTimecardRequest
type V1Settlement
type V1SettlementEntry
type V1SettlementEntryType
type V1SettlementStatus
type V1Tender
type V1TenderCardBrand
type V1TenderEntryMethod
type V1TenderType
type V1Timecard
type V1TimecardEvent
type V1TimecardEventEventType
type V1TransactionsApiListOrdersOpts
type V1TransactionsApiListPaymentsOpts
type V1TransactionsApiListRefundsOpts
type V1TransactionsApiListSettlementsOpts
type V1TransactionsApiService
- func (a *V1TransactionsApiService) CreateRefund(ctx context.Context, body V1CreateRefundRequest, locationId string) (V1Refund, *http.Response, error)
- func (a *V1TransactionsApiService) ListBankAccounts(ctx context.Context, locationId string) ([]V1BankAccount, *http.Response, error)
- func (a *V1TransactionsApiService) ListOrders(ctx context.Context, locationId string, ...) ([]V1Order, *http.Response, error)
- func (a *V1TransactionsApiService) ListPayments(ctx context.Context, locationId string, ...) ([]V1Payment, *http.Response, error)
- func (a *V1TransactionsApiService) ListRefunds(ctx context.Context, locationId string, ...) ([]V1Refund, *http.Response, error)
- func (a *V1TransactionsApiService) ListSettlements(ctx context.Context, locationId string, ...) ([]V1Settlement, *http.Response, error)
- func (a *V1TransactionsApiService) RetrieveBankAccount(ctx context.Context, locationId string, bankAccountId string) (V1BankAccount, *http.Response, error)
- func (a *V1TransactionsApiService) RetrieveOrder(ctx context.Context, locationId string, orderId string) (V1Order, *http.Response, error)
- func (a *V1TransactionsApiService) RetrievePayment(ctx context.Context, locationId string, paymentId string) (V1Payment, *http.Response, error)
- func (a *V1TransactionsApiService) RetrieveSettlement(ctx context.Context, locationId string, settlementId string) (V1Settlement, *http.Response, error)
- func (a *V1TransactionsApiService) UpdateOrder(ctx context.Context, body V1UpdateOrderRequest, locationId string, ...) (V1Order, *http.Response, error)
type V1UpdateCategoryRequest
type V1UpdateDiscountRequest
type V1UpdateEmployeeRequest
type V1UpdateEmployeeRoleRequest
type V1UpdateFeeRequest
type V1UpdateItemRequest
type V1UpdateModifierListRequest
type V1UpdateModifierListRequestSelectionType
type V1UpdateModifierOptionRequest
type V1UpdateOrderRequest
type V1UpdateOrderRequestAction
type V1UpdatePageCellRequest
type V1UpdatePageRequest
type V1UpdateTimecardRequest
type V1UpdateVariationRequest
type V1Variation
type V1VariationInventoryAlertType
type V1VariationPricingType
type VoidTransactionRequest
type VoidTransactionResponse
type WageSetting
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

	BookingsApi *BookingsApiService

	CashDrawersApi *CashDrawersApiService

	CatalogApi *CatalogApiService

	CheckoutApi *CheckoutApiService

	CustomerGroupsApi *CustomerGroupsApiService

	CustomerSegmentsApi *CustomerSegmentsApiService

	CustomersApi *CustomersApiService

	DevicesApi *DevicesApiService

	DisputesApi *DisputesApiService

	EmployeesApi *EmployeesApiService

	InventoryApi *InventoryApiService

	InvoicesApi *InvoicesApiService

	LaborApi *LaborApiService

	LocationsApi *LocationsApiService

	LoyaltyApi *LoyaltyApiService

	MerchantsApi *MerchantsApiService

	MobileAuthorizationApi *MobileAuthorizationApiService

	OAuthApi *OAuthApiService

	OrdersApi *OrdersApiService

	PaymentsApi *PaymentsApiService

	RefundsApi *RefundsApiService

	SubscriptionsApi *SubscriptionsApiService

	TeamApi *TeamApiService

	TerminalApi *TerminalApiService

	TransactionsApi *TransactionsApiService

	V1EmployeesApi *V1EmployeesApiService

	V1ItemsApi *V1ItemsApiService

	V1TransactionsApi *V1TransactionsApiService
	// 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 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` where the purchase was made.
	LocationId string `json:"location_id"`
}

A request to accumulate points for a purchase.

type AccumulateLoyaltyPointsResponse ¶

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

A response containing the resulting loyalty event.

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 AddGroupToCustomerRequest ¶

type AddGroupToCustomerRequest struct {
}

Defines the fields that are included in the request body of a request to the [AddGroupToCustomer](#endpoint-addgrouptocustomer) 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](#endpoint-addgrouptocustomer) 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"`
	AmountMoney *Money `json:"amount_money"`
	// The unique ID for this `AdditionalRecipientReceivable`, assigned by the server.
	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.
	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.
	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.
	PostalCode string `json:"postal_code,omitempty"`
	// The address's country, in ISO 3166-1-alpha-2 format. See [Country](#type-country) for possible values
	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"`
	// Optional organization name when it's representing recipient.
	Organization string `json:"organization,omitempty"`
}

Represents a physical address.

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"`
}

A request to adjust (add or subtract) points manually.

type AdjustLoyaltyPointsResponse ¶

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

A response that includes the loyalty event that resulted from the successful API call.

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 Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain. This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform. To learn more about Apple Pay on Web see the Apple Pay section in the [Square Payment Form Walkthrough](/docs/payment-form/payment-form-walkthrough).

@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 AppointmentSegment ¶

type AppointmentSegment struct {
	// The time span in minutes of an appointment segment.
	DurationMinutes int32 `json:"duration_minutes"`
	// The ID of the `CatalogItemVariation` object representing the service booked in this segment.
	ServiceVariationId string `json:"service_variation_id"`
	// The ID of the `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"`
}

Defines an appointment segment of a booking.

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"`
}

Describes a slot available for booking, encapsulating appointment segments, the location and starting time.

type BalancePaymentDetails ¶

type BalancePaymentDetails struct {
	// The ID of the account used to fund the payment.
	AccountId string `json:"account_id,omitempty"`
	// The balance payment’s current state. The state can be COMPLETED or FAILED.
	Status string `json:"status,omitempty"`
}

Reflects the current status of a balance payment.

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. See [Country](#type-country) for possible values
	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`. See [Currency](#type-currency) for possible values
	Currency string `json:"currency"`
	// The financial purpose of the associated bank account. See [BankAccountType](#type-bankaccounttype) for possible values
	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/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/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. See [BankAccountStatus](#type-bankaccountstatus) for possible values
	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](/docs/bank-accounts-api).

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(#type-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(#type-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/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/basics/api101/idempotency) in the [API Development 101](https://developer.squareup.com/docs/basics/api101/overview) section for more information.
	IdempotencyKey string `json:"idempotency_key,omitempty"`
	// 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"`
}

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, as follows:  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.
	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`s' `version` attribute.
	CatalogVersion int64 `json:"catalog_version,omitempty"`
}

type BatchRetrieveCatalogObjectsResponse ¶

type BatchRetrieveCatalogObjectsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// A list of `CatalogObject`s returned.
	Objects []CatalogObject `json:"objects,omitempty"`
	// A list of `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]`. See [InventoryChangeType](#type-inventorychangetype) for possible values
	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. See [InventoryState](#type-inventorystate) for possible values
	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"`
}

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. See [InventoryState](#type-inventorystate) for possible values
	States []string `json:"states,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/basics/api101/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. See [BookingStatus](#type-bookingstatus) for possible values
	Status string `json:"status,omitempty"`
	// The timestamp specifying the creation time of this booking.
	CreatedAt string `json:"created_at,omitempty"`
	// The timestamp specifying the most recent update time of this booking.
	UpdatedAt string `json:"updated_at,omitempty"`
	// The timestamp specifying the starting time of this booking.
	StartAt string `json:"start_at,omitempty"`
	// The ID of the `Location` object representing the location where the booked service is provided.
	LocationId string `json:"location_id,omitempty"`
	// The ID of the `Customer` object representing the customer attending this booking
	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` 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` 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"`
}

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 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 BookingsApiListTeamMemberBookingProfilesOpts ¶

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

type BookingsApiService ¶

type BookingsApiService service

func (*BookingsApiService) CancelBooking ¶

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

BookingsApiService CancelBooking Cancels an existing booking.

@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` 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.

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

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

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

@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` object representing the to-be-updated booking.

@return UpdateBookingResponse

type BreakType ¶

type BreakType struct {
	// 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. Will be 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 below minutes is truncated.
	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; request will fail if version provided does not match server version at time of 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 BulkCreateTeamMembersRequest ¶

type BulkCreateTeamMembersRequest struct {
	// The data which will be used to create the `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`.
	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 BulkUpdateTeamMembersRequest ¶

type BulkUpdateTeamMembersRequest struct {
	// The data which will be used to update the `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`.
	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 BusinessAppointmentSettings ¶

type BusinessAppointmentSettings struct {
	// Types of the location allowed for bookings. See [BusinessAppointmentSettingsBookingLocationType](#type-businessappointmentsettingsbookinglocationtype) for possible values
	LocationTypes []string `json:"location_types,omitempty"`
	// The time unit of the service duration for bookings. See [BusinessAppointmentSettingsAlignmentTime](#type-businessappointmentsettingsalignmenttime) for possible values
	AlignmentTime string `json:"alignment_time,omitempty"`
	// The minimum lead time in seconds before a service can be booked. Bookings must be created at least this far ahead of the booking's starting time.
	MinBookingLeadTimeSeconds int32 `json:"min_booking_lead_time_seconds,omitempty"`
	// The maximum lead time in seconds before a service can be booked. Bookings must be created at most this far ahead of the booking's 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. See [BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType](#type-businessappointmentsettingsmaxappointmentsperdaylimittype) for possible values
	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. See [BusinessAppointmentSettingsCancellationPolicy](#type-businessappointmentsettingscancellationpolicy) for possible values
	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 : 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. See [BusinessBookingProfileCustomerTimezoneChoice](#type-businessbookingprofilecustomertimezonechoice) for possible values
	CustomerTimezoneChoice string `json:"customer_timezone_choice,omitempty"`
	// The policy for the seller to automatically accept booking requests (`ACCEPT_ALL`) or not (`REQUIRES_ACCEPTANCE`). See [BusinessBookingProfileBookingPolicy](#type-businessbookingprofilebookingpolicy) for possible values
	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"`
}

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 may be at most 10 periods per day.
	Periods []BusinessHoursPeriod `json:"periods,omitempty"`
}

Represents the hours of operation for a business location.

type BusinessHoursPeriod ¶

type BusinessHoursPeriod struct {
	// The day of week for this time period. See [DayOfWeek](#type-dayofweek) for possible values
	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.
	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.
	EndLocalTime string `json:"end_local_time,omitempty"`
}

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

type CalculateLoyaltyPointsRequest ¶

type CalculateLoyaltyPointsRequest struct {
	// The `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`.
	OrderId                string `json:"order_id,omitempty"`
	TransactionAmountMoney *Money `json:"transaction_amount_money,omitempty"`
}

A request to calculate the points that a buyer can earn from a specified purchase.

type CalculateLoyaltyPointsResponse ¶

type CalculateLoyaltyPointsResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The points that the buyer can earn from a specified purchase.
	Points int32 `json:"points,omitempty"`
}

A response that includes the points that the buyer can earn from a specified purchase.

type CalculateOrderRequest ¶

type CalculateOrderRequest struct {
	Order *Order `json:"order"`
	// Identifies one or more loyalty reward tiers to apply during order calculation. The discounts defined by the reward tiers are added to the order only to preview the effect of applying the specified reward(s). The reward(s) 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"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type CancelInvoiceRequest ¶

type CancelInvoiceRequest struct {
	// The version of the `invoice` to cancel. If you do not know the version, you can call  `GetInvoice](#endpoint-Invoices-GetInvoice) or [ListInvoices`.
	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 CancelPaymentByIdempotencyKeyRequest ¶

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

Specifies the idempotency key of a payment to cancel.

type CancelPaymentByIdempotencyKeyResponse ¶

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

The return value from the [CancelPaymentByIdempotencyKey](#endpoint-payments-cancelpaymentbyidempotencykey) endpoint. On success, `errors` is empty.

type CancelPaymentRequest ¶

type CancelPaymentRequest struct {
}

Cancels (voids) a payment before it has been completed. Note: Only payments created with `autocomplete` set to `false` can be canceled.

type CancelPaymentResponse ¶

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

The return value from the [CancelPayment](#endpoint-payments-cancelpayment) endpoint.

type CancelSubscriptionRequest ¶

type CancelSubscriptionRequest struct {
}

Defines parameters in a [CancelSubscription](#endpoint-subscriptions-cancelsubscription) endpoint request.

type CancelSubscriptionResponse ¶

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

Defines fields that are included in a [CancelSubscription](#endpoint-subscriptions-cancelsubscription) response.

type CancelTerminalCheckoutRequest ¶

type CancelTerminalCheckoutRequest struct {
}

type CancelTerminalCheckoutResponse ¶

type CancelTerminalCheckoutResponse struct {
	// Information on 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 on 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](#endpoint-capturetransaction) endpoint.

type Card ¶

type Card struct {
	// Unique ID for this card. Generated by Square.
	Id string `json:"id,omitempty"`
	// The card's brand. See [CardBrand](#type-cardbrand) for possible values
	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"`
	// __Not currently set.__ 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"`
	// The type of the card. The Card object includes this field only in response to Payments API calls. See [CardType](#type-cardtype) for possible values
	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. See [CardPrepaidType](#type-cardprepaidtype) for possible values
	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"`
}

Represents the payment details of a card to be used for payments. These details are determined by the `card_nonce` generated by `SqPaymentForm`.

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

List of CardBrand

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"`
	// 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.

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 CardSquareProduct ¶

type CardSquareProduct string

const (
	UNKNOWN_SQUARE_PRODUCT_CardSquareProduct CardSquareProduct = "UNKNOWN_SQUARE_PRODUCT"
	CONNECT_API_CardSquareProduct            CardSquareProduct = "CONNECT_API"
	DASHBOARD_CardSquareProduct              CardSquareProduct = "DASHBOARD"
	REGISTER_CLIENT_CardSquareProduct        CardSquareProduct = "REGISTER_CLIENT"
	BUYER_DASHBOARD_CardSquareProduct        CardSquareProduct = "BUYER_DASHBOARD"
	WEB_CardSquareProduct                    CardSquareProduct = "WEB"
	INVOICES_CardSquareProduct               CardSquareProduct = "INVOICES"
	GIFT_CARD_CardSquareProduct              CardSquareProduct = "GIFT_CARD"
	VIRTUAL_TERMINAL_CardSquareProduct       CardSquareProduct = "VIRTUAL_TERMINAL"
	READER_SDK_CardSquareProduct             CardSquareProduct = "READER_SDK"
)

List of CardSquareProduct

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 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. See [CashDrawerShiftState](#type-cashdrawershiftstate) for possible values
	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 IDs of all employees that were logged into Square Point of Sale at any point while the cash drawer shift was open.
	EmployeeIds []string `json:"employee_ids,omitempty"`
	// The ID of the employee that started the cash drawer shift.
	OpeningEmployeeId string `json:"opening_employee_id,omitempty"`
	// The ID of the employee that ended the cash drawer shift.
	EndingEmployeeId string `json:"ending_employee_id,omitempty"`
	// The ID of the employee that closed the cash drawer shift by auditing the cash drawer contents.
	ClosingEmployeeId string `json:"closing_employee_id,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"`
}

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 ID of the employee that created the event.
	EmployeeId string `json:"employee_id,omitempty"`
	// The type of cash drawer shift event. See [CashDrawerEventType](#type-cashdrawereventtype) for possible values
	EventType  string `json:"event_type,omitempty"`
	EventMoney *Money `json:"event_money,omitempty"`
	// The event time in ISO 8601 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"`
}

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. See [CashDrawerShiftState](#type-cashdrawershiftstate) for possible values
	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 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](#endpoint-CashDrawers-ListCashDrawerShiftEvents) 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 CatalogApiListCatalogOpts ¶

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

type CatalogApiRetrieveCatalogObjectOpts ¶

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

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(#type-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(#type-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.

@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(#type-catalogitem) returned in the set includes all of its child information including: all of its CatalogItemVariation(#type-catalogitemvariation) objects, references to its CatalogModifierList(#type-catalogmodifierlist) objects, and the ids of any CatalogTax(#type-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.

@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(#type-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(#type-catalogitem) will also delete all of its CatalogItemVariation(#type-catalogitemvariation) children.

@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 expressions. This (`SearchCatalogItems`) endpoint differs from the [SearchCatalogObjects](#endpoint-Catalog-SearchCatalogObjects) 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(#type-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 expressions. This (`SearchCatalogObjects`) endpoint differs from the [SearchCatalogItems](#endpoint-Catalog-SearchCatalogItems) 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(#type-catalogmodifierlist) objects that apply to the targeted CatalogItem(#type-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(#type-catalogtax) objects that apply to the targeted CatalogItem(#type-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 or updates the target CatalogObject(#type-catalogobject).

@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 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"`
}

A category to which a `CatalogItem` instance belongs.

type CatalogCustomAttributeDefinition ¶

type CatalogCustomAttributeDefinition struct {
	// The type of this custom attribute. Cannot be modified after creation. Required. See [CatalogCustomAttributeDefinitionType](#type-catalogcustomattributedefinitiontype) for possible values
	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 Catalog Object Types that this Custom Attribute may be applied to. Currently, only `ITEM` and `ITEM_VARIATION` are allowed. At least one type must be included. See [CatalogObjectType](#type-catalogobjecttype) for possible values
	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. See [CatalogCustomAttributeDefinitionSellerVisibility](#type-catalogcustomattributedefinitionsellervisibility) for possible values
	SellerVisibility string `json:"seller_visibility,omitempty"`
	// The visibility of a custom attribute to applications other than the application that created the attribute. See [CatalogCustomAttributeDefinitionAppVisibility](#type-catalogcustomattributedefinitionappvisibility) for possible values
	AppVisibility   string                                           `json:"app_visibility,omitempty"`
	StringConfig    *CatalogCustomAttributeDefinitionStringConfig    `json:"string_config,omitempty"`
	NumberConfig    *CatalogCustomAttributeDefinitionNumberConfig    `json:"number_config,omitempty"`
	SelectionConfig *CatalogCustomAttributeDefinitionSelectionConfig `json:"selection_config,omitempty"`
	// __Read-only.__ 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](/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"`
	// __Read-only.__ The id of the `CatalogCustomAttributeDefinition` this value belongs to.
	CustomAttributeDefinitionId string `json:"custom_attribute_definition_id,omitempty"`
	// __Read-only.__ A copy of type from the associated `CatalogCustomAttributeDefinition`. See [CatalogCustomAttributeDefinitionType](#type-catalogcustomattributedefinitiontype) for possible values
	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"`
	// __Read-only.__ A copy of key from the associated `CatalogCustomAttributeDefinition`.
	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](/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. See [CatalogDiscountType](#type-catalogdiscounttype) for possible values
	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. See [CatalogDiscountModifyTaxBasis](#type-catalogdiscountmodifytaxbasis) for possible values
	ModifyTaxBasis string `json:"modify_tax_basis,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 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](#endpoint-Catalog-UpsertCatalogObject) or [BatchUpsertCatalogObjects](#endpoint-Catalog-BatchUpsertCatalogObjects) to create a CatalogObject(#type-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.
	Name string `json:"name,omitempty"`
	// The URL of this image, generated by Square after an image is uploaded using the `CreateCatalogImage` endpoint.
	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.
	Caption string `json:"caption,omitempty"`
}

An image file to use in Square catalogs. It can be associated with catalog items, item variations, and categories.

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.
	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"`
	// 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.
	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 CatalogObjects containing the `CatalogItemVariation`s for this item.
	Variations []CatalogObject `json:"variations,omitempty"`
	// The product type of the item. May not be changed once an item has been created.  Only items of product type `REGULAR` or `APPOINTMENTS_SERVICE` may be created by this API; items with other product types are read-only. See [CatalogItemProductType](#type-catalogitemproducttype) for possible values
	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"`
}

A CatalogObject(#type-CatalogObject) instance of the `ITEM` type, also referred to as an item, in the catalog.

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`.
	MinSelectedModifiers int32 `json:"min_selected_modifiers,omitempty"`
	// If 0 or larger, the largest number of `CatalogModifier`s that can be selected from this `CatalogModifierList`.
	MaxSelectedModifiers int32 `json:"max_selected_modifiers,omitempty"`
	// If `true`, enable this `CatalogModifierList`. The default value is `true`.
	Enabled bool `json:"enabled,omitempty"`
}

Options to control the properties of a `CatalogModifierList` applied to a `CatalogItem` instance.

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

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, and its value length is of 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. See [CatalogPricingType](#type-catalogpricingtype) for possible values
	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`. See [InventoryAlertType](#type-inventoryalerttype) for possible values
	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"`
	// 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"`
}

An item variation (i.e., product) in the Catalog object model. Each item may have a maximum of 250 item variations.

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"`
}

A modifier applicable to items at the time of sale.

type CatalogModifierList ¶

type CatalogModifierList struct {
	// The name for 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"`
	// Determines where this modifier list appears in a list of `CatalogModifierList` values.
	Ordinal int32 `json:"ordinal,omitempty"`
	// Indicates whether multiple options from the modifier list can be applied to a single `CatalogItem`. See [CatalogModifierListSelectionType](#type-catalogmodifierlistselectiontype) for possible values
	SelectionType string `json:"selection_type,omitempty"`
	// The options included in the `CatalogModifierList`. You must include at least one `CatalogModifier`. Each CatalogObject must have type `MODIFIER` and contain `CatalogModifier` data.
	Modifiers []CatalogObject `json:"modifiers,omitempty"`
}

A list of modifiers applicable to items at the time of sale. For example, a \"Condiments\" modifier list applicable to a \"Hot Dog\" item may contain \"Ketchup\", \"Mustard\", and \"Relish\" modifiers. Use the `selection_type` field to specify whether or not multiple selections from the modifier list are allowed.

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. See [CatalogObjectType](#type-catalogobjecttype) for possible values
	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` object. The key is the `key` attribute value defined in the associated `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 that 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`.
	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`.
	AbsentAtLocationIds []string `json:"absent_at_location_ids,omitempty"`
	// Identifies the `CatalogImage` attached to this `CatalogObject`.
	ImageId                       string                            `json:"image_id,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"`
}

The wrapper object for the Catalog entries of a given object type. The type of a particular `CatalogObject` is determined by the value of the `type` attribute and only the corresponding data attribute can be set on the `CatalogObject` instance. For example, the following list shows some instances of `CatalogObject` of a given `type` and their corresponding data attribute that can be set: - For a `CatalogObject` of the `ITEM` type, set the `item_data` attribute to yield the `CatalogItem` object. - For a `CatalogObject` of the `ITEM_VARIATION` type, set the `item_variation_data` attribute to yield the `CatalogItemVariation` object. - For a `CatalogObject` of the `MODIFIER` type, set the `modifier_data` attribute to yield the `CatalogModifier` object. - For a `CatalogObject` of the `MODIFIER_LIST` type, set the `modifier_list_data` attribute to yield the `CatalogModifierList` object. - For a `CatalogObject` of the `CATEGORY` type, set the `category_data` attribute to yield the `CatalogCategory` object. - For a `CatalogObject` of the `DISCOUNT` type, set the `discount_data` attribute to yield the `CatalogDiscount` object. - For a `CatalogObject` of the `TAX` type, set the `tax_data` attribute to yield the `CatalogTax` object. - For a `CatalogObject` of the `IMAGE` type, set the `image_data` attribute to yield the `CatalogImageData` object. - For a `CatalogObject` of the `QUICK_AMOUNTS_SETTINGS` type, set the `quick_amounts_settings_data` attribute to yield the `CatalogQuickAmountsSettings` object. - For a `CatalogObject` of the `PRICING_RULE` type, set the `pricing_rule_data` attribute to yield the `CatalogPricingRule` object. - For a `CatalogObject` of the `TIME_PERIOD` type, set the `time_period_data` attribute to yield the `CatalogTimePeriod` object. - For a `CatalogObject` of the `PRODUCT_SET` type, set the `product_set_data` attribute to yield the `CatalogProductSet` object. - For a `CatalogObject` of the `SUBSCRIPTION_PLAN` type, set the `subscription_plan_data` attribute to yield the `CatalogSubscriptionPlan` object. For a more detailed discussion of the Catalog data model, please see the [Design a Catalog](/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 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 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_CatalogObjectType           CatalogObjectType = "SUBSCRIPTION_PLAN"
	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"
)

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` See [ExcludeStrategy](#type-excludestrategy) for possible values
	ExcludeStrategy string `json:"exclude_strategy,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](#endpoint-Catalog-SearchCatalogObjects). Any combination of the following types may be used together: - [exact_query](#type-CatalogExactQuery) - [prefix_query](#type-CatalogPrefixQuery) - [range_query](#type-CatalogRangeQuery) - [sorted_attribute_query](#type-CatalogSortedAttribute) - [text_query](#type-CatalogTextQuery) 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(#type-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). See [SortOrder](#type-sortorder) for possible values
	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 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. See [CatalogQuickAmountType](#type-catalogquickamounttype) for possible values
	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. See [CatalogQuickAmountsSettingsOption](#type-catalogquickamountssettingsoption) for possible values
	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 CatalogSubscriptionPlan ¶

type CatalogSubscriptionPlan struct {
	// The name of the plan.
	Name string `json:"name,omitempty"`
	// A list of SubscriptionPhase containing the `SubscriptionPhase` for this plan.
	Phases []SubscriptionPhase `json:"phases,omitempty"`
}

Describes a subscription plan. For more information, see [Set Up and Manage a Subscription Plan](/docs/subscriptions-api/setup-plan).

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. See [TaxCalculationPhase](#type-taxcalculationphase) for possible values
	CalculationPhase string `json:"calculation_phase,omitempty"`
	// Whether the tax is `ADDITIVE` or `INCLUSIVE`. See [TaxInclusionType](#type-taxinclusiontype) for possible values
	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%.
	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"`
}

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 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](#idempotencykeys) for more information.
	IdempotencyKey string `json:"idempotency_key"`
	AmountMoney    *Money `json:"amount_money"`
	// A nonce generated from the `SqPaymentForm` that represents the card to charge.  The application that provides a nonce to this endpoint must be the _same application_ that generated the nonce with the `SqPaymentForm`. 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` or a Void (with the `VoidTransaction`.  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](#endpoint-charge) endpoint. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment)

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](#endpoint-charge) endpoint. One of `errors` or `transaction` is present in a given response (never both).

type CheckAppointmentsOnboardedRequest ¶

type CheckAppointmentsOnboardedRequest struct {
}

type CheckAppointmentsOnboardedResponse ¶

type CheckAppointmentsOnboardedResponse struct {
	// Indicates whether the seller has enabled the Square Appointments service (`true`) or not (`false`).
	AppointmentsOnboarded bool `json:"appointments_onboarded,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

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 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 will be directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.

@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

type CompletePaymentRequest ¶

type CompletePaymentRequest struct {
}

Completes (captures) a 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"`
}

The return value from a [CompletePayment](#endpoint-payments-completepayment) call.

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 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 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"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type CreateBreakTypeRequest ¶

type CreateBreakTypeRequest struct {
	// Unique string value to insure 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`. Contains the created `BreakType` object. May contain a set of `Error` objects if the request resulted in errors.

type CreateCheckoutRequest ¶

type CreateCheckoutRequest struct {
	// A unique string that identifies this checkout among others you've 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're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates.  We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys.  See the [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency) guide for more information.
	IdempotencyKey string              `json:"idempotency_key"`
	Order          *CreateOrderRequest `json:"order"`
	// 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.  Default: none; only exists if explicitly set.
	RedirectUrl string `json:"redirect_url,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 `total_money` calculated by Square for your order. The `location_id` must be the valid location of the app owner merchant.  This field requires `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission.  This field is currently not supported in 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. See [Embedding the payment form](https://developer.squareup.com/docs/payment-form/payment-form-walkthrough) for more information.  __NOTE:__ Card nonces generated by digital wallets (e.g., 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 `SqPaymentForm.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. One of `errors` or `card` is present in a given response (never both).

type CreateCustomerGroupRequest ¶

type CreateCustomerGroupRequest struct {
	// The idempotency key for the request. See the [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) guide for more information.
	IdempotencyKey string         `json:"idempotency_key,omitempty"`
	Group          *CustomerGroup `json:"group"`
}

Defines the body parameters that can be provided in a request to the [CreateCustomerGroup](#endpoint-createcustomegroup) 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](#endpoint-createcustomergroup) endpoint. One of `errors` or `group` is present in a given response (never both).

type CreateCustomerRequest ¶

type CreateCustomerRequest struct {
	// The idempotency key for the request. See the [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency) guide for more information.
	IdempotencyKey string `json:"idempotency_key,omitempty"`
	// The given (i.e., first) name associated with the customer profile.
	GivenName string `json:"given_name,omitempty"`
	// The family (i.e., 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 11-digit phone number associated with the customer profile.
	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 RFC 3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__.
	Birthday string `json:"birthday,omitempty"`
}

Defines the body parameters that can be provided 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 endpoint. One of `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/basics/api101/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 {
	// The Unique ID. For more information, see [Idempotency](https://developer.squareup.com/docs/docs/working-with-apis/idempotency).
	IdempotencyKey string `json:"idempotency_key"`
	// The type of evidence you are uploading. See [DisputeEvidenceType](#type-disputeevidencetype) for possible values
	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 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/docs/working-with-apis/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 CreateLocationRequest ¶

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

Request object for the [CreateLocation](#endpoint-createlocation) endpoint.

type CreateLocationResponse ¶

type CreateLocationResponse struct {
	// Information on errors encountered during the request.
	Errors   []ModelError `json:"errors,omitempty"`
	Location *Location    `json:"location,omitempty"`
}

Response object returned by the [CreateLocation](#endpoint-createlocation) 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 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 CreateMobileAuthorizationCodeRequest ¶

type CreateMobileAuthorizationCodeRequest struct {
	// The Square location ID 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 {
	// 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, e.g., \"2016-09-04T23:59:33.123Z\".
	ExpiresAt string      `json:"expires_at,omitempty"`
	Error_    *ModelError `json:"error,omitempty"`
}

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

type CreateOrderRequest ¶

type CreateOrderRequest struct {
	Order *Order `json:"order,omitempty"`
	// The ID of the business location to associate the order with.
	LocationId string `json:"location_id,omitempty"`
	// A value you specify that uniquely identifies this order among orders you've created.  If you're unsure whether a particular order was created successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate orders.  See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.
	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. One of `errors` or `order` is present in a given response (never both).

type CreatePaymentRequest ¶

type CreatePaymentRequest struct {
	// The ID for the source of funds for this payment. This can be a nonce generated by the Square payment form or a card on file made with the Customers API.
	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.  Max: 45 characters  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"`
	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 cancels the payment. This automatic cancellation applies only to payments that do not reach a terminal state (COMPLETED, CANCELED, or FAILED) 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`, 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#delayed-payments).  Default: true
	Autocomplete bool `json:"autocomplete,omitempty"`
	// Associates a previously created order with this payment.
	OrderId string `json:"order_id,omitempty"`
	// The `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 Customers API.
	CustomerId string `json:"customer_id,omitempty"`
	// The location ID to associate with the payment. If not specified, the default location is used.
	LocationId string `json:"location_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).  Limit 40 characters.
	ReferenceId string `json:"reference_id,omitempty"`
	// An identifying token generated by `SqPaymentForm.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.  Limit 500 characters.
	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"`
}

Creates a payment from a provided source (such as a nonce or a card on file). The `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required to enable application fees. For more information, see [Payments and Refunds APIs Overview](/payments-api/overview). For information about application fees in a payment, see [Take Payments and Collect Fees](/payments-api/take-payments-and-collect-fees).

type CreatePaymentResponse ¶

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

Defines the fields that are included in the response body of a request to the [CreatePayment](#endpoint-payments-createpayment) endpoint. Note: 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](#idempotencykeys) for more information.
	IdempotencyKey string `json:"idempotency_key"`
	// The ID of the tender to refund.  A “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](#endpoint-createrefund) endpoint. Deprecated - recommend using [RefundPayment](#endpoint-refunds-refundpayment)

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](#endpoint-createrefund) endpoint. One of `errors` or `refund` is present in a given response (never both).

type CreateShiftRequest ¶

type CreateShiftRequest struct {
	// Unique string value to insure 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 the request to create a `Shift`. Contains the created `Shift` object. May 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/docs/working-with-apis/idempotency).
	IdempotencyKey string `json:"idempotency_key"`
	// The ID of the location the subscription is associated with.
	LocationId string `json:"location_id"`
	// The ID of the subscription plan. For more information, see  [Subscription Plan Overview](https://developer.squareup.com/docs/docs/subscriptions/overview).
	PlanId string `json:"plan_id"`
	// The ID of the `customer` profile.
	CustomerId string `json:"customer_id"`
	// The start date of the subscription, in YYYY-MM-DD format. For example, 2013-01-15. If the start date is left empty, the subscription begins  immediately.
	StartDate string `json:"start_date,omitempty"`
	// The date when the subscription should be canceled, in  YYYY-MM-DD format (for example, 2025-02-29). This overrides the plan configuration  if it comes before the date the subscription would otherwise end.
	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 `customer](#type-customer) [card` to charge. If not specified, Square sends an invoice via email. For an example to create a customer and add a card on file, see [Subscriptions Walkthrough](https://developer.squareup.com/docs/docs/subscriptions-api/walkthrough).
	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"`
}

Defines parameters in a [CreateSubscription](#endpoint-subscriptions-createsubscription) endpoint request.

type CreateSubscriptionResponse ¶

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

Defines the fields that are included in the response from the [CreateSubscription](#endpoint-subscriptions-createsubscription) 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. See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. <br> <b>Min Length 1    Max Length 45</b>
	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 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/basics/api101/idempotency) for more information.
	IdempotencyKey string            `json:"idempotency_key"`
	Checkout       *TerminalCheckout `json:"checkout"`
}

type CreateTerminalCheckoutResponse ¶

type CreateTerminalCheckoutResponse struct {
	// Information on 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/basics/api101/idempotency) for more information.
	IdempotencyKey string          `json:"idempotency_key"`
	Refund         *TerminalRefund `json:"refund,omitempty"`
}

type CreateTerminalRefundResponse ¶

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

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

List of Currency

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.
	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.
	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.
	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.
	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.
	BoolFilter bool `json:"bool_filter,omitempty"`
}

Supported custom attribute query expressions for calling the [SearchCatalogItems](#endpoint-Catalog-SearchCatalogItems) endpoint to search for items or item variations.

type Customer ¶

type Customer struct {
	// A unique Square-assigned ID for the customer profile.
	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 cards stored on file for the customer profile.
	Cards []Card `json:"cards,omitempty"`
	// The given (i.e., first) name associated with the customer profile.
	GivenName string `json:"given_name,omitempty"`
	// The family (i.e., 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 11-digit phone number associated with the customer profile.
	PhoneNumber string `json:"phone_number,omitempty"`
	// The birthday associated with the customer profile, in RFC 3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__.
	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 customer groups and segments the customer belongs to. This deprecated field has been replaced with  the dedicated `group_ids` for customer groups and the dedicated `segment_ids` field for customer segments. You can retrieve information about a given customer group and segment respectively using the Customer Groups API and Customer Segments API.
	Groups []CustomerGroupInfo `json:"groups,omitempty"`
	// A creation source represents the method used to create the customer profile. See [CustomerCreationSource](#type-customercreationsource) for possible values
	CreationSource string `json:"creation_source,omitempty"`
	// The IDs of customer groups the customer belongs to.
	GroupIds []string `json:"group_ids,omitempty"`
	// The IDs of segments the customer belongs to.
	SegmentIds []string `json:"segment_ids,omitempty"`
}

Represents a Square customer profile, which can have one or more cards on file associated with it.

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. See [CustomerCreationSource](#type-customercreationsource) for possible values
	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`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values
	Rule string `json:"rule,omitempty"`
}

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 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"`
}

Represents a set of `CustomerQuery` filters used to limit the set of `Customers` returned by `SearchCustomers`.

type CustomerGroup ¶

type CustomerGroup struct {
	// Unique Square-generated ID for the customer group.
	Id string `json:"id,omitempty"`
	// 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, modified, and have their membership defined either via the Customers API or within Customer Directory in the Square Dashboard or Point of Sale.

type CustomerGroupInfo ¶

type CustomerGroupInfo struct {
	// The ID of the Customer Group.
	Id string `json:"id"`
	// The name of the Customer Group.
	Name string `json:"name"`
}

Contains some brief information about a Customer Group with its identifier included.

type CustomerGroupsApiListCustomerGroupsOpts ¶

type CustomerGroupsApiListCustomerGroupsOpts struct {
	Cursor optional.String
}

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 {
	// The customer has unsubscribed from receiving marketing campaign emails.
	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 a query (including filtering criteria, sorting criteria, or both) used to search for customer profiles.

type CustomerSegment ¶

type CustomerSegment struct {
	// Unique Square-generated ID for the segment.
	Id string `json:"id,omitempty"`
	// 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 Customer Directory in the Square Dashboard or Point of Sale.

type CustomerSegmentsApiListCustomerSegmentsOpts ¶

type CustomerSegmentsApiListCustomerSegmentsOpts struct {
	Cursor optional.String
}

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 {
	//  Use one or more customer attributes as the sort key to sort searched customer profiles.  For example, use creation date (`created_at`) of customers or default attributes as the sort key.   Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values
	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.  Default: `ASC`. See [SortOrder](#type-sortorder) for possible values
	Order string `json:"order,omitempty"`
}

Specifies how searched customers profiles are sorted, including the sort key and sort order.

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 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 customer attributes, the filter can be case sensitive. This filter can be either exact or fuzzy. It cannot be both.

type CustomersApiListCustomersOpts ¶

type CustomersApiListCustomersOpts struct {
	Cursor    optional.String
	SortField optional.String
	SortOrder optional.String
}

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) CreateCustomer ¶

func (a *CustomersApiService) CreateCustomer(ctx context.Context, body CreateCustomerRequest) (CreateCustomerResponse, *http.Response, error)

CustomersApiService CreateCustomer Creates a new customer for a business, which can have associated cards on file. 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) (DeleteCustomerResponse, *http.Response, error)

CustomersApiService DeleteCustomer Deletes a customer from a business, along with any linked cards on file. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to delete merged profiles.

@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 delete.

@return DeleteCustomerResponse

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 a supported query filter. 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 the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-Customers-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-Customers-createcustomercard) 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 customerId The ID of the customer to update.

@return UpdateCustomerResponse

type DateRange ¶

type DateRange struct {
	// String in `YYYY-MM-DD` format, e.g. `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"`
	// String in `YYYY-MM-DD` format, e.g. `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 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`. May 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 DeleteCustomerGroupRequest ¶

type DeleteCustomerGroupRequest struct {
}

Defines the fields that can be provided in a request to the [DeleteCustomerGroup](#endpoint-deletecustomergroup) 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](#endpoint-deletecustomergroup) endpoint.

type DeleteCustomerRequest ¶

type DeleteCustomerRequest struct {
}

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 DeleteInvoiceRequest ¶

type DeleteInvoiceRequest struct {
	// The version of the `invoice` to delete. If you do not know the version, you can call `GetInvoice` or  `ListInvoices`.
	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 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 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`. May contain a set of `Error` objects if the request resulted in errors.

type Device ¶

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

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"`
	// Instruct the device to skip the receipt screen. Defaults to false.
	SkipReceiptScreen bool         `json:"skip_receipt_screen,omitempty"`
	TipSettings       *TipSettings `json:"tip_settings,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. See [ProductType](#type-producttype) for possible values
	ProductType string `json:"product_type"`
	// The location assigned to this code.
	LocationId string `json:"location_id,omitempty"`
	// The pairing status of the device code. See [DeviceCodeStatus](#type-devicecodestatus) for possible values
	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 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 DevicesApiListDeviceCodesOpts ¶

type DevicesApiListDeviceCodesOpts struct {
	Cursor      optional.String
	LocationId  optional.String
	ProductType optional.String
	Status      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) 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)

type Dispute ¶

type Dispute struct {
	// The unique ID for this `Dispute`, generated by Square.
	DisputeId   string `json:"dispute_id,omitempty"`
	AmountMoney *Money `json:"amount_money,omitempty"`
	// The dispute reason why the cardholder initiated the dispute with their bank. See [DisputeReason](#type-disputereason) for possible values
	Reason string `json:"reason,omitempty"`
	// The current state of this dispute. See [DisputeState](#type-disputestate) for possible values
	State string `json:"state,omitempty"`
	// The time when the next action is due, in RFC 3339 format.
	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. See [CardBrand](#type-cardbrand) for possible values
	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 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 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 ID of the dispute the evidence is associated with.
	DisputeId string `json:"dispute_id,omitempty"`
	// The time when the next action is due, in RFC 3339 format.
	UploadedAt string `json:"uploaded_at,omitempty"`
	// The type of the evidence. See [DisputeEvidenceType](#type-disputeevidencetype) for possible values
	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 (
	UNKNOWN_STATE_DisputeState             DisputeState = "UNKNOWN_STATE"
	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"
	WAITING_THIRD_PARTY_DisputeState       DisputeState = "WAITING_THIRD_PARTY"
)

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 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 you want to upload evidence for.

@return CreateDisputeEvidenceTextResponse

func (*DisputesApiService) ListDisputeEvidence ¶

func (a *DisputesApiService) ListDisputeEvidence(ctx context.Context, disputeId string) (ListDisputeEvidenceResponse, *http.Response, error)

DisputesApiService ListDisputeEvidence Returns a list of evidence associated with a 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.

@return ListDisputeEvidenceResponse

func (*DisputesApiService) ListDisputes ¶

func (a *DisputesApiService) ListDisputes(ctx context.Context, localVarOptionals *DisputesApiListDisputesOpts) (ListDisputesResponse, *http.Response, error)

func (*DisputesApiService) RemoveDisputeEvidence ¶

func (a *DisputesApiService) RemoveDisputeEvidence(ctx context.Context, disputeId string, evidenceId string) (RemoveDisputeEvidenceResponse, *http.Response, error)

DisputesApiService RemoveDisputeEvidence Removes specified evidence from a dispute. Square does not send the bank any evidence that is removed. Also, you cannot remove evidence after submitting it to the bank using [SubmitEvidence](/reference/square/disputes-api/submit-evidence).

@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 remove evidence from.
@param evidenceId The ID of the evidence you want to remove.

@return RemoveDisputeEvidenceResponse

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 specific evidence metadata associated with a specific dispute. You must maintain a copy of the evidence you upload if you want to reference it later. You cannot download the evidence 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 that you want to retrieve evidence from.
@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. Before submitting evidence, Square compiles all available evidence. This includes evidence uploaded using the [CreateDisputeEvidenceFile](/reference/square/disputes-api/create-dispute-evidence-file) and [CreateDisputeEvidenceText](/reference/square/disputes-api/create-dispute-evidence-text) endpoints and evidence automatically provided by Square, when available.

@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 that you want to submit evidence for.

@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. See [EmployeeStatus](#type-employeestatus) for possible values
	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.

type EmployeeStatus ¶

type EmployeeStatus string

EmployeeStatus : The status of the Employee being retrieved.

const (
	ACTIVE_EmployeeStatus   EmployeeStatus = "ACTIVE"
	INACTIVE_EmployeeStatus EmployeeStatus = "INACTIVE"
)

List of EmployeeStatus

type EmployeeWage ¶

type EmployeeWage struct {
	// 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 will earn on a `Shift` for doing the job specified by the `title` property of this object. Deprecated at verison 2020-08-26. Use `TeamMemberWage` instead.

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

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"
	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"
	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"
	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"
	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"
	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"
	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_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"
	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 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 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 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`. Contains the requested `BreakType` objects. May 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 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`. Contains the requested `EmployeeWage` objects. May 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 {
}

Retrieves a specific `Refund` using the `refund_id`.

type GetPaymentRefundResponse ¶

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

Defines the fields that are included in the response body of a request to the [GetRefund](#endpoint-refunds-getpaymentrefund) endpoint. 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 {
}

Retrieve details for a specific 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 fields that are included in the response body of a request to the [GetPayment](#endpoint-payments-getpayment) endpoint.

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 request to get a `Shift`. Contains the requested `Shift` object. May contain a set of `Error` objects if the request resulted in errors.

type GetTeamMemberWageRequest ¶

type GetTeamMemberWageRequest struct {
}

A request to get an `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`. Contains the requested `TeamMemberWage` objects. May contain a set of `Error` objects if the request resulted in errors.

type GetTerminalCheckoutRequest ¶

type GetTerminalCheckoutRequest struct {
}

type GetTerminalCheckoutResponse ¶

type GetTerminalCheckoutResponse struct {
	// Information on 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 on errors encountered during the request.
	Errors []ModelError    `json:"errors,omitempty"`
	Refund *TerminalRefund `json:"refund,omitempty"`
}

type InlineTypes ¶

type InlineTypes string

InlineTypes : Object types to inline under their respective parent object in certain connect v2 responses

const (
	NONE_InlineTypes       InlineTypes = "INLINE_NONE"
	VARIATIONS_InlineTypes InlineTypes = "INLINE_VARIATIONS"
	ALL_InlineTypes        InlineTypes = "INLINE_ALL"
)

List of InlineTypes

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 `InventoryState` of the related quantity of items before the adjustment. See [InventoryState](#type-inventorystate) for possible values
	FromState string `json:"from_state,omitempty"`
	// The `InventoryState` of the related quantity of items after the adjustment. See [InventoryState](#type-inventorystate) for possible values
	ToState string `json:"to_state,omitempty"`
	// The Square ID of the `Location` where the related quantity of items are being tracked.
	LocationId string `json:"location_id,omitempty"`
	// The Square generated ID of the `CatalogObject` being tracked.
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The `CatalogObjectType` of the `CatalogObject` being tracked. Tracking is only supported for the `ITEM_VARIATION` type.
	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 timestamp in RFC 3339 format that indicates when the adjustment 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"`
	// A read-only timestamp in RFC 3339 format that indicates when Square received the adjustment.
	CreatedAt string             `json:"created_at,omitempty"`
	Source    *SourceApplication `json:"source,omitempty"`
	// The Square ID of the `Employee` responsible for the inventory adjustment.
	EmployeeId string `json:"employee_id,omitempty"`
	// The read-only Square ID of the [Transaction][#type-transaction] that caused the adjustment. Only relevant for payment-related state transitions.
	TransactionId string `json:"transaction_id,omitempty"`
	// The read-only Square ID of the [Refund][#type-refund] that caused the adjustment. Only relevant for refund-related state transitions.
	RefundId string `json:"refund_id,omitempty"`
	// The read-only Square 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 read-only Square ID of the Square goods receipt that caused the adjustment. Only relevant for state transitions from the Square for Retail app.
	GoodsReceiptId string `json:"goods_receipt_id,omitempty"`
}

Represents a change in state or quantity of product inventory at a particular time and location.

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(#type-catalogobject)s at the requested Location(#type-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) RetrieveInventoryAdjustment ¶

func (a *InventoryApiService) RetrieveInventoryAdjustment(ctx context.Context, adjustmentId string) (RetrieveInventoryAdjustmentResponse, *http.Response, error)

InventoryApiService RetrieveInventoryAdjustment Returns the InventoryAdjustment(#type-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` 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(#type-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` to retrieve.

@return RetrieveInventoryPhysicalCountResponse

type InventoryChange ¶

type InventoryChange struct {
	// Indicates how the inventory change was applied. See `InventoryChangeType` for all possible values. See [InventoryChangeType](#type-inventorychangetype) for possible values
	Type_         string                  `json:"type,omitempty"`
	PhysicalCount *InventoryPhysicalCount `json:"physical_count,omitempty"`
	Adjustment    *InventoryAdjustment    `json:"adjustment,omitempty"`
	Transfer      *InventoryTransfer      `json:"transfer,omitempty"`
}

Represents a single physical count, inventory, adjustment, or transfer that is part of the history of inventory changes for a particular `CatalogObject`.

type InventoryChangeType ¶

type InventoryChangeType string

InventoryChangeType : Indicates how the inventory change was applied to a tracked quantity of items.

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` being tracked.
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The `CatalogObjectType` of the `CatalogObject` being tracked. Tracking is only supported for the `ITEM_VARIATION` type.
	CatalogObjectType string `json:"catalog_object_type,omitempty"`
	// The current `InventoryState` for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values
	State string `json:"state,omitempty"`
	// The Square ID of the `Location` where the related quantity of items are 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"`
	// A read-only timestamp in RFC 3339 format that indicates when Square received the most recent physical count or adjustment that had an affect on the estimated count.
	CalculatedAt string `json:"calculated_at,omitempty"`
}

Represents Square's estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments.

type InventoryPhysicalCount ¶

type InventoryPhysicalCount struct {
	// A unique ID generated by Square for the `InventoryPhysicalCount`.
	Id string `json:"id,omitempty"`
	// An optional ID provided by the application to tie the `InventoryPhysicalCount` to an external system.
	ReferenceId string `json:"reference_id,omitempty"`
	// The Square generated ID of the `CatalogObject` being tracked.
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The `CatalogObjectType` of the `CatalogObject` being tracked. Tracking is only supported for the `ITEM_VARIATION` type.
	CatalogObjectType string `json:"catalog_object_type,omitempty"`
	// The current `InventoryState` for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values
	State string `json:"state,omitempty"`
	// The Square ID of the `Location` where the related quantity of items are being tracked.
	LocationId string `json:"location_id,omitempty"`
	// The number of items affected by the physical count as a decimal string. Can support up to 5 digits after the decimal point.
	Quantity string             `json:"quantity,omitempty"`
	Source   *SourceApplication `json:"source,omitempty"`
	// The Square ID of the `Employee` responsible for the physical count.
	EmployeeId string `json:"employee_id,omitempty"`
	// A client-generated timestamp in RFC 3339 format that indicates when the physical count 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"`
	// A read-only timestamp in RFC 3339 format that indicates when Square received the physical count.
	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"
)

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 `InventoryState` for the quantity of items being transferred. See [InventoryState](#type-inventorystate) for possible values
	State string `json:"state,omitempty"`
	// The Square ID of the `Location` where the related quantity of items were tracked before the transfer.
	FromLocationId string `json:"from_location_id,omitempty"`
	// The Square ID of the `Location` where the related quantity of items were tracked after the transfer.
	ToLocationId string `json:"to_location_id,omitempty"`
	// The Square generated ID of the `CatalogObject` being tracked.
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The `CatalogObjectType` of the `CatalogObject` being tracked.Tracking is only supported for the `ITEM_VARIATION` type.
	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 timestamp in RFC 3339 format 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"`
	// A read-only timestamp in RFC 3339 format that indicates when Square received the transfer request.
	CreatedAt string             `json:"created_at,omitempty"`
	Source    *SourceApplication `json:"source,omitempty"`
	// The Square ID of the `Employee` responsible for the inventory transfer.
	EmployeeId string `json:"employee_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. This field is required when creating an invoice.
	LocationId string `json:"location_id,omitempty"`
	// The ID of the `order` for which the invoice is created.  This order must be in the `OPEN` state and must belong to the `location_id` specified for this invoice. This field is required when creating an invoice.
	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. You can specify a maximum of 13 payment requests, with up to 12 `INSTALLMENT` request types. For more information, see [Payment requests](https://developer.squareup.com/docs/docs/invoices-api/overview#payment-requests).  This field is required when creating an invoice. It must contain at least one payment request.
	PaymentRequests []InvoicePaymentRequest `json:"payment_requests,omitempty"`
	DeliveryMethod  *InvoiceDeliveryMethod  `json:"delivery_method,omitempty"`
	// A user-friendly invoice number. The value is unique within a location. If not provided when creating an invoice, Square assigns a value. It increments from 1 and padded with zeros making it 7 characters long for example, 0000001, 0000002.
	InvoiceNumber string `json:"invoice_number,omitempty"`
	// The title of the invoice.
	Title string `json:"title,omitempty"`
	// The description of the invoice. This is visible to the customer receiving 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. See [InvoiceStatus](#type-invoicestatus) for possible values
	Status string `json:"status,omitempty"`
	// The time zone of the date values (for example, `due_date`) specified in the invoice.
	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"`
	// Additional seller-defined fields to render on the invoice. These fields are visible to sellers and buyers on the Square-hosted invoice page and in emailed or PDF copies of invoices. For more information, see [Custom fields](https://developer.squareup.com/docs/docs/invoices-api/overview#custom-fields).  Max: 2 custom fields
	CustomFields []InvoiceCustomField `json:"custom_fields,omitempty"`
}

Stores information about an invoice. You use the Invoices API to create and manage invoices. For more information, see [Manage Invoices Using the Invoices API](/docs/invoices-api/overview).

type InvoiceAutomaticPaymentSource ¶

type InvoiceAutomaticPaymentSource string

InvoiceAutomaticPaymentSource : Indicates the automatic payment method for an `invoice payment request`.

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. See [InvoiceCustomFieldPlacement](#type-invoicecustomfieldplacement) for possible values
	Placement string `json:"placement,omitempty"`
}

An additional seller-defined and customer-facing field to include on the invoice. For more information, see [Custom fields](/docs/invoices-api/overview#custom-fields).

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` to the customer.

const (
	EMAIL_InvoiceDeliveryMethod          InvoiceDeliveryMethod = "EMAIL"
	SHARE_MANUALLY_InvoiceDeliveryMethod InvoiceDeliveryMethod = "SHARE_MANUALLY"
)

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. See [InvoicePaymentReminderStatus](#type-invoicepaymentreminderstatus) for possible values
	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`.
	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`. See [InvoiceRequestMethod](#type-invoicerequestmethod) for possible values
	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. See [InvoiceRequestType](#type-invoicerequesttype) for possible values
	RequestType string `json:"request_type,omitempty"`
	// The due date (in the invoice location's time zone) for the payment request, in `YYYY-MM-DD` format.  After this date, the invoice becomes overdue. This field is required to create a payment request.
	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 total amount. - When the payment `request_type` is `INSTALLMENT`, it is the percentage of the order 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`. See [InvoiceAutomaticPaymentSource](#type-invoiceautomaticpaymentsource) for possible values
	AutomaticPaymentSource string `json:"automatic_payment_source,omitempty"`
	// The ID of the card on file to charge for the payment request. To get the customer’s card on file, use the `customer_id` of the invoice recipient to call `RetrieveCustomer` in the Customers API. Then, get the ID of the target card from the `cards` field in the response.
	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](#type-Invoice). Invoices can specify a maximum of 13 payment requests, with up to 12 `INSTALLMENT` request types. For more information, see [Payment requests](/docs/invoices-api/overview#payment-requests).

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"`
}

Provides customer data that Square uses to deliver an invoice.

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

List of InvoiceRequestMethod

type InvoiceRequestType ¶

type InvoiceRequestType string

InvoiceRequestType : Indicates the type of the payment request. An invoice supports the following payment request combinations: - 1 balance - 1 deposit with 1 balance - 2 - 12 installments - 1 deposit with 2 - 12 installments For more information, see [Payment requests](https://developer.squareup.com/docs/docs/invoices-api/overview#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 sort on. See [InvoiceSortField](#type-invoicesortfield) for possible values
	Field string `json:"field"`
	// The order to use for sorting the results. See [SortOrder](#type-sortorder) for possible values
	Order string `json:"order,omitempty"`
}

Identifies the sort field and sort order.

type InvoiceSortField ¶

type InvoiceSortField string

InvoiceSortField : Field to use for sorting.

const (
	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` 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](#type-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) 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 charge a card on file for a portion of the invoice 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.

@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 fetch 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 by modifying fields, clearing fields, or both. For most updates, you can use a sparse `Invoice` object to add fields or change values, and use the `fields_to_clear` field to specify fields to clear. However, some restrictions apply. For example, you cannot change the `order_id` or `location_id` field, and you must provide the complete `custom_fields` list to update a custom field. Published invoices have additional restrictions.

@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`.
	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`. See [CatalogPricingType](#type-catalogpricingtype) for possible values
	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`. See [InventoryAlertType](#type-inventoryalerttype) for possible values
	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"`
}

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. See [JobAssignmentPayType](#type-jobassignmentpaytype) for possible values
	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 3 `BreakType` instances per location. If you attempt to add a 4th `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 work day for a single employee. You must provide the following values in your request to this endpoint: - `location_id` - `employee_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 employee has another shift with an `OPEN` status. - The `start_at` date is in the future - the `start_at` or `end_at` overlaps another shift for the same employee - If `Break`s are set in the request, a break `start_at` must not be before the `Shift.start_at`. A break `end_at` must not be after the `Shift.end_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 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 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 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 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 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 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 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 **and** - employee IDs **and** - shift status (`OPEN`, `CLOSED`) **and** - shift start **and** - shift end **and** - work day 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 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 `Breaks` 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 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 UUID for the `WorkweekConfig` object being updated.

@return UpdateWorkweekConfigResponse

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/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/docs/working-with-apis/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Response object returned by ListBankAccounts.

type ListBreakTypesRequest ¶

type ListBreakTypesRequest struct {
	// Filter Break Types returned to only those that are associated with the specified location.
	LocationId string `json:"location_id,omitempty"`
	// Maximum number of Break Types to return per page. Can range between 1 and 200. The default is the maximum at 200.
	Limit int32 `json:"limit,omitempty"`
	// Pointer to the next page of Break Type 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"`
	// Value supplied in the subsequent request to fetch the next next page of Break Type 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 `BreakTypes`. Contains the requested `BreakType` objects. May contain a set of `Error` objects if the request resulted in errors.

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 {
	// All of the events (payments, refunds, etc.) for a cash drawer during the shift.
	Events []CashDrawerShiftEvent `json:"events,omitempty"`
	// 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"`
}

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 See [SortOrder](#type-sortorder) for possible values
	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 {
	// A collection of CashDrawerShiftSummary objects for shifts that match the query.
	Items []CashDrawerShiftSummary `json:"items,omitempty"`
	// 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"`
}

type ListCatalogRequest ¶

type ListCatalogRequest struct {
	// The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
	// An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`.  The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`.
	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`s' `version` attribute.
	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/basics/api101/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
	// The CatalogObjects returned.
	Objects []CatalogObject `json:"objects,omitempty"`
}

type ListCustomerGroupsRequest ¶

type ListCustomerGroupsRequest 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 the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
}

Defines the query parameters that can be provided in a request to the [ListCustomerGroups](#endpoint-listcustomergroups) 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 merchant.
	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.  See the [Pagination guide](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 [ListCustomerGroups](#endpoint-listcustomergroups) endpoint. One of `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__. Used to retrieve the next set of query results.  See the [Pagination guide](https://developer.squareup.com/docs/docs/working-with-apis/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
}

Defines the valid parameters for requests to __ListCustomerSegments__.

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. Only present only if the request succeeded and additional results are available.  See the [Pagination guide](https://developer.squareup.com/docs/docs/working-with-apis/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
}

Defines the fields included in the response body for requests to __ListCustomerSegments__. One of `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 to retrieve the next set of results for your original query.  See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
	// Indicates how Customers should be sorted.  Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values
	SortField string `json:"sort_field,omitempty"`
	// Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order.  Default: `ASC`. See [SortOrder](#type-sortorder) for possible values
	SortOrder string `json:"sort_order,omitempty"`
}

Defines the query parameters that can be provided in a request to the ListCustomers endpoint.

type ListCustomersResponse ¶

type ListCustomersResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// An array of `Customer` objects that match the provided query.
	Customers []Customer `json:"customers,omitempty"`
	// A pagination cursor to retrieve the next set of results for the original query. Only present if the request succeeded and additional results are available.  See the [Pagination guide](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 ListCustomers endpoint. One of `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](#paginatingresults) 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. See [ProductType](#type-producttype) for possible values
	ProductType string `json:"product_type,omitempty"`
	// If specified, returns DeviceCodes with the specified statuses. Returns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty. See [DeviceCodeStatus](#type-devicecodestatus) for possible values
	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](#paginatingresults) for more information.
	Cursor string `json:"cursor,omitempty"`
}

type ListDisputeEvidenceRequest ¶

type ListDisputeEvidenceRequest struct {
}

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"`
}

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/basics/api101/pagination).
	Cursor string `json:"cursor,omitempty"`
	// The dispute states to filter the result. If not specified, the endpoint returns all open disputes (the dispute status is not `INQUIRY_CLOSED`, `WON`, or `LOST`). See [DisputeState](#type-disputestate) for possible values
	States []string `json:"states,omitempty"`
	// The ID of the location for which to return a list of disputes. If not specified, the endpoint returns all open disputes (the dispute status is not `INQUIRY_CLOSED`, `WON`, or `LOST`) 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/basics/api101/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Defines fields in a `ListDisputes` response.

type ListEmployeeWagesRequest ¶

type ListEmployeeWagesRequest struct {
	// Filter wages returned to only those that are associated with the specified employee.
	EmployeeId string `json:"employee_id,omitempty"`
	// Maximum number of Employee Wages to return per page. Can range between 1 and 200. The default is the maximum at 200.
	Limit int32 `json:"limit,omitempty"`
	// Pointer to the next page of Employee Wage results to fetch.
	Cursor string `json:"cursor,omitempty"`
}

A request for a set of `EmployeeWage` objects

type ListEmployeeWagesResponse ¶

type ListEmployeeWagesResponse struct {
	// A page of Employee Wage results.
	EmployeeWages []EmployeeWage `json:"employee_wages,omitempty"`
	// Value supplied in the subsequent request to fetch the next next page of Employee Wage 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. Contains a set of `EmployeeWage`.

type ListEmployeesRequest ¶

type ListEmployeesRequest struct {
	LocationId string `json:"location_id,omitempty"`
	// Specifies the EmployeeStatus to filter the employee by. See [EmployeeStatus](#type-employeestatus) for possible values
	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 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/docs/working-with-apis/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 fetch the next set of invoices. If empty, this is the final  response.  For more information, see [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination).
	Cursor string `json:"cursor,omitempty"`
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

Describes a `ListInvoice` response.

type ListLocationsRequest ¶

type ListLocationsRequest struct {
}

Defines the fields that are included in requests to the __ListLocations__ 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__ endpoint. One of `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 ListMerchantsRequest ¶

type ListMerchantsRequest struct {
	// The cursor generated by the previous response.
	Cursor int32 `json:"cursor,omitempty"`
}

Request object for the [ListMerchant](#endpoint-listmerchant) 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](#endpoint-listmerchant) endpoint.

type ListPaymentRefundsRequest ¶

type ListPaymentRefundsRequest struct {
	// The timestamp for the beginning of the requested reporting period, in RFC 3339 format.  Default: The current time minus one year.
	BeginTime string `json:"begin_time,omitempty"`
	// The timestamp for the end of the requested reporting period, in RFC 3339 format.  Default: The current time.
	EndTime string `json:"end_time,omitempty"`
	// The order in which results are listed: - `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/basics/api101/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`.  Default: If omitted, refunds are returned regardless of their status.
	Status string `json:"status,omitempty"`
	// If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where `CARD` was specified as the payment source.  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"`
}

Retrieves a list of refunds for the account making the request. 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/basics/api101/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Defines the fields that are included in the response body of a request to the [ListPaymentRefunds](#endpoint-refunds-listpaymentrefunds) endpoint. Either `errors` or `refunds` is present in a given response (never both).

type ListPaymentsRequest ¶

type ListPaymentsRequest struct {
	// The timestamp for the beginning of the reporting period, 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 reporting period, in RFC 3339 format.  Default: The current time.
	EndTime string `json:"end_time,omitempty"`
	// The order in which results are listed: - `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/basics/api101/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"`
}

Retrieves a list of payments taken by the account making the request. 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/basics/api101/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Defines the fields that are included in the response body of a request to the [ListPayments](#endpoint-payments-listpayments) endpoint.

type ListRefundsRequest ¶

type ListRefundsRequest struct {
	// The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) 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](#dateranges) 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` See [SortOrder](#type-sortorder) for possible values
	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](#paginatingresults) for more information.
	Cursor string `json:"cursor,omitempty"`
}

Defines the query parameters that can be included in a request to the [ListRefunds](#endpoint-listrefunds) endpoint. Deprecated - recommend using [SearchOrders](#endpoint-orders-searchorders)

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](#paginatingresults) for more information.
	Cursor string `json:"cursor,omitempty"`
}

Defines the fields that are included in the response body of a request to the [ListRefunds](#endpoint-listrefunds) endpoint. One of `errors` or `refunds` is present in a given response (never both).

type ListSubscriptionEventsRequest ¶

type ListSubscriptionEventsRequest struct {
	// 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/docs/working-with-apis/pagination).
	Cursor string `json:"cursor,omitempty"`
	// The upper limit on the number of subscription events to return  in the response.   Default: `200`
	Limit int32 `json:"limit,omitempty"`
}

Defines parameters in a [ListSubscriptionEvents](#endpoint-subscriptions-listsubscriptionevents) endpoint request.

type ListSubscriptionEventsResponse ¶

type ListSubscriptionEventsResponse struct {
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The `SubscriptionEvents` retrieved.
	SubscriptionEvents []SubscriptionEvent `json:"subscription_events,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/docs/working-with-apis/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Defines the fields that are included in the response from the [ListSubscriptionEvents](#endpoint-subscriptions-listsubscriptionevents) endpoint.

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.
	Limit int32 `json:"limit,omitempty"`
	// The cursor for paginating through 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.
	TeamMemberBookingProfiles []TeamMemberBookingProfile `json:"team_member_booking_profiles,omitempty"`
	// The cursor for paginating through the results.
	Cursor string `json:"cursor,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

type ListTeamMemberWagesRequest ¶

type ListTeamMemberWagesRequest struct {
	// Filter wages returned to only those that are associated with the specified team member.
	TeamMemberId string `json:"team_member_id,omitempty"`
	// Maximum number of Team Member Wages to return per page. Can range between 1 and 200. The default is the maximum at 200.
	Limit int32 `json:"limit,omitempty"`
	// Pointer to the next page of Employee Wage results to fetch.
	Cursor string `json:"cursor,omitempty"`
}

A request for a set of `TeamMemberWage` objects

type ListTeamMemberWagesResponse ¶

type ListTeamMemberWagesResponse struct {
	// A page of Team Member Wage results.
	TeamMemberWages []TeamMemberWage `json:"team_member_wages,omitempty"`
	// Value supplied in the subsequent request to fetch the next next page of Team Member Wage 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. Contains a set of `TeamMemberWage`.

type ListTransactionsRequest ¶

type ListTransactionsRequest struct {
	// The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) 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](#dateranges) 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` See [SortOrder](#type-sortorder) for possible values
	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](#paginatingresults) for more information.
	Cursor string `json:"cursor,omitempty"`
}

Defines the query parameters that can be included in a request to the [ListTransactions](#endpoint-listtransactions) endpoint. Deprecated - recommend using [SearchOrders](#endpoint-orders-searchorders)

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](#paginatingresults) for more information.
	Cursor string `json:"cursor,omitempty"`
}

Defines the fields that are included in the response body of a request to the [ListTransactions](#endpoint-listtransactions) endpoint. One of `errors` or `transactions` is present in a given response (never both).

type ListWorkweekConfigsRequest ¶

type ListWorkweekConfigsRequest struct {
	// Maximum number of Workweek Configs to return per page.
	Limit int32 `json:"limit,omitempty"`
	// Pointer to the next page of Workweek Config results to fetch.
	Cursor string `json:"cursor,omitempty"`
}

A request for a set of `WorkweekConfig` objects

type ListWorkweekConfigsResponse ¶

type ListWorkweekConfigsResponse struct {
	// A page of Employee Wage results.
	WorkweekConfigs []WorkweekConfig `json:"workweek_configs,omitempty"`
	// Value supplied in the subsequent request to fetch the next page of Employee Wage 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. Contains the requested `WorkweekConfig` objects. May contain a set of `Error` objects if the request resulted in errors.

type Location ¶

type Location struct {
	// The Square-issued ID of the location.
	Id string `json:"id,omitempty"`
	// The name of the location. This information appears in the dashboard as the nickname.
	Name    string   `json:"name,omitempty"`
	Address *Address `json:"address,omitempty"`
	// The [IANA Timezone](https://www.iana.org/time-zones) identifier for the timezone of the location.
	Timezone string `json:"timezone,omitempty"`
	// The Square features that are enabled for the location. See `LocationCapability` for possible values. See [LocationCapability](#type-locationcapability) for possible values
	Capabilities []string `json:"capabilities,omitempty"`
	// The status of the location, either active or inactive. See [LocationStatus](#type-locationstatus) for possible values
	Status string `json:"status,omitempty"`
	// The time when the location was created, in RFC 3339 format.
	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 ISO 3166-1-alpha-2 format.  See `Country` for possible values. See [Country](#type-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).
	LanguageCode string `json:"language_code,omitempty"`
	// The currency used for all transactions at this location, in ISO 4217 format. See `Currency` for possible values. See [Currency](#type-currency) for possible values
	Currency string `json:"currency,omitempty"`
	// The phone number of the location in human readable format.
	PhoneNumber string `json:"phone_number,omitempty"`
	// The business name of the location This is the name visible to the customers of the location. For example, this name appears on customer receipts.
	BusinessName string `json:"business_name,omitempty"`
	// The type of the location, either physical or mobile. See [LocationType](#type-locationtype) for possible values
	Type_ string `json:"type,omitempty"`
	// The website URL of the location.
	WebsiteUrl    string         `json:"website_url,omitempty"`
	BusinessHours *BusinessHours `json:"business_hours,omitempty"`
	// The email of the location. This email is visible to the customers of the location. For example, the email appears on customer receipts.
	BusinessEmail string `json:"business_email,omitempty"`
	// The description of the location.
	Description string `json:"description,omitempty"`
	// The Twitter username of the location without the '&#64;' symbol.
	TwitterUsername string `json:"twitter_username,omitempty"`
	// The Instagram username of the location without the '&#64;' symbol.
	InstagramUsername string `json:"instagram_username,omitempty"`
	// The Facebook profile URL of the location. The URL should begin with 'facebook.com/'.
	FacebookUrl string       `json:"facebook_url,omitempty"`
	Coordinates *Coordinates `json:"coordinates,omitempty"`
	// The URL of the logo image for the location. The Seller must choose this logo in the Seller dashboard (Receipts section) for the logo to appear on transactions (such as receipts, invoices) that Square generates on behalf of the Seller. This image should have an aspect ratio close to 1:1 and is recommended to 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"`
	// The merchant category code (MCC) of the location, as standardized by ISO 18245. The MCC describes the kind of goods or services sold at the location.
	Mcc string `json:"mcc,omitempty"`
	// The URL of a full-format logo image for the location. The Seller must choose this logo in the Seller dashboard (Receipts section) for the logo to appear on transactions (such as receipts, invoices) that Square generates on behalf of the Seller. This image can have an aspect ratio of 2:1 or greater and is recommended to be at least 1280x648 pixels.
	FullFormatLogoUrl string `json:"full_format_logo_url,omitempty"`
}

type LocationCapability ¶

type LocationCapability string

LocationCapability : The capabilities a location may have.

const (
	PROCESSING_LocationCapability LocationCapability = "CREDIT_CARD_PROCESSING"
)

List of LocationCapability

type LocationStatus ¶

type LocationStatus string

LocationStatus : The status of the location, whether a location is active or inactive.

const (
	ACTIVE_LocationStatus   LocationStatus = "ACTIVE"
	INACTIVE_LocationStatus LocationStatus = "INACTIVE"
)

List of LocationStatus

type LocationType ¶

type LocationType string

LocationType : A location's physical or mobile 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.

@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 information of all locations of a business. Many Square API endpoints require a `location_id` parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter.

@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 location. You can specify \"main\" as the location ID to retrieve details of 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. If you specify the string \"main\", then the endpoint returns 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.

@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 list of mappings that the account is associated with.  Currently, a buyer can only be mapped to a loyalty account using  a phone number. Therefore, the list can only have one mapping.
	Mappings []LoyaltyAccountMapping `json:"mappings"`
	// The Square-assigned ID of the `loyalty program` to which the account belongs.
	ProgramId string `json:"program_id"`
	// The available point balance in the loyalty account.    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` that is associated with the account.
	CustomerId string `json:"customer_id,omitempty"`
	// The timestamp when enrollment occurred, in RFC 3339 format.
	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"`
}

Describes a loyalty account. For more information, see [Loyalty Overview](/docs/loyalty/overview).

type LoyaltyAccountMapping ¶

type LoyaltyAccountMapping struct {
	// The Square-assigned ID of the mapping.
	Id string `json:"id,omitempty"`
	// The type of mapping. See [LoyaltyAccountMappingType](#type-loyaltyaccountmappingtype) for possible values
	Type_ string `json:"type"`
	// The phone number, in E.164 format. For example, \"+14155551111\".
	Value string `json:"value"`
	// The timestamp when the mapping was created, in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
}

Associates a loyalty account with the buyer's phone number. For more information, see [Loyalty Overview](/docs/loyalty/overview).

type LoyaltyAccountMappingType ¶

type LoyaltyAccountMappingType string

LoyaltyAccountMappingType : The type of mapping.

const (
	PHONE_LoyaltyAccountMappingType LoyaltyAccountMappingType = "PHONE"
)

List of LoyaltyAccountMappingType

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 to a loyalty account. - If you are using the Orders API to manage orders, you only provide the `order_id`. The endpoint reads the order to compute points to add to the buyer's account. - If you are not using the Orders API to manage orders, you first perform a client-side computation to compute the points. For spend-based and visit-based programs, you can call [CalculateLoyaltyPoints](#endpoint-Loyalty-CalculateLoyaltyPoints) to compute the points. For more information, see [Loyalty Program Overview](/docs/loyalty/overview). You then provide the points in a request to 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 accountId The `loyalty account` ID to which to add the points.

@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](#endpoint-Loyalty-AccumulateLoyaltyPoints) 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 `loyalty account` in which to adjust the points.

@return AdjustLoyaltyPointsResponse

func (*LoyaltyApiService) CalculateLoyaltyPoints ¶

func (a *LoyaltyApiService) CalculateLoyaltyPoints(ctx context.Context, body CalculateLoyaltyPointsRequest, programId string) (CalculateLoyaltyPointsResponse, *http.Response, error)

LoyaltyApiService CalculateLoyaltyPoints Calculates the points a purchase earns. - If you are using the Orders API to manage orders, you provide `order_id` in the request. The endpoint calculates the points by reading the order. - If you are not using the Orders API to manage orders, you provide the purchase amount in the request for the endpoint to calculate the points. An application might call this endpoint to show the points that a buyer can earn with the specific 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 programId The `loyalty program` ID, which defines the rules for accruing points.

@return CalculateLoyaltyPointsResponse

func (*LoyaltyApiService) CreateLoyaltyAccount ¶

func (a *LoyaltyApiService) CreateLoyaltyAccount(ctx context.Context, body CreateLoyaltyAccountRequest) (CreateLoyaltyAccountResponse, *http.Response, error)

LoyaltyApiService CreateLoyaltyAccount Creates a loyalty 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 CreateLoyaltyAccountResponse

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](#endpoint-Loyalty-CreateLoyaltyReward)), 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` 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. Currently, a seller can only have one loyalty program.

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

@return ListLoyaltyProgramsResponse

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` 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` to retrieve.

@return RetrieveLoyaltyAccountResponse

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

@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 in a loyalty account. In the current implementation, the endpoint supports search by the reward `status`. If you know a reward ID, use the [RetrieveLoyaltyReward](#endpoint-Loyalty-RetrieveLoyaltyReward) 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 SearchLoyaltyRewardsResponse

type LoyaltyEvent ¶

type LoyaltyEvent struct {
	// The Square-assigned ID of the loyalty event.
	Id string `json:"id"`
	// The type of the loyalty event. See [LoyaltyEventType](#type-loyaltyeventtype) for possible values
	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` in which the event occurred.
	LoyaltyAccountId string `json:"loyalty_account_id"`
	// The ID of the `location` where the event occurred.
	LocationId string `json:"location_id,omitempty"`
	// Defines whether the event was generated by the Square Point of Sale. See [LoyaltyEventSource](#type-loyaltyeventsource) for possible values
	Source       string                    `json:"source"`
	ExpirePoints *LoyaltyEventExpirePoints `json:"expire_points,omitempty"`
	OtherEvent   *LoyaltyEventOther        `json:"other_event,omitempty"`
}

Provides information about a loyalty event. For more information, see [Loyalty events](/docs/loyalty-api/overview/#loyalty-events).

type LoyaltyEventAccumulatePoints ¶

type LoyaltyEventAccumulatePoints struct {
	// The ID of the `loyalty program`.
	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` 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 LoyaltyEventAdjustPoints ¶

type LoyaltyEventAdjustPoints struct {
	// The Square-assigned ID of the `loyalty program`.
	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`.
	LoyaltyProgramId string `json:"loyalty_program_id"`
	// The Square-assigned ID of the created `loyalty reward`. 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`.
	LoyaltyProgramId string `json:"loyalty_program_id"`
	// The ID of the deleted `loyalty reward`. 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`.
	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` 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` 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` 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`.
	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`.
	LoyaltyProgramId string `json:"loyalty_program_id"`
	// The ID of the redeemed `loyalty reward`. This field is returned only if the event source is `LOYALTY_API`.
	RewardId string `json:"reward_id,omitempty"`
	// The ID of the `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"
)

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. See [LoyaltyEventType](#type-loyaltyeventtype) for possible values
	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"`
	// Whether the program is currently active. See [LoyaltyProgramStatus](#type-loyaltyprogramstatus) for possible values
	Status string `json:"status"`
	// The list of rewards for buyers, sorted by ascending points.
	RewardTiers      []LoyaltyProgramRewardTier      `json:"reward_tiers"`
	ExpirationPolicy *LoyaltyProgramExpirationPolicy `json:"expiration_policy,omitempty"`
	Terminology      *LoyaltyProgramTerminology      `json:"terminology"`
	// The `locations` 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"`
	// The timestamp when the reward was last updated, in RFC 3339 format.
	UpdatedAt string `json:"updated_at"`
	// Defines how buyers can earn loyalty points.
	AccrualRules []LoyaltyProgramAccrualRule `json:"accrual_rules"`
}

type LoyaltyProgramAccrualRule ¶

type LoyaltyProgramAccrualRule struct {
	// The type of the accrual rule that defines how buyers can earn points. See [LoyaltyProgramAccrualRuleType](#type-loyaltyprogramaccrualruletype) for possible values
	AccrualType string `json:"accrual_type"`
	// The number of points that  buyers earn based on the `accrual_type`.
	Points                  int32  `json:"points,omitempty"`
	VisitMinimumAmountMoney *Money `json:"visit_minimum_amount_money,omitempty"`
	SpendAmountMoney        *Money `json:"spend_amount_money,omitempty"`
	// The ID of the `catalog object` to purchase to earn the number of points defined by the rule. This is either an item variation or a category, depending on the type. This is defined on `ITEM_VARIATION` rules and `CATEGORY` rules.
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
}

Defines an accrual rule, which is how buyers can earn points.

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 LoyaltyProgramExpirationPolicy ¶

type LoyaltyProgramExpirationPolicy struct {
	// The duration of time before points expire, in RFC 3339 format.
	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 `discount_target_scope` field of the `PRICING_RULE` catalog object and the `product_set_data` field of the `PRODUCT_SET` catalog object referenced by the pricing rule. For `ORDER` scopes, the target scope is `WHOLE_PURCHASE` and `all_products` is true. For `ITEM_VARIATION` and `CATEGORY` scopes, the target scope is `LINE_ITEM` and `product_ids_any` is a list of catalog object IDs of the given type. See [LoyaltyProgramRewardDefinitionScope](#type-loyaltyprogramrewarddefinitionscope) for possible values
	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. See [LoyaltyProgramRewardDefinitionType](#type-loyaltyprogramrewarddefinitiontype) for possible values
	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 [Get discount details for the reward](/docs/loyalty-api/overview#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 [Get discount details for the reward](https://developer.squareup.com/docs/docs/loyalty-api/overview#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 [Get discount details for the reward](https://developer.squareup.com/docs/docs/loyalty-api/overview#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"`
	// The points exchanged for the reward tier.
	Points int32 `json:"points"`
	// The name of the reward tier.
	Name       string                          `json:"name"`
	Definition *LoyaltyProgramRewardDefinition `json:"definition"`
	// The timestamp when the reward tier was created, in RFC 3339 format.
	CreatedAt            string                  `json:"created_at"`
	PricingRuleReference *CatalogObjectReference `json:"pricing_rule_reference,omitempty"`
}

Describes a loyalty program reward tier.

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"`
}

type LoyaltyReward ¶

type LoyaltyReward struct {
	// The Square-assigned ID of the loyalty reward.
	Id string `json:"id,omitempty"`
	// The status of a loyalty reward. See [LoyaltyRewardStatus](#type-loyaltyrewardstatus) for possible values
	Status string `json:"status,omitempty"`
	// The Square-assigned ID of the `loyalty account` to which the reward belongs.
	LoyaltyAccountId string `json:"loyalty_account_id"`
	// The Square-assigned ID of the `reward tier` 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` 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"`
}

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. See [MeasurementUnitArea](#type-measurementunitarea) for possible values
	AreaUnit string `json:"area_unit,omitempty"`
	// Represents a standard length unit. See [MeasurementUnitLength](#type-measurementunitlength) for possible values
	LengthUnit string `json:"length_unit,omitempty"`
	// Represents a standard volume unit. See [MeasurementUnitVolume](#type-measurementunitvolume) for possible values
	VolumeUnit string `json:"volume_unit,omitempty"`
	// Represents a standard unit of weight or mass. See [MeasurementUnitWeight](#type-measurementunitweight) for possible values
	WeightUnit string `json:"weight_unit,omitempty"`
	// Reserved for API integrations that lack the ability to specify a real measurement unit See [MeasurementUnitGeneric](#type-measurementunitgeneric) for possible values
	GenericUnit string `json:"generic_unit,omitempty"`
	// Represents a standard unit of time. See [MeasurementUnitTime](#type-measurementunittime) for possible values
	TimeUnit string `json:"time_unit,omitempty"`
	// Represents the type of the measurement unit. See [MeasurementUnitUnitType](#type-measurementunitunittype) for possible values
	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 business name of the merchant.
	BusinessName string `json:"business_name,omitempty"`
	// The country code associated with the merchant account, in ISO 3166 format. See [Country](#type-country) for possible values
	Country string `json:"country"`
	// The language code associated with the merchant account, in BCP 47 format.
	LanguageCode string `json:"language_code,omitempty"`
	// The currency associated with the merchant account, in ISO 4217 format. See [Currency](#type-currency) for possible values
	Currency string `json:"currency,omitempty"`
	// The merchant status, active or inactive. See [MerchantStatus](#type-merchantstatus) for possible values
	Status string `json:"status,omitempty"`
	// The ID of the main `Location` for this merchant.
	MainLocationId string `json:"main_location_id,omitempty"`
}

Represents a Square seller.

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 Retrieve a `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 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](/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 {
	// UUID for this object
	Id string `json:"id,omitempty"`
	// RFC 3339; follows same timezone info as `Shift`. Precision up to the minute is respected; seconds are truncated.
	StartAt string `json:"start_at"`
	// RFC 3339; follows same timezone info as `Shift`. Precision up to the minute is respected; seconds are truncated.
	EndAt string `json:"end_at,omitempty"`
	// The `BreakType` 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. See [ErrorCategory](#type-errorcategory) for possible values
	Category string `json:"category"`
	// The specific code of the error. See [ErrorCode](#type-errorcode) for possible values
	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](#handlingerrors) for more information.

type ModelRange ¶

type ModelRange struct {
	// The lower bound of the number range.
	Min string `json:"min,omitempty"`
	// The upper bound of the number range.
	Max string `json:"max,omitempty"`
}

The range of a number value between the specified lower and upper bounds.

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` for possible values. See [Currency](#type-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](/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. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. 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) RenewToken ¶

func (a *OAuthApiService) RenewToken(ctx context.Context, body RenewTokenRequest, clientId string) (RenewTokenResponse, *http.Response, error)

OAuthApiService RenewToken `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __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 Credentials page in the [application dashboard](https://connect.squareup.com/apps).

@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 clientId Your application ID, available from the [application dashboard](https://connect.squareup.com/apps).

@return RenewTokenResponse

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. When an OAuth access token is revoked, all of the active subscriptions associated with that OAuth token are canceled immediately. __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 Credentials page in the [Developer Dashboard](https://developer.squareup.com/apps).

@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, available from the [application dashboard](https://connect.squareup.com/apps).
	ClientId string `json:"client_id"`
	// The Square-issued application secret for your application, available from the [application dashboard](https://connect.squareup.com/apps).
	ClientSecret string `json:"client_secret"`
	// The authorization code to exchange. This 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 in the [application dashboard](https://connect.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 the application wants a replacement for an expired OAuth access token.
	RefreshToken string `json:"refresh_token,omitempty"`
	// 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/authz/oauth/migration).
	MigrationToken string `json:"migration_token,omitempty"`
	// __OPTIONAL__  A JSON list of strings representing the permissions 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"`
	// __OPTIONAL__  A boolean indicating a request for a short-lived access token. The short-lived access token returned in the response will expire in 24 hours.
	ShortLived bool `json:"short_lived,omitempty"`
}

type ObtainTokenResponse ¶

type ObtainTokenResponse struct {
	// A valid OAuth access token. OAuth access tokens are 64 bytes long. Provide the access token in a header with every request to Connect API endpoints. See [OAuth API: Walkthrough](https://developer.squareup.com/docs/oauth-api/walkthrough) for more information.
	AccessToken string `json:"access_token,omitempty"`
	// This value is always _bearer_.
	TokenType string `json:"token_type,omitempty"`
	// The date when 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. Only present if the merchant signed up for a subscription during authorization.
	SubscriptionId string `json:"subscription_id,omitempty"`
	// __LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization.
	PlanId string `json:"plan_id,omitempty"`
	// Then OpenID token belonging to this this person. Only present if the OPENID scope is included in the authorize request.
	IdToken string `json:"id_token,omitempty"`
	// A refresh token. OAuth refresh tokens are 64 bytes long. For more information, see [OAuth access token management](https://developer.squareup.com/docs/authz/oauth/how-it-works#oauth-access-token-management).
	RefreshToken string `json:"refresh_token,omitempty"`
	// A boolean indicating the access token is a short-lived access token. The short-lived access token returned in the response will expire in 24 hours.
	ShortLived bool `json:"short_lived,omitempty"`
}

type OnboardAppointmentsRequest ¶

type OnboardAppointmentsRequest struct {
}

type OnboardAppointmentsResponse ¶

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

type Order ¶

type Order struct {
	// The order's unique ID.
	Id string `json:"id,omitempty"`
	// The ID of the merchant location this order is associated with.
	LocationId string `json:"location_id"`
	// A client specified identifier to associate an entity in another system with this order.
	ReferenceId string       `json:"reference_id,omitempty"`
	Source      *OrderSource `json:"source,omitempty"`
	// The `Customer` ID of the customer associated with the order.
	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 will generate an `OrderLineItemAppliedTax` for every line item.  On reads, each tax in the list will include the total amount of that tax applied to the order.  __IMPORTANT__: If `LINE_ITEM` scope is set on any taxes in this field, usage of the deprecated `line_items.taxes` field will result in an error. Please 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 will generate an `OrderLineItemAppliedDiscount` for every line item.  __IMPORTANT__: If `LINE_ITEM` scope is set on any discounts in this field, usage of the deprecated `line_items.discounts` field will result in an error. Please 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 on order fulfillment.  Orders can only be created with at most one fulfillment. However, orders returned by the API may contain multiple fulfillments.
	Fulfillments []OrderFulfillment `json:"fulfillments,omitempty"`
	// Collection of items from sale Orders being returned in this one. Normally part of an Itemized Return or Exchange.  There will be 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 which 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 (personally identifiable information, card details, etc.).  Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character.  Values have a max length of 255 characters.  An application may 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.  See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information.
	Metadata map[string]string `json:"metadata,omitempty"`
	// Timestamp for when the order was created. In RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".
	CreatedAt string `json:"created_at,omitempty"`
	// Timestamp for when the order was last updated. In RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".
	UpdatedAt string `json:"updated_at,omitempty"`
	// Timestamp for when the order reached a terminal [state](#property-state). In RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\".
	ClosedAt string `json:"closed_at,omitempty"`
	// The current state of the order. `OPEN`,`COMPLETED`,`CANCELED` See [OrderState](#type-orderstate) for possible values
	State string `json:"state,omitempty"`
	// Version number which is incremented each time an update is committed to the order. Orders that were not created through the API will not include a version and thus 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"`
	PricingOptions          *OrderPricingOptions `json:"pricing_options,omitempty"`
	// A set-like list of rewards that have been added to the order.
	Rewards []OrderReward `json:"rewards,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 on 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"`
	// Version number which is incremented each time an update is committed to the order. Orders that were not created through the API will not include a version and thus cannot be updated.  [Read more about working with versions](https://developer.squareup.com/docs/docs/orders-api/manage-orders#update-orders)
	Version int32 `json:"version,omitempty"`
	// The ID of the merchant location this order is associated with.
	LocationId string `json:"location_id,omitempty"`
	// The state of the order. See [OrderState](#type-orderstate) for possible values
	State string `json:"state,omitempty"`
	// 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 OrderEntry ¶

type OrderEntry struct {
	// The id of the Order
	OrderId string `json:"order_id,omitempty"`
	// Version number which is incremented each time an update is committed to the order. Orders that were not created through the API will not include a version and thus 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(#type-order) that is returned when `returned_entries` is true on a [SearchOrderRequest](#type-searchorderrequest)

type OrderFulfillment ¶

type OrderFulfillment struct {
	// Unique ID that identifies the fulfillment only within this order.
	Uid string `json:"uid,omitempty"`
	// The type of the fulfillment. See [OrderFulfillmentType](#type-orderfulfillmenttype) for possible values
	Type_ string `json:"type,omitempty"`
	// The state of the fulfillment. See [OrderFulfillmentState](#type-orderfulfillmentstate) for possible values
	State string `json:"state,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 (personally identifiable information, card details, etc.).  Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character.  Values have a max length of 255 characters.  An application may 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.  See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information.
	Metadata        map[string]string                `json:"metadata,omitempty"`
	PickupDetails   *OrderFulfillmentPickupDetails   `json:"pickup_details,omitempty"`
	ShipmentDetails *OrderFulfillmentShipmentDetails `json:"shipment_details,omitempty"`
}

Contains details on how to fulfill this order.

type OrderFulfillmentPickupDetails ¶

type OrderFulfillmentPickupDetails struct {
	Recipient *OrderFulfillmentRecipient `json:"recipient,omitempty"`
	// The [timestamp](#workingwithdates) indicating when this fulfillment will expire if it is not accepted. Must be in RFC 3339 format e.g., \"2016-09-04T23:59:33.123Z\". Expiration time can only be set up to 7 days in the future. If `expires_at` is not set, this pickup fulfillment will be automatically accepted when placed.
	ExpiresAt string `json:"expires_at,omitempty"`
	// The duration of time after which an open and accepted pickup fulfillment will automatically move to the `COMPLETED` state. Must be in RFC3339 duration format e.g., \"P1W3D\".  If not set, this pickup fulfillment will remain accepted until it is canceled or completed.
	AutoCompleteDuration string `json:"auto_complete_duration,omitempty"`
	// The schedule type of the pickup fulfillment. Defaults to `SCHEDULED`. See [OrderFulfillmentPickupDetailsScheduleType](#type-orderfulfillmentpickupdetailsscheduletype) for possible values
	ScheduleType string `json:"schedule_type,omitempty"`
	// The [timestamp](#workingwithdates) that represents the start of the pickup window. Must be in RFC3339 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 RFC3339 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. Must be in RFC3339 duration format, e.g., \"P1W3D\".
	PrepTimeDuration string `json:"prep_time_duration,omitempty"`
	// A note meant to provide additional instructions about the pickup fulfillment displayed in the Square Point of Sale and set by the API.
	Note string `json:"note,omitempty"`
	// The [timestamp](#workingwithdates) indicating when the fulfillment was placed. Must be in RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\".
	PlacedAt string `json:"placed_at,omitempty"`
	// The [timestamp](#workingwithdates) indicating when the fulfillment was accepted. In RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\".
	AcceptedAt string `json:"accepted_at,omitempty"`
	// The [timestamp](#workingwithdates) indicating when the fulfillment was rejected. In RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\".
	RejectedAt string `json:"rejected_at,omitempty"`
	// The [timestamp](#workingwithdates) indicating when the fulfillment is marked as ready for pickup. In RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\".
	ReadyAt string `json:"ready_at,omitempty"`
	// The [timestamp](#workingwithdates) indicating when the fulfillment expired. In RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\".
	ExpiredAt string `json:"expired_at,omitempty"`
	// The [timestamp](#workingwithdates) indicating when the fulfillment was picked up by the recipient. In RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\".
	PickedUpAt string `json:"picked_up_at,omitempty"`
	// The [timestamp](#workingwithdates) in RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\", indicating when the fulfillment was canceled.
	CanceledAt string `json:"canceled_at,omitempty"`
	// A description of why the pickup was canceled. Max length: 100 characters.
	CancelReason string `json:"cancel_reason,omitempty"`
	// If true, indicates 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, vehicle model, etc.
	CurbsideDetails string `json:"curbside_details,omitempty"`
	// The [timestamp](#workingwithdates) in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\", indicating when the buyer arrived and is waiting for pickup.
	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 Customer 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 will 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 will result in an error.
	CustomerId string `json:"customer_id,omitempty"`
	// The display name of the fulfillment recipient.  If provided, overrides the value pulled from the customer profile indicated by `customer_id`.
	DisplayName string `json:"display_name,omitempty"`
	// The email address of the fulfillment recipient.  If provided, overrides the value pulled from the customer profile indicated by `customer_id`.
	EmailAddress string `json:"email_address,omitempty"`
	// The phone number of the fulfillment recipient.  If provided, overrides the value pulled from the customer profile indicated by `customer_id`.
	PhoneNumber string   `json:"phone_number,omitempty"`
	Address     *Address `json:"address,omitempty"`
}

Contains information on the recipient of a fulfillment.

type OrderFulfillmentShipmentDetails ¶

type OrderFulfillmentShipmentDetails struct {
	Recipient *OrderFulfillmentRecipient `json:"recipient,omitempty"`
	// The shipping carrier being used to ship this fulfillment e.g. UPS, FedEx, USPS, etc.
	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. e.g. First Class, Priority, 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](#workingwithdates) indicating when the shipment was requested. Must be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\".
	PlacedAt string `json:"placed_at,omitempty"`
	// The [timestamp](#workingwithdates) indicating when this fulfillment was moved to the `RESERVED` state. Indicates that preparation of this shipment has begun. Must be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\".
	InProgressAt string `json:"in_progress_at,omitempty"`
	// The [timestamp](#workingwithdates) indicating when this fulfillment was moved to the `PREPARED` state. Indicates that the fulfillment is packaged. Must be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\".
	PackagedAt string `json:"packaged_at,omitempty"`
	// The [timestamp](#workingwithdates) indicating when the shipment is expected to be delivered to the shipping carrier. Must be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\".
	ExpectedShippedAt string `json:"expected_shipped_at,omitempty"`
	// The [timestamp](#workingwithdates) indicating when this fulfillment was moved to the `COMPLETED`state. Indicates that the fulfillment has been given to the shipping carrier. Must be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\".
	ShippedAt string `json:"shipped_at,omitempty"`
	// The [timestamp](#workingwithdates) indicating the shipment was canceled. Must be in RFC 3339 timestamp format, e.g., \"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](#workingwithdates) indicating when the shipment failed to be completed. Must be in RFC 3339 timestamp format, e.g., \"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 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"
)

List of OrderFulfillmentType

type OrderFulfillmentUpdated ¶

type OrderFulfillmentUpdated struct {
	// The order's unique ID.
	OrderId string `json:"order_id,omitempty"`
	// Version number which is incremented each time an update is committed to the order. Orders that were not created through the API will not include a version and thus cannot be updated.  [Read more about working with versions](https://developer.squareup.com/docs/docs/orders-api/manage-orders#update-orders)
	Version int32 `json:"version,omitempty"`
	// The ID of the merchant location this order is associated with.
	LocationId string `json:"location_id,omitempty"`
	// The state of the order. See [OrderState](#type-orderstate) for possible values
	State string `json:"state,omitempty"`
	// Timestamp for when the order was created in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// 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 {
	// Unique ID that identifies the fulfillment only within this order.
	FulfillmentUid string `json:"fulfillment_uid,omitempty"`
	// The state of the fulfillment before the change. Will not be populated if the fulfillment is created with this new Order version. See [OrderFulfillmentState](#type-orderfulfillmentstate) for possible values
	OldState string `json:"old_state,omitempty"`
	// The state of the fulfillment after the change. May be equal to old_state if a non-state field was changed on the fulfillment (e.g. tracking number). See [OrderFulfillmentState](#type-orderfulfillmentstate) for possible values
	NewState string `json:"new_state,omitempty"`
}

Information about fulfillment updates.

type OrderLineItem ¶

type OrderLineItem struct {
	// 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 quantity purchased, formatted as a decimal number. For example: `\"3\"`.  Line items with a quantity of `\"0\"` will be automatically removed upon paying for or otherwise completing the order.  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 line item.
	Note string `json:"note,omitempty"`
	// The `CatalogItemVariation` id applied to this line item.
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The name of the variation applied to this line item.
	VariationName string `json:"variation_name,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 (personally identifiable information, card details, etc.).  Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character.  Values have a max length of 255 characters.  An application may 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.  See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information.
	Metadata map[string]string `json:"metadata,omitempty"`
	// The `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` will be 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` will be 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"`
	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"`
}

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 {
	// Unique ID that identifies the applied discount only within this order.
	Uid string `json:"uid,omitempty"`
	// The `uid` of the discount the applied discount represents. 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 will automatically have 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 will automatically be computed based on participating line items.

type OrderLineItemAppliedTax ¶

type OrderLineItemAppliedTax struct {
	// 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.  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 new `OrderLineItemAppliedTax`s.
	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 {
	// Unique ID that identifies the discount only within this order.
	Uid string `json:"uid,omitempty"`
	// The catalog object id referencing `CatalogDiscount`.
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The discount's name.
	Name string `json:"name,omitempty"`
	// The type of the discount.  Discounts that don't reference a catalog object ID must have a type of `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values
	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 (personally identifiable information, card details, etc.).  Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character.  Values have a max length of 255 characters.  An application may 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.  See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information.
	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. See [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for possible values
	Scope string `json:"scope,omitempty"`
	// The reward identifiers 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 identifier of a `pricing rule` 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 OrderLineItemModifier ¶

type OrderLineItemModifier struct {
	// Unique ID that identifies the modifier only within this order.
	Uid string `json:"uid,omitempty"`
	// The catalog object id referencing `CatalogModifier`.
	CatalogObjectId string `json:"catalog_object_id,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"`
}

A CatalogModifier(#type-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 manual and automatic application to a line item. For more information, see [Apply Taxes and Discounts](/docs/orders-api/apply-taxes-and-discounts).

type OrderLineItemPricingBlocklistsBlockedDiscount ¶

type OrderLineItemPricingBlocklistsBlockedDiscount struct {
	// 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 {
	// 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 {
	// Unique ID that identifies the tax only within this order.
	Uid string `json:"uid,omitempty"`
	// The catalog object id referencing `CatalogTax`.
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The tax's name.
	Name string `json:"name,omitempty"`
	// Indicates the calculation method used to apply the tax. See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values
	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 (personally identifiable information, card details, etc.).  Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character.  Values have a max length of 255 characters.  An application may 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.  See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information.
	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 will only apply 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. See [OrderLineItemTaxScope](#type-orderlineitemtaxscope) for possible values
	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/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 pre-configured [pricing rules](/reference/square/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 like `\"1.0\"` and `\"1.1\"`, but not `\"1.01\"`.  Min: 0. Max: 5.
	Precision int32 `json:"precision,omitempty"`
}

Contains the measurement unit for a quantity and a precision which specifies the number of digits after the decimal point for decimal quantities.

type OrderReturn ¶

type OrderReturn struct {
	// Unique ID that identifies the return only within this order.
	Uid string `json:"uid,omitempty"`
	// Order which contains the original sale of these returned line items. This will be unset for unlinked returns.
	SourceOrderId string `json:"source_order_id,omitempty"`
	// Collection of line items which are being returned.
	ReturnLineItems []OrderReturnLineItem `json:"return_line_items,omitempty"`
	// Collection of service charges which are being returned.
	ReturnServiceCharges []OrderReturnServiceCharge `json:"return_service_charges,omitempty"`
	// 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"`
	// 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"`
	RoundingAdjustment *OrderRoundingAdjustment `json:"rounding_adjustment,omitempty"`
	ReturnAmounts      *OrderMoneyAmounts       `json:"return_amounts,omitempty"`
}

The set of line items, service charges, taxes, discounts, tips, etc. being returned in an Order.

type OrderReturnDiscount ¶

type OrderReturnDiscount struct {
	// Unique ID that identifies the return discount only within this order.
	Uid string `json:"uid,omitempty"`
	// `uid` of the Discount from the Order which contains the original application of this discount.
	SourceDiscountUid string `json:"source_discount_uid,omitempty"`
	// The catalog object id referencing `CatalogDiscount`.
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The discount's name.
	Name string `json:"name,omitempty"`
	// The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`.  Discounts that don't reference a catalog object ID must have a type of `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values
	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 will generate references in `applied_discounts` on all `OrderReturnLineItem`s. For `LINE_ITEM` scoped discounts, the discount will only apply to `OrderReturnLineItem`s with references in their `applied_discounts` field. See [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for possible values
	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 {
	// Unique identifier for this return line item entry.
	Uid string `json:"uid,omitempty"`
	// `uid` of the LineItem 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 returned line item.
	Note string `json:"note,omitempty"`
	// The `CatalogItemVariation` id applied to this returned line item.
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The name of the variation applied to this returned line item.
	VariationName string `json:"variation_name,omitempty"`
	// The `CatalogModifier`s applied to this line item.
	ReturnModifiers []OrderReturnLineItemModifier `json:"return_modifiers,omitempty"`
	// The list of references to `OrderReturnTax` entities applied to the returned line item. Each `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level `OrderReturnTax` applied to the returned line item. On reads, the amount applied is populated.
	AppliedTaxes []OrderLineItemAppliedTax `json:"applied_taxes,omitempty"`
	// The list of references to `OrderReturnDiscount` entities applied to the returned line item. Each `OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level `OrderReturnDiscount` applied to the returned line item. On reads, the amount applied 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 line item being returned in an Order.

type OrderReturnLineItemModifier ¶

type OrderReturnLineItemModifier struct {
	// Unique ID that identifies the return modifier only within this order.
	Uid string `json:"uid,omitempty"`
	// `uid` of the Modifier from the LineItem from the Order which contains the original sale of this line item modifier.
	SourceModifierUid string `json:"source_modifier_uid,omitempty"`
	// The catalog object id referencing `CatalogModifier`.
	CatalogObjectId string `json:"catalog_object_id,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"`
}

A line item modifier being returned.

type OrderReturnServiceCharge ¶

type OrderReturnServiceCharge struct {
	// Unique ID that identifies the return service charge only within this order.
	Uid string `json:"uid,omitempty"`
	// `uid` of the Service Charge from the Order containing the original charge of the 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 `CatalogServiceCharge`.
	CatalogObjectId string `json:"catalog_object_id,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%.  Exactly one 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 after which to apply the service charge. See [OrderServiceChargeCalculationPhase](#type-orderservicechargecalculationphase) for possible values
	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 amount applied is populated.
	AppliedTaxes []OrderLineItemAppliedTax `json:"applied_taxes,omitempty"`
}

Represents the service charge applied to the original order.

type OrderReturnTax ¶

type OrderReturnTax struct {
	// Unique ID that identifies the return tax only within this order.
	Uid string `json:"uid,omitempty"`
	// `uid` of the Tax from the Order which contains the original charge of this tax.
	SourceTaxUid string `json:"source_tax_uid,omitempty"`
	// The catalog object id referencing `CatalogTax`.
	CatalogObjectId string `json:"catalog_object_id,omitempty"`
	// The tax's name.
	Name string `json:"name,omitempty"`
	// Indicates the calculation method used to apply the tax. See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values
	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 will only apply to `OrderReturnLineItem`s with references in their `applied_discounts` field. See [OrderLineItemTaxScope](#type-orderlineitemtaxscope) for possible values
	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 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 may 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 {
	// 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 account is smaller than the lowest physical denomination of currency.

type OrderServiceCharge ¶

type OrderServiceCharge struct {
	// 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`.
	CatalogObjectId string `json:"catalog_object_id,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. See [OrderServiceChargeCalculationPhase](#type-orderservicechargecalculationphase) for possible values
	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 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` will be 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 (personally identifiable information, card details, etc.).  Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character.  Values have a max length of 255 characters.  An application may 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.  See [Metadata](https://developer.squareup.com/docs/build-basics/metadata) for more information.
	Metadata map[string]string `json:"metadata,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/docs/orders-api/how-it-works#how-totals-are-calculated)

const (
	SUBTOTAL_PHASE_OrderServiceChargeCalculationPhase OrderServiceChargeCalculationPhase = "SUBTOTAL_PHASE"
	TOTAL_PHASE_OrderServiceChargeCalculationPhase    OrderServiceChargeCalculationPhase = "TOTAL_PHASE"
)

List of OrderServiceChargeCalculationPhase

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

List of OrderState

type OrderUpdated ¶

type OrderUpdated struct {
	// The order's unique ID.
	OrderId string `json:"order_id,omitempty"`
	// Version number which is incremented each time an update is committed to the order. Orders that were not created through the API will not include a version and thus cannot be updated.  [Read more about working with versions](https://developer.squareup.com/docs/docs/orders-api/manage-orders#update-orders)
	Version int32 `json:"version,omitempty"`
	// The ID of the merchant location this order is associated with.
	LocationId string `json:"location_id,omitempty"`
	// The state of the order. See [OrderState](#type-orderstate) for possible values
	State string `json:"state,omitempty"`
	// Timestamp for when the order was created in RFC 3339 format.
	CreatedAt string `json:"created_at,omitempty"`
	// 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 Order(#type-order)s 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 Calculates an Order(#type-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) CreateOrder ¶

func (a *OrdersApiService) CreateOrder(ctx context.Context, body CreateOrderRequest) (CreateOrderResponse, *http.Response, error)

OrdersApiService CreateOrder Creates a new Order(#type-order) which can include information on products for purchase and settings to apply to the purchase. To pay for a created order, please refer to the [Pay for Orders](/orders-api/pay-for-orders) guide. You can modify open orders using the [UpdateOrder](#endpoint-orders-updateorder) 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](#type-order) using one or more approved [payments](#type-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](#endpoint-payments-createpayment). Any approved payments that reference the same `order_id` not specified in the `payment_ids` will be canceled. - Be approved with [delayed capture](/payments-api/take-payments#delayed-capture). Using a delayed capture payment with PayOrder will complete 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(#type-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 (e.g. Point of Sale, Invoices, Connect APIs, etc). SearchOrders requests need to specify which locations to search and define a [`SearchOrdersQuery`](#type-searchordersquery) object which controls how to sort or filter the results. Your SearchOrdersQuery can: Set filter criteria. Set sort order. Determine whether to return results as complete Order objects, or as OrderEntry(#type-orderentry) objects. Note that details for orders processed with Square Point of Sale while in offline mode may 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(#type-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](/orders-api/manage-orders#sparse-order-objects) containing only the fields to update and the version the update is being applied to. - If deleting fields, the [dot notation paths](/orders-api/manage-orders#on-dot-notation) identifying fields to clear. To pay for an order, please refer to the [Pay for Orders](/orders-api/pay-for-orders) guide.

@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 PayOrderRequest ¶

type PayOrderRequest struct {
	// A value you specify that uniquely identifies this request among requests you've sent. If you're unsure whether a particular payment request was completed successfully, you can reattempt it with the same idempotency key without worrying about duplicate payments.  See [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency) for more information.
	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` 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](#endpoint-payorder) 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](#endpoint-payorder) 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"`
	// 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, 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. This field is read-only.  Current values include `CANCEL`.
	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`.
	SourceType  string              `json:"source_type,omitempty"`
	CardDetails *CardPaymentDetails `json:"card_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 `Customer` ID of the customer associated with the payment.
	CustomerId string `json:"customer_id,omitempty"`
	// An optional ID of the employee associated with taking the payment.
	EmployeeId string `json:"employee_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"`
	// 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"`
}

Represents a payment processed by the Square API.

type PaymentOptions ¶

type PaymentOptions struct {
	// Indicates whether the Payment objects created from this `TerminalCheckout` will automatically be `COMPLETED` or left in an `APPROVED` state for later modification.
	Autocomplete bool `json:"autocomplete,omitempty"`
}

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"`
	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"`
}

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. If you set `autocomplete` to `false` when creating a payment, you can cancel the payment using this endpoint.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param paymentId The `payment_id` identifying the payment to be canceled.

@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, paymentId string) (CompletePaymentResponse, *http.Response, error)

PaymentsApiService CompletePayment Completes (captures) a payment. By default, payments are set to complete immediately after they are created. If you set `autocomplete` to `false` when creating a payment, you can complete (capture) the payment using this endpoint.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@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 Charges a payment source (for example, a card represented by customer's card on file or a card nonce). In addition to the payment source, the request must include the amount to accept for the payment. There are several optional parameters that you can include in the request (for example, tip money, whether to autocomplete the payment, or a reference ID to correlate this payment with another system). The `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required to enable application fees.

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

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 an inventory 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 (
	API_ProductType ProductType = "TERMINAL_API"
)

List of ProductType

type PublishInvoiceRequest ¶

type PublishInvoiceRequest struct {
	// The version of the `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/docs/working-with-apis/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 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` 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"`
	// 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`). See [RefundStatus](#type-refundstatus) for possible values
	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.  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.
	PaymentId string `json:"payment_id"`
	// A description of the reason for the refund.
	Reason string `json:"reason,omitempty"`
}

Refunds a 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 fields that are included in the response body of a request to the [RefundPayment](#endpoint-refunds-refundpayment) endpoint. 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 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.

@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](#endpoint-registerdomain) endpoint.

type RegisterDomainResponse ¶

type RegisterDomainResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// Status of the domain registration.  See `RegisterDomainResponseStatus` for possible values. See [RegisterDomainResponseStatus](#type-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](#endpoint-registerdomain) endpoint. Either `errors` or `status` will be present in a given response (never both).

type RegisterDomainResponseStatus ¶

type RegisterDomainResponseStatus string

RegisterDomainResponseStatus : The status of domain registration.

const (
	PENDING_RegisterDomainResponseStatus  RegisterDomainResponseStatus = "PENDING"
	VERIFIED_RegisterDomainResponseStatus RegisterDomainResponseStatus = "VERIFIED"
)

List of RegisterDomainResponseStatus

type RemoveDisputeEvidenceRequest ¶

type RemoveDisputeEvidenceRequest struct {
}

Defines the parameters for a `RemoveDisputeEvidence` request.

type RemoveDisputeEvidenceResponse ¶

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

Defines the fields in a `RemoveDisputeEvidence` response.

type RemoveGroupFromCustomerRequest ¶

type RemoveGroupFromCustomerRequest struct {
}

Defines the fields that are included in the request body of a request to the [RemoveGroupFromCustomer](#endpoint-removegroupfromcustomer) 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](#endpoint-removegroupfromcustomer) endpoint.

type RenewTokenRequest ¶

type RenewTokenRequest struct {
	// The token you want to renew.
	AccessToken string `json:"access_token,omitempty"`
}

type RenewTokenResponse ¶

type RenewTokenResponse struct {
	// The renewed access token. This value might be different from the `access_token` you provided in your request. You provide this token in a header with every request to Connect API endpoints. See [Request and response headers](https://developer.squareup.com/docs/api/connect/v2/#requestandresponseheaders) for the format of this header.
	AccessToken string `json:"access_token,omitempty"`
	// This value is always _bearer_.
	TokenType string `json:"token_type,omitempty"`
	// The date when 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 the merchant subscription associated with the authorization. Only present if the merchant signed up for a subscription during authorization..
	SubscriptionId string `json:"subscription_id,omitempty"`
	// __LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization.
	PlanId string `json:"plan_id,omitempty"`
}

type RetrieveBookingRequest ¶

type RetrieveBookingRequest struct {
}

type RetrieveBookingResponse ¶

type RetrieveBookingResponse struct {
	Booking *Booking `json:"booking,omitempty"`
	// Any 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"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

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 object, as follows:  If the `object` field of the response contains a `CatalogItem`, its associated `CatalogCategory`, `CatalogTax`, `CatalogImage` and `CatalogModifierList` objects will be returned in the `related_objects` field of the response. If the `object` 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`s.
	CatalogVersion int64 `json:"catalog_version,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 RetrieveCustomerGroupRequest ¶

type RetrieveCustomerGroupRequest struct {
}

Defines the fields that can be provided in a request to the [RetrieveCustomerGroup](#endpoint-retrievecustomergroup) 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](#endpoint-retrievecustomergroup) endpoint. One of `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. One of `errors` or `customer` is present in a given response (never both).

type RetrieveCustomerSegmentRequest ¶

type RetrieveCustomerSegmentRequest struct {
}

Defines the valid parameters for requests to __RetrieveCustomerSegmentRequest__.

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 included in the response body for requests to __RetrieveCustomerSegment__. One of `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 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` 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` 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/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/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 RetrieveLocationRequest ¶

type RetrieveLocationRequest struct {
}

Defines the fields that are included in the request body for the __RetrieveLocation__ endpoint.

type RetrieveLocationResponse ¶

type RetrieveLocationResponse struct {
	// Information on errors encountered during the request.
	Errors   []ModelError `json:"errors,omitempty"`
	Location *Location    `json:"location,omitempty"`
}

Defines the fields that the [RetrieveLocation](#endpoint-retrievelocation) endpoint returns in a response.

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 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 RetrieveMerchantRequest ¶

type RetrieveMerchantRequest struct {
}

Request object for the [RetrieveMerchant](#endpoint-retrievemerchant) 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](#endpoint-retrieveMerchant) endpoint.

type RetrieveObsMigrationProfileRequest ¶

type RetrieveObsMigrationProfileRequest struct {
}

type RetrieveObsMigrationProfileResponse ¶

type RetrieveObsMigrationProfileResponse struct {
	// Indicates whether the seller has enabled the COVID banner (`true`) or not (`false`).
	BannerEnabled bool `json:"banner_enabled,omitempty"`
	// The text appearing on the COVID banner.
	BannerText string `json:"banner_text,omitempty"`
	// The text of the label of the CTA button beneath the banner.
	BannerCtaText string `json:"banner_cta_text,omitempty"`
	// The URL to link to when the CTA button is clicked.
	BannerCtaUrl string `json:"banner_cta_url,omitempty"`
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
}

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 RetrieveSubscriptionRequest ¶

type RetrieveSubscriptionRequest struct {
}

Defines parameters in a [RetrieveSubscription](#endpoint-subscriptions-retrievesubscription) endpoint request.

type RetrieveSubscriptionResponse ¶

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

Defines the fields that are included in the response from the [RetrieveSubscription](#endpoint-subscriptions-retrievesubscription) endpoint.

type RetrieveTeamMemberBookingProfileRequest ¶

type RetrieveTeamMemberBookingProfileRequest struct {
}

type RetrieveTeamMemberBookingProfileResponse ¶

type RetrieveTeamMemberBookingProfileResponse struct {
	TeamMemberBookingProfile *TeamMemberBookingProfile `json:"team_member_booking_profile,omitempty"`
	// Any 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 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](#endpont-retrievetransaction) endpoint. One of `errors` or `transaction` is present in a given response (never both).

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 RevokeTokenRequest ¶

type RevokeTokenRequest struct {
	// The Square issued ID for your application, available from the [application dashboard](https://connect.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"`
}

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 See [RiskEvaluationRiskLevel](#type-riskevaluationrisklevel) for possible values
	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 SearchAvailabilityFilter ¶

type SearchAvailabilityFilter struct {
	StartAtRange *TimeRange `json:"start_at_range"`
	// The query expression to search for availabilities matching the specified seller location IDs. This query expression is not applicable when `booking_id` is present.
	LocationId string `json:"location_id,omitempty"`
	// The list of segment filters to apply. A query with `n` segment filters returns availabilities with `n` segments per availability. It is not applicable when `booking_id` is present.
	SegmentFilters []SegmentFilter `json:"segment_filters,omitempty"`
	// The query expression to search for availabilities for an existing booking by matching the specified `booking_id` value. This is commonly used to reschedule an appointment. If this expression is specified, the `location_id` and `segment_filters` expressions are not allowed.
	BookingId string `json:"booking_id,omitempty"`
}

A query filter to search for availabilities by.

type SearchAvailabilityQuery ¶

type SearchAvailabilityQuery struct {
	Filter *SearchAvailabilityFilter `json:"filter"`
}

Query conditions to search for availabilities of bookings.

type SearchAvailabilityRequest ¶

type SearchAvailabilityRequest struct {
	Query *SearchAvailabilityQuery `json:"query"`
}

type SearchAvailabilityResponse ¶

type SearchAvailabilityResponse struct {
	// List of slots available for booking.
	Availabilities []Availability `json:"availabilities,omitempty"`
	// Any 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. See [SearchCatalogItemsRequestStockLevel](#type-searchcatalogitemsrequeststocklevel) for possible values
	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`). See [SortOrder](#type-sortorder) for possible values
	SortOrder string `json:"sort_order,omitempty"`
	// The product types query expression to return items or item variations having the specified product types. See [CatalogItemProductType](#type-catalogitemproducttype) for possible values
	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` endpoint.
	CustomAttributeFilters []CustomAttributeFilter `json:"custom_attribute_filters,omitempty"`
}

Defines the request body for the [SearchCatalogItems](#endpoint-Catalog-SearchCatalogItems) 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](#endpoint-Catalog-SearchCatalogItems) 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/basics/api101/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
	// The desired set of object types to appear in the search results. See [CatalogObjectType](#type-catalogobjecttype) for possible values
	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 object, as follows:  If a CatalogItem is returned in the object field of the response, its associated CatalogCategory, CatalogTax objects, CatalogImage objects and CatalogModifierList objects will be included in the `related_objects` field of the response.  If a CatalogItemVariation is returned in the object field of the response, its parent CatalogItem will be included in the `related_objects` field of the response.
	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"`
}

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/basics/api101/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.  See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.
	Cursor string `json:"cursor,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 100, it will be ignored.
	Limit int64          `json:"limit,omitempty"`
	Query *CustomerQuery `json:"query,omitempty"`
}

Defines the fields included in the request body for the SearchCustomers endpoint.

type SearchCustomersResponse ¶

type SearchCustomersResponse struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// An array of `Customer` objects that match a query.
	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.  See the [Pagination guide](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 SearchCustomers endpoint. One of `errors` or `customers` is present in a given response (never both).

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/docs/working-with-apis/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/docs/working-with-apis/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.
	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/docs/basics/api101/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/docs/basics/api101/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/docs/basics/api101/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/docs/basics/api101/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.
	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/docs/basics/api101/pagination).
	Cursor string `json:"cursor,omitempty"`
}

A request to search for loyalty rewards.

type SearchLoyaltyRewardsRequestLoyaltyRewardQuery ¶

type SearchLoyaltyRewardsRequestLoyaltyRewardQuery struct {
	// The ID of the `loyalty account` to which the loyalty reward belongs.
	LoyaltyAccountId string `json:"loyalty_account_id"`
	// The status of the loyalty reward. See [LoyaltyRewardStatus](#type-loyaltyrewardstatus) for possible values
	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 {
	// List of customer IDs to filter by.  Max: 10 customer IDs.
	CustomerIds []string `json:"customer_ids,omitempty"`
}

Filter based on Order `customer_id` and any Tender `customer_id` associated with the Order. Does not filter based on the [FulfillmentRecipient](#type-orderfulfillmentrecipient) `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 also set the `sort_field` in [OrdersSort](#type-searchorderordersort) to the same field you filter for. For example, if you set the `CLOSED_AT` field in DateTimeFilter, you must also set the `sort_field` in SearchOrdersSort to `CLOSED_AT`. Otherwise, SearchOrders will throw an error. [Learn more about filtering orders by time range](/orders-api/manage-orders#important-note-on-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 will be ANDed together.

type SearchOrdersFulfillmentFilter ¶

type SearchOrdersFulfillmentFilter struct {
	// List of `fulfillment types` to filter for. Will return orders if any of its fulfillments match any of the fulfillment types listed in this field. See [OrderFulfillmentType](#type-orderfulfillmenttype) for possible values
	FulfillmentTypes []string `json:"fulfillment_types,omitempty"`
	// List of `fulfillment states` to filter for. Will return orders if any of its fulfillments match any of the fulfillment states listed in this field. See [OrderFulfillmentState](#type-orderfulfillmentstate) for possible values
	FulfillmentStates []string `json:"fulfillment_states,omitempty"`
}

Filter based on [Order Fulfillment](#type-orderfulfillment) 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.  Min: 1 location IDs.  Max: 10 location IDs.
	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 your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.
	Cursor string             `json:"cursor,omitempty"`
	Query  *SearchOrdersQuery `json:"query,omitempty"`
	// 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.  Default: `500`
	Limit int32 `json:"limit,omitempty"`
	// Boolean that controls the format of the search results. If `true`, SearchOrders will return “OrderEntry“ objects. If `false`, SearchOrders will return complete Order objects.  Default: `false`.
	ReturnEntries bool `json:"return_entries,omitempty"`
}

The request does not have any required fields. When given no query criteria, SearchOrders will return all results for all of the merchant’s locations. When fetching additional pages using a `cursor`, the `query` must be equal to the `query` used to fetch the first page of results.

type SearchOrdersResponse ¶

type SearchOrdersResponse struct {
	// List of `OrderEntries` that fit the query conditions. Populated only if `return_entries` was set to `true` in the request.
	OrderEntries []OrderEntry `json:"order_entries,omitempty"`
	// List of `Order` objects that match query conditions. Populated only if `return_entries` in the request is set to `false`.
	Orders []Order `json:"orders,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/basics/api101/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
	// `Errors` encountered during the search.
	Errors []ModelError `json:"errors,omitempty"`
}

Only one of `order_entries` or `orders` fields will be set, depending on whether `return_entries` was set on the SearchOrdersRequest(#type-searchorderrequest).

type SearchOrdersSort ¶

type SearchOrdersSort struct {
	// The field to sort by.  __Important:__ When using a `DateTimeFilter`, `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 will return an error.  Default: `CREATED_AT`. See [SearchOrdersSortField](#type-searchorderssortfield) for possible values
	SortField string `json:"sort_field"`
	// The chronological order in which results are returned. Defaults to `DESC`. See [SortOrder](#type-sortorder) for possible values
	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 `Source` `name`. Will return any orders with with a `source.name` that matches any of the listed source names.  Max: 10 source names.
	SourceNames []string `json:"source_names,omitempty"`
}

Filter based on order `source` information.

type SearchOrdersStateFilter ¶

type SearchOrdersStateFilter struct {
	// States to filter for. See [OrderState](#type-orderstate) for possible values
	States []string `json:"states"`
}

Filter by current Order `state`.

type SearchShiftsRequest ¶

type SearchShiftsRequest struct {
	Query *ShiftQuery `json:"query,omitempty"`
	// number of resources in a page (200 by default).
	Limit int32 `json:"limit,omitempty"`
	// 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"`
	// 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. Contains the requested `Shift` objects. May 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 customer.
	CustomerIds []string `json:"customer_ids,omitempty"`
	// A filter to select subscriptions based the location.
	LocationIds []string `json:"location_ids,omitempty"`
}

Represents a set of SearchSubscriptionsQuery filters used to limit the set of Subscriptions returned by SearchSubscriptions.

type SearchSubscriptionsQuery ¶

type SearchSubscriptionsQuery struct {
	Filter *SearchSubscriptionsFilter `json:"filter,omitempty"`
}

Represents a query (including filtering criteria) used to search for subscriptions.

type SearchSubscriptionsRequest ¶

type SearchSubscriptionsRequest struct {
	// 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/docs/working-with-apis/pagination).
	Cursor string `json:"cursor,omitempty"`
	// The upper limit on the number of subscriptions to return  in the response.   Default: `200`
	Limit int32                     `json:"limit,omitempty"`
	Query *SearchSubscriptionsQuery `json:"query,omitempty"`
}

Defines parameters in a [SearchSubscriptions](#endpoint-subscriptions-searchsubscriptions) endpoint request.

type SearchSubscriptionsResponse ¶

type SearchSubscriptionsResponse struct {
	// Information about errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The search result.
	Subscriptions []Subscription `json:"subscriptions,omitempty"`
	// When a response is truncated, it includes a cursor that you can  use in a subsequent request to fetch the next set of subscriptions.  If empty, this is the final response.  For more information, see [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination).
	Cursor string `json:"cursor,omitempty"`
}

Defines the fields that are included in the response from the [SearchSubscriptions](#endpoint-subscriptions-searchsubscriptions) endpoint.

type SearchTeamMembersFilter ¶

type SearchTeamMembersFilter struct {
	// When present, filter by team members assigned to the specified locations. When empty, include team members assigned to any location.
	LocationIds []string `json:"location_ids,omitempty"`
	// When present, filter by team members who match the given status. When empty, include team members of all statuses. See [TeamMemberStatus](#type-teammemberstatus) for possible values
	Status string `json:"status,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 (25 by default).
	Limit int32 `json:"limit,omitempty"`
	// The opaque cursor for fetching the next page. Read about [pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) with Square APIs for more information.
	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. Read about [pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) with Square APIs for more information.
	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 SearchTerminalCheckoutsRequest ¶

type SearchTerminalCheckoutsRequest struct {
	Query *TerminalCheckoutQuery `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/basics/api101/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 SearchTerminalCheckoutsResponse ¶

type SearchTerminalCheckoutsResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The requested search result of `TerminalCheckout`s.
	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/basics/api101/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 to retrieve the next set of results for the original query.
	Cursor string `json:"cursor,omitempty"`
	// Limit the number of results returned for a single request.
	Limit int32 `json:"limit,omitempty"`
}

type SearchTerminalRefundsResponse ¶

type SearchTerminalRefundsResponse struct {
	// Information on errors encountered during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The requested search result of `TerminalRefund`s.
	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/basics/api101/pagination) for more information.
	Cursor string `json:"cursor,omitempty"`
}

type SegmentFilter ¶

type SegmentFilter struct {
	// The ID of the `CatalogItemVariation` 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 appointment segments by.

type Shift ¶

type Shift struct {
	// 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. Should be based on where the employee clocked in.
	LocationId string `json:"location_id,omitempty"`
	// Read-only convenience value that is calculated from the location based on `location_id`. Format: the IANA Timezone Database identifier for the location timezone.
	Timezone string `json:"timezone,omitempty"`
	// RFC 3339; shifted to location timezone + offset. Precision up to the minute is respected; seconds are truncated.
	StartAt string `json:"start_at"`
	// RFC 3339; shifted to 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 any paid or unpaid breaks that were taken during this shift.
	Breaks []ModelBreak `json:"breaks,omitempty"`
	// Describes working state of the current `Shift`. See [ShiftStatus](#type-shiftstatus) for possible values
	Status string `json:"status,omitempty"`
	// Used for resolving concurrency issues; request will fail if version provided does not match server version at time of 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"`
}

A record of the hourly rate, start, and end times for a single work shift for an employee. May 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`. See [ShiftFilterStatus](#type-shiftfilterstatus) for possible values
	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. Includes filter and sort options.

type ShiftSort ¶

type ShiftSort struct {
	// The field to sort on. See [ShiftSortField](#type-shiftsortfield) for possible values
	Field string `json:"field,omitempty"`
	// The order in which results are returned. Defaults to DESC. See [SortOrder](#type-sortorder) for possible values
	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. Square labor-reporting UIs may group shifts together by title.
	Title      string `json:"title,omitempty"`
	HourlyRate *Money `json:"hourly_rate,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. See [ShiftWorkdayMatcher](#type-shiftworkdaymatcher) for possible values
	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 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 `Product` type for the application. See [Product](#type-product) for possible values
	Product string `json:"product,omitempty"`
	// Read-only Square ID assigned to the application. Only used for `Product` type `EXTERNAL_API`.
	ApplicationId string `json:"application_id,omitempty"`
	// Read-only display name assigned to the application (e.g. `\"Custom Application\"`, `\"Square POS 4.74 for Android\"`).
	Name string `json:"name,omitempty"`
}

Provides information about the application used to generate a change.

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 associated `subscription plan`.
	PlanId string `json:"plan_id,omitempty"`
	// The ID of the associated `customer` profile.
	CustomerId string `json:"customer_id,omitempty"`
	// The start date of the subscription, in YYYY-MM-DD format (for example, 2013-01-15).
	StartDate string `json:"start_date,omitempty"`
	// The subscription cancellation date, in YYYY-MM-DD format (for example, 2013-01-15). On this date, the subscription status changes  to `CANCELED` and the subscription billing stops.  If you don't set this field, the subscription plan dictates if and  when subscription ends.   You cannot update this field, you can only clear it.
	CanceledDate string `json:"canceled_date,omitempty"`
	// The current status of the subscription. See [SubscriptionStatus](#type-subscriptionstatus) for possible values
	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` created for the  subscription, listed in order when the invoices were created  (oldest 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 `customer](#type-customer) [card` that is charged for the subscription.
	CardId string `json:"card_id,omitempty"`
	// The date up to which the customer is invoiced for the subscription, in YYYY-MM-DD format (for example, 2013-01-15).  After the invoice is paid 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 customer gets an invoice (or charged the card) on May 1. For the monthly billing scenario, this date is then set to May 31.
	PaidUntilDate string `json:"paid_until_date,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"`
}

Represents a customer subscription to a subscription plan. For an overview of the `Subscription` type, see [Subscription object](/docs/subscriptions-api/overview#subscription-object-overview).

type SubscriptionCadence ¶

type SubscriptionCadence string

SubscriptionCadence : Determines the billing cadence of a `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. See [SubscriptionEventSubscriptionEventType](#type-subscriptioneventsubscriptioneventtype) for possible values
	SubscriptionEventType string `json:"subscription_event_type"`
	// The date, in YYYY-MM-DD format (for example, 2013-01-15), when the subscription event went into effect.
	EffectiveDate string `json:"effective_date"`
	// The ID of the subscription plan associated with the subscription.
	PlanId string `json:"plan_id"`
}

Describes changes to subscription and billing states.

type SubscriptionEventSubscriptionEventType ¶

type SubscriptionEventSubscriptionEventType string

SubscriptionEventSubscriptionEventType : The possible subscription event types.

const (
	START_SUBSCRIPTION_SubscriptionEventSubscriptionEventType SubscriptionEventSubscriptionEventType = "START_SUBSCRIPTION"
	PLAN_CHANGE_SubscriptionEventSubscriptionEventType        SubscriptionEventSubscriptionEventType = "PLAN_CHANGE"
	STOP_SUBSCRIPTION_SubscriptionEventSubscriptionEventType  SubscriptionEventSubscriptionEventType = "STOP_SUBSCRIPTION"
)

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. See [SubscriptionCadence](#type-subscriptioncadence) for possible values
	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"`
	// 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"`
}

Describes a phase in a subscription plan. For more information, see [Set Up and Manage a Subscription Plan](/docs/subscriptions-api/setup-plan).

type SubscriptionStatus ¶

type SubscriptionStatus string

SubscriptionStatus : Possible subscription status values.

const (
	DEFAULT_SUBSCRIPTION_STATUS_DO_NOT_USE_SubscriptionStatus SubscriptionStatus = "DEFAULT_SUBSCRIPTION_STATUS_DO_NOT_USE"
	PENDING_SubscriptionStatus                                SubscriptionStatus = "PENDING"
	ACTIVE_SubscriptionStatus                                 SubscriptionStatus = "ACTIVE"
	CANCELED_SubscriptionStatus                               SubscriptionStatus = "CANCELED"
)

List of SubscriptionStatus

type SubscriptionsApiListSubscriptionEventsOpts ¶

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

type SubscriptionsApiService ¶

type SubscriptionsApiService service

func (*SubscriptionsApiService) CancelSubscription ¶

func (a *SubscriptionsApiService) CancelSubscription(ctx context.Context, subscriptionId string) (CancelSubscriptionResponse, *http.Response, error)

SubscriptionsApiService CancelSubscription Sets the `canceled_date` field to the end of the active billing period. After this date, the 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) CreateSubscription ¶

func (a *SubscriptionsApiService) CreateSubscription(ctx context.Context, body CreateSubscriptionRequest) (CreateSubscriptionResponse, *http.Response, error)

SubscriptionsApiService CreateSubscription Creates a subscription for a customer to a subscription plan. If you provide a card on file in the request, Square charges the card for the subscription. Otherwise, Square bills 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.

@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) ListSubscriptionEvents ¶

func (a *SubscriptionsApiService) ListSubscriptionEvents(ctx context.Context, subscriptionId string, localVarOptionals *SubscriptionsApiListSubscriptionEventsOpts) (ListSubscriptionEventsResponse, *http.Response, error)

func (*SubscriptionsApiService) RetrieveSubscription ¶

func (a *SubscriptionsApiService) RetrieveSubscription(ctx context.Context, subscriptionId string) (RetrieveSubscriptionResponse, *http.Response, error)

SubscriptionsApiService RetrieveSubscription Retrieves 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 to retrieve.

@return RetrieveSubscriptionResponse

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. For more information, see [Retrieve subscriptions](/docs/subscriptions-api/overview#retrieve-subscriptions).

@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) UpdateSubscription ¶

func (a *SubscriptionsApiService) UpdateSubscription(ctx context.Context, body UpdateSubscriptionRequest, subscriptionId string) (UpdateSubscriptionResponse, *http.Response, error)

SubscriptionsApiService UpdateSubscription Updates a subscription. You can set, modify, and clear the `subscription` field 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 subscriptionId The ID for the subscription to update.

@return UpdateSubscriptionResponse

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 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 will be returned on successful creates. This process is non-transactional and will process as much of the request as is possible. If one of the creates in the request cannot be successfully processed, the request will NOT be marked as failed, but the body of the response will contain explicit error information for this particular create. Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#bulkcreateteammembers).

@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 will be returned on successful updates. This process is non-transactional and will process as much of the request as is possible. If one of the updates in the request cannot be successfully processed, the request will NOT be marked as failed, but the body of the response will contain explicit error information for this particular update. Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#bulkupdateteammembers).

@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` will be returned on successful creates. You must provide the following values in your request to this endpoint: - `given_name` - `family_name` Learn about [Troubleshooting the Teams API](/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 Retrieve a `TeamMember` object for the given `TeamMember.id`. Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#retrieveteammember).

@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 Retrieve a `WageSetting` object for a team member specified by `TeamMember.id`. Learn about [Troubleshooting the Teams API](/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 to retrieve wage setting for

@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 to be returned can be filtered by: - location IDs **and** - `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` will be returned on successful updates. Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#updateteammember).

@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` will be returned upon successful update. Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#updatewagesetting).

@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 the `WageSetting` object for.

@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. See [TeamMemberStatus](#type-teammemberstatus) for possible values
	Status string `json:"status,omitempty"`
	// The given (i.e., first) name associated with the team member.
	GivenName string `json:"given_name,omitempty"`
	// The family (i.e., 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. Examples: +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. Ex: \"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. Ex: \"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. See [TeamMemberAssignedLocationsAssignmentType](#type-teammemberassignedlocationsassignmenttype) for possible values
	AssignmentType string `json:"assignment_type,omitempty"`
	// The 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 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` 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 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 {
	// UUID for this object.
	Id string `json:"id,omitempty"`
	// The `Team Member` 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"`
}

The hourly wage rate that a team member will earn 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.
	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`. See [TenderType](#type-tendertype) for possible values
	Type_       string             `json:"type"`
	CardDetails *TenderCardDetails `json:"card_details,omitempty"`
	CashDetails *TenderCashDetails `json:"cash_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` 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 TenderCardDetails ¶

type TenderCardDetails struct {
	// The credit card payment's current state (such as `AUTHORIZED` or `CAPTURED`). See `TenderCardDetailsStatus` for possible values. See [TenderCardDetailsStatus](#type-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. See [TenderCardDetailsEntryMethod](#type-tendercarddetailsentrymethod) for possible values
	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 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"
	WALLET_TenderType           TenderType = "WALLET"
	OTHER_TenderType            TenderType = "OTHER"
)

List of TenderType

type TerminalApiService ¶

type TerminalApiService service

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 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 Unique ID for the desired `TerminalRefund`

@return CancelTerminalRefundResponse

func (*TerminalApiService) CreateTerminalCheckout ¶

func (a *TerminalApiService) CreateTerminalCheckout(ctx context.Context, body CreateTerminalCheckoutRequest) (CreateTerminalCheckoutResponse, *http.Response, error)

TerminalApiService CreateTerminalCheckout Creates a new 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.

@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) GetTerminalCheckout ¶

func (a *TerminalApiService) GetTerminalCheckout(ctx context.Context, checkoutId string) (GetTerminalCheckoutResponse, *http.Response, error)

TerminalApiService GetTerminalCheckout Retrieves a Terminal checkout request by checkout_id.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param checkoutId 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.

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

@return GetTerminalRefundResponse

func (*TerminalApiService) SearchTerminalCheckouts ¶

func (a *TerminalApiService) SearchTerminalCheckouts(ctx context.Context, body SearchTerminalCheckoutsRequest) (SearchTerminalCheckoutsResponse, *http.Response, error)

TerminalApiService SearchTerminalCheckouts Retrieves a filtered list of Terminal checkout requests created by the account making the request.

@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 Terminal Interac refund requests created by the seller making the request.

@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 which 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. Will also be 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 any payments used to complete the checkout.
	Note          string                 `json:"note,omitempty"`
	DeviceOptions *DeviceCheckoutOptions `json:"device_options"`
	// The duration as an RFC 3339 duration, after which the checkout will be automatically canceled. TerminalCheckouts 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 `TerminalCheckout`. Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`
	Status string `json:"status,omitempty"`
	// Present if the status is `CANCELED`. See [ActionCancelReason](#type-actioncancelreason) for possible values
	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"`
}

type TerminalCheckoutQuery ¶

type TerminalCheckoutQuery struct {
	Filter *TerminalCheckoutQueryFilter `json:"filter,omitempty"`
	Sort   *TerminalCheckoutQuerySort   `json:"sort,omitempty"`
}

type TerminalCheckoutQueryFilter ¶

type TerminalCheckoutQueryFilter struct {
	// `TerminalCheckout`s associated with a specific device. If no device is specified then all `TerminalCheckout`s for the merchant will be 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, CANCELED, COMPLETED
	Status string `json:"status,omitempty"`
}

type TerminalCheckoutQuerySort ¶

type TerminalCheckoutQuerySort struct {
	// The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default).
	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"`
	// 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. Note: maximum 192 characters
	Reason string `json:"reason,omitempty"`
	// The unique Id of the device intended for this `TerminalRefund`. 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 refund will be automatically canceled. TerminalRefunds 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 `TerminalRefund`. Options: `PENDING`, `IN_PROGRESS`, `CANCELED`, `COMPLETED`
	Status string `json:"status,omitempty"`
	// Present if the status is `CANCELED`. See [ActionCancelReason](#type-actioncancelreason) for possible values
	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"`
}

type TerminalRefundQuery ¶

type TerminalRefundQuery struct {
	Filter *TerminalRefundQueryFilter `json:"filter,omitempty"`
	Sort   *TerminalRefundQuerySort   `json:"sort,omitempty"`
}

type TerminalRefundQueryFilter ¶

type TerminalRefundQueryFilter struct {
	// `TerminalRefund`s associated with a specific device. If no device is specified then all `TerminalRefund`s for the signed in account will be 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`, `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 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 their own 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, 25]
	TipPercentages []int32 `json:"tip_percentages,omitempty"`
	// Enables the \"Smart Tip Amounts\" behavior described in https://squareup.com/help/us/en/article/5069-accept-tips-with-the-square-app. Exact tipping options depend on the region the Square seller is active in.  In the United States and Canada, tipping options will be presented in whole dollar amounts for payments under 10 USD/CAD respectively.  If set to true, the tip_percentages settings is ignored. Defaults to false.
	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` 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. See [TransactionProduct](#type-transactionproduct) for possible values
	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 TransactionsApiListRefundsOpts ¶

type TransactionsApiListRefundsOpts struct {
	BeginTime optional.String
	EndTime   optional.String
	SortOrder optional.String
	Cursor    optional.String
}

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](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/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) Charge ¶

func (a *TransactionsApiService) Charge(ctx context.Context, body ChargeRequest, locationId string) (ChargeResponse, *http.Response, error)

TransactionsApiService Charge Charges a card represented by a card nonce or a customer's card on file. Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction.

@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 associate the created transaction with.

@return ChargeResponse

func (*TransactionsApiService) CreateRefund ¶

func (a *TransactionsApiService) CreateRefund(ctx context.Context, body CreateRefundRequest, locationId string, transactionId string) (CreateRefundResponse, *http.Response, error)

TransactionsApiService CreateRefund Initiates a refund for a previously charged tender. You must issue a refund within 120 days of the associated payment. See [this article](https://squareup.com/help/us/en/article/5060) for more information on refund behavior. NOTE: Card-present transactions with Interac credit cards **cannot be refunded using the Connect API**. Interac transactions must refunded in-person (e.g., dipping the card using POS app).

@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 original transaction's associated location.
@param transactionId The ID of the original transaction that includes the tender to refund.

@return CreateRefundResponse

func (*TransactionsApiService) ListRefunds ¶

func (a *TransactionsApiService) ListRefunds(ctx context.Context, locationId string, localVarOptionals *TransactionsApiListRefundsOpts) (ListRefundsResponse, *http.Response, error)

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](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/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 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"`
	// Any 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`. Contains the requested `BreakType` objects. May contain a set of `Error` objects if the request resulted in errors.

type UpdateCustomerGroupRequest ¶

type UpdateCustomerGroupRequest struct {
	Group *CustomerGroup `json:"group"`
}

Defines the body parameters that can be provided in a request to the [UpdateCustomerGroup](#endpoint-updatecustomergroup) 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](#endpoint-updatecustomergroup) endpoint. One of `errors` or `group` is present in a given response (never both).

type UpdateCustomerRequest ¶

type UpdateCustomerRequest struct {
	// The given (i.e., first) name associated with the customer profile.
	GivenName string `json:"given_name,omitempty"`
	// The family (i.e., 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 11-digit phone number associated with the customer profile.
	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 RFC 3339 format. Year is optional, timezone and times are not allowed. For example: `0000-09-01T00:00:00-00:00` indicates a birthday on September 1st. `1998-09-01T00:00:00-00:00` indications a birthday on September 1st __1998__.
	Birthday string `json:"birthday,omitempty"`
}

Defines the body parameters that can be provided 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 endpoint. One of `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/docs/working-with-apis/idempotency).
	IdempotencyKey string `json:"idempotency_key,omitempty"`
	// The list of fields to clear. For examples, see [Update an invoice](https://developer.squareup.com/docs/docs/invoices-api/overview#update-an-invoice).
	FieldsToClear []string `json:"fields_to_clear,omitempty"`
}

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.
	ModifierListsToEnable []string `json:"modifier_lists_to_enable,omitempty"`
	// The IDs of the CatalogModifierList objects to disable for the CatalogItem.
	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/working-with-date) 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.
	ItemIds []string `json:"item_ids"`
	// IDs of the CatalogTax objects to enable.
	TaxesToEnable []string `json:"taxes_to_enable,omitempty"`
	// IDs of the CatalogTax objects to disable.
	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 UpdateLocationRequest ¶

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

Request object for the [UpdateLocation](#endpoint-updatelocation) endpoint.

type UpdateLocationResponse ¶

type UpdateLocationResponse struct {
	// Information on errors encountered during the request.
	Errors   []ModelError `json:"errors,omitempty"`
	Location *Location    `json:"location,omitempty"`
}

Response object returned by the [UpdateLocation](#endpoint-updatelocation) endpoint.

type UpdateOrderRequest ¶

type UpdateOrderRequest struct {
	Order *Order `json:"order,omitempty"`
	// The [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders#on-dot-notation) fields to clear. For example, `line_items[uid].note` [Read more about Deleting fields](https://developer.squareup.com/docs/orders-api/manage-orders#delete-fields).
	FieldsToClear []string `json:"fields_to_clear,omitempty"`
	// A value you specify that uniquely identifies this update request  If you're 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 will be returned.  See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.
	IdempotencyKey string `json:"idempotency_key,omitempty"`
}

Defines the fields that are included in requests to the [UpdateOrder](#endpoint-orders-updateorder) 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](#endpoint-orders-updateorder) endpoint.

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`. Contains the updated `Shift` object. May contain a set of `Error` objects if the request resulted in errors.

type UpdateSubscriptionRequest ¶

type UpdateSubscriptionRequest struct {
	Subscription *Subscription `json:"subscription,omitempty"`
}

Defines parameters in a [UpdateSubscription](#endpoint-subscriptions-updatesubscription) endpoint request.

type UpdateSubscriptionResponse ¶

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

Defines the fields that are included in the response from the [UpdateSubscription](#endpoint-subscriptions-updatesubscription) 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 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 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. Contains the updated `WorkweekConfig` object. May contain a set of `Error` objects if the request resulted in errors.

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/basics/api101/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 V1AdjustInventoryRequest ¶

type V1AdjustInventoryRequest struct {
	// The number to adjust the variation's quantity by.
	QuantityDelta float64 `json:"quantity_delta,omitempty"`
	// The reason for the inventory adjustment. See [V1AdjustInventoryRequestAdjustmentType](#type-v1adjustinventoryrequestadjustmenttype) for possible values
	AdjustmentType string `json:"adjustment_type,omitempty"`
	// A note about the inventory adjustment.
	Memo string `json:"memo,omitempty"`
}

V1AdjustInventoryRequest

type V1AdjustInventoryRequestAdjustmentType ¶

type V1AdjustInventoryRequestAdjustmentType string

const (
	SALE_V1AdjustInventoryRequestAdjustmentType          V1AdjustInventoryRequestAdjustmentType = "SALE"
	RECEIVE_STOCK_V1AdjustInventoryRequestAdjustmentType V1AdjustInventoryRequestAdjustmentType = "RECEIVE_STOCK"
	MANUAL_ADJUST_V1AdjustInventoryRequestAdjustmentType V1AdjustInventoryRequestAdjustmentType = "MANUAL_ADJUST"
)

List of V1AdjustInventoryRequestAdjustmentType

type V1ApplyFeeRequest ¶

type V1ApplyFeeRequest struct {
}

type V1ApplyModifierListRequest ¶

type V1ApplyModifierListRequest struct {
}

type V1BankAccount ¶

type V1BankAccount struct {
	// The bank account's Square-issued ID.
	Id string `json:"id,omitempty"`
	// The Square-issued ID of the merchant associated with the bank account.
	MerchantId string `json:"merchant_id,omitempty"`
	// The name of the bank that manages the account.
	BankName string `json:"bank_name,omitempty"`
	// The name associated with the bank account.
	Name string `json:"name,omitempty"`
	// The bank account's routing number.
	RoutingNumber string `json:"routing_number,omitempty"`
	// The last few digits of the bank account number.
	AccountNumberSuffix string `json:"account_number_suffix,omitempty"`
	// The currency code of the currency associated with the bank account, in ISO 4217 format. For example, the currency code for US dollars is USD.
	CurrencyCode string `json:"currency_code,omitempty"`
	// The bank account's type (for example, savings or checking). See [V1BankAccountType](#type-v1bankaccounttype) for possible values
	Type_ string `json:"type,omitempty"`
}

V1BankAccount

type V1BankAccountType ¶

type V1BankAccountType string

const (
	BUSINESS_CHECKING_V1BankAccountType V1BankAccountType = "BUSINESS_CHECKING"
	CHECKING_V1BankAccountType          V1BankAccountType = "CHECKING"
	INVESTMENT_V1BankAccountType        V1BankAccountType = "INVESTMENT"
	LOAN_V1BankAccountType              V1BankAccountType = "LOAN"
	SAVINGS_V1BankAccountType           V1BankAccountType = "SAVINGS"
	OTHER_V1BankAccountType             V1BankAccountType = "OTHER"
)

List of V1BankAccountType

type V1CashDrawerEvent ¶

type V1CashDrawerEvent struct {
	// The event's unique ID.
	Id string `json:"id,omitempty"`
	// The ID of the employee that created the event.
	EmployeeId string `json:"employee_id,omitempty"`
	// The type of event that occurred. See [V1CashDrawerEventEventType](#type-v1cashdrawereventeventtype) for possible values
	EventType  string   `json:"event_type,omitempty"`
	EventMoney *V1Money `json:"event_money,omitempty"`
	// The time when the event occurred, in ISO 8601 format.
	CreatedAt string `json:"created_at,omitempty"`
	// An optional description of the event, entered by the employee that created it.
	Description string `json:"description,omitempty"`
}

V1CashDrawerEvent

type V1CashDrawerEventEventType ¶

type V1CashDrawerEventEventType string

const (
	NO_SALE_V1CashDrawerEventEventType                       V1CashDrawerEventEventType = "NO_SALE"
	CASH_TENDER_PAYMENT_V1CashDrawerEventEventType           V1CashDrawerEventEventType = "CASH_TENDER_PAYMENT"
	OTHER_TENDER_PAYMENT_V1CashDrawerEventEventType          V1CashDrawerEventEventType = "OTHER_TENDER_PAYMENT"
	CASH_TENDER_CANCELED_PAYMENT_V1CashDrawerEventEventType  V1CashDrawerEventEventType = "CASH_TENDER_CANCELED_PAYMENT"
	OTHER_TENDER_CANCELED_PAYMENT_V1CashDrawerEventEventType V1CashDrawerEventEventType = "OTHER_TENDER_CANCELED_PAYMENT"
	CASH_TENDER_REFUND_V1CashDrawerEventEventType            V1CashDrawerEventEventType = "CASH_TENDER_REFUND"
	OTHER_TENDER_REFUND_V1CashDrawerEventEventType           V1CashDrawerEventEventType = "OTHER_TENDER_REFUND"
	PAID_IN_V1CashDrawerEventEventType                       V1CashDrawerEventEventType = "PAID_IN"
	PAID_OUT_V1CashDrawerEventEventType                      V1CashDrawerEventEventType = "PAID_OUT"
)

List of V1CashDrawerEventEventType

type V1CashDrawerShift ¶

type V1CashDrawerShift struct {
	// The shift's unique ID.
	Id string `json:"id,omitempty"`
	// The shift's current state. See [V1CashDrawerShiftEventType](#type-v1cashdrawershifteventtype) for possible values
	EventType string `json:"event_type,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 IDs of all employees that were logged into Square Register at some point during the cash drawer shift.
	EmployeeIds []string `json:"employee_ids,omitempty"`
	// The ID of the employee that started the cash drawer shift.
	OpeningEmployeeId string `json:"opening_employee_id,omitempty"`
	// The ID of the employee that ended the cash drawer shift.
	EndingEmployeeId string `json:"ending_employee_id,omitempty"`
	// The ID of the employee that closed the cash drawer shift by auditing the cash drawer's contents.
	ClosingEmployeeId string `json:"closing_employee_id,omitempty"`
	// A description of the cash drawer shift.
	Description       string   `json:"description,omitempty"`
	StartingCashMoney *V1Money `json:"starting_cash_money,omitempty"`
	CashPaymentMoney  *V1Money `json:"cash_payment_money,omitempty"`
	CashRefundsMoney  *V1Money `json:"cash_refunds_money,omitempty"`
	CashPaidInMoney   *V1Money `json:"cash_paid_in_money,omitempty"`
	CashPaidOutMoney  *V1Money `json:"cash_paid_out_money,omitempty"`
	ExpectedCashMoney *V1Money `json:"expected_cash_money,omitempty"`
	ClosedCashMoney   *V1Money `json:"closed_cash_money,omitempty"`
	Device            *Device  `json:"device,omitempty"`
	// All of the events (payments, refunds, and so on) that involved the cash drawer during the shift.
	Events []V1CashDrawerEvent `json:"events,omitempty"`
}

Contains details for a single cash drawer shift.

type V1CashDrawerShiftEventType ¶

type V1CashDrawerShiftEventType string

const (
	OPEN_V1CashDrawerShiftEventType   V1CashDrawerShiftEventType = "OPEN"
	ENDED_V1CashDrawerShiftEventType  V1CashDrawerShiftEventType = "ENDED"
	CLOSED_V1CashDrawerShiftEventType V1CashDrawerShiftEventType = "CLOSED"
)

List of V1CashDrawerShiftEventType

type V1Category ¶

type V1Category struct {
	// The category's unique ID.
	Id string `json:"id,omitempty"`
	// The category's name.
	Name string `json:"name,omitempty"`
	// The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.
	V2Id string `json:"v2_id,omitempty"`
}

V1Category

type V1CreateCategoryRequest ¶

type V1CreateCategoryRequest struct {
	Body *V1Category `json:"body,omitempty"`
}

type V1CreateDiscountRequest ¶

type V1CreateDiscountRequest struct {
	Body *V1Discount `json:"body,omitempty"`
}

type V1CreateEmployeeRoleRequest ¶

type V1CreateEmployeeRoleRequest struct {
	EmployeeRole *V1EmployeeRole `json:"employee_role,omitempty"`
}

type V1CreateFeeRequest ¶

type V1CreateFeeRequest struct {
	Body *V1Fee `json:"body,omitempty"`
}

type V1CreateItemRequest ¶

type V1CreateItemRequest struct {
	Body *V1Item `json:"body,omitempty"`
}

type V1CreateModifierListRequest ¶

type V1CreateModifierListRequest struct {
	Body *V1ModifierList `json:"body,omitempty"`
}

type V1CreateModifierOptionRequest ¶

type V1CreateModifierOptionRequest struct {
	Body *V1ModifierOption `json:"body,omitempty"`
}

type V1CreatePageRequest ¶

type V1CreatePageRequest struct {
	Body *V1Page `json:"body,omitempty"`
}

type V1CreateRefundRequest ¶

type V1CreateRefundRequest struct {
	// The ID of the payment to refund. If you are creating a `PARTIAL` refund for a split tender payment, instead provide the id of the particular tender you want to refund.
	PaymentId string `json:"payment_id"`
	// TThe type of refund (FULL or PARTIAL). See [V1CreateRefundRequestType](#type-v1createrefundrequesttype) for possible values
	Type_ string `json:"type"`
	// The reason for the refund.
	Reason        string   `json:"reason"`
	RefundedMoney *V1Money `json:"refunded_money,omitempty"`
	// An optional key to ensure idempotence if you issue the same PARTIAL refund request more than once.
	RequestIdempotenceKey string `json:"request_idempotence_key,omitempty"`
}

V1CreateRefundRequest

type V1CreateRefundRequestType ¶

type V1CreateRefundRequestType string

const (
	FULL_V1CreateRefundRequestType    V1CreateRefundRequestType = "FULL"
	PARTIAL_V1CreateRefundRequestType V1CreateRefundRequestType = "PARTIAL"
)

List of V1CreateRefundRequestType

type V1CreateVariationRequest ¶

type V1CreateVariationRequest struct {
	Body *V1Variation `json:"body,omitempty"`
}

type V1DeleteCategoryRequest ¶

type V1DeleteCategoryRequest struct {
}

type V1DeleteDiscountRequest ¶

type V1DeleteDiscountRequest struct {
}

type V1DeleteFeeRequest ¶

type V1DeleteFeeRequest struct {
}

type V1DeleteItemRequest ¶

type V1DeleteItemRequest struct {
}

type V1DeleteModifierListRequest ¶

type V1DeleteModifierListRequest struct {
}

type V1DeleteModifierOptionRequest ¶

type V1DeleteModifierOptionRequest struct {
}

type V1DeletePageCellRequest ¶

type V1DeletePageCellRequest struct {
	// The row of the cell to clear. Always an integer between 0 and 4, inclusive. Row 0 is the top row.
	Row string `json:"row,omitempty"`
	// The column of the cell to clear. Always an integer between 0 and 4, inclusive. Column 0 is the leftmost column.
	Column string `json:"column,omitempty"`
}

type V1DeletePageRequest ¶

type V1DeletePageRequest struct {
}

type V1DeleteTimecardRequest ¶

type V1DeleteTimecardRequest struct {
}

type V1DeleteTimecardResponse ¶

type V1DeleteTimecardResponse struct {
}

type V1DeleteVariationRequest ¶

type V1DeleteVariationRequest struct {
}

type V1Discount ¶

type V1Discount struct {
	// The discount's unique ID.
	Id string `json:"id,omitempty"`
	// The discount's name.
	Name string `json:"name,omitempty"`
	// The rate of the discount, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. This rate is 0 if discount_type is VARIABLE_PERCENTAGE.
	Rate        string   `json:"rate,omitempty"`
	AmountMoney *V1Money `json:"amount_money,omitempty"`
	// Indicates whether the discount is a FIXED value or entered at the time of sale. See [V1DiscountDiscountType](#type-v1discountdiscounttype) for possible values
	DiscountType string `json:"discount_type,omitempty"`
	// Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment.
	PinRequired bool `json:"pin_required,omitempty"`
	// The color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values
	Color string `json:"color,omitempty"`
	// The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.
	V2Id string `json:"v2_id,omitempty"`
}

V1Discount

type V1DiscountDiscountType ¶

type V1DiscountDiscountType string

const (
	FIXED_V1DiscountDiscountType               V1DiscountDiscountType = "FIXED"
	VARIABLE_PERCENTAGE_V1DiscountDiscountType V1DiscountDiscountType = "VARIABLE_PERCENTAGE"
	VARIABLE_AMOUNT_V1DiscountDiscountType     V1DiscountDiscountType = "VARIABLE_AMOUNT"
)

List of V1DiscountDiscountType

type V1Employee ¶

type V1Employee struct {
	// The employee's unique ID.
	Id string `json:"id,omitempty"`
	// The employee's first name.
	FirstName string `json:"first_name"`
	// The employee's last name.
	LastName string `json:"last_name"`
	// The ids of the employee's associated roles. Currently, you can specify only one or zero roles per employee.
	RoleIds []string `json:"role_ids,omitempty"`
	// The IDs of the locations the employee is allowed to clock in at.
	AuthorizedLocationIds []string `json:"authorized_location_ids,omitempty"`
	// The employee's email address.
	Email string `json:"email,omitempty"`
	// CWhether the employee is ACTIVE or INACTIVE. Inactive employees cannot sign in to Square Register.Merchants update this field from the Square Dashboard. See [V1EmployeeStatus](#type-v1employeestatus) for possible values
	Status string `json:"status,omitempty"`
	// An ID the merchant can set to associate the employee with an entity in another system.
	ExternalId string `json:"external_id,omitempty"`
	// The time when the employee entity was created, in ISO 8601 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The time when the employee entity was most recently updated, in ISO 8601 format.
	UpdatedAt string `json:"updated_at,omitempty"`
}

Represents one of a business's employees.

type V1EmployeeRole ¶

type V1EmployeeRole struct {
	// The role's unique ID, Can only be set by Square.
	Id string `json:"id,omitempty"`
	// The role's merchant-defined name.
	Name string `json:"name"`
	// The role's permissions. See [V1EmployeeRolePermissions](#type-v1employeerolepermissions) for possible values
	Permissions []string `json:"permissions"`
	// If true, employees with this role have all permissions, regardless of the values indicated in permissions.
	IsOwner bool `json:"is_owner,omitempty"`
	// The time when the employee entity was created, in ISO 8601 format. Is set by Square when the Role is created.
	CreatedAt string `json:"created_at,omitempty"`
	// The time when the employee entity was most recently updated, in ISO 8601 format. Is set by Square when the Role updated.
	UpdatedAt string `json:"updated_at,omitempty"`
}

V1EmployeeRole

type V1EmployeeRolePermissions ¶

type V1EmployeeRolePermissions string

const (
	ACCESS_SALES_HISTORY_V1EmployeeRolePermissions          V1EmployeeRolePermissions = "REGISTER_ACCESS_SALES_HISTORY"
	APPLY_RESTRICTED_DISCOUNTS_V1EmployeeRolePermissions    V1EmployeeRolePermissions = "REGISTER_APPLY_RESTRICTED_DISCOUNTS"
	CHANGE_SETTINGS_V1EmployeeRolePermissions               V1EmployeeRolePermissions = "REGISTER_CHANGE_SETTINGS"
	EDIT_ITEM_V1EmployeeRolePermissions                     V1EmployeeRolePermissions = "REGISTER_EDIT_ITEM"
	ISSUE_REFUNDS_V1EmployeeRolePermissions                 V1EmployeeRolePermissions = "REGISTER_ISSUE_REFUNDS"
	OPEN_CASH_DRAWER_OUTSIDE_SALE_V1EmployeeRolePermissions V1EmployeeRolePermissions = "REGISTER_OPEN_CASH_DRAWER_OUTSIDE_SALE"
	VIEW_SUMMARY_REPORTS_V1EmployeeRolePermissions          V1EmployeeRolePermissions = "REGISTER_VIEW_SUMMARY_REPORTS"
)

List of V1EmployeeRolePermissions

type V1EmployeeStatus ¶

type V1EmployeeStatus string

const (
	ACTIVE_V1EmployeeStatus   V1EmployeeStatus = "ACTIVE"
	INACTIVE_V1EmployeeStatus V1EmployeeStatus = "INACTIVE"
)

List of V1EmployeeStatus

type V1EmployeesApiListCashDrawerShiftsOpts ¶

type V1EmployeesApiListCashDrawerShiftsOpts struct {
	Order     optional.String
	BeginTime optional.String
	EndTime   optional.String
}

type V1EmployeesApiListEmployeeRolesOpts ¶

type V1EmployeesApiListEmployeeRolesOpts struct {
	Order      optional.String
	Limit      optional.Int32
	BatchToken optional.String
}

type V1EmployeesApiListEmployeesOpts ¶

type V1EmployeesApiListEmployeesOpts struct {
	Order          optional.String
	BeginUpdatedAt optional.String
	EndUpdatedAt   optional.String
	BeginCreatedAt optional.String
	EndCreatedAt   optional.String
	Status         optional.String
	ExternalId     optional.String
	Limit          optional.Int32
	BatchToken     optional.String
}

type V1EmployeesApiListTimecardsOpts ¶

type V1EmployeesApiListTimecardsOpts struct {
	Order             optional.String
	EmployeeId        optional.String
	BeginClockinTime  optional.String
	EndClockinTime    optional.String
	BeginClockoutTime optional.String
	EndClockoutTime   optional.String
	BeginUpdatedAt    optional.String
	EndUpdatedAt      optional.String
	Deleted           optional.Bool
	Limit             optional.Int32
	BatchToken        optional.String
}

type V1EmployeesApiService ¶

type V1EmployeesApiService service

func (*V1EmployeesApiService) CreateEmployee ¶

func (a *V1EmployeesApiService) CreateEmployee(ctx context.Context, body V1Employee) (V1Employee, *http.Response, error)

V1EmployeesApiService CreateEmployee

Use the CreateEmployee endpoint to add an employee to a Square account. Employees created with the Connect API have an initial status of &#x60;INACTIVE&#x60;. Inactive employees cannot sign in to Square Point of Sale until they are activated from the Square Dashboard. Employee status cannot be changed with the Connect API.  Employee entities cannot be deleted. To disable employee profiles, set the employee&#x27;s status to &lt;code&gt;INACTIVE&lt;/code&gt;
* @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 V1Employee

func (*V1EmployeesApiService) CreateEmployeeRole ¶

func (a *V1EmployeesApiService) CreateEmployeeRole(ctx context.Context, body V1EmployeeRole) (V1EmployeeRole, *http.Response, error)

V1EmployeesApiService CreateEmployeeRole Creates an employee role you can then assign to employees. Square accounts can include any number of roles that can be assigned to employees. These roles define the actions and permissions granted to an employee with that role. For example, an employee with a \"Shift Manager\" role might be able to issue refunds in Square Point of Sale, whereas an employee with a \"Clerk\" role might not. Roles are assigned with the [V1UpdateEmployee](#endpoint-v1updateemployee) endpoint. An employee can have only one role at a time. If an employee has no role, they have none of the permissions associated with roles. All employees can accept payments with Square Point of Sale.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body An EmployeeRole object with a name and permissions, and an optional owner flag.

@return V1EmployeeRole

func (*V1EmployeesApiService) CreateTimecard ¶

func (a *V1EmployeesApiService) CreateTimecard(ctx context.Context, body V1Timecard) (V1Timecard, *http.Response, error)

V1EmployeesApiService CreateTimecard Creates a timecard for an employee and clocks them in with an `API_CREATE` event and a `clockin_time` set to the current time unless the request provides a different value. To import timecards from another system (rather than clocking someone in). Specify the `clockin_time` and* `clockout_time` in the request. Timecards correspond to exactly one shift for a given employee, bounded by the `clockin_time` and `clockout_time` fields. An employee is considered clocked in if they have a timecard that doesn't have a `clockout_time` set. An employee that is currently clocked in cannot be clocked in a second time.

@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 V1Timecard

func (*V1EmployeesApiService) DeleteTimecard ¶

func (a *V1EmployeesApiService) DeleteTimecard(ctx context.Context, timecardId string) (interface{}, *http.Response, error)

V1EmployeesApiService DeleteTimecard Deletes a timecard. Timecards can also be deleted through the Square Dashboard. Deleted timecards are still accessible through Connect API endpoints, but cannot be modified. The `deleted` field of the `Timecard` object indicates whether the timecard has been deleted. __Note__: By default, deleted timecards appear alongside valid timecards in results returned by the [ListTimecards](#endpoint-v1employees-listtimecards) endpoint. To filter deleted timecards, include the `deleted` query parameter in the list request. Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API.

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

@return interface{}

func (*V1EmployeesApiService) ListCashDrawerShifts ¶

func (a *V1EmployeesApiService) ListCashDrawerShifts(ctx context.Context, locationId string, localVarOptionals *V1EmployeesApiListCashDrawerShiftsOpts) ([]V1CashDrawerShift, *http.Response, error)

func (*V1EmployeesApiService) ListEmployeeRoles ¶

func (a *V1EmployeesApiService) ListEmployeeRoles(ctx context.Context, localVarOptionals *V1EmployeesApiListEmployeeRolesOpts) ([]V1EmployeeRole, *http.Response, error)

func (*V1EmployeesApiService) ListEmployees ¶

func (a *V1EmployeesApiService) ListEmployees(ctx context.Context, localVarOptionals *V1EmployeesApiListEmployeesOpts) ([]V1Employee, *http.Response, error)

func (*V1EmployeesApiService) ListTimecardEvents ¶

func (a *V1EmployeesApiService) ListTimecardEvents(ctx context.Context, timecardId string) ([]V1TimecardEvent, *http.Response, error)

V1EmployeesApiService ListTimecardEvents Provides summary information for all events associated with a particular timecard. Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param timecardId The ID of the timecard to list events for.

@return []V1TimecardEvent

func (*V1EmployeesApiService) ListTimecards ¶

func (a *V1EmployeesApiService) ListTimecards(ctx context.Context, localVarOptionals *V1EmployeesApiListTimecardsOpts) ([]V1Timecard, *http.Response, error)

func (*V1EmployeesApiService) RetrieveCashDrawerShift ¶

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

V1EmployeesApiService RetrieveCashDrawerShift Provides the details for a single cash drawer shift, including all events that occurred during the shift.

@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 list cash drawer shifts for.
@param shiftId The shift's ID.

@return V1CashDrawerShift

func (*V1EmployeesApiService) RetrieveEmployee ¶

func (a *V1EmployeesApiService) RetrieveEmployee(ctx context.Context, employeeId string) (V1Employee, *http.Response, error)

V1EmployeesApiService RetrieveEmployee Provides the details for a single employee.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param employeeId The employee's ID.

@return V1Employee

func (*V1EmployeesApiService) RetrieveEmployeeRole ¶

func (a *V1EmployeesApiService) RetrieveEmployeeRole(ctx context.Context, roleId string) (V1EmployeeRole, *http.Response, error)

V1EmployeesApiService RetrieveEmployeeRole Provides the details for a single employee role.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param roleId The role's ID.

@return V1EmployeeRole

func (*V1EmployeesApiService) RetrieveTimecard ¶

func (a *V1EmployeesApiService) RetrieveTimecard(ctx context.Context, timecardId string) (V1Timecard, *http.Response, error)

V1EmployeesApiService RetrieveTimecard Provides the details for a single timecard. Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param timecardId The timecard's ID.

@return V1Timecard

func (*V1EmployeesApiService) UpdateEmployee ¶

func (a *V1EmployeesApiService) UpdateEmployee(ctx context.Context, body V1Employee, employeeId string) (V1Employee, *http.Response, error)

V1EmployeesApiService UpdateEmployee

@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 employeeId The ID of the role to modify.

@return V1Employee

func (*V1EmployeesApiService) UpdateEmployeeRole ¶

func (a *V1EmployeesApiService) UpdateEmployeeRole(ctx context.Context, body V1EmployeeRole, roleId string) (V1EmployeeRole, *http.Response, error)

V1EmployeesApiService UpdateEmployeeRole Modifies the details of an employee role.

@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 roleId The ID of the role to modify.

@return V1EmployeeRole

func (*V1EmployeesApiService) UpdateTimecard ¶

func (a *V1EmployeesApiService) UpdateTimecard(ctx context.Context, body V1Timecard, timecardId string) (V1Timecard, *http.Response, error)

V1EmployeesApiService UpdateTimecard Modifies the details of a timecard with an `API_EDIT` event for the timecard. Updating an active timecard with a `clockout_time` clocks the employee out.

@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 timecardId TThe ID of the timecard to modify.

@return V1Timecard

type V1Fee ¶

type V1Fee struct {
	// The fee's unique ID.
	Id string `json:"id,omitempty"`
	// The fee's name.
	Name string `json:"name,omitempty"`
	// The rate of the fee, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%.
	Rate string `json:"rate,omitempty"`
	// Forthcoming See [V1FeeCalculationPhase](#type-v1feecalculationphase) for possible values
	CalculationPhase string `json:"calculation_phase,omitempty"`
	// The type of adjustment the fee applies to a payment. Currently, this value is TAX for all fees. See [V1FeeAdjustmentType](#type-v1feeadjustmenttype) for possible values
	AdjustmentType string `json:"adjustment_type,omitempty"`
	// If true, the fee applies to custom amounts entered into Square Point of Sale that are not associated with a particular item.
	AppliesToCustomAmounts bool `json:"applies_to_custom_amounts,omitempty"`
	// If true, the fee is applied to all appropriate items. If false, the fee is not applied at all.
	Enabled bool `json:"enabled,omitempty"`
	// Whether the fee is ADDITIVE or INCLUSIVE. See [V1FeeInclusionType](#type-v1feeinclusiontype) for possible values
	InclusionType string `json:"inclusion_type,omitempty"`
	// In countries with multiple classifications for sales taxes, indicates which classification the fee falls under. Currently relevant only to Canadian merchants. See [V1FeeType](#type-v1feetype) for possible values
	Type_ string `json:"type,omitempty"`
	// The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.
	V2Id string `json:"v2_id,omitempty"`
}

V1Fee

type V1FeeAdjustmentType ¶

type V1FeeAdjustmentType string

const (
	TAX_V1FeeAdjustmentType V1FeeAdjustmentType = "TAX"
)

List of V1FeeAdjustmentType

type V1FeeCalculationPhase ¶

type V1FeeCalculationPhase string

const (
	FEE_SUBTOTAL_PHASE_V1FeeCalculationPhase V1FeeCalculationPhase = "FEE_SUBTOTAL_PHASE"
	OTHER_V1FeeCalculationPhase              V1FeeCalculationPhase = "OTHER"
	FEE_TOTAL_PHASE_V1FeeCalculationPhase    V1FeeCalculationPhase = "FEE_TOTAL_PHASE"
)

List of V1FeeCalculationPhase

type V1FeeInclusionType ¶

type V1FeeInclusionType string

const (
	ADDITIVE_V1FeeInclusionType  V1FeeInclusionType = "ADDITIVE"
	INCLUSIVE_V1FeeInclusionType V1FeeInclusionType = "INCLUSIVE"
)

List of V1FeeInclusionType

type V1FeeType ¶

type V1FeeType string

const (
	CA_GST_V1FeeType             V1FeeType = "CA_GST"
	CA_HST_V1FeeType             V1FeeType = "CA_HST"
	CA_PST_V1FeeType             V1FeeType = "CA_PST"
	CA_QST_V1FeeType             V1FeeType = "CA_QST"
	JP_CONSUMPTION_TAX_V1FeeType V1FeeType = "JP_CONSUMPTION_TAX"
	CA_PEI_PST_V1FeeType         V1FeeType = "CA_PEI_PST"
	US_SALES_TAX_V1FeeType       V1FeeType = "US_SALES_TAX"
	OTHER_V1FeeType              V1FeeType = "OTHER"
)

List of V1FeeType

type V1InventoryEntry ¶

type V1InventoryEntry struct {
	// The variation that the entry corresponds to.
	VariationId string `json:"variation_id,omitempty"`
	// The current available quantity of the item variation.
	QuantityOnHand float64 `json:"quantity_on_hand,omitempty"`
}

V1InventoryEntry

type V1Item ¶

type V1Item struct {
	// The item's ID. Must be unique among all entity IDs ever provided on behalf of the merchant. You can never reuse an ID. This value can include alphanumeric characters, dashes (-), and underscores (_).
	Id string `json:"id,omitempty"`
	// The item's name.
	Name string `json:"name,omitempty"`
	// The item's description.
	Description string `json:"description,omitempty"`
	// The item's type. This value is NORMAL for almost all items. See [V1ItemType](#type-v1itemtype) for possible values
	Type_ string `json:"type,omitempty"`
	// The color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values
	Color string `json:"color,omitempty"`
	// The text of the item's display label in Square Point of Sale. Only up to the first five characters of the string are used.
	Abbreviation string `json:"abbreviation,omitempty"`
	// Indicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE. See [V1ItemVisibility](#type-v1itemvisibility) for possible values
	Visibility string `json:"visibility,omitempty"`
	// If true, the item can be added to shipping orders from the merchant's online store.
	AvailableOnline bool         `json:"available_online,omitempty"`
	MasterImage     *V1ItemImage `json:"master_image,omitempty"`
	Category        *V1Category  `json:"category,omitempty"`
	// The item's variations. You must specify at least one variation.
	Variations []V1Variation `json:"variations,omitempty"`
	// The modifier lists that apply to the item, if any.
	ModifierLists []V1ModifierList `json:"modifier_lists,omitempty"`
	// The fees that apply to the item, if any.
	Fees []V1Fee `json:"fees,omitempty"`
	// Deprecated. This field is not used.
	Taxable bool `json:"taxable,omitempty"`
	// The ID of the item's category, if any.
	CategoryId string `json:"category_id,omitempty"`
	// If true, the item can be added to pickup orders from the merchant's online store. Default value: false
	AvailableForPickup bool `json:"available_for_pickup,omitempty"`
	// The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.
	V2Id string `json:"v2_id,omitempty"`
}

V1Item

type V1ItemImage ¶

type V1ItemImage struct {
	// The image's unique ID.
	Id string `json:"id,omitempty"`
	// The image's publicly accessible URL.
	Url string `json:"url,omitempty"`
}

V1ItemImage

type V1ItemType ¶

type V1ItemType string

const (
	NORMAL_V1ItemType    V1ItemType = "NORMAL"
	GIFT_CARD_V1ItemType V1ItemType = "GIFT_CARD"
	OTHER_V1ItemType     V1ItemType = "OTHER"
)

List of V1ItemType

type V1ItemVisibility ¶

type V1ItemVisibility string

const (
	PUBLIC_V1ItemVisibility  V1ItemVisibility = "PUBLIC"
	PRIVATE_V1ItemVisibility V1ItemVisibility = "PRIVATE"
)

List of V1ItemVisibility

type V1ItemsApiDeletePageCellOpts ¶

type V1ItemsApiDeletePageCellOpts struct {
	Row    optional.String
	Column optional.String
}

type V1ItemsApiListInventoryOpts ¶

type V1ItemsApiListInventoryOpts struct {
	Limit      optional.Int32
	BatchToken optional.String
}

type V1ItemsApiListItemsOpts ¶

type V1ItemsApiListItemsOpts struct {
	BatchToken optional.String
}

type V1ItemsApiService ¶

type V1ItemsApiService service

func (*V1ItemsApiService) AdjustInventory ¶

func (a *V1ItemsApiService) AdjustInventory(ctx context.Context, body V1AdjustInventoryRequest, locationId string, variationId string) (V1InventoryEntry, *http.Response, error)

V1ItemsApiService AdjustInventory Adjusts the current available inventory of an item variation.

@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 item's associated location.
@param variationId The ID of the variation to adjust inventory information for.

@return V1InventoryEntry

func (*V1ItemsApiService) ApplyFee ¶

func (a *V1ItemsApiService) ApplyFee(ctx context.Context, locationId string, itemId string, feeId string) (V1Item, *http.Response, error)

V1ItemsApiService ApplyFee Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the fee's associated location.
@param itemId The ID of the item to add the fee to.
@param feeId The ID of the fee to apply.

@return V1Item

func (*V1ItemsApiService) ApplyModifierList ¶

func (a *V1ItemsApiService) ApplyModifierList(ctx context.Context, locationId string, modifierListId string, itemId string) (V1Item, *http.Response, error)

V1ItemsApiService ApplyModifierList Associates a modifier list with an item so the associated modifier options can be applied to the item.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the item's associated location.
@param modifierListId The ID of the modifier list to apply.
@param itemId The ID of the item to add the modifier list to.

@return V1Item

func (*V1ItemsApiService) CreateCategory ¶

func (a *V1ItemsApiService) CreateCategory(ctx context.Context, body V1Category, locationId string) (V1Category, *http.Response, error)

V1ItemsApiService CreateCategory Creates an item category.

@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 create an item for.

@return V1Category

func (*V1ItemsApiService) CreateDiscount ¶

func (a *V1ItemsApiService) CreateDiscount(ctx context.Context, body V1Discount, locationId string) (V1Discount, *http.Response, error)

V1ItemsApiService CreateDiscount Creates a discount.

@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 create an item for.

@return V1Discount

func (*V1ItemsApiService) CreateFee ¶

func (a *V1ItemsApiService) CreateFee(ctx context.Context, body V1Fee, locationId string) (V1Fee, *http.Response, error)

V1ItemsApiService CreateFee Creates a fee (tax).

@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 create a fee for.

@return V1Fee

func (*V1ItemsApiService) CreateItem ¶

func (a *V1ItemsApiService) CreateItem(ctx context.Context, body V1Item, locationId string) (V1Item, *http.Response, error)

V1ItemsApiService CreateItem Creates an item and at least one variation for it. Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters.

@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 create an item for.

@return V1Item

func (*V1ItemsApiService) CreateModifierList ¶

func (a *V1ItemsApiService) CreateModifierList(ctx context.Context, body V1ModifierList, locationId string) (V1ModifierList, *http.Response, error)

V1ItemsApiService CreateModifierList Creates an item modifier list and at least 1 modifier option for 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.

@param locationId The ID of the location to create a modifier list for.

@return V1ModifierList

func (*V1ItemsApiService) CreateModifierOption ¶

func (a *V1ItemsApiService) CreateModifierOption(ctx context.Context, body V1ModifierOption, locationId string, modifierListId string) (V1ModifierOption, *http.Response, error)

V1ItemsApiService CreateModifierOption Creates an item modifier option and adds it to a modifier list.

@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 item's associated location.
@param modifierListId The ID of the modifier list to edit.

@return V1ModifierOption

func (*V1ItemsApiService) CreatePage ¶

func (a *V1ItemsApiService) CreatePage(ctx context.Context, body V1Page, locationId string) (V1Page, *http.Response, error)

V1ItemsApiService CreatePage Creates a Favorites page in Square Point of Sale.

@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 create an item for.

@return V1Page

func (*V1ItemsApiService) CreateVariation ¶

func (a *V1ItemsApiService) CreateVariation(ctx context.Context, body V1Variation, locationId string, itemId string) (V1Variation, *http.Response, error)

V1ItemsApiService CreateVariation Creates an item variation for an existing 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.

@param locationId The ID of the item's associated location.
@param itemId The item's ID.

@return V1Variation

func (*V1ItemsApiService) DeleteCategory ¶

func (a *V1ItemsApiService) DeleteCategory(ctx context.Context, locationId string, categoryId string) (V1Category, *http.Response, error)

V1ItemsApiService DeleteCategory Deletes an existing item category. __DeleteCategory__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the item's associated location.
@param categoryId The ID of the category to delete.

@return V1Category

func (*V1ItemsApiService) DeleteDiscount ¶

func (a *V1ItemsApiService) DeleteDiscount(ctx context.Context, locationId string, discountId string) (V1Discount, *http.Response, error)

V1ItemsApiService DeleteDiscount Deletes an existing discount. __DeleteDiscount__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the item's associated location.
@param discountId The ID of the discount to delete.

@return V1Discount

func (*V1ItemsApiService) DeleteFee ¶

func (a *V1ItemsApiService) DeleteFee(ctx context.Context, locationId string, feeId string) (V1Fee, *http.Response, error)

V1ItemsApiService DeleteFee Deletes an existing fee (tax). __DeleteFee__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the fee's associated location.
@param feeId The ID of the fee to delete.

@return V1Fee

func (*V1ItemsApiService) DeleteItem ¶

func (a *V1ItemsApiService) DeleteItem(ctx context.Context, locationId string, itemId string) (V1Item, *http.Response, error)

V1ItemsApiService DeleteItem Deletes an existing item and all item variations associated with it. __DeleteItem__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the item's associated location.
@param itemId The ID of the item to modify.

@return V1Item

func (*V1ItemsApiService) DeleteModifierList ¶

func (a *V1ItemsApiService) DeleteModifierList(ctx context.Context, locationId string, modifierListId string) (V1ModifierList, *http.Response, error)

V1ItemsApiService DeleteModifierList Deletes an existing item modifier list and all modifier options associated with it. __DeleteModifierList__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the item's associated location.
@param modifierListId The ID of the modifier list to delete.

@return V1ModifierList

func (*V1ItemsApiService) DeleteModifierOption ¶

func (a *V1ItemsApiService) DeleteModifierOption(ctx context.Context, locationId string, modifierListId string, modifierOptionId string) (V1ModifierOption, *http.Response, error)

V1ItemsApiService DeleteModifierOption Deletes an existing item modifier option from a modifier list. __DeleteModifierOption__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the item's associated location.
@param modifierListId The ID of the modifier list to delete.
@param modifierOptionId The ID of the modifier list to edit.

@return V1ModifierOption

func (*V1ItemsApiService) DeletePage ¶

func (a *V1ItemsApiService) DeletePage(ctx context.Context, locationId string, pageId string) (V1Page, *http.Response, error)

V1ItemsApiService DeletePage Deletes an existing Favorites page and all of its cells. __DeletePage__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the Favorites page's associated location.
@param pageId The ID of the page to delete.

@return V1Page

func (*V1ItemsApiService) DeletePageCell ¶

func (a *V1ItemsApiService) DeletePageCell(ctx context.Context, locationId string, pageId string, localVarOptionals *V1ItemsApiDeletePageCellOpts) (V1Page, *http.Response, error)

func (*V1ItemsApiService) DeleteVariation ¶

func (a *V1ItemsApiService) DeleteVariation(ctx context.Context, locationId string, itemId string, variationId string) (V1Variation, *http.Response, error)

V1ItemsApiService DeleteVariation Deletes an existing item variation from an item. __DeleteVariation__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the item's associated location.
@param itemId The ID of the item to delete.
@param variationId The ID of the variation to delete.

@return V1Variation

func (a *V1ItemsApiService) ListCategories(ctx context.Context, locationId string) ([]V1Category, *http.Response, error)

V1ItemsApiService ListCategories Lists all the item categories for a given 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 list categories for.

@return []V1Category

func (*V1ItemsApiService) ListDiscounts ¶

func (a *V1ItemsApiService) ListDiscounts(ctx context.Context, locationId string) ([]V1Discount, *http.Response, error)

V1ItemsApiService ListDiscounts Lists all the discounts for a given 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 list categories for.

@return []V1Discount

func (*V1ItemsApiService) ListFees ¶

func (a *V1ItemsApiService) ListFees(ctx context.Context, locationId string) ([]V1Fee, *http.Response, error)

V1ItemsApiService ListFees Lists all the fees (taxes) for a given 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 list fees for.

@return []V1Fee

func (*V1ItemsApiService) ListInventory ¶

func (a *V1ItemsApiService) ListInventory(ctx context.Context, locationId string, localVarOptionals *V1ItemsApiListInventoryOpts) ([]V1InventoryEntry, *http.Response, error)

func (*V1ItemsApiService) ListItems ¶

func (a *V1ItemsApiService) ListItems(ctx context.Context, locationId string, localVarOptionals *V1ItemsApiListItemsOpts) ([]V1Item, *http.Response, error)

func (*V1ItemsApiService) ListModifierLists ¶

func (a *V1ItemsApiService) ListModifierLists(ctx context.Context, locationId string) ([]V1ModifierList, *http.Response, error)

V1ItemsApiService ListModifierLists Lists all the modifier lists for a given 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 list modifier lists for.

@return []V1ModifierList

func (*V1ItemsApiService) ListPages ¶

func (a *V1ItemsApiService) ListPages(ctx context.Context, locationId string) ([]V1Page, *http.Response, error)

V1ItemsApiService ListPages Lists all Favorites pages (in Square Point of Sale) for a given 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 list Favorites pages for.

@return []V1Page

func (*V1ItemsApiService) RemoveFee ¶

func (a *V1ItemsApiService) RemoveFee(ctx context.Context, locationId string, itemId string, feeId string) (V1Item, *http.Response, error)

V1ItemsApiService RemoveFee Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the fee's associated location.
@param itemId The ID of the item to add the fee to.
@param feeId The ID of the fee to apply.

@return V1Item

func (*V1ItemsApiService) RemoveModifierList ¶

func (a *V1ItemsApiService) RemoveModifierList(ctx context.Context, locationId string, modifierListId string, itemId string) (V1Item, *http.Response, error)

V1ItemsApiService RemoveModifierList Removes a modifier list association from an item so the modifier options from the list can no longer be applied to the item.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the item's associated location.
@param modifierListId The ID of the modifier list to remove.
@param itemId The ID of the item to remove the modifier list from.

@return V1Item

func (*V1ItemsApiService) RetrieveItem ¶

func (a *V1ItemsApiService) RetrieveItem(ctx context.Context, locationId string, itemId string) (V1Item, *http.Response, error)

V1ItemsApiService RetrieveItem Provides the details for a single item, including associated modifier lists and fees.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the item's associated location.
@param itemId The item's ID.

@return V1Item

func (*V1ItemsApiService) RetrieveModifierList ¶

func (a *V1ItemsApiService) RetrieveModifierList(ctx context.Context, locationId string, modifierListId string) (V1ModifierList, *http.Response, error)

V1ItemsApiService RetrieveModifierList Provides the details for a single modifier list.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the item's associated location.
@param modifierListId The modifier list's ID.

@return V1ModifierList

func (*V1ItemsApiService) UpdateCategory ¶

func (a *V1ItemsApiService) UpdateCategory(ctx context.Context, body V1Category, locationId string, categoryId string) (V1Category, *http.Response, error)

V1ItemsApiService UpdateCategory Modifies the details of an existing item category.

@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 category's associated location.
@param categoryId The ID of the category to edit.

@return V1Category

func (*V1ItemsApiService) UpdateDiscount ¶

func (a *V1ItemsApiService) UpdateDiscount(ctx context.Context, body V1Discount, locationId string, discountId string) (V1Discount, *http.Response, error)

V1ItemsApiService UpdateDiscount Modifies the details of an existing discount.

@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 category's associated location.
@param discountId The ID of the discount to edit.

@return V1Discount

func (*V1ItemsApiService) UpdateFee ¶

func (a *V1ItemsApiService) UpdateFee(ctx context.Context, body V1Fee, locationId string, feeId string) (V1Fee, *http.Response, error)

V1ItemsApiService UpdateFee Modifies the details of an existing fee (tax).

@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 fee's associated location.
@param feeId The ID of the fee to edit.

@return V1Fee

func (*V1ItemsApiService) UpdateItem ¶

func (a *V1ItemsApiService) UpdateItem(ctx context.Context, body V1Item, locationId string, itemId string) (V1Item, *http.Response, error)

V1ItemsApiService UpdateItem Modifies the core details of an existing 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.

@param locationId The ID of the item's associated location.
@param itemId The ID of the item to modify.

@return V1Item

func (*V1ItemsApiService) UpdateModifierList ¶

func (a *V1ItemsApiService) UpdateModifierList(ctx context.Context, body V1UpdateModifierListRequest, locationId string, modifierListId string) (V1ModifierList, *http.Response, error)

V1ItemsApiService UpdateModifierList Modifies the details of an existing item modifier list.

@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 item's associated location.
@param modifierListId The ID of the modifier list to edit.

@return V1ModifierList

func (*V1ItemsApiService) UpdateModifierOption ¶

func (a *V1ItemsApiService) UpdateModifierOption(ctx context.Context, body V1ModifierOption, locationId string, modifierListId string, modifierOptionId string) (V1ModifierOption, *http.Response, error)

V1ItemsApiService UpdateModifierOption Modifies the details of an existing item modifier option.

@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 item's associated location.
@param modifierListId The ID of the modifier list to edit.
@param modifierOptionId The ID of the modifier list to edit.

@return V1ModifierOption

func (*V1ItemsApiService) UpdatePage ¶

func (a *V1ItemsApiService) UpdatePage(ctx context.Context, body V1Page, locationId string, pageId string) (V1Page, *http.Response, error)

V1ItemsApiService UpdatePage Modifies the details of a Favorites page in Square Point of Sale.

@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 Favorites page's associated location
@param pageId The ID of the page to modify.

@return V1Page

func (*V1ItemsApiService) UpdatePageCell ¶

func (a *V1ItemsApiService) UpdatePageCell(ctx context.Context, body V1PageCell, locationId string, pageId string) (V1Page, *http.Response, error)

V1ItemsApiService UpdatePageCell Modifies a cell of a Favorites page in Square Point of Sale.

@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 Favorites page's associated location.
@param pageId The ID of the page the cell belongs to.

@return V1Page

func (*V1ItemsApiService) UpdateVariation ¶

func (a *V1ItemsApiService) UpdateVariation(ctx context.Context, body V1Variation, locationId string, itemId string, variationId string) (V1Variation, *http.Response, error)

V1ItemsApiService UpdateVariation Modifies the details of an existing item variation.

@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 item's associated location.
@param itemId The ID of the item to modify.
@param variationId The ID of the variation to modify.

@return V1Variation

type V1ListBankAccountsRequest ¶

type V1ListBankAccountsRequest struct {
}

type V1ListBankAccountsResponse ¶

type V1ListBankAccountsResponse struct {
	Items []V1BankAccount `json:"items,omitempty"`
}

type V1ListCashDrawerShiftsRequest ¶

type V1ListCashDrawerShiftsRequest struct {
	// The order in which cash drawer shifts are listed in the response, based on their created_at field. Default value: ASC See [SortOrder](#type-sortorder) for possible values
	Order string `json:"order,omitempty"`
	// The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time minus 90 days.
	BeginTime string `json:"begin_time,omitempty"`
	// The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time.
	EndTime string `json:"end_time,omitempty"`
}

type V1ListCashDrawerShiftsResponse ¶

type V1ListCashDrawerShiftsResponse struct {
	Items []V1CashDrawerShift `json:"items,omitempty"`
}

type V1ListCategoriesRequest ¶

type V1ListCategoriesRequest struct {
}

type V1ListCategoriesResponse ¶

type V1ListCategoriesResponse struct {
	Items []V1Category `json:"items,omitempty"`
}

type V1ListDiscountsRequest ¶

type V1ListDiscountsRequest struct {
}

type V1ListDiscountsResponse ¶

type V1ListDiscountsResponse struct {
	Items []V1Discount `json:"items,omitempty"`
}

type V1ListEmployeeRolesRequest ¶

type V1ListEmployeeRolesRequest struct {
	// The order in which employees are listed in the response, based on their created_at field.Default value: ASC See [SortOrder](#type-sortorder) for possible values
	Order string `json:"order,omitempty"`
	// The maximum integer number of employee entities to return in a single response. Default 100, maximum 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 V1ListEmployeeRolesResponse ¶

type V1ListEmployeeRolesResponse struct {
	Items []V1EmployeeRole `json:"items,omitempty"`
}

type V1ListEmployeesRequest ¶

type V1ListEmployeesRequest struct {
	// The order in which employees are listed in the response, based on their created_at field.      Default value: ASC See [SortOrder](#type-sortorder) for possible values
	Order string `json:"order,omitempty"`
	// If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format
	BeginUpdatedAt string `json:"begin_updated_at,omitempty"`
	// If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format.
	EndUpdatedAt string `json:"end_updated_at,omitempty"`
	// If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format.
	BeginCreatedAt string `json:"begin_created_at,omitempty"`
	// If filtering results by their created_at field, the end of the requested reporting period, in ISO 8601 format.
	EndCreatedAt string `json:"end_created_at,omitempty"`
	// If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE). See [V1ListEmployeesRequestStatus](#type-v1listemployeesrequeststatus) for possible values
	Status string `json:"status,omitempty"`
	// If provided, the endpoint returns only employee entities with the specified external_id.
	ExternalId string `json:"external_id,omitempty"`
	// The maximum integer number of employee entities to return in a single response. Default 100, maximum 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 V1ListEmployeesRequestStatus ¶

type V1ListEmployeesRequestStatus string

const (
	ACTIVE_V1ListEmployeesRequestStatus   V1ListEmployeesRequestStatus = "ACTIVE"
	INACTIVE_V1ListEmployeesRequestStatus V1ListEmployeesRequestStatus = "INACTIVE"
)

List of V1ListEmployeesRequestStatus

type V1ListEmployeesResponse ¶

type V1ListEmployeesResponse struct {
	Items []V1Employee `json:"items,omitempty"`
}

type V1ListFeesRequest ¶

type V1ListFeesRequest struct {
}

type V1ListFeesResponse ¶

type V1ListFeesResponse struct {
	Items []V1Fee `json:"items,omitempty"`
}

type V1ListInventoryRequest ¶

type V1ListInventoryRequest struct {
	// The maximum number of inventory entries to return in a single response. This value cannot exceed 1000.
	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 V1ListInventoryResponse ¶

type V1ListInventoryResponse struct {
	Items []V1InventoryEntry `json:"items,omitempty"`
}

type V1ListItemsRequest ¶

type V1ListItemsRequest struct {
	// A pagination cursor to retrieve the next set of results for your original query to the endpoint.
	BatchToken string `json:"batch_token,omitempty"`
}

type V1ListItemsResponse ¶

type V1ListItemsResponse struct {
	Items []V1Item `json:"items,omitempty"`
}

type V1ListModifierListsRequest ¶

type V1ListModifierListsRequest struct {
}

type V1ListModifierListsResponse ¶

type V1ListModifierListsResponse struct {
	Items []V1ModifierList `json:"items,omitempty"`
}

type V1ListOrdersRequest ¶

type V1ListOrdersRequest struct {
	// TThe order in which payments are listed in the response. See [SortOrder](#type-sortorder) for possible values
	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 V1ListPagesRequest ¶

type V1ListPagesRequest struct {
}

type V1ListPagesResponse ¶

type V1ListPagesResponse struct {
	Items []V1Page `json:"items,omitempty"`
}

type V1ListPaymentsRequest ¶

type V1ListPaymentsRequest struct {
	// The order in which payments are listed in the response. See [SortOrder](#type-sortorder) for possible values
	Order string `json:"order,omitempty"`
	// The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.
	BeginTime string `json:"begin_time,omitempty"`
	// The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.
	EndTime string `json:"end_time,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"`
	// Indicates whether or not to include partial payments in the response. Partial payments will have the tenders collected so far, but the itemizations will be empty until the payment is completed.
	IncludePartial bool `json:"include_partial,omitempty"`
}

type V1ListPaymentsResponse ¶

type V1ListPaymentsResponse struct {
	Items []V1Payment `json:"items,omitempty"`
}

type V1ListRefundsRequest ¶

type V1ListRefundsRequest struct {
	// TThe order in which payments are listed in the response. See [SortOrder](#type-sortorder) for possible values
	Order string `json:"order,omitempty"`
	// The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.
	BeginTime string `json:"begin_time,omitempty"`
	// The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.
	EndTime string `json:"end_time,omitempty"`
	// The approximate number of refunds to return in a single response. Default: 100. Max: 200. Response may contain more results than the prescribed limit when refunds are made simultaneously to multiple tenders in a payment or when refunds are generated in an exchange to account for the value of returned goods.
	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 V1ListRefundsResponse ¶

type V1ListRefundsResponse struct {
	Items []V1Refund `json:"items,omitempty"`
}

type V1ListSettlementsRequest ¶

type V1ListSettlementsRequest struct {
	// The order in which settlements are listed in the response. See [SortOrder](#type-sortorder) for possible values
	Order string `json:"order,omitempty"`
	// The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.
	BeginTime string `json:"begin_time,omitempty"`
	// The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.
	EndTime string `json:"end_time,omitempty"`
	// The maximum number of settlements to return in a single response. This value cannot exceed 200.
	Limit int32 `json:"limit,omitempty"`
	// Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED). See [V1ListSettlementsRequestStatus](#type-v1listsettlementsrequeststatus) for possible values
	Status string `json:"status,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 V1ListSettlementsRequestStatus ¶

type V1ListSettlementsRequestStatus string

const (
	SENT_V1ListSettlementsRequestStatus   V1ListSettlementsRequestStatus = "SENT"
	FAILED_V1ListSettlementsRequestStatus V1ListSettlementsRequestStatus = "FAILED"
)

List of V1ListSettlementsRequestStatus

type V1ListSettlementsResponse ¶

type V1ListSettlementsResponse struct {
	Items []V1Settlement `json:"items,omitempty"`
}

type V1ListTimecardEventsRequest ¶

type V1ListTimecardEventsRequest struct {
}

type V1ListTimecardEventsResponse ¶

type V1ListTimecardEventsResponse struct {
	Items []V1TimecardEvent `json:"items,omitempty"`
}

type V1ListTimecardsRequest ¶

type V1ListTimecardsRequest struct {
	// The order in which timecards are listed in the response, based on their created_at field. See [SortOrder](#type-sortorder) for possible values
	Order string `json:"order,omitempty"`
	// If provided, the endpoint returns only timecards for the employee with the specified ID.
	EmployeeId string `json:"employee_id,omitempty"`
	// If filtering results by their clockin_time field, the beginning of the requested reporting period, in ISO 8601 format.
	BeginClockinTime string `json:"begin_clockin_time,omitempty"`
	// If filtering results by their clockin_time field, the end of the requested reporting period, in ISO 8601 format.
	EndClockinTime string `json:"end_clockin_time,omitempty"`
	// If filtering results by their clockout_time field, the beginning of the requested reporting period, in ISO 8601 format.
	BeginClockoutTime string `json:"begin_clockout_time,omitempty"`
	// If filtering results by their clockout_time field, the end of the requested reporting period, in ISO 8601 format.
	EndClockoutTime string `json:"end_clockout_time,omitempty"`
	// If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format.
	BeginUpdatedAt string `json:"begin_updated_at,omitempty"`
	// If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format.
	EndUpdatedAt string `json:"end_updated_at,omitempty"`
	// If true, only deleted timecards are returned. If false, only valid timecards are returned.If you don't provide this parameter, both valid and deleted timecards are returned.
	Deleted bool `json:"deleted,omitempty"`
	// The maximum integer number of employee entities to return in a single response. Default 100, maximum 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 V1ListTimecardsResponse ¶

type V1ListTimecardsResponse struct {
	Items []V1Timecard `json:"items,omitempty"`
}

type V1ModifierList ¶

type V1ModifierList struct {
	// The modifier list's unique ID.
	Id string `json:"id,omitempty"`
	// The modifier list's name.
	Name string `json:"name,omitempty"`
	// Indicates whether MULTIPLE options or a SINGLE option from the modifier list can be applied to a single item. See [V1ModifierListSelectionType](#type-v1modifierlistselectiontype) for possible values
	SelectionType string `json:"selection_type,omitempty"`
	// The options included in the modifier list.
	ModifierOptions []V1ModifierOption `json:"modifier_options,omitempty"`
	// The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.
	V2Id string `json:"v2_id,omitempty"`
}

V1ModifierList

type V1ModifierListSelectionType ¶

type V1ModifierListSelectionType string

const (
	SINGLE_V1ModifierListSelectionType   V1ModifierListSelectionType = "SINGLE"
	MULTIPLE_V1ModifierListSelectionType V1ModifierListSelectionType = "MULTIPLE"
)

List of V1ModifierListSelectionType

type V1ModifierOption ¶

type V1ModifierOption struct {
	// The modifier option's unique ID.
	Id string `json:"id,omitempty"`
	// The modifier option's name.
	Name       string   `json:"name,omitempty"`
	PriceMoney *V1Money `json:"price_money,omitempty"`
	// If true, the modifier option is the default option in a modifier list for which selection_type is SINGLE.
	OnByDefault bool `json:"on_by_default,omitempty"`
	// Indicates the modifier option's list position when displayed in Square Point of Sale and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order.
	Ordinal int32 `json:"ordinal,omitempty"`
	// The ID of the modifier list the option belongs to.
	ModifierListId string `json:"modifier_list_id,omitempty"`
	// The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.
	V2Id string `json:"v2_id,omitempty"`
}

V1ModifierOption

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"`
	//  See [Currency](#type-currency) for possible values
	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. See [V1OrderState](#type-v1orderstate) for possible values
	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. See [V1OrderHistoryEntryAction](#type-v1orderhistoryentryaction) for possible values
	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 V1Page ¶

type V1Page struct {
	// The page's unique identifier.
	Id string `json:"id,omitempty"`
	// The page's name, if any.
	Name string `json:"name,omitempty"`
	// The page's position in the merchant's list of pages. Always an integer between 0 and 6, inclusive.
	PageIndex int32 `json:"page_index,omitempty"`
	// The cells included on the page.
	Cells []V1PageCell `json:"cells,omitempty"`
}

V1Page

type V1PageCell ¶

type V1PageCell struct {
	// The unique identifier of the page the cell is included on.
	PageId string `json:"page_id,omitempty"`
	// The row of the cell. Always an integer between 0 and 4, inclusive.
	Row int32 `json:"row,omitempty"`
	// The column of the cell. Always an integer between 0 and 4, inclusive.
	Column int32 `json:"column,omitempty"`
	// The type of entity represented in the cell (ITEM, DISCOUNT, CATEGORY, or PLACEHOLDER). See [V1PageCellObjectType](#type-v1pagecellobjecttype) for possible values
	ObjectType string `json:"object_type,omitempty"`
	// The unique identifier of the entity represented in the cell. Not present for cells with an object_type of PLACEHOLDER.
	ObjectId string `json:"object_id,omitempty"`
	// For a cell with an object_type of PLACEHOLDER, this value indicates the cell's special behavior. See [V1PageCellPlaceholderType](#type-v1pagecellplaceholdertype) for possible values
	PlaceholderType string `json:"placeholder_type,omitempty"`
}

V1PageCell

type V1PageCellObjectType ¶

type V1PageCellObjectType string

const (
	ITEM_V1PageCellObjectType        V1PageCellObjectType = "ITEM"
	DISCOUNT_V1PageCellObjectType    V1PageCellObjectType = "DISCOUNT"
	CATEGORY_V1PageCellObjectType    V1PageCellObjectType = "CATEGORY"
	PLACEHOLDER_V1PageCellObjectType V1PageCellObjectType = "PLACEHOLDER"
)

List of V1PageCellObjectType

type V1PageCellPlaceholderType ¶

type V1PageCellPlaceholderType string

const (
	ALL_ITEMS_V1PageCellPlaceholderType          V1PageCellPlaceholderType = "ALL_ITEMS"
	DISCOUNTS_CATEGORY_V1PageCellPlaceholderType V1PageCellPlaceholderType = "DISCOUNTS_CATEGORY"
	REWARDS_FINDER_V1PageCellPlaceholderType     V1PageCellPlaceholderType = "REWARDS_FINDER"
)

List of V1PageCellPlaceholderType

type V1Payment ¶

type V1Payment struct {
	// The payment's unique identifier.
	Id string `json:"id,omitempty"`
	// The unique identifier of the merchant that took the payment.
	MerchantId string `json:"merchant_id,omitempty"`
	// The time when the payment was created, in ISO 8601 format. Reflects the time of the first payment if the object represents an incomplete partial payment, and the time of the last or complete payment otherwise.
	CreatedAt string `json:"created_at,omitempty"`
	// The unique identifier of the Square account that took the payment.
	CreatorId string  `json:"creator_id,omitempty"`
	Device    *Device `json:"device,omitempty"`
	// The URL of the payment's detail page in the merchant dashboard. The merchant must be signed in to the merchant dashboard to view this page.
	PaymentUrl string `json:"payment_url,omitempty"`
	// The URL of the receipt for the payment. Note that for split tender payments, this URL corresponds to the receipt for the first tender listed in the payment's tender field. Each Tender object has its own receipt_url field you can use to get the other receipts associated with a split tender payment.
	ReceiptUrl           string   `json:"receipt_url,omitempty"`
	InclusiveTaxMoney    *V1Money `json:"inclusive_tax_money,omitempty"`
	AdditiveTaxMoney     *V1Money `json:"additive_tax_money,omitempty"`
	TaxMoney             *V1Money `json:"tax_money,omitempty"`
	TipMoney             *V1Money `json:"tip_money,omitempty"`
	DiscountMoney        *V1Money `json:"discount_money,omitempty"`
	TotalCollectedMoney  *V1Money `json:"total_collected_money,omitempty"`
	ProcessingFeeMoney   *V1Money `json:"processing_fee_money,omitempty"`
	NetTotalMoney        *V1Money `json:"net_total_money,omitempty"`
	RefundedMoney        *V1Money `json:"refunded_money,omitempty"`
	SwedishRoundingMoney *V1Money `json:"swedish_rounding_money,omitempty"`
	GrossSalesMoney      *V1Money `json:"gross_sales_money,omitempty"`
	NetSalesMoney        *V1Money `json:"net_sales_money,omitempty"`
	// All of the inclusive taxes associated with the payment.
	InclusiveTax []V1PaymentTax `json:"inclusive_tax,omitempty"`
	// All of the additive taxes associated with the payment.
	AdditiveTax []V1PaymentTax `json:"additive_tax,omitempty"`
	// All of the tenders associated with the payment.
	Tender []V1Tender `json:"tender,omitempty"`
	// All of the refunds applied to the payment. Note that the value of all refunds on a payment can exceed the value of all tenders if a merchant chooses to refund money to a tender after previously accepting returned goods as part of an exchange.
	Refunds []V1Refund `json:"refunds,omitempty"`
	// The items purchased in the payment.
	Itemizations   []V1PaymentItemization `json:"itemizations,omitempty"`
	SurchargeMoney *V1Money               `json:"surcharge_money,omitempty"`
	// A list of all surcharges associated with the payment.
	Surcharges []V1PaymentSurcharge `json:"surcharges,omitempty"`
	// Indicates whether or not the payment is only partially paid for. If true, this payment will have the tenders collected so far, but the itemizations will be empty until the payment is completed.
	IsPartial bool `json:"is_partial,omitempty"`
}

A payment represents a paid transaction between a Square merchant and a customer. Payment details are usually available from Connect API endpoints within a few minutes after the transaction completes. Each Payment object includes several fields that end in `_money`. These fields describe the various amounts of money that contribute to the payment total: <ul> <li> Monetary values are positive if they represent an increase in the amount of money the merchant receives (e.g., <code>tax_money</code>, <code>tip_money</code>). </li> <li> Monetary values are negative if they represent an decrease in the amount of money the merchant receives (e.g., <code>discount_money</code>, <code>refunded_money</code>). </li> </ul>

type V1PaymentDiscount ¶

type V1PaymentDiscount struct {
	// The discount's name.
	Name         string   `json:"name,omitempty"`
	AppliedMoney *V1Money `json:"applied_money,omitempty"`
	// The ID of the applied discount, if available. Discounts applied in older versions of Square Register might not have an ID.
	DiscountId string `json:"discount_id,omitempty"`
}

V1PaymentDiscount

type V1PaymentItemDetail ¶

type V1PaymentItemDetail struct {
	// The name of the item's merchant-defined category, if any.
	CategoryName string `json:"category_name,omitempty"`
	//  The item's merchant-defined SKU, if any.
	Sku string `json:"sku,omitempty"`
	// The unique ID of the item purchased, if any.
	ItemId string `json:"item_id,omitempty"`
	// The unique ID of the item variation purchased, if any.
	ItemVariationId string `json:"item_variation_id,omitempty"`
}

V1PaymentItemDetail

type V1PaymentItemization ¶

type V1PaymentItemization struct {
	// The item's name.
	Name string `json:"name,omitempty"`
	// The quantity of the item purchased. This can be a decimal value.
	Quantity float64 `json:"quantity,omitempty"`
	// The type of purchase that the itemization represents, such as an ITEM or CUSTOM_AMOUNT See [V1PaymentItemizationItemizationType](#type-v1paymentitemizationitemizationtype) for possible values
	ItemizationType string               `json:"itemization_type,omitempty"`
	ItemDetail      *V1PaymentItemDetail `json:"item_detail,omitempty"`
	// Notes entered by the merchant about the item at the time of payment, if any.
	Notes string `json:"notes,omitempty"`
	// The name of the item variation purchased, if any.
	ItemVariationName   string   `json:"item_variation_name,omitempty"`
	TotalMoney          *V1Money `json:"total_money,omitempty"`
	SingleQuantityMoney *V1Money `json:"single_quantity_money,omitempty"`
	GrossSalesMoney     *V1Money `json:"gross_sales_money,omitempty"`
	DiscountMoney       *V1Money `json:"discount_money,omitempty"`
	NetSalesMoney       *V1Money `json:"net_sales_money,omitempty"`
	// All taxes applied to this itemization.
	Taxes []V1PaymentTax `json:"taxes,omitempty"`
	// All discounts applied to this itemization.
	Discounts []V1PaymentDiscount `json:"discounts,omitempty"`
	// All modifier options applied to this itemization.
	Modifiers []V1PaymentModifier `json:"modifiers,omitempty"`
}

Payment include an` itemizations` field that lists the items purchased, along with associated fees, modifiers, and discounts. Each itemization has an `itemization_type` field that indicates which of the following the itemization represents: <ul> <li>An item variation from the merchant's item library</li> <li>A custom monetary amount</li> <li> An action performed on a Square gift card, such as activating or reloading it. </li> </ul> *Note**: itemization information included in a `Payment` object reflects details collected **at the time of the payment**. Details such as the name or price of items might have changed since the payment was processed.

type V1PaymentItemizationItemizationType ¶

type V1PaymentItemizationItemizationType string

const (
	ITEM_V1PaymentItemizationItemizationType                 V1PaymentItemizationItemizationType = "ITEM"
	CUSTOM_AMOUNT_V1PaymentItemizationItemizationType        V1PaymentItemizationItemizationType = "CUSTOM_AMOUNT"
	GIFT_CARD_ACTIVATION_V1PaymentItemizationItemizationType V1PaymentItemizationItemizationType = "GIFT_CARD_ACTIVATION"
	GIFT_CARD_RELOAD_V1PaymentItemizationItemizationType     V1PaymentItemizationItemizationType = "GIFT_CARD_RELOAD"
	GIFT_CARD_UNKNOWN_V1PaymentItemizationItemizationType    V1PaymentItemizationItemizationType = "GIFT_CARD_UNKNOWN"
	OTHER_V1PaymentItemizationItemizationType                V1PaymentItemizationItemizationType = "OTHER"
)

List of V1PaymentItemizationItemizationType

type V1PaymentModifier ¶

type V1PaymentModifier struct {
	// The modifier option's name.
	Name         string   `json:"name,omitempty"`
	AppliedMoney *V1Money `json:"applied_money,omitempty"`
	// TThe ID of the applied modifier option, if available. Modifier options applied in older versions of Square Register might not have an ID.
	ModifierOptionId string `json:"modifier_option_id,omitempty"`
}

V1PaymentModifier

type V1PaymentSurcharge ¶

type V1PaymentSurcharge struct {
	// The name of the surcharge.
	Name         string   `json:"name,omitempty"`
	AppliedMoney *V1Money `json:"applied_money,omitempty"`
	// The amount of the surcharge as a percentage. The percentage is provided as a string representing the decimal equivalent of the percentage. For example, \"0.7\" corresponds to a 7% surcharge. Exactly one of rate or amount_money should be set.
	Rate        string   `json:"rate,omitempty"`
	AmountMoney *V1Money `json:"amount_money,omitempty"`
	// Indicates the source of the surcharge. For example, if it was applied as an automatic gratuity for a large group. See [V1PaymentSurchargeType](#type-v1paymentsurchargetype) for possible values
	Type_ string `json:"type,omitempty"`
	// Indicates whether the surcharge is taxable.
	Taxable bool `json:"taxable,omitempty"`
	// The list of taxes that should be applied to the surcharge.
	Taxes []V1PaymentTax `json:"taxes,omitempty"`
	// A Square-issued unique identifier associated with the surcharge.
	SurchargeId string `json:"surcharge_id,omitempty"`
}

V1PaymentSurcharge

type V1PaymentSurchargeType ¶

type V1PaymentSurchargeType string

const (
	UNKNOWN_V1PaymentSurchargeType       V1PaymentSurchargeType = "UNKNOWN"
	AUTO_GRATUITY_V1PaymentSurchargeType V1PaymentSurchargeType = "AUTO_GRATUITY"
	CUSTOM_V1PaymentSurchargeType        V1PaymentSurchargeType = "CUSTOM"
)

List of V1PaymentSurchargeType

type V1PaymentTax ¶

type V1PaymentTax struct {
	// Any errors that occurred during the request.
	Errors []ModelError `json:"errors,omitempty"`
	// The merchant-defined name of the tax.
	Name         string   `json:"name,omitempty"`
	AppliedMoney *V1Money `json:"applied_money,omitempty"`
	// The rate of the tax, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%.
	Rate string `json:"rate,omitempty"`
	// Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. See [V1PaymentTaxInclusionType](#type-v1paymenttaxinclusiontype) for possible values
	InclusionType string `json:"inclusion_type,omitempty"`
	// The ID of the tax, if available. Taxes applied in older versions of Square Register might not have an ID.
	FeeId string `json:"fee_id,omitempty"`
}

V1PaymentTax

type V1PaymentTaxInclusionType ¶

type V1PaymentTaxInclusionType string

const (
	ADDITIVE_V1PaymentTaxInclusionType  V1PaymentTaxInclusionType = "ADDITIVE"
	INCLUSIVE_V1PaymentTaxInclusionType V1PaymentTaxInclusionType = "INCLUSIVE"
)

List of V1PaymentTaxInclusionType

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 V1Refund ¶

type V1Refund struct {
	// The type of refund See [V1RefundType](#type-v1refundtype) for possible values
	Type_ string `json:"type,omitempty"`
	// The merchant-specified reason for the refund.
	Reason                     string   `json:"reason,omitempty"`
	RefundedMoney              *V1Money `json:"refunded_money,omitempty"`
	RefundedProcessingFeeMoney *V1Money `json:"refunded_processing_fee_money,omitempty"`
	RefundedTaxMoney           *V1Money `json:"refunded_tax_money,omitempty"`
	RefundedAdditiveTaxMoney   *V1Money `json:"refunded_additive_tax_money,omitempty"`
	// All of the additive taxes associated with the refund.
	RefundedAdditiveTax       []V1PaymentTax `json:"refunded_additive_tax,omitempty"`
	RefundedInclusiveTaxMoney *V1Money       `json:"refunded_inclusive_tax_money,omitempty"`
	// All of the inclusive taxes associated with the refund.
	RefundedInclusiveTax   []V1PaymentTax `json:"refunded_inclusive_tax,omitempty"`
	RefundedTipMoney       *V1Money       `json:"refunded_tip_money,omitempty"`
	RefundedDiscountMoney  *V1Money       `json:"refunded_discount_money,omitempty"`
	RefundedSurchargeMoney *V1Money       `json:"refunded_surcharge_money,omitempty"`
	// A list of all surcharges associated with the refund.
	RefundedSurcharges []V1PaymentSurcharge `json:"refunded_surcharges,omitempty"`
	// The time when the merchant initiated the refund for Square to process, in ISO 8601 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The time when Square processed the refund on behalf of the merchant, in ISO 8601 format.
	ProcessedAt string `json:"processed_at,omitempty"`
	// A Square-issued ID associated with the refund. For single-tender refunds, payment_id is the ID of the original payment ID. For split-tender refunds, payment_id is the ID of the original tender. For exchange-based refunds (is_exchange == true), payment_id is the ID of the original payment ID even if the payment includes other tenders.
	PaymentId  string `json:"payment_id,omitempty"`
	MerchantId string `json:"merchant_id,omitempty"`
	// Indicates whether or not the refund is associated with an exchange. If is_exchange is true, the refund reflects the value of goods returned in the exchange not the total money refunded.
	IsExchange bool `json:"is_exchange,omitempty"`
}

V1Refund

type V1RefundType ¶

type V1RefundType string

const (
	FULL_V1RefundType    V1RefundType = "FULL"
	PARTIAL_V1RefundType V1RefundType = "PARTIAL"
)

List of V1RefundType

type V1RemoveFeeRequest ¶

type V1RemoveFeeRequest struct {
}

type V1RemoveModifierListRequest ¶

type V1RemoveModifierListRequest struct {
}

type V1RetrieveBankAccountRequest ¶

type V1RetrieveBankAccountRequest struct {
}

type V1RetrieveCashDrawerShiftRequest ¶

type V1RetrieveCashDrawerShiftRequest struct {
}

type V1RetrieveEmployeeRequest ¶

type V1RetrieveEmployeeRequest struct {
}

type V1RetrieveEmployeeRoleRequest ¶

type V1RetrieveEmployeeRoleRequest struct {
}

type V1RetrieveItemRequest ¶

type V1RetrieveItemRequest struct {
}

type V1RetrieveModifierListRequest ¶

type V1RetrieveModifierListRequest struct {
}

type V1RetrieveOrderRequest ¶

type V1RetrieveOrderRequest struct {
}

type V1RetrievePaymentRequest ¶

type V1RetrievePaymentRequest struct {
}

type V1RetrieveSettlementRequest ¶

type V1RetrieveSettlementRequest struct {
}

type V1RetrieveTimecardRequest ¶

type V1RetrieveTimecardRequest struct {
}

type V1Settlement ¶

type V1Settlement struct {
	// The settlement's unique identifier.
	Id string `json:"id,omitempty"`
	// The settlement's current status. See [V1SettlementStatus](#type-v1settlementstatus) for possible values
	Status     string   `json:"status,omitempty"`
	TotalMoney *V1Money `json:"total_money,omitempty"`
	// The time when the settlement was submitted for deposit or withdrawal, in ISO 8601 format.
	InitiatedAt string `json:"initiated_at,omitempty"`
	// The Square-issued unique identifier for the bank account associated with the settlement.
	BankAccountId string `json:"bank_account_id,omitempty"`
	// The entries included in this settlement.
	Entries []V1SettlementEntry `json:"entries,omitempty"`
}

V1Settlement

type V1SettlementEntry ¶

type V1SettlementEntry struct {
	// The settlement's unique identifier.
	PaymentId string `json:"payment_id,omitempty"`
	// The settlement's current status. See [V1SettlementEntryType](#type-v1settlemententrytype) for possible values
	Type_       string   `json:"type,omitempty"`
	AmountMoney *V1Money `json:"amount_money,omitempty"`
	FeeMoney    *V1Money `json:"fee_money,omitempty"`
}

V1SettlementEntry

type V1SettlementEntryType ¶

type V1SettlementEntryType string

const (
	ADJUSTMENT_V1SettlementEntryType                      V1SettlementEntryType = "ADJUSTMENT"
	BALANCE_CHARGE_V1SettlementEntryType                  V1SettlementEntryType = "BALANCE_CHARGE"
	CHARGE_V1SettlementEntryType                          V1SettlementEntryType = "CHARGE"
	FREE_PROCESSING_V1SettlementEntryType                 V1SettlementEntryType = "FREE_PROCESSING"
	HOLD_ADJUSTMENT_V1SettlementEntryType                 V1SettlementEntryType = "HOLD_ADJUSTMENT"
	PAID_SERVICE_FEE_V1SettlementEntryType                V1SettlementEntryType = "PAID_SERVICE_FEE"
	PAID_SERVICE_FEE_REFUND_V1SettlementEntryType         V1SettlementEntryType = "PAID_SERVICE_FEE_REFUND"
	REDEMPTION_CODE_V1SettlementEntryType                 V1SettlementEntryType = "REDEMPTION_CODE"
	REFUND_V1SettlementEntryType                          V1SettlementEntryType = "REFUND"
	RETURNED_PAYOUT_V1SettlementEntryType                 V1SettlementEntryType = "RETURNED_PAYOUT"
	SQUARE_CAPITAL_ADVANCE_V1SettlementEntryType          V1SettlementEntryType = "SQUARE_CAPITAL_ADVANCE"
	SQUARE_CAPITAL_PAYMENT_V1SettlementEntryType          V1SettlementEntryType = "SQUARE_CAPITAL_PAYMENT"
	SQUARE_CAPITAL_REVERSED_PAYMENT_V1SettlementEntryType V1SettlementEntryType = "SQUARE_CAPITAL_REVERSED_PAYMENT"
	SUBSCRIPTION_FEE_V1SettlementEntryType                V1SettlementEntryType = "SUBSCRIPTION_FEE"
	SUBSCRIPTION_FEE_REFUND_V1SettlementEntryType         V1SettlementEntryType = "SUBSCRIPTION_FEE_REFUND"
	OTHER_V1SettlementEntryType                           V1SettlementEntryType = "OTHER"
	INCENTED_PAYMENT_V1SettlementEntryType                V1SettlementEntryType = "INCENTED_PAYMENT"
	RETURNED_ACH_ENTRY_V1SettlementEntryType              V1SettlementEntryType = "RETURNED_ACH_ENTRY"
	RETURNED_SQUARE_275_V1SettlementEntryType             V1SettlementEntryType = "RETURNED_SQUARE_275"
	SQUARE_275_V1SettlementEntryType                      V1SettlementEntryType = "SQUARE_275"
	SQUARE_CARD_V1SettlementEntryType                     V1SettlementEntryType = "SQUARE_CARD"
)

List of V1SettlementEntryType

type V1SettlementStatus ¶

type V1SettlementStatus string

const (
	FAILED_V1SettlementStatus V1SettlementStatus = "FAILED"
	SENT_V1SettlementStatus   V1SettlementStatus = "SENT"
)

List of V1SettlementStatus

type V1Tender ¶

type V1Tender struct {
	// The tender's unique ID.
	Id string `json:"id,omitempty"`
	// The type of tender. See [V1TenderType](#type-v1tendertype) for possible values
	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. See [V1TenderCardBrand](#type-v1tendercardbrand) for possible values
	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. See [V1TenderEntryMethod](#type-v1tenderentrymethod) for possible values
	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 V1Timecard ¶

type V1Timecard struct {
	// The timecard's unique ID.
	Id string `json:"id,omitempty"`
	// The ID of the employee the timecard is associated with.
	EmployeeId string `json:"employee_id"`
	// If true, the timecard was deleted by the merchant, and it is no longer valid.
	Deleted bool `json:"deleted,omitempty"`
	// The clock-in time for the timecard, in ISO 8601 format.
	ClockinTime string `json:"clockin_time,omitempty"`
	// The clock-out time for the timecard, in ISO 8601 format. Provide this value only if importing timecard information from another system.
	ClockoutTime string `json:"clockout_time,omitempty"`
	// The ID of the location the employee clocked in from. We strongly reccomend providing a clockin_location_id. Square uses the clockin_location_id to determine a timecard’s timezone and overtime rules.
	ClockinLocationId string `json:"clockin_location_id,omitempty"`
	// The ID of the location the employee clocked out from. Provide this value only if importing timecard information from another system.
	ClockoutLocationId string `json:"clockout_location_id,omitempty"`
	// The time when the timecard was created, in ISO 8601 format.
	CreatedAt string `json:"created_at,omitempty"`
	// The time when the timecard was most recently updated, in ISO 8601 format.
	UpdatedAt string `json:"updated_at,omitempty"`
	// The total number of regular (non-overtime) seconds worked in the timecard.
	RegularSecondsWorked float64 `json:"regular_seconds_worked,omitempty"`
	// The total number of overtime seconds worked in the timecard.
	OvertimeSecondsWorked float64 `json:"overtime_seconds_worked,omitempty"`
	// The total number of doubletime seconds worked in the timecard.
	DoubletimeSecondsWorked float64 `json:"doubletime_seconds_worked,omitempty"`
}

Represents a timecard for an employee.

type V1TimecardEvent ¶

type V1TimecardEvent struct {
	// The event's unique ID.
	Id string `json:"id,omitempty"`
	// The ID of the timecard to list events for. See [V1TimecardEventEventType](#type-v1timecardeventeventtype) for possible values
	EventType string `json:"event_type,omitempty"`
	// The time the employee clocked in, in ISO 8601 format.
	ClockinTime string `json:"clockin_time,omitempty"`
	// The time the employee clocked out, in ISO 8601 format.
	ClockoutTime string `json:"clockout_time,omitempty"`
	// The time when the event was created, in ISO 8601 format.
	CreatedAt string `json:"created_at,omitempty"`
}

V1TimecardEvent

type V1TimecardEventEventType ¶

type V1TimecardEventEventType string

V1TimecardEventEventType : Actions that resulted in a change to a timecard. All timecard events created with the Connect API have an event type that begins with `API`.

const (
	API_CREATE_V1TimecardEventEventType                 V1TimecardEventEventType = "API_CREATE"
	API_EDIT_V1TimecardEventEventType                   V1TimecardEventEventType = "API_EDIT"
	API_DELETE_V1TimecardEventEventType                 V1TimecardEventEventType = "API_DELETE"
	REGISTER_CLOCKIN_V1TimecardEventEventType           V1TimecardEventEventType = "REGISTER_CLOCKIN"
	REGISTER_CLOCKOUT_V1TimecardEventEventType          V1TimecardEventEventType = "REGISTER_CLOCKOUT"
	DASHBOARD_SUPERVISOR_CLOSE_V1TimecardEventEventType V1TimecardEventEventType = "DASHBOARD_SUPERVISOR_CLOSE"
	DASHBOARD_EDIT_V1TimecardEventEventType             V1TimecardEventEventType = "DASHBOARD_EDIT"
	DASHBOARD_DELETE_V1TimecardEventEventType           V1TimecardEventEventType = "DASHBOARD_DELETE"
)

List of V1TimecardEventEventType

type V1TransactionsApiListOrdersOpts ¶

type V1TransactionsApiListOrdersOpts struct {
	Order      optional.String
	Limit      optional.Int32
	BatchToken optional.String
}

type V1TransactionsApiListPaymentsOpts ¶

type V1TransactionsApiListPaymentsOpts struct {
	Order          optional.String
	BeginTime      optional.String
	EndTime        optional.String
	Limit          optional.Int32
	BatchToken     optional.String
	IncludePartial optional.Bool
}

type V1TransactionsApiListRefundsOpts ¶

type V1TransactionsApiListRefundsOpts struct {
	Order      optional.String
	BeginTime  optional.String
	EndTime    optional.String
	Limit      optional.Int32
	BatchToken optional.String
}

type V1TransactionsApiListSettlementsOpts ¶

type V1TransactionsApiListSettlementsOpts struct {
	Order      optional.String
	BeginTime  optional.String
	EndTime    optional.String
	Limit      optional.Int32
	Status     optional.String
	BatchToken optional.String
}

type V1TransactionsApiService ¶

type V1TransactionsApiService service

func (*V1TransactionsApiService) CreateRefund ¶

func (a *V1TransactionsApiService) CreateRefund(ctx context.Context, body V1CreateRefundRequest, locationId string) (V1Refund, *http.Response, error)

V1TransactionsApiService CreateRefund Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment. You cannot issue a partial refund for a split tender payment. You must instead issue a full or partial refund for a particular tender, by providing the applicable tender id to the V1CreateRefund endpoint. Issuing a full refund for a split tender payment refunds all tenders associated with the payment. Issuing a refund for a card payment is not reversible. For development purposes, you can create fake cash payments in Square Point of Sale and refund them.

@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 original payment's associated location.

@return V1Refund

func (*V1TransactionsApiService) ListBankAccounts ¶

func (a *V1TransactionsApiService) ListBankAccounts(ctx context.Context, locationId string) ([]V1BankAccount, *http.Response, error)

V1TransactionsApiService ListBankAccounts Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.

@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 list bank accounts for.

@return []V1BankAccount

func (*V1TransactionsApiService) ListOrders ¶

func (a *V1TransactionsApiService) ListOrders(ctx context.Context, locationId string, localVarOptionals *V1TransactionsApiListOrdersOpts) ([]V1Order, *http.Response, error)

func (*V1TransactionsApiService) ListPayments ¶

func (a *V1TransactionsApiService) ListPayments(ctx context.Context, locationId string, localVarOptionals *V1TransactionsApiListPaymentsOpts) ([]V1Payment, *http.Response, error)

func (*V1TransactionsApiService) ListRefunds ¶

func (a *V1TransactionsApiService) ListRefunds(ctx context.Context, locationId string, localVarOptionals *V1TransactionsApiListRefundsOpts) ([]V1Refund, *http.Response, error)

func (*V1TransactionsApiService) ListSettlements ¶

func (a *V1TransactionsApiService) ListSettlements(ctx context.Context, locationId string, localVarOptionals *V1TransactionsApiListSettlementsOpts) ([]V1Settlement, *http.Response, error)

func (*V1TransactionsApiService) RetrieveBankAccount ¶

func (a *V1TransactionsApiService) RetrieveBankAccount(ctx context.Context, locationId string, bankAccountId string) (V1BankAccount, *http.Response, error)

V1TransactionsApiService RetrieveBankAccount Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the bank account's associated location.
@param bankAccountId The bank account's Square-issued ID. You obtain this value from Settlement objects returned.

@return V1BankAccount

func (*V1TransactionsApiService) RetrieveOrder ¶

func (a *V1TransactionsApiService) RetrieveOrder(ctx context.Context, locationId string, orderId string) (V1Order, *http.Response, error)

V1TransactionsApiService RetrieveOrder 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) RetrievePayment ¶

func (a *V1TransactionsApiService) RetrievePayment(ctx context.Context, locationId string, paymentId string) (V1Payment, *http.Response, error)

V1TransactionsApiService RetrievePayment Provides comprehensive information for a single payment.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the payment's associated location.
@param paymentId The Square-issued payment ID. payment_id comes from Payment objects returned by the List Payments endpoint, Settlement objects returned by the List Settlements endpoint, or Refund objects returned by the List Refunds endpoint.

@return V1Payment

func (*V1TransactionsApiService) RetrieveSettlement ¶

func (a *V1TransactionsApiService) RetrieveSettlement(ctx context.Context, locationId string, settlementId string) (V1Settlement, *http.Response, error)

V1TransactionsApiService RetrieveSettlement Provides comprehensive information for a single settlement. The returned `Settlement` objects include an `entries` field that lists the transactions that contribute to the settlement total. Most settlement entries correspond to a payment payout, but settlement entries are also generated for less common events, like refunds, manual adjustments, or chargeback holds. Square initiates its regular deposits as indicated in the [Deposit Options with Square](https://squareup.com/help/us/en/article/3807) help article. Details for a regular deposit are usually not available from Connect API endpoints before 10 p.m. PST the same day. Square does not know when an initiated settlement **completes**, only whether it has failed. A completed settlement is typically reflected in a bank account within 3 business days, but in exceptional cases it may take longer.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param locationId The ID of the settlements's associated location.
@param settlementId The settlement's Square-issued ID. You obtain this value from Settlement objects returned by the List Settlements endpoint.

@return V1Settlement

func (*V1TransactionsApiService) UpdateOrder ¶

func (a *V1TransactionsApiService) UpdateOrder(ctx context.Context, body V1UpdateOrderRequest, locationId string, orderId string) (V1Order, *http.Response, error)

V1TransactionsApiService UpdateOrder 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 V1UpdateCategoryRequest ¶

type V1UpdateCategoryRequest struct {
	Body *V1Category `json:"body"`
}

type V1UpdateDiscountRequest ¶

type V1UpdateDiscountRequest struct {
	Body *V1Discount `json:"body"`
}

type V1UpdateEmployeeRequest ¶

type V1UpdateEmployeeRequest struct {
	Body *V1Employee `json:"body"`
}

type V1UpdateEmployeeRoleRequest ¶

type V1UpdateEmployeeRoleRequest struct {
	Body *V1EmployeeRole `json:"body"`
}

type V1UpdateFeeRequest ¶

type V1UpdateFeeRequest struct {
	Body *V1Fee `json:"body"`
}

type V1UpdateItemRequest ¶

type V1UpdateItemRequest struct {
	Body *V1Item `json:"body"`
}

type V1UpdateModifierListRequest ¶

type V1UpdateModifierListRequest struct {
	// The modifier list's name.
	Name string `json:"name,omitempty"`
	// Indicates whether multiple options from the modifier list can be applied to a single item. See [V1UpdateModifierListRequestSelectionType](#type-v1updatemodifierlistrequestselectiontype) for possible values
	SelectionType string `json:"selection_type,omitempty"`
}

V1UpdateModifierListRequest

type V1UpdateModifierListRequestSelectionType ¶

type V1UpdateModifierListRequestSelectionType string

const (
	SINGLE_V1UpdateModifierListRequestSelectionType   V1UpdateModifierListRequestSelectionType = "SINGLE"
	MULTIPLE_V1UpdateModifierListRequestSelectionType V1UpdateModifierListRequestSelectionType = "MULTIPLE"
)

List of V1UpdateModifierListRequestSelectionType

type V1UpdateModifierOptionRequest ¶

type V1UpdateModifierOptionRequest struct {
	Body *V1ModifierOption `json:"body"`
}

type V1UpdateOrderRequest ¶

type V1UpdateOrderRequest struct {
	// The action to perform on the order (COMPLETE, CANCEL, or REFUND). See [V1UpdateOrderRequestAction](#type-v1updateorderrequestaction) for possible values
	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 V1UpdatePageCellRequest ¶

type V1UpdatePageCellRequest struct {
	Body *V1PageCell `json:"body"`
}

type V1UpdatePageRequest ¶

type V1UpdatePageRequest struct {
	Body *V1Page `json:"body"`
}

type V1UpdateTimecardRequest ¶

type V1UpdateTimecardRequest struct {
	Body *V1Timecard `json:"body"`
}

type V1UpdateVariationRequest ¶

type V1UpdateVariationRequest struct {
	Body *V1Variation `json:"body"`
}

type V1Variation ¶

type V1Variation struct {
	// The item variation's unique ID.
	Id string `json:"id,omitempty"`
	// The item variation's name.
	Name string `json:"name,omitempty"`
	// The ID of the variation's associated item.
	ItemId string `json:"item_id,omitempty"`
	// Indicates the variation's list position when displayed in Square Point of Sale and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order
	Ordinal int32 `json:"ordinal,omitempty"`
	// Indicates whether the item variation's price is fixed or determined at the time of sale. See [V1VariationPricingType](#type-v1variationpricingtype) for possible values
	PricingType string   `json:"pricing_type,omitempty"`
	PriceMoney  *V1Money `json:"price_money,omitempty"`
	// The item variation's SKU, if any.
	Sku string `json:"sku,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. See [V1VariationInventoryAlertType](#type-v1variationinventoryalerttype) for possible values
	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.
	InventoryAlertThreshold int32 `json:"inventory_alert_threshold,omitempty"`
	// Arbitrary metadata associated with the variation. Cannot exceed 255 characters.
	UserData string `json:"user_data,omitempty"`
	// The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.
	V2Id string `json:"v2_id,omitempty"`
}

V1Variation

type V1VariationInventoryAlertType ¶

type V1VariationInventoryAlertType string

const (
	LOW_QUANTITY_V1VariationInventoryAlertType V1VariationInventoryAlertType = "LOW_QUANTITY"
	NONE_V1VariationInventoryAlertType         V1VariationInventoryAlertType = "NONE"
	INVESTMENT_V1VariationInventoryAlertType   V1VariationInventoryAlertType = "INVESTMENT"
	LOAN_V1VariationInventoryAlertType         V1VariationInventoryAlertType = "LOAN"
	SAVINGS_V1VariationInventoryAlertType      V1VariationInventoryAlertType = "SAVINGS"
	OTHER_V1VariationInventoryAlertType        V1VariationInventoryAlertType = "OTHER"
)

List of V1VariationInventoryAlertType

type V1VariationPricingType ¶

type V1VariationPricingType string

const (
	FIXED_PRICING_V1VariationPricingType    V1VariationPricingType = "FIXED_PRICING"
	VARIABLE_PRICING_V1VariationPricingType V1VariationPricingType = "VARIABLE_PRICING"
)

List of V1VariationPricingType

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](#endpoint-voidtransaction) endpoint.

type WageSetting ¶

type WageSetting struct {
	// The unique ID of the `TeamMember` whom this wage setting describes.
	TeamMemberId string `json:"team_member_id,omitempty"`
	// <b>Required</b> The ordered list of jobs that the team member is assigned to. The first job assignment is considered the team member's \"Primary Job\". <br> <b>Min Length 1    Max Length 12</b>
	JobAssignments []JobAssignment `json:"job_assignments,omitempty"`
	// Whether the team member is exempt from the overtime rules of the seller country.
	IsOvertimeExempt bool `json:"is_overtime_exempt,omitempty"`
	// Used for resolving concurrency issues; request will fail if version provided does not match server version at time of request. If not provided, Square executes a blind write, potentially overwriting data from another write. Read about [optimistic concurrency](https://developer.squareup.com/docs/docs/working-with-apis/optimistic-concurrency) in Square APIs for more information.
	Version int32 `json:"version,omitempty"`
	// The timestamp in RFC 3339 format describing when the wage setting object was created. Ex: \"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. Ex: \"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 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 {
	// UUID for this object
	Id string `json:"id,omitempty"`
	// The day of the week on which a business week cuts over for compensation purposes. See [Weekday](#type-weekday) for possible values
	StartOfWeek string `json:"start_of_week"`
	// The local time at which a business week cuts over. 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; request will fail if version provided does not match server version at time of 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 work week. Used for the calculation of overtime pay.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL