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
Redistributable license
Tagged version
Stable version
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 appointmen