Documentation by YARD 0.9.38

Alphabetic Index

File Listing

Namespace Listing A-Z

APIException (SquareLegacy)
APIHelper (SquareLegacy)
AcceptDisputeResponse (Square::Types)
AcceptDisputesRequest (Square::Disputes::Types)
AcceptedPaymentMethods (Square::Types)
Accounts (Square::Loyalty)
AccumulateLoyaltyPointsRequest (Square::Loyalty::Accounts::Types)
AccumulateLoyaltyPointsResponse (Square::Types)
AchDetails (Square::Types)
ActionCancelReason (Square::Types)
Actions (Square::Terminal)
Activities (Square::GiftCards)
ActivityType (Square::Types)
AddGroupToCustomerResponse (Square::Types)
AddGroupsRequest (Square::Customers::Groups::Types)
AdditionalRecipient (Square::Types)
Address (Square::Types)
AdjustLoyaltyPointsRequest (Square::Loyalty::Accounts::Types)
AdjustLoyaltyPointsResponse (Square::Types)
AfterpayDetails (Square::Types)
ApiError (Square::Errors)
ApiResponse (SquareLegacy)
ApplePay (Square)
ApplePayApi (SquareLegacy)
ApplicationDetails (Square::Types)
ApplicationDetailsExternalSquareProduct (Square::Types)
ApplicationType (Square::Types)
AppointmentSegment (Square::Types)
ArchivedState (Square::Types)
Array (Square::Internal::Types)
Availability (Square::Types)

EcomVisibility (Square::Types)
Employee (Square::Types)
EmployeeStatus (Square::Types)
EmployeeWage (Square::Types)
EmployeeWages (Square::Labor)
Employees (Square)
EmployeesApi (SquareLegacy)
EnableEventsResponse (Square::Types)
Encoder (Square::Internal::Multipart)
Enum (Square::Internal::Types)
Environment (Square)
Error (Square::Types)
ErrorCategory (Square::Types)
ErrorCode (Square::Types)
Errors (Square)
Errors (Square::Internal)
Event (Square::Types)
EventData (Square::Types)
EventMetadata (Square::Types)
EventTypeMetadata (Square::Types)
EventTypes (Square::Webhooks)
Events (Square)
EventsApi (SquareLegacy)
Evidence (Square::Disputes)
ExcludeStrategy (Square::Types)
ExternalPaymentDetails (Square::Types)

GetAccountsRequest (Square::Loyalty::Accounts::Types)
GetActionsRequest (Square::Terminal::Actions::Types)
GetAdjustmentInventoryRequest (Square::Inventory::Types)
GetBankAccountByV1IdResponse (Square::Types)
GetBankAccountResponse (Square::Types)
GetBankAccountsRequest (Square::BankAccounts::Types)
GetBookingRequest (Square::Types)
GetBookingResponse (Square::Types)
GetBookingsRequest (Square::Bookings::Types)
GetBreakTypeResponse (Square::Types)
GetBreakTypesRequest (Square::Labor::BreakTypes::Types)
GetBusinessBookingProfileRequest (Square::Types)
GetBusinessBookingProfileResponse (Square::Types)
GetByV1IdBankAccountsRequest (Square::BankAccounts::Types)
GetCardRequest (Square::Types)
GetCardResponse (Square::Types)
GetCardsRequest (Square::Cards::Types)
GetCashDrawerShiftResponse (Square::Types)
GetCatalogObjectResponse (Square::Types)
GetChannelsRequest (Square::Channels::Types)
GetCheckoutsRequest (Square::Terminal::Checkouts::Types)
GetCodesRequest (Square::Devices::Codes::Types)
GetCustomAttributeDefinitionsRequest (Square::Orders::CustomAttributeDefinitions::Types)
GetCustomAttributeDefinitionsRequest (Square::Bookings::CustomAttributeDefinitions::Types)
GetCustomAttributeDefinitionsRequest (Square::Customers::CustomAttributeDefinitions::Types)
GetCustomAttributeDefinitionsRequest (Square::Locations::CustomAttributeDefinitions::Types)
GetCustomAttributeDefinitionsRequest (Square::Merchants::CustomAttributeDefinitions::Types)
GetCustomAttributesRequest (Square::Orders::CustomAttributes::Types)
GetCustomAttributesRequest (Square::Bookings::CustomAttributes::Types)
GetCustomAttributesRequest (Square::Customers::CustomAttributes::Types)
GetCustomAttributesRequest (Square::Locations::CustomAttributes::Types)
GetCustomAttributesRequest (Square::Merchants::CustomAttributes::Types)
GetCustomerCustomAttributeDefinitionResponse (Square::Types)
GetCustomerCustomAttributeResponse (Square::Types)
GetCustomerGroupRequest (Square::Types)
GetCustomerGroupResponse (Square::Types)
GetCustomerRequest (Square::Types)
GetCustomerResponse (Square::Types)
GetCustomerSegmentRequest (Square::Types)
GetCustomerSegmentResponse (Square::Types)
GetCustomersRequest (Square::Customers::Types)
GetDeviceCodeResponse (Square::Types)
GetDeviceResponse (Square::Types)
GetDevicesRequest (Square::Devices::Types)
GetDisputeEvidenceRequest (Square::Types)
GetDisputeEvidenceResponse (Square::Types)
GetDisputeRequest (Square::Types)
GetDisputeResponse (Square::Types)
GetDisputesRequest (Square::Disputes::Types)
GetEmployeeRequest (Square::Types)
GetEmployeeResponse (Square::Types)
GetEmployeeWageResponse (Square::Types)
GetEmployeeWagesRequest (Square::Labor::EmployeeWages::Types)
GetEmployeesRequest (Square::Employees::Types)
GetEvidenceRequest (Square::Disputes::Evidence::Types)
GetGiftCardFromGanRequest (Square::GiftCards::Types)
GetGiftCardFromGanResponse (Square::Types)
GetGiftCardFromNonceRequest (Square::GiftCards::Types)
GetGiftCardFromNonceResponse (Square::Types)
GetGiftCardRequest (Square::Types)
GetGiftCardResponse (Square::Types)
GetGiftCardsRequest (Square::GiftCards::Types)
GetGroupsRequest (Square::Customers::Groups::Types)
GetInventoryAdjustmentRequest (Square::Types)
GetInventoryAdjustmentResponse (Square::Types)
GetInventoryChangesResponse (Square::Types)
GetInventoryCountResponse (Square::Types)
GetInventoryPhysicalCountRequest (Square::Types)
GetInventoryPhysicalCountResponse (Square::Types)
GetInventoryRequest (Square::Inventory::Types)
GetInventoryTransferRequest (Square::Types)
GetInventoryTransferResponse (Square::Types)
GetInvoiceResponse (Square::Types)
GetInvoicesRequest (Square::Invoices::Types)
GetLocationRequest (Square::Types)
GetLocationResponse (Square::Types)
GetLocationsRequest (Square::Locations::Types)
GetLoyaltyAccountRequest (Square::Types)
GetLoyaltyAccountResponse (Square::Types)
GetLoyaltyProgramRequest (Square::Types)
GetLoyaltyProgramResponse (Square::Types)
GetLoyaltyPromotionRequest (Square::Types)
GetLoyaltyPromotionResponse (Square::Types)
GetLoyaltyRewardRequest (Square::Types)
GetLoyaltyRewardResponse (Square::Types)
GetMerchantRequest (Square::Types)
GetMerchantResponse (Square::Types)
GetMerchantsRequest (Square::Merchants::Types)
GetObjectRequest (Square::Catalog::Object_::Types)
GetOrderRequest (Square::Types)
GetOrderResponse (Square::Types)
GetOrdersRequest (Square::Orders::Types)
GetPaymentLinkRequest (Square::Types)
GetPaymentLinkResponse (Square::Types)
GetPaymentLinksRequest (Square::Checkout::PaymentLinks::Types)
GetPaymentRefundResponse (Square::Types)
GetPaymentResponse (Square::Types)
GetPaymentsRequest (Square::Payments::Types)
GetPayoutResponse (Square::Types)
GetPayoutsRequest (Square::Payouts::Types)
GetPhysicalCountInventoryRequest (Square::Inventory::Types)
GetProgramsRequest (Square::Loyalty::Programs::Types)
GetPromotionsRequest (Square::Loyalty::Programs::Promotions::Types)
GetRefundsRequest (Square::Refunds::Types)
GetRefundsRequest (Square::Terminal::Refunds::Types)
GetRewardsRequest (Square::Loyalty::Rewards::Types)
GetSegmentsRequest (Square::Customers::Segments::Types)
GetShiftResponse (Square::Types)
GetShiftsRequest (Square::Labor::Shifts::Types)
GetShiftsRequest (Square::CashDrawers::Shifts::Types)
GetSnippetRequest (Square::Types)
GetSnippetResponse (Square::Types)
GetSnippetsRequest (Square::Snippets::Types)
GetSubscriptionResponse (Square::Types)
GetSubscriptionsRequest (Square::Subscriptions::Types)
GetSubscriptionsRequest (Square::Webhooks::Subscriptions::Types)
GetTeamMemberBookingProfileRequest (Square::Types)
GetTeamMemberBookingProfileResponse (Square::Types)
GetTeamMemberProfilesRequest (Square::Bookings::TeamMemberProfiles::Types)
GetTeamMemberRequest (Square::Types)
GetTeamMemberResponse (Square::Types)
GetTeamMemberWageResponse (Square::Types)
GetTeamMemberWagesRequest (Square::Labor::TeamMemberWages::Types)
GetTeamMembersRequest (Square::TeamMembers::Types)
GetTerminalActionResponse (Square::Types)
GetTerminalCheckoutResponse (Square::Types)
GetTerminalRefundResponse (Square::Types)
GetTransactionRequest (Square::Types)
GetTransactionResponse (Square::Types)
GetTransactionsRequest (Square::Locations::Transactions::Types)
GetTransferInventoryRequest (Square::Inventory::Types)
GetTransferOrdersRequest (Square::TransferOrders::Types)
GetVendorRequest (Square::Types)
GetVendorResponse (Square::Types)
GetVendorsRequest (Square::Vendors::Types)
GetWageSettingRequest (Square::TeamMembers::WageSetting::Types)
GetWageSettingRequest (Square::Types)
GetWageSettingResponse (Square::Types)
GetWebhookSubscriptionRequest (Square::Types)
GetWebhookSubscriptionResponse (Square::Types)
GiftCard (Square::Types)
GiftCardActivitiesApi (SquareLegacy)
GiftCardActivity (Square::Types)
GiftCardActivityActivate (Square::Types)
GiftCardActivityAdjustDecrement (Square::Types)
GiftCardActivityAdjustDecrementReason (Square::Types)
GiftCardActivityAdjustIncrement (Square::Types)
GiftCardActivityAdjustIncrementReason (Square::Types)
GiftCardActivityBlock (Square::Types)
GiftCardActivityBlockReason (Square::Types)
GiftCardActivityClearBalance (Square::Types)
GiftCardActivityClearBalanceReason (Square::Types)
GiftCardActivityCreatedEvent (Square::Types)
GiftCardActivityCreatedEventData (Square::Types)
GiftCardActivityCreatedEventObject (Square::Types)
GiftCardActivityDeactivate (Square::Types)
GiftCardActivityDeactivateReason (Square::Types)
GiftCardActivityImport (Square::Types)
GiftCardActivityImportReversal (Square::Types)
GiftCardActivityLoad (Square::Types)
GiftCardActivityRedeem (Square::Types)
GiftCardActivityRedeemStatus (Square::Types)
GiftCardActivityRefund (Square::Types)
GiftCardActivityTransferBalanceFrom (Square::Types)
GiftCardActivityTransferBalanceTo (Square::Types)
GiftCardActivityType (Square::Types)
GiftCardActivityUnblock (Square::Types)
GiftCardActivityUnblockReason (Square::Types)
GiftCardActivityUnlinkedActivityRefund (Square::Types)
GiftCardActivityUpdatedEvent (Square::Types)
GiftCardActivityUpdatedEventData (Square::Types)
GiftCardActivityUpdatedEventObject (Square::Types)
GiftCardCreatedEvent (Square::Types)
GiftCardCreatedEventData (Square::Types)
GiftCardCreatedEventObject (Square::Types)
GiftCardCustomerLinkedEvent (Square::Types)
GiftCardCustomerLinkedEventData (Square::Types)
GiftCardCustomerLinkedEventObject (Square::Types)
GiftCardCustomerUnlinkedEvent (Square::Types)
GiftCardCustomerUnlinkedEventData (Square::Types)
GiftCardCustomerUnlinkedEventObject (Square::Types)
GiftCardGanSource (Square::Types)
GiftCardStatus (Square::Types)
GiftCardType (Square::Types)
GiftCardUpdatedEvent (Square::Types)
GiftCardUpdatedEventData (Square::Types)
GiftCardUpdatedEventObject (Square::Types)
GiftCards (Square)
GiftCardsApi (SquareLegacy)
Groups (Square::Customers)

Hash (Square::Internal::Types)
Http (Square::Internal)
HttpCallBack (SquareLegacy)
HttpMethodEnum (SquareLegacy)
HttpRequest (SquareLegacy)
HttpResponse (SquareLegacy)

JSON (Square::Internal)
Job (Square::Types)
JobAssignment (Square::Types)
JobAssignmentPayType (Square::Types)
JobCreatedEvent (Square::Types)
JobCreatedEventData (Square::Types)
JobCreatedEventObject (Square::Types)
JobUpdatedEvent (Square::Types)
JobUpdatedEventData (Square::Types)
JobUpdatedEventObject (Square::Types)

NotFoundError (Square::Errors)

QrCodeOptions (Square::Types)
QuickPay (Square::Types)

TaxCalculationPhase (Square::Types)
TaxIds (Square::Types)
TaxInclusionType (Square::Types)
Team (Square)
TeamApi (SquareLegacy)
TeamMember (Square::Types)
TeamMemberAssignedLocations (Square::Types)
TeamMemberAssignedLocationsAssignmentType (Square::Types)
TeamMemberBookingProfile (Square::Types)
TeamMemberCreatedEvent (Square::Types)
TeamMemberCreatedEventData (Square::Types)
TeamMemberCreatedEventObject (Square::Types)
TeamMemberInvitationStatus (Square::Types)
TeamMemberProfiles (Square::Bookings)
TeamMemberStatus (Square::Types)
TeamMemberUpdatedEvent (Square::Types)
TeamMemberUpdatedEventData (Square::Types)
TeamMemberUpdatedEventObject (Square::Types)
TeamMemberWage (Square::Types)
TeamMemberWageSettingUpdatedEvent (Square::Types)
TeamMemberWageSettingUpdatedEventData (Square::Types)
TeamMemberWageSettingUpdatedEventObject (Square::Types)
TeamMemberWages (Square::Labor)
TeamMembers (Square)
Tender (Square::Types)
TenderBankAccountDetails (Square::Types)
TenderBankAccountDetailsStatus (Square::Types)
TenderBuyNowPayLaterDetails (Square::Types)
TenderBuyNowPayLaterDetailsBrand (Square::Types)
TenderBuyNowPayLaterDetailsStatus (Square::Types)
TenderCardDetails (Square::Types)
TenderCardDetailsEntryMethod (Square::Types)
TenderCardDetailsStatus (Square::Types)
TenderCashDetails (Square::Types)
TenderSquareAccountDetails (Square::Types)
TenderSquareAccountDetailsStatus (Square::Types)
TenderType (Square::Types)
Terminal (Square)
TerminalAction (Square::Types)
TerminalActionActionType (Square::Types)
TerminalActionCreatedEvent (Square::Types)
TerminalActionCreatedEventData (Square::Types)
TerminalActionCreatedEventObject (Square::Types)
TerminalActionQuery (Square::Types)
TerminalActionQueryFilter (Square::Types)
TerminalActionQuerySort (Square::Types)
TerminalActionUpdatedEvent (Square::Types)
TerminalActionUpdatedEventData (Square::Types)
TerminalActionUpdatedEventObject (Square::Types)
TerminalApi (SquareLegacy)
TerminalCheckout (Square::Types)
TerminalCheckoutCreatedEvent (Square::Types)
TerminalCheckoutCreatedEventData (Square::Types)
TerminalCheckoutCreatedEventObject (Square::Types)
TerminalCheckoutQuery (Square::Types)
TerminalCheckoutQueryFilter (Square::Types)
TerminalCheckoutQuerySort (Square::Types)
TerminalCheckoutUpdatedEvent (Square::Types)
TerminalCheckoutUpdatedEventData (Square::Types)
TerminalCheckoutUpdatedEventObject (Square::Types)
TerminalRefund (Square::Types)
TerminalRefundCreatedEvent (Square::Types)
TerminalRefundCreatedEventData (Square::Types)
TerminalRefundCreatedEventObject (Square::Types)
TerminalRefundQuery (Square::Types)
TerminalRefundQueryFilter (Square::Types)
TerminalRefundQuerySort (Square::Types)
TerminalRefundUpdatedEvent (Square::Types)
TerminalRefundUpdatedEventData (Square::Types)
TerminalRefundUpdatedEventObject (Square::Types)
TestWebhookSubscriptionRequest (Square::Webhooks::Subscriptions::Types)
TestWebhookSubscriptionResponse (Square::Types)
TimeRange (Square::Types)
Timecard (Square::Types)
TimecardFilter (Square::Types)
TimecardFilterStatus (Square::Types)
TimecardQuery (Square::Types)
TimecardSort (Square::Types)
TimecardSortField (Square::Types)
TimecardStatus (Square::Types)
TimecardWage (Square::Types)
TimecardWorkday (Square::Types)
TimecardWorkdayMatcher (Square::Types)
TimeoutError (Square::Errors)
TipSettings (Square::Types)
Transaction (Square::Types)
TransactionProduct (Square::Types)
TransactionType (Square::Types)
Transactions (Square::Locations)
TransactionsApi (SquareLegacy)
TransferOrder (Square::Types)
TransferOrderCreatedEvent (Square::Types)
TransferOrderCreatedEventData (Square::Types)
TransferOrderCreatedEventObject (Square::Types)
TransferOrderDeletedEvent (Square::Types)
TransferOrderDeletedEventData (Square::Types)
TransferOrderFilter (Square::Types)
TransferOrderGoodsReceipt (Square::Types)
TransferOrderGoodsReceiptLineItem (Square::Types)
TransferOrderLine (Square::Types)
TransferOrderQuery (Square::Types)
TransferOrderSort (Square::Types)
TransferOrderSortField (Square::Types)
TransferOrderStatus (Square::Types)
TransferOrderUpdatedEvent (Square::Types)
TransferOrderUpdatedEventData (Square::Types)
TransferOrderUpdatedEventObject (Square::Types)
TransferOrders (Square)
Type (Square::Internal::Types)
TypeError (Square::Internal::Errors)
Types (Square)
Types (Square::Internal)
Types (Square::Team)
Types (Square::Cards)
Types (Square::Orders)
Types (Square::Devices)
Types (Square::OAuth)
Types (Square::Payouts)
Types (Square::Refunds)
Types (Square::Vendors)
Types (Square::Catalog)
Types (Square::Events)
Types (Square::Bookings)
Types (Square::Channels)
Types (Square::Disputes)
Types (Square::Invoices)
Types (Square::Labor)
Types (Square::Payments)
Types (Square::Snippets)
Types (Square::Customers)
Types (Square::Devices::Codes)
Types (Square::Employees)
Types (Square::Inventory)
Types (Square::Labor::Shifts)
Types (Square::Locations)
Types (Square::Merchants)
Types (Square::Subscriptions)
Types (Square::ApplePay)
Types (Square::Catalog::Object_)
Types (Square::GiftCards)
Types (Square::Customers::Groups)
Types (Square::Loyalty::Rewards)
Types (Square::Catalog::Images)
Types (Square::Customers::Cards)
Types (Square::Terminal::Actions)
Types (Square::Terminal::Refunds)
Types (Square::Loyalty::Accounts)
Types (Square::Loyalty::Programs)
Types (Square::Loyalty)
Types (Square::TeamMembers)
Types (Square::CashDrawers::Shifts)
Types (Square::Disputes::Evidence)
Types (Square::BankAccounts)
Types (Square::Customers::Segments)
Types (Square::Terminal::Checkouts)
Types (Square::Terminal)
Types (Square::V1Transactions)
Types (Square::Checkout)
Types (Square::Labor::BreakTypes)
Types (Square::TransferOrders)
Types (Square::GiftCards::Activities)
Types (Square::Webhooks::EventTypes)
Types (Square::Labor::EmployeeWages)
Types (Square::Locations::Transactions)
Types (Square::Checkout::PaymentLinks)
Types (Square::Webhooks::Subscriptions)
Types (Square::Loyalty::Programs::Promotions)
Types (Square::TeamMembers::WageSetting)
Types (Square::Labor::WorkweekConfigs)
Types (Square::Labor::TeamMemberWages)
Types (Square::Orders::CustomAttributes)
Types (Square::Bookings::CustomAttributes)
Types (Square::Bookings::LocationProfiles)
Types (Square::Customers::CustomAttributes)
Types (Square::Locations::CustomAttributes)
Types (Square::Merchants::CustomAttributes)
Types (Square::Bookings::TeamMemberProfiles)
Types (Square::Orders::CustomAttributeDefinitions)
Types (Square::Bookings::CustomAttributeDefinitions)
Types (Square::Customers::CustomAttributeDefinitions)
Types (Square::Locations::CustomAttributeDefinitions)
Types (Square::Merchants::CustomAttributeDefinitions)

V1GetPaymentRequest (Square::Types)
V1GetSettlementRequest (Square::Types)
V1ListOrdersRequest (Square::V1Transactions::Types)
V1Money (Square::Types)
V1Order (Square::Types)
V1OrderHistoryEntry (Square::Types)
V1OrderHistoryEntryAction (Square::Types)
V1OrderState (Square::Types)
V1RetrieveOrderRequest (Square::V1Transactions::Types)
V1Tender (Square::Types)
V1TenderCardBrand (Square::Types)
V1TenderEntryMethod (Square::Types)
V1TenderType (Square::Types)
V1Transactions (Square)
V1TransactionsApi (SquareLegacy)
V1UpdateOrderRequest (Square::V1Transactions::Types)
V1UpdateOrderRequestAction (Square::Types)
Vendor (Square::Types)
VendorContact (Square::Types)
VendorCreatedEvent (Square::Types)
VendorCreatedEventData (Square::Types)
VendorCreatedEventObject (Square::Types)
VendorCreatedEventObjectOperation (Square::Types)
VendorStatus (Square::Types)
VendorUpdatedEvent (Square::Types)
VendorUpdatedEventData (Square::Types)
VendorUpdatedEventObject (Square::Types)
VendorUpdatedEventObjectOperation (Square::Types)
Vendors (Square)
VendorsApi (SquareLegacy)
VisibilityFilter (Square::Types)
VoidTransactionResponse (Square::Types)
VoidTransactionsRequest (Square::Locations::Transactions::Types)

WageSetting (Square::Types)
WageSetting (Square::TeamMembers)
WebhookSubscription (Square::Types)
WebhookSubscriptionsApi (SquareLegacy)
Webhooks (Square)
WebhooksHelper (SquareLegacy)
Weekday (Square::Types)
WorkweekConfig (Square::Types)
WorkweekConfigs (Square::Labor)