├── .gitignore
├── tests
    └── Integration
    │   ├── testdata
    │       └── image.jpeg
    │   └── LocationsTest.php
├── src
    ├── Types
    │   ├── SortOrder.php
    │   ├── PayoutType.php
    │   ├── ShiftStatus.php
    │   ├── TimecardStatus.php
    │   ├── ChannelStatus.php
    │   ├── EmployeeStatus.php
    │   ├── GiftCardGanSource.php
    │   ├── GiftCardType.php
    │   ├── LocationStatus.php
    │   ├── LocationType.php
    │   ├── MerchantStatus.php
    │   ├── ShiftFilterStatus.php
    │   ├── TransactionType.php
    │   ├── VendorStatus.php
    │   ├── TeamMemberStatus.php
    │   ├── TimecardFilterStatus.php
    │   ├── TaxInclusionType.php
    │   ├── CustomerSortField.php
    │   ├── InventoryAlertType.php
    │   ├── LoyaltyEventSource.php
    │   ├── LoyaltyProgramStatus.php
    │   ├── PayoutStatus.php
    │   ├── SubscriptionPricingType.php
    │   ├── CatalogModifierListModifierType.php
    │   ├── ChangeTiming.php
    │   ├── CustomerInclusionExclusion.php
    │   ├── OrderServiceChargeType.php
    │   ├── PaymentOptionsDelayAction.php
    │   ├── DeviceAttributesDeviceType.php
    │   ├── ExcludeStrategy.php
    │   ├── PayoutFeeType.php
    │   ├── RegisterDomainResponseStatus.php
    │   ├── SearchCatalogItemsRequestStockLevel.php
    │   ├── SearchVendorsRequestSortField.php
    │   ├── TransferOrderSortField.php
    │   ├── VisibilityFilter.php
    │   ├── CardCoBrand.php
    │   ├── CardType.php
    │   ├── CashDrawerShiftState.php
    │   ├── CatalogModifierListSelectionType.php
    │   ├── CatalogPricingType.php
    │   ├── DataCollectionOptionsInputType.php
    │   ├── FulfillmentType.php
    │   ├── JobAssignmentPayType.php
    │   ├── LoyaltyPromotionTriggerLimitInterval.php
    │   ├── BookingCreatorDetailsCreatorType.php
    │   ├── FulfillmentPickupDetailsScheduleType.php
    │   ├── LoyaltyProgramAccrualRuleTaxMode.php
    │   ├── LoyaltyRewardStatus.php
    │   ├── TaxCalculationPhase.php
    │   ├── TenderBuyNowPayLaterDetailsBrand.php
    │   ├── InvoiceDeliveryMethod.php
    │   ├── ListPaymentRefundsRequestSortField.php
    │   ├── OrderFulfillmentType.php
    │   ├── FulfillmentFulfillmentLineItemApplication.php
    │   ├── InvoiceRequestType.php
    │   ├── OrderFulfillmentPickupDetailsScheduleType.php
    │   ├── ScheduledShiftFilterAssignmentStatus.php
    │   ├── ScheduledShiftFilterScheduledShiftStatus.php
    │   ├── ShiftWorkdayMatcher.php
    │   ├── InvoiceCustomFieldPlacement.php
    │   ├── OrderFulfillmentDeliveryDetailsScheduleType.php
    │   ├── OrderLineItemItemType.php
    │   ├── OrderLineItemTaxType.php
    │   ├── OrderState.php
    │   ├── TimecardWorkdayMatcher.php
    │   ├── V1UpdateOrderRequestAction.php
    │   ├── LoyaltyPromotionIncentiveType.php
    │   ├── OrderFulfillmentFulfillmentLineItemApplication.php
    │   ├── OrderLineItemTaxScope.php
    │   ├── ScheduledShiftNotificationAudience.php
    │   ├── SearchOrdersSortField.php
    │   ├── TeamMemberInvitationStatus.php
    │   ├── BusinessBookingProfileBookingPolicy.php
    │   ├── CardPrepaidType.php
    │   ├── CatalogQuickAmountsSettingsOption.php
    │   ├── DeviceStatusCategory.php
    │   ├── GiftCardActivityRedeemStatus.php
    │   ├── InventoryChangeType.php
    │   ├── InvoicePaymentReminderStatus.php
    │   ├── RefundStatus.php
    │   ├── TenderBankAccountDetailsStatus.php
    │   ├── ActionCancelReason.php
    │   ├── CatalogDiscountModifyTaxBasis.php
    │   ├── CatalogQuickAmountType.php
    │   ├── DeviceCodeStatus.php
    │   ├── InvoiceAutomaticPaymentSource.php
    │   ├── ScheduledShiftWorkdayMatcher.php
    │   ├── BankAccountStatus.php
    │   ├── CatalogItemFoodAndBeverageDetailsDietaryPreferenceType.php
    │   ├── EcomVisibility.php
    │   ├── GiftCardStatus.php
    │   ├── ShiftSortField.php
    │   ├── OrderLineItemDiscountScope.php
    │   ├── OrderServiceChargeTreatmentType.php
    │   ├── RiskEvaluationRiskLevel.php
    │   ├── TimecardSortField.php
    │   ├── CatalogCategoryType.php
    │   ├── CheckoutLocationSettingsBrandingButtonShape.php
    │   ├── LoyaltyPromotionStatus.php
    │   ├── OrderServiceChargeScope.php
    │   ├── ListPaymentsRequestSortField.php
    │   ├── TenderCardDetailsStatus.php
    │   ├── OauthAuthorizationRevokedEventRevokerType.php
    │   ├── ScheduledShiftSortField.php
    │   ├── Weekday.php
    │   ├── BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType.php
    │   ├── DayOfWeek.php
    │   ├── FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType.php
    │   ├── LoyaltyProgramAccrualRuleType.php
    │   ├── TenderSquareAccountDetailsStatus.php
    │   ├── BusinessBookingProfileCustomerTimezoneChoice.php
    │   ├── CatalogCustomAttributeDefinitionType.php
    │   ├── DestinationType.php
    │   ├── LocationCapability.php
    │   ├── TenderBuyNowPayLaterDetailsStatus.php
    │   ├── ArchivedState.php
    │   ├── BusinessAppointmentSettingsCancellationPolicy.php
    │   ├── CheckoutLocationSettingsBrandingHeaderType.php
    │   ├── GiftCardActivityAdjustIncrementReason.php
    │   ├── GiftCardActivityClearBalanceReason.php
    │   ├── TeamMemberAssignedLocationsAssignmentType.php
    │   ├── BankAccountType.php
    │   ├── TenderCardDetailsEntryMethod.php
    │   ├── BookingBookingSource.php
    │   ├── BusinessAppointmentSettingsBookingLocationType.php
    │   ├── GiftCardActivityDeactivateReason.php
    │   ├── TransferOrderStatus.php
    │   ├── V1OrderState.php
    │   ├── CatalogDiscountType.php
    │   ├── CatalogCustomAttributeDefinitionSellerVisibility.php
    │   ├── FulfillmentState.php
    │   ├── BusinessAppointmentSettingsAlignmentTime.php
    │   ├── CustomAttributeDefinitionVisibility.php
    │   ├── SubscriptionStatus.php
    │   ├── OrderFulfillmentState.php
    │   ├── ComponentComponentType.php
    │   ├── MeasurementUnitTime.php
    │   ├── BookingStatus.php
    │   ├── SubscriptionActionType.php
    │   ├── DeviceComponentDetailsExternalPower.php
    │   ├── CatalogCustomAttributeDefinitionAppVisibility.php
    │   ├── MeasurementUnitUnitType.php
    │   ├── V1TenderEntryMethod.php
    │   ├── OrderServiceChargeCalculationPhase.php
    │   ├── OrderLineItemDiscountType.php
    │   ├── GiftCardActivityAdjustDecrementReason.php
    │   ├── V1OrderHistoryEntryAction.php
    │   ├── MeasurementUnitWeight.php
    │   ├── V1TenderType.php
    │   ├── TransactionProduct.php
    │   ├── TerminalActionActionType.php
    │   ├── DisputeState.php
    │   ├── InvoiceRequestMethod.php
    │   ├── SubscriptionEventInfoCode.php
    │   ├── CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference.php
    │   ├── V1TenderCardBrand.php
    │   ├── CheckoutOptionsPaymentType.php
    │   ├── InvoiceStatus.php
    │   ├── LoyaltyEventType.php
    │   ├── Product.php
    │   ├── TenderType.php
    │   ├── MeasurementUnitLength.php
    │   ├── DisputeReason.php
    │   ├── ErrorCategory.php
    │   ├── CatalogItemProductType.php
    │   ├── SubscriptionEventSubscriptionEventType.php
    │   ├── ApplicationDetailsExternalSquareProduct.php
    │   ├── MeasurementUnitArea.php
    │   ├── CashDrawerEventType.php
    │   ├── CardBrand.php
    │   ├── SubscriptionCadence.php
    │   ├── CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient.php
    │   ├── MeasurementUnitVolume.php
    │   ├── GiftCardActivityType.php
    │   ├── InventoryState.php
    │   ├── ReferenceType.php
    │   ├── CustomerCreationSource.php
    │   └── CatalogObjectType.php
    ├── Legacy
    │   ├── Models
    │   │   ├── ProductType.php
    │   │   ├── ApplicationType.php
    │   │   ├── MeasurementUnitGeneric.php
    │   │   ├── OrderServiceChargeType.php
    │   │   ├── DeviceAttributesDeviceType.php
    │   │   ├── TenderBuyNowPayLaterDetailsBrand.php
    │   │   ├── TransactionType.php
    │   │   ├── V1UpdateOrderRequestAction.php
    │   │   ├── DeviceStatusCategory.php
    │   │   ├── PaymentSortField.php
    │   │   ├── LoyaltyAccountMappingType.php
    │   │   ├── CheckoutLocationSettingsBrandingButtonShape.php
    │   │   ├── CardCoBrand.php
    │   │   ├── CardType.php
    │   │   ├── CheckoutLocationSettingsBrandingHeaderType.php
    │   │   ├── GiftCardType.php
    │   │   ├── CardPrepaidType.php
    │   │   ├── V1OrderState.php
    │   │   ├── SearchEventsSortField.php
    │   │   ├── GiftCardActivityUnblockReason.php
    │   │   ├── SubscriptionPricingType.php
    │   │   ├── GiftCardActivityBlockReason.php
    │   │   ├── LocationType.php
    │   │   ├── OrderServiceChargeTreatmentType.php
    │   │   ├── SearchCatalogItemsRequestStockLevel.php
    │   │   ├── ShiftStatus.php
    │   │   ├── ShiftFilterStatus.php
    │   │   ├── BookingCreatorDetailsCreatorType.php
    │   │   ├── CatalogDiscountModifyTaxBasis.php
    │   │   ├── V1TenderEntryMethod.php
    │   │   ├── ComponentComponentType.php
    │   │   ├── PayoutFeeType.php
    │   │   ├── RegisterDomainResponseStatus.php
    │   │   ├── ChangeTiming.php
    │   │   ├── LoyaltyRewardStatus.php
    │   │   ├── TaxCalculationPhase.php
    │   │   ├── VendorStatus.php
    │   │   ├── V1OrderHistoryEntryAction.php
    │   │   ├── BusinessBookingProfileBookingPolicy.php
    │   │   ├── CatalogModifierListModifierType.php
    │   │   ├── SortOrder.php
    │   │   ├── InventoryAlertType.php
    │   │   ├── LocationStatus.php
    │   │   ├── LoyaltyProgramStatus.php
    │   │   ├── SearchVendorsRequestSortField.php
    │   │   ├── V1TenderType.php
    │   │   ├── CatalogItemFoodAndBeverageDetailsDietaryPreferenceType.php
    │   │   ├── LoyaltyEventSource.php
    │   │   ├── MerchantStatus.php
    │   │   ├── CatalogQuickAmountType.php
    │   │   ├── CatalogPricingType.php
    │   │   ├── JobAssignmentPayType.php
    │   │   ├── EmployeeStatus.php
    │   │   ├── InvoiceSortField.php
    │   │   ├── BusinessBookingProfileCustomerTimezoneChoice.php
    │   │   ├── FulfillmentPickupDetailsScheduleType.php
    │   │   ├── FulfillmentType.php
    │   │   ├── OrderFulfillmentDeliveryDetailsScheduleType.php
    │   │   ├── PayoutStatus.php
    │   │   ├── OrderFulfillmentPickupDetailsScheduleType.php
    │   │   ├── OrderFulfillmentType.php
    │   │   ├── BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType.php
    │   │   ├── DataCollectionOptionsInputType.php
    │   │   ├── TenderBankAccountDetailsStatus.php
    │   │   ├── InvoiceCustomFieldPlacement.php
    │   │   ├── TeamMemberStatus.php
    │   │   ├── CatalogModifierListSelectionType.php
    │   │   ├── FulfillmentFulfillmentLineItemApplication.php
    │   │   ├── ActionCancelReason.php
    │   │   ├── CatalogCategoryType.php
    │   │   ├── OrderFulfillmentFulfillmentLineItemApplication.php
    │   │   ├── FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType.php
    │   │   ├── RefundStatus.php
    │   │   ├── ShiftWorkdayMatcher.php
    │   │   ├── CatalogQuickAmountsSettingsOption.php
    │   │   ├── PaymentOptionsDelayAction.php
    │   │   ├── CashDrawerShiftState.php
    │   │   ├── CustomerInclusionExclusion.php
    │   │   ├── V1TenderCardBrand.php
    │   │   ├── BusinessAppointmentSettingsBookingLocationType.php
    │   │   ├── LocationCapability.php
    │   │   ├── RiskEvaluationRiskLevel.php
    │   │   ├── ShiftSortField.php
    │   │   ├── TeamMemberInvitationStatus.php
    │   │   ├── CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference.php
    │   │   ├── BusinessAppointmentSettingsCancellationPolicy.php
    │   │   ├── DestinationType.php
    │   │   ├── InventoryChangeType.php
    │   │   ├── DeviceCodeStatus.php
    │   │   ├── GiftCardActivityAdjustIncrementReason.php
    │   │   ├── DeviceComponentDetailsExternalPower.php
    │   │   ├── GiftCardGANSource.php
    │   │   ├── LoyaltyProgramAccrualRuleTaxMode.php
    │   │   ├── Weekday.php
    │   │   ├── OrderLineItemTaxScope.php
    │   │   ├── OrderLineItemItemType.php
    │   │   ├── TenderSquareAccountDetailsStatus.php
    │   │   ├── DayOfWeek.php
    │   │   ├── LoyaltyProgramRewardDefinitionType.php
    │   │   ├── SubscriptionStatus.php
    │   │   ├── TenderBuyNowPayLaterDetailsStatus.php
    │   │   ├── ApplicationDetailsExternalSquareProduct.php
    │   │   ├── LoyaltyPromotionIncentiveType.php
    │   │   ├── CatalogCustomAttributeDefinitionType.php
    │   │   ├── OrderLineItemDiscountScope.php
    │   │   ├── PayoutType.php
    │   │   ├── TenderCardDetailsStatus.php
    │   │   ├── TeamMemberAssignedLocationsAssignmentType.php
    │   │   ├── CustomerSortField.php
    │   │   ├── OrderServiceChargeScope.php
    │   │   ├── EcomVisibility.php
    │   │   ├── MeasurementUnitTime.php
    │   │   ├── VisibilityFilter.php
    │   │   ├── GiftCardActivityClearBalanceReason.php
    │   │   ├── ArchivedState.php
    │   │   ├── CatalogCustomAttributeDefinitionSellerVisibility.php
    │   │   ├── TaxInclusionType.php
    │   │   ├── CardBrand.php
    │   │   ├── LoyaltyProgramRewardDefinitionScope.php
    │   │   ├── BankAccountStatus.php
    │   │   └── CatalogCustomAttributeDefinitionAppVisibility.php
    │   ├── Server.php
    │   ├── Http
    │   │   ├── HttpResponse.php
    │   │   ├── HttpRequest.php
    │   │   ├── HttpCallBack.php
    │   │   ├── HttpMethod.php
    │   │   └── HttpContext.php
    │   ├── Environment.php
    │   ├── BearerAuthCredentials.php
    │   └── Utils
    │   │   └── FileWrapper.php
    ├── Core
    │   ├── Client
    │   │   ├── HttpMethod.php
    │   │   └── BaseApiRequest.php
    │   ├── Json
    │   │   ├── JsonProperty.php
    │   │   └── JsonEncoder.php
    │   ├── Types
    │   │   ├── Constant.php
    │   │   ├── Date.php
    │   │   └── ArrayType.php
    │   └── Pagination
    │   │   └── Pager.php
    ├── Environments.php
    ├── Exceptions
    │   └── SquareException.php
    ├── GiftCards
    │   └── Requests
    │   │   └── GetGiftCardsRequest.php
    ├── Employees
    │   └── Requests
    │   │   └── GetEmployeesRequest.php
    ├── Labor
    │   ├── Requests
    │   │   ├── DeleteTimecardRequest.php
    │   │   ├── RetrieveTimecardRequest.php
    │   │   └── RetrieveScheduledShiftRequest.php
    │   ├── Shifts
    │   │   └── Requests
    │   │   │   ├── GetShiftsRequest.php
    │   │   │   └── DeleteShiftsRequest.php
    │   ├── BreakTypes
    │   │   └── Requests
    │   │   │   ├── GetBreakTypesRequest.php
    │   │   │   └── DeleteBreakTypesRequest.php
    │   ├── EmployeeWages
    │   │   └── Requests
    │   │   │   └── GetEmployeeWagesRequest.php
    │   └── TeamMemberWages
    │   │   └── Requests
    │   │       └── GetTeamMemberWagesRequest.php
    ├── Devices
    │   ├── Codes
    │   │   └── Requests
    │   │   │   └── GetCodesRequest.php
    │   └── Requests
    │   │   └── GetDevicesRequest.php
    ├── Team
    │   └── Requests
    │   │   └── RetrieveJobRequest.php
    ├── Cards
    │   └── Requests
    │   │   ├── GetCardsRequest.php
    │   │   └── DisableCardsRequest.php
    ├── Checkout
    │   └── PaymentLinks
    │   │   └── Requests
    │   │       ├── GetPaymentLinksRequest.php
    │   │       └── DeletePaymentLinksRequest.php
    ├── Orders
    │   └── Requests
    │   │   └── GetOrdersRequest.php
    ├── Channels
    │   └── Requests
    │   │   └── GetChannelsRequest.php
    ├── Snippets
    │   └── Requests
    │   │   ├── GetSnippetsRequest.php
    │   │   └── DeleteSnippetsRequest.php
    ├── Merchants
    │   └── Requests
    │   │   └── ListMerchantsRequest.php
    ├── Customers
    │   ├── Groups
    │   │   └── Requests
    │   │   │   ├── GetGroupsRequest.php
    │   │   │   └── DeleteGroupsRequest.php
    │   ├── Requests
    │   │   └── GetCustomersRequest.php
    │   └── Segments
    │   │   └── Requests
    │   │       └── GetSegmentsRequest.php
    ├── Invoices
    │   └── Requests
    │   │   └── GetInvoicesRequest.php
    ├── Payments
    │   └── Requests
    │   │   ├── GetPaymentsRequest.php
    │   │   └── CancelPaymentsRequest.php
    ├── Refunds
    │   └── Requests
    │   │   └── GetRefundsRequest.php
    ├── Vendors
    │   └── Requests
    │   │   └── GetVendorsRequest.php
    ├── Payouts
    │   └── Requests
    │   │   └── GetPayoutsRequest.php
    ├── Disputes
    │   └── Requests
    │   │   ├── AcceptDisputesRequest.php
    │   │   └── GetDisputesRequest.php
    └── Terminal
    │   └── Actions
    │       └── Requests
    │           ├── GetActionsRequest.php
    │           └── CancelActionsRequest.php
├── phpstan.neon
├── .fernignore
├── phpunit.xml
└── .fern
    └── metadata.json


/.gitignore:
--------------------------------------------------------------------------------
1 | .idea
2 | .php-cs-fixer.cache
3 | .phpunit.result.cache
4 | composer.lock
5 | vendor/


--------------------------------------------------------------------------------
/tests/Integration/testdata/image.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/square/square-php-sdk/HEAD/tests/Integration/testdata/image.jpeg


--------------------------------------------------------------------------------
/src/Types/SortOrder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum SortOrder: string
 6 | {
 7 |     case Desc = "DESC";
 8 |     case Asc = "ASC";
 9 | }
10 | 


--------------------------------------------------------------------------------
/phpstan.neon:
--------------------------------------------------------------------------------
1 | parameters:
2 |     level: max
3 |     reportUnmatchedIgnoredErrors: false
4 |     paths:
5 |         - src
6 |         - tests
7 |     excludePaths:
8 |         - src/Legacy


--------------------------------------------------------------------------------
/src/Types/PayoutType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum PayoutType: string
 6 | {
 7 |     case Batch = "BATCH";
 8 |     case Simple = "SIMPLE";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/ShiftStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum ShiftStatus: string
 6 | {
 7 |     case Open = "OPEN";
 8 |     case Closed = "CLOSED";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/TimecardStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TimecardStatus: string
 6 | {
 7 |     case Open = "OPEN";
 8 |     case Closed = "CLOSED";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/ChannelStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum ChannelStatus: string
 6 | {
 7 |     case Active = "ACTIVE";
 8 |     case Inactive = "INACTIVE";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/EmployeeStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum EmployeeStatus: string
 6 | {
 7 |     case Active = "ACTIVE";
 8 |     case Inactive = "INACTIVE";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/GiftCardGanSource.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum GiftCardGanSource: string
 6 | {
 7 |     case Square = "SQUARE";
 8 |     case Other = "OTHER";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/GiftCardType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum GiftCardType: string
 6 | {
 7 |     case Physical = "PHYSICAL";
 8 |     case Digital = "DIGITAL";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/LocationStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum LocationStatus: string
 6 | {
 7 |     case Active = "ACTIVE";
 8 |     case Inactive = "INACTIVE";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/LocationType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum LocationType: string
 6 | {
 7 |     case Physical = "PHYSICAL";
 8 |     case Mobile = "MOBILE";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/MerchantStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum MerchantStatus: string
 6 | {
 7 |     case Active = "ACTIVE";
 8 |     case Inactive = "INACTIVE";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/ShiftFilterStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum ShiftFilterStatus: string
 6 | {
 7 |     case Open = "OPEN";
 8 |     case Closed = "CLOSED";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/TransactionType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TransactionType: string
 6 | {
 7 |     case Debit = "DEBIT";
 8 |     case Credit = "CREDIT";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/VendorStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum VendorStatus: string
 6 | {
 7 |     case Active = "ACTIVE";
 8 |     case Inactive = "INACTIVE";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/TeamMemberStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TeamMemberStatus: string
 6 | {
 7 |     case Active = "ACTIVE";
 8 |     case Inactive = "INACTIVE";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/TimecardFilterStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TimecardFilterStatus: string
 6 | {
 7 |     case Open = "OPEN";
 8 |     case Closed = "CLOSED";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/TaxInclusionType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TaxInclusionType: string
 6 | {
 7 |     case Additive = "ADDITIVE";
 8 |     case Inclusive = "INCLUSIVE";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/CustomerSortField.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CustomerSortField: string
 6 | {
 7 |     case Default_ = "DEFAULT";
 8 |     case CreatedAt = "CREATED_AT";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/InventoryAlertType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum InventoryAlertType: string
 6 | {
 7 |     case None = "NONE";
 8 |     case LowQuantity = "LOW_QUANTITY";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/LoyaltyEventSource.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum LoyaltyEventSource: string
 6 | {
 7 |     case Square = "SQUARE";
 8 |     case LoyaltyApi = "LOYALTY_API";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/LoyaltyProgramStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum LoyaltyProgramStatus: string
 6 | {
 7 |     case Inactive = "INACTIVE";
 8 |     case Active = "ACTIVE";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/PayoutStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum PayoutStatus: string
 6 | {
 7 |     case Sent = "SENT";
 8 |     case Failed = "FAILED";
 9 |     case Paid = "PAID";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/SubscriptionPricingType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum SubscriptionPricingType: string
 6 | {
 7 |     case Static_ = "STATIC";
 8 |     case Relative = "RELATIVE";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/ProductType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | class ProductType
 8 | {
 9 |     public const TERMINAL_API = 'TERMINAL_API';
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/CatalogModifierListModifierType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CatalogModifierListModifierType: string
 6 | {
 7 |     case List_ = "LIST";
 8 |     case Text = "TEXT";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/ChangeTiming.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum ChangeTiming: string
 6 | {
 7 |     case Immediate = "IMMEDIATE";
 8 |     case EndOfBillingCycle = "END_OF_BILLING_CYCLE";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/CustomerInclusionExclusion.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CustomerInclusionExclusion: string
 6 | {
 7 |     case Include_ = "INCLUDE";
 8 |     case Exclude = "EXCLUDE";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/OrderServiceChargeType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum OrderServiceChargeType: string
 6 | {
 7 |     case AutoGratuity = "AUTO_GRATUITY";
 8 |     case Custom = "CUSTOM";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/PaymentOptionsDelayAction.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum PaymentOptionsDelayAction: string
 6 | {
 7 |     case Cancel = "CANCEL";
 8 |     case Complete = "COMPLETE";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Core/Client/HttpMethod.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Core\Client;
 4 | 
 5 | enum HttpMethod
 6 | {
 7 |     case GET;
 8 |     case POST;
 9 |     case PUT;
10 |     case PATCH;
11 |     case DELETE;
12 | }
13 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/ApplicationType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | class ApplicationType
 8 | {
 9 |     public const TERMINAL_API = 'TERMINAL_API';
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/DeviceAttributesDeviceType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum DeviceAttributesDeviceType: string
 6 | {
 7 |     case Terminal = "TERMINAL";
 8 |     case Handheld = "HANDHELD";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/ExcludeStrategy.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum ExcludeStrategy: string
 6 | {
 7 |     case LeastExpensive = "LEAST_EXPENSIVE";
 8 |     case MostExpensive = "MOST_EXPENSIVE";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/PayoutFeeType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum PayoutFeeType: string
 6 | {
 7 |     case TransferFee = "TRANSFER_FEE";
 8 |     case TaxOnTransferFee = "TAX_ON_TRANSFER_FEE";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/RegisterDomainResponseStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum RegisterDomainResponseStatus: string
 6 | {
 7 |     case Pending = "PENDING";
 8 |     case Verified = "VERIFIED";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/SearchCatalogItemsRequestStockLevel.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum SearchCatalogItemsRequestStockLevel: string
 6 | {
 7 |     case Out = "OUT";
 8 |     case Low = "LOW";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/SearchVendorsRequestSortField.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum SearchVendorsRequestSortField: string
 6 | {
 7 |     case Name = "NAME";
 8 |     case CreatedAt = "CREATED_AT";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/TransferOrderSortField.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TransferOrderSortField: string
 6 | {
 7 |     case CreatedAt = "CREATED_AT";
 8 |     case UpdatedAt = "UPDATED_AT";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/VisibilityFilter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum VisibilityFilter: string
 6 | {
 7 |     case All = "ALL";
 8 |     case Read = "READ";
 9 |     case ReadWrite = "READ_WRITE";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Legacy/Server.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy;
 6 | 
 7 | /**
 8 |  * Baseurl aliases
 9 |  */
10 | class Server
11 | {
12 |     public const DEFAULT_ = 'default';
13 | }
14 | 


--------------------------------------------------------------------------------
/src/Types/CardCoBrand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CardCoBrand: string
 6 | {
 7 |     case Unknown = "UNKNOWN";
 8 |     case Afterpay = "AFTERPAY";
 9 |     case Clearpay = "CLEARPAY";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/CardType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CardType: string
 6 | {
 7 |     case UnknownCardType = "UNKNOWN_CARD_TYPE";
 8 |     case Credit = "CREDIT";
 9 |     case Debit = "DEBIT";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/CashDrawerShiftState.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CashDrawerShiftState: string
 6 | {
 7 |     case Open = "OPEN";
 8 |     case Ended = "ENDED";
 9 |     case Closed = "CLOSED";
10 | }
11 | 


--------------------------------------------------------------------------------
/.fernignore:
--------------------------------------------------------------------------------
1 | # Specify files that shouldn't be modified by Fern
2 | 
3 | .github/workflows/ci.yml
4 | README.md
5 | phpstan.neon
6 | src/Exceptions/SquareApiException.php
7 | src/Legacy
8 | src/Utils/WebhooksHelper.php
9 | tests/Integration


--------------------------------------------------------------------------------
/src/Environments.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square;
 4 | 
 5 | enum Environments: string
 6 | {
 7 |     case Production = "https://connect.squareup.com";
 8 |     case Sandbox = "https://connect.squareupsandbox.com";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/CatalogModifierListSelectionType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CatalogModifierListSelectionType: string
 6 | {
 7 |     case Single = "SINGLE";
 8 |     case Multiple = "MULTIPLE";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/CatalogPricingType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CatalogPricingType: string
 6 | {
 7 |     case FixedPricing = "FIXED_PRICING";
 8 |     case VariablePricing = "VARIABLE_PRICING";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/DataCollectionOptionsInputType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum DataCollectionOptionsInputType: string
 6 | {
 7 |     case Email = "EMAIL";
 8 |     case PhoneNumber = "PHONE_NUMBER";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/FulfillmentType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum FulfillmentType: string
 6 | {
 7 |     case Pickup = "PICKUP";
 8 |     case Shipment = "SHIPMENT";
 9 |     case Delivery = "DELIVERY";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/JobAssignmentPayType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum JobAssignmentPayType: string
 6 | {
 7 |     case None = "NONE";
 8 |     case Hourly = "HOURLY";
 9 |     case Salary = "SALARY";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/LoyaltyPromotionTriggerLimitInterval.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum LoyaltyPromotionTriggerLimitInterval: string
 6 | {
 7 |     case AllTime = "ALL_TIME";
 8 |     case Day = "DAY";
 9 | }
10 | 


--------------------------------------------------------------------------------
/phpunit.xml:
--------------------------------------------------------------------------------
1 | <phpunit bootstrap="vendor/autoload.php">
2 |     <testsuites>
3 |         <testsuite name="Test Suite">
4 |             <directory suffix="Test.php">tests</directory>
5 |         </testsuite>
6 |     </testsuites>
7 | </phpunit>


--------------------------------------------------------------------------------
/src/Types/BookingCreatorDetailsCreatorType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum BookingCreatorDetailsCreatorType: string
 6 | {
 7 |     case TeamMember = "TEAM_MEMBER";
 8 |     case Customer = "CUSTOMER";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/FulfillmentPickupDetailsScheduleType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum FulfillmentPickupDetailsScheduleType: string
 6 | {
 7 |     case Scheduled = "SCHEDULED";
 8 |     case Asap = "ASAP";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/LoyaltyProgramAccrualRuleTaxMode.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum LoyaltyProgramAccrualRuleTaxMode: string
 6 | {
 7 |     case BeforeTax = "BEFORE_TAX";
 8 |     case AfterTax = "AFTER_TAX";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/LoyaltyRewardStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum LoyaltyRewardStatus: string
 6 | {
 7 |     case Issued = "ISSUED";
 8 |     case Redeemed = "REDEEMED";
 9 |     case Deleted = "DELETED";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/TaxCalculationPhase.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TaxCalculationPhase: string
 6 | {
 7 |     case TaxSubtotalPhase = "TAX_SUBTOTAL_PHASE";
 8 |     case TaxTotalPhase = "TAX_TOTAL_PHASE";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/TenderBuyNowPayLaterDetailsBrand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TenderBuyNowPayLaterDetailsBrand: string
 6 | {
 7 |     case OtherBrand = "OTHER_BRAND";
 8 |     case Afterpay = "AFTERPAY";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/InvoiceDeliveryMethod.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum InvoiceDeliveryMethod: string
 6 | {
 7 |     case Email = "EMAIL";
 8 |     case ShareManually = "SHARE_MANUALLY";
 9 |     case Sms = "SMS";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/ListPaymentRefundsRequestSortField.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum ListPaymentRefundsRequestSortField: string
 6 | {
 7 |     case CreatedAt = "CREATED_AT";
 8 |     case UpdatedAt = "UPDATED_AT";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/OrderFulfillmentType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum OrderFulfillmentType: string
 6 | {
 7 |     case Pickup = "PICKUP";
 8 |     case Shipment = "SHIPMENT";
 9 |     case Delivery = "DELIVERY";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/FulfillmentFulfillmentLineItemApplication.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum FulfillmentFulfillmentLineItemApplication: string
 6 | {
 7 |     case All = "ALL";
 8 |     case EntryList = "ENTRY_LIST";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/InvoiceRequestType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum InvoiceRequestType: string
 6 | {
 7 |     case Balance = "BALANCE";
 8 |     case Deposit = "DEPOSIT";
 9 |     case Installment = "INSTALLMENT";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/OrderFulfillmentPickupDetailsScheduleType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum OrderFulfillmentPickupDetailsScheduleType: string
 6 | {
 7 |     case Scheduled = "SCHEDULED";
 8 |     case Asap = "ASAP";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/ScheduledShiftFilterAssignmentStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum ScheduledShiftFilterAssignmentStatus: string
 6 | {
 7 |     case Assigned = "ASSIGNED";
 8 |     case Unassigned = "UNASSIGNED";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/ScheduledShiftFilterScheduledShiftStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum ScheduledShiftFilterScheduledShiftStatus: string
 6 | {
 7 |     case Draft = "DRAFT";
 8 |     case Published = "PUBLISHED";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/ShiftWorkdayMatcher.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum ShiftWorkdayMatcher: string
 6 | {
 7 |     case StartAt = "START_AT";
 8 |     case EndAt = "END_AT";
 9 |     case Intersection = "INTERSECTION";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/InvoiceCustomFieldPlacement.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum InvoiceCustomFieldPlacement: string
 6 | {
 7 |     case AboveLineItems = "ABOVE_LINE_ITEMS";
 8 |     case BelowLineItems = "BELOW_LINE_ITEMS";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/OrderFulfillmentDeliveryDetailsScheduleType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum OrderFulfillmentDeliveryDetailsScheduleType: string
 6 | {
 7 |     case Scheduled = "SCHEDULED";
 8 |     case Asap = "ASAP";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/OrderLineItemItemType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum OrderLineItemItemType: string
 6 | {
 7 |     case Item = "ITEM";
 8 |     case CustomAmount = "CUSTOM_AMOUNT";
 9 |     case GiftCard = "GIFT_CARD";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/OrderLineItemTaxType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum OrderLineItemTaxType: string
 6 | {
 7 |     case UnknownTax = "UNKNOWN_TAX";
 8 |     case Additive = "ADDITIVE";
 9 |     case Inclusive = "INCLUSIVE";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/OrderState.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum OrderState: string
 6 | {
 7 |     case Open = "OPEN";
 8 |     case Completed = "COMPLETED";
 9 |     case Canceled = "CANCELED";
10 |     case Draft = "DRAFT";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Types/TimecardWorkdayMatcher.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TimecardWorkdayMatcher: string
 6 | {
 7 |     case StartAt = "START_AT";
 8 |     case EndAt = "END_AT";
 9 |     case Intersection = "INTERSECTION";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/V1UpdateOrderRequestAction.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum V1UpdateOrderRequestAction: string
 6 | {
 7 |     case Complete = "COMPLETE";
 8 |     case Cancel = "CANCEL";
 9 |     case Refund = "REFUND";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Exceptions/SquareException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Exceptions;
 4 | 
 5 | use Exception;
 6 | 
 7 | /**
 8 |  * Base exception class for all exceptions thrown by the SDK.
 9 |  */
10 | class SquareException extends Exception
11 | {
12 | }
13 | 


--------------------------------------------------------------------------------
/src/Types/LoyaltyPromotionIncentiveType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum LoyaltyPromotionIncentiveType: string
 6 | {
 7 |     case PointsMultiplier = "POINTS_MULTIPLIER";
 8 |     case PointsAddition = "POINTS_ADDITION";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/OrderFulfillmentFulfillmentLineItemApplication.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum OrderFulfillmentFulfillmentLineItemApplication: string
 6 | {
 7 |     case All = "ALL";
 8 |     case EntryList = "ENTRY_LIST";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/OrderLineItemTaxScope.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum OrderLineItemTaxScope: string
 6 | {
 7 |     case OtherTaxScope = "OTHER_TAX_SCOPE";
 8 |     case LineItem = "LINE_ITEM";
 9 |     case Order = "ORDER";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/ScheduledShiftNotificationAudience.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum ScheduledShiftNotificationAudience: string
 6 | {
 7 |     case All = "ALL";
 8 |     case Affected = "AFFECTED";
 9 |     case None = "NONE";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/SearchOrdersSortField.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum SearchOrdersSortField: string
 6 | {
 7 |     case CreatedAt = "CREATED_AT";
 8 |     case UpdatedAt = "UPDATED_AT";
 9 |     case ClosedAt = "CLOSED_AT";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/TeamMemberInvitationStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TeamMemberInvitationStatus: string
 6 | {
 7 |     case Uninvited = "UNINVITED";
 8 |     case Pending = "PENDING";
 9 |     case Accepted = "ACCEPTED";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/BusinessBookingProfileBookingPolicy.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum BusinessBookingProfileBookingPolicy: string
 6 | {
 7 |     case AcceptAll = "ACCEPT_ALL";
 8 |     case RequiresAcceptance = "REQUIRES_ACCEPTANCE";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/CardPrepaidType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CardPrepaidType: string
 6 | {
 7 |     case UnknownPrepaidType = "UNKNOWN_PREPAID_TYPE";
 8 |     case NotPrepaid = "NOT_PREPAID";
 9 |     case Prepaid = "PREPAID";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/CatalogQuickAmountsSettingsOption.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CatalogQuickAmountsSettingsOption: string
 6 | {
 7 |     case Disabled = "DISABLED";
 8 |     case Manual = "MANUAL";
 9 |     case Auto = "AUTO";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/DeviceStatusCategory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum DeviceStatusCategory: string
 6 | {
 7 |     case Available = "AVAILABLE";
 8 |     case NeedsAttention = "NEEDS_ATTENTION";
 9 |     case Offline = "OFFLINE";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/GiftCardActivityRedeemStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum GiftCardActivityRedeemStatus: string
 6 | {
 7 |     case Pending = "PENDING";
 8 |     case Completed = "COMPLETED";
 9 |     case Canceled = "CANCELED";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/InventoryChangeType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum InventoryChangeType: string
 6 | {
 7 |     case PhysicalCount = "PHYSICAL_COUNT";
 8 |     case Adjustment = "ADJUSTMENT";
 9 |     case Transfer = "TRANSFER";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/InvoicePaymentReminderStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum InvoicePaymentReminderStatus: string
 6 | {
 7 |     case Pending = "PENDING";
 8 |     case NotApplicable = "NOT_APPLICABLE";
 9 |     case Sent = "SENT";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/RefundStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum RefundStatus: string
 6 | {
 7 |     case Pending = "PENDING";
 8 |     case Approved = "APPROVED";
 9 |     case Rejected = "REJECTED";
10 |     case Failed = "FAILED";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Types/TenderBankAccountDetailsStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TenderBankAccountDetailsStatus: string
 6 | {
 7 |     case Pending = "PENDING";
 8 |     case Completed = "COMPLETED";
 9 |     case Failed = "FAILED";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/ActionCancelReason.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum ActionCancelReason: string
 6 | {
 7 |     case BuyerCanceled = "BUYER_CANCELED";
 8 |     case SellerCanceled = "SELLER_CANCELED";
 9 |     case TimedOut = "TIMED_OUT";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/CatalogDiscountModifyTaxBasis.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CatalogDiscountModifyTaxBasis: string
 6 | {
 7 |     case ModifyTaxBasis = "MODIFY_TAX_BASIS";
 8 |     case DoNotModifyTaxBasis = "DO_NOT_MODIFY_TAX_BASIS";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/CatalogQuickAmountType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CatalogQuickAmountType: string
 6 | {
 7 |     case QuickAmountTypeManual = "QUICK_AMOUNT_TYPE_MANUAL";
 8 |     case QuickAmountTypeAuto = "QUICK_AMOUNT_TYPE_AUTO";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/DeviceCodeStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum DeviceCodeStatus: string
 6 | {
 7 |     case Unknown = "UNKNOWN";
 8 |     case Unpaired = "UNPAIRED";
 9 |     case Paired = "PAIRED";
10 |     case Expired = "EXPIRED";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Types/InvoiceAutomaticPaymentSource.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum InvoiceAutomaticPaymentSource: string
 6 | {
 7 |     case None = "NONE";
 8 |     case CardOnFile = "CARD_ON_FILE";
 9 |     case BankOnFile = "BANK_ON_FILE";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/ScheduledShiftWorkdayMatcher.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum ScheduledShiftWorkdayMatcher: string
 6 | {
 7 |     case StartAt = "START_AT";
 8 |     case EndAt = "END_AT";
 9 |     case Intersection = "INTERSECTION";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Core/Json/JsonProperty.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Core\Json;
 4 | 
 5 | use Attribute;
 6 | 
 7 | #[Attribute(Attribute::TARGET_PROPERTY)]
 8 | class JsonProperty
 9 | {
10 |     public function __construct(public string $name)
11 |     {
12 |     }
13 | }
14 | 


--------------------------------------------------------------------------------
/src/Types/BankAccountStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum BankAccountStatus: string
 6 | {
 7 |     case VerificationInProgress = "VERIFICATION_IN_PROGRESS";
 8 |     case Verified = "VERIFIED";
 9 |     case Disabled = "DISABLED";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/CatalogItemFoodAndBeverageDetailsDietaryPreferenceType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CatalogItemFoodAndBeverageDetailsDietaryPreferenceType: string
 6 | {
 7 |     case Standard = "STANDARD";
 8 |     case Custom = "CUSTOM";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/EcomVisibility.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum EcomVisibility: string
 6 | {
 7 |     case Unindexed = "UNINDEXED";
 8 |     case Unavailable = "UNAVAILABLE";
 9 |     case Hidden = "HIDDEN";
10 |     case Visible = "VISIBLE";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Types/GiftCardStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum GiftCardStatus: string
 6 | {
 7 |     case Active = "ACTIVE";
 8 |     case Deactivated = "DEACTIVATED";
 9 |     case Blocked = "BLOCKED";
10 |     case Pending = "PENDING";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Types/ShiftSortField.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum ShiftSortField: string
 6 | {
 7 |     case StartAt = "START_AT";
 8 |     case EndAt = "END_AT";
 9 |     case CreatedAt = "CREATED_AT";
10 |     case UpdatedAt = "UPDATED_AT";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Legacy/Http/HttpResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Http;
 6 | 
 7 | use Core\Types\Sdk\CoreResponse;
 8 | 
 9 | /**
10 |  * HTTP response received
11 |  */
12 | class HttpResponse extends CoreResponse
13 | {
14 | }
15 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/MeasurementUnitGeneric.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | class MeasurementUnitGeneric
 8 | {
 9 |     /**
10 |      * The generic unit.
11 |      */
12 |     public const UNIT = 'UNIT';
13 | }
14 | 


--------------------------------------------------------------------------------
/src/Types/OrderLineItemDiscountScope.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum OrderLineItemDiscountScope: string
 6 | {
 7 |     case OtherDiscountScope = "OTHER_DISCOUNT_SCOPE";
 8 |     case LineItem = "LINE_ITEM";
 9 |     case Order = "ORDER";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/OrderServiceChargeTreatmentType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum OrderServiceChargeTreatmentType: string
 6 | {
 7 |     case LineItemTreatment = "LINE_ITEM_TREATMENT";
 8 |     case ApportionedTreatment = "APPORTIONED_TREATMENT";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/RiskEvaluationRiskLevel.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum RiskEvaluationRiskLevel: string
 6 | {
 7 |     case Pending = "PENDING";
 8 |     case Normal = "NORMAL";
 9 |     case Moderate = "MODERATE";
10 |     case High = "HIGH";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Types/TimecardSortField.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TimecardSortField: string
 6 | {
 7 |     case StartAt = "START_AT";
 8 |     case EndAt = "END_AT";
 9 |     case CreatedAt = "CREATED_AT";
10 |     case UpdatedAt = "UPDATED_AT";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Legacy/Http/HttpRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Http;
 6 | 
 7 | use Core\Types\Sdk\CoreRequest;
 8 | 
 9 | /**
10 |  * Represents a single Http Request
11 |  */
12 | class HttpRequest extends CoreRequest
13 | {
14 | }
15 | 


--------------------------------------------------------------------------------
/src/Types/CatalogCategoryType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CatalogCategoryType: string
 6 | {
 7 |     case RegularCategory = "REGULAR_CATEGORY";
 8 |     case MenuCategory = "MENU_CATEGORY";
 9 |     case KitchenCategory = "KITCHEN_CATEGORY";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/CheckoutLocationSettingsBrandingButtonShape.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CheckoutLocationSettingsBrandingButtonShape: string
 6 | {
 7 |     case Squared = "SQUARED";
 8 |     case Rounded = "ROUNDED";
 9 |     case Pill = "PILL";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/LoyaltyPromotionStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum LoyaltyPromotionStatus: string
 6 | {
 7 |     case Active = "ACTIVE";
 8 |     case Ended = "ENDED";
 9 |     case Canceled = "CANCELED";
10 |     case Scheduled = "SCHEDULED";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Types/OrderServiceChargeScope.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum OrderServiceChargeScope: string
 6 | {
 7 |     case OtherServiceChargeScope = "OTHER_SERVICE_CHARGE_SCOPE";
 8 |     case LineItem = "LINE_ITEM";
 9 |     case Order = "ORDER";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/OrderServiceChargeType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | class OrderServiceChargeType
 8 | {
 9 |     public const AUTO_GRATUITY = 'AUTO_GRATUITY';
10 | 
11 |     public const CUSTOM = 'CUSTOM';
12 | }
13 | 


--------------------------------------------------------------------------------
/src/Types/ListPaymentsRequestSortField.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum ListPaymentsRequestSortField: string
 6 | {
 7 |     case CreatedAt = "CREATED_AT";
 8 |     case OfflineCreatedAt = "OFFLINE_CREATED_AT";
 9 |     case UpdatedAt = "UPDATED_AT";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/TenderCardDetailsStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TenderCardDetailsStatus: string
 6 | {
 7 |     case Authorized = "AUTHORIZED";
 8 |     case Captured = "CAPTURED";
 9 |     case Voided = "VOIDED";
10 |     case Failed = "FAILED";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Types/OauthAuthorizationRevokedEventRevokerType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum OauthAuthorizationRevokedEventRevokerType: string
 6 | {
 7 |     case Application = "APPLICATION";
 8 |     case Merchant = "MERCHANT";
 9 |     case Square = "SQUARE";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/ScheduledShiftSortField.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum ScheduledShiftSortField: string
 6 | {
 7 |     case StartAt = "START_AT";
 8 |     case EndAt = "END_AT";
 9 |     case CreatedAt = "CREATED_AT";
10 |     case UpdatedAt = "UPDATED_AT";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Types/Weekday.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum Weekday: string
 6 | {
 7 |     case Mon = "MON";
 8 |     case Tue = "TUE";
 9 |     case Wed = "WED";
10 |     case Thu = "THU";
11 |     case Fri = "FRI";
12 |     case Sat = "SAT";
13 |     case Sun = "SUN";
14 | }
15 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/DeviceAttributesDeviceType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * An enum identifier of the device type.
 9 |  */
10 | class DeviceAttributesDeviceType
11 | {
12 |     public const TERMINAL = 'TERMINAL';
13 | }
14 | 


--------------------------------------------------------------------------------
/src/Types/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType: string
 6 | {
 7 |     case PerTeamMember = "PER_TEAM_MEMBER";
 8 |     case PerLocation = "PER_LOCATION";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/DayOfWeek.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum DayOfWeek: string
 6 | {
 7 |     case Sun = "SUN";
 8 |     case Mon = "MON";
 9 |     case Tue = "TUE";
10 |     case Wed = "WED";
11 |     case Thu = "THU";
12 |     case Fri = "FRI";
13 |     case Sat = "SAT";
14 | }
15 | 


--------------------------------------------------------------------------------
/src/Types/FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType: string
 6 | {
 7 |     case Scheduled = "SCHEDULED";
 8 |     case Asap = "ASAP";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/LoyaltyProgramAccrualRuleType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum LoyaltyProgramAccrualRuleType: string
 6 | {
 7 |     case Visit = "VISIT";
 8 |     case Spend = "SPEND";
 9 |     case ItemVariation = "ITEM_VARIATION";
10 |     case Category = "CATEGORY";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Types/TenderSquareAccountDetailsStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TenderSquareAccountDetailsStatus: string
 6 | {
 7 |     case Authorized = "AUTHORIZED";
 8 |     case Captured = "CAPTURED";
 9 |     case Voided = "VOIDED";
10 |     case Failed = "FAILED";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/TenderBuyNowPayLaterDetailsBrand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | class TenderBuyNowPayLaterDetailsBrand
 8 | {
 9 |     public const OTHER_BRAND = 'OTHER_BRAND';
10 | 
11 |     public const AFTERPAY = 'AFTERPAY';
12 | }
13 | 


--------------------------------------------------------------------------------
/src/Types/BusinessBookingProfileCustomerTimezoneChoice.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum BusinessBookingProfileCustomerTimezoneChoice: string
 6 | {
 7 |     case BusinessLocationTimezone = "BUSINESS_LOCATION_TIMEZONE";
 8 |     case CustomerChoice = "CUSTOMER_CHOICE";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/CatalogCustomAttributeDefinitionType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CatalogCustomAttributeDefinitionType: string
 6 | {
 7 |     case String = "STRING";
 8 |     case Boolean = "BOOLEAN";
 9 |     case Number = "NUMBER";
10 |     case Selection = "SELECTION";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Types/DestinationType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum DestinationType: string
 6 | {
 7 |     case BankAccount = "BANK_ACCOUNT";
 8 |     case Card = "CARD";
 9 |     case SquareBalance = "SQUARE_BALANCE";
10 |     case SquareStoredBalance = "SQUARE_STORED_BALANCE";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Types/LocationCapability.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum LocationCapability: string
 6 | {
 7 |     case CreditCardProcessing = "CREDIT_CARD_PROCESSING";
 8 |     case AutomaticTransfers = "AUTOMATIC_TRANSFERS";
 9 |     case UnlinkedRefunds = "UNLINKED_REFUNDS";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/TenderBuyNowPayLaterDetailsStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TenderBuyNowPayLaterDetailsStatus: string
 6 | {
 7 |     case Authorized = "AUTHORIZED";
 8 |     case Captured = "CAPTURED";
 9 |     case Voided = "VOIDED";
10 |     case Failed = "FAILED";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Types/ArchivedState.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum ArchivedState: string
 6 | {
 7 |     case ArchivedStateNotArchived = "ARCHIVED_STATE_NOT_ARCHIVED";
 8 |     case ArchivedStateArchived = "ARCHIVED_STATE_ARCHIVED";
 9 |     case ArchivedStateAll = "ARCHIVED_STATE_ALL";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/BusinessAppointmentSettingsCancellationPolicy.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum BusinessAppointmentSettingsCancellationPolicy: string
 6 | {
 7 |     case CancellationTreatedAsNoShow = "CANCELLATION_TREATED_AS_NO_SHOW";
 8 |     case CustomPolicy = "CUSTOM_POLICY";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Legacy/Http/HttpCallBack.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Http;
 6 | 
 7 | use Core\Types\Sdk\CoreCallback;
 8 | 
 9 | /**
10 |  * HttpCallBack allows defining callables for pre and post API calls.
11 |  */
12 | class HttpCallBack extends CoreCallback
13 | {
14 | }
15 | 


--------------------------------------------------------------------------------
/src/Types/CheckoutLocationSettingsBrandingHeaderType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CheckoutLocationSettingsBrandingHeaderType: string
 6 | {
 7 |     case BusinessName = "BUSINESS_NAME";
 8 |     case FramedLogo = "FRAMED_LOGO";
 9 |     case FullWidthLogo = "FULL_WIDTH_LOGO";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/GiftCardActivityAdjustIncrementReason.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum GiftCardActivityAdjustIncrementReason: string
 6 | {
 7 |     case Complimentary = "COMPLIMENTARY";
 8 |     case SupportIssue = "SUPPORT_ISSUE";
 9 |     case TransactionVoided = "TRANSACTION_VOIDED";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/GiftCardActivityClearBalanceReason.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum GiftCardActivityClearBalanceReason: string
 6 | {
 7 |     case SuspiciousActivity = "SUSPICIOUS_ACTIVITY";
 8 |     case ReuseGiftcard = "REUSE_GIFTCARD";
 9 |     case UnknownReason = "UNKNOWN_REASON";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/TeamMemberAssignedLocationsAssignmentType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TeamMemberAssignedLocationsAssignmentType: string
 6 | {
 7 |     case AllCurrentAndFutureLocations = "ALL_CURRENT_AND_FUTURE_LOCATIONS";
 8 |     case ExplicitLocations = "EXPLICIT_LOCATIONS";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/BankAccountType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum BankAccountType: string
 6 | {
 7 |     case Checking = "CHECKING";
 8 |     case Savings = "SAVINGS";
 9 |     case Investment = "INVESTMENT";
10 |     case Other = "OTHER";
11 |     case BusinessChecking = "BUSINESS_CHECKING";
12 | }
13 | 


--------------------------------------------------------------------------------
/src/Types/TenderCardDetailsEntryMethod.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TenderCardDetailsEntryMethod: string
 6 | {
 7 |     case Swiped = "SWIPED";
 8 |     case Keyed = "KEYED";
 9 |     case Emv = "EMV";
10 |     case OnFile = "ON_FILE";
11 |     case Contactless = "CONTACTLESS";
12 | }
13 | 


--------------------------------------------------------------------------------
/src/Types/BookingBookingSource.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum BookingBookingSource: string
 6 | {
 7 |     case FirstPartyMerchant = "FIRST_PARTY_MERCHANT";
 8 |     case FirstPartyBuyer = "FIRST_PARTY_BUYER";
 9 |     case ThirdPartyBuyer = "THIRD_PARTY_BUYER";
10 |     case Api = "API";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Types/BusinessAppointmentSettingsBookingLocationType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum BusinessAppointmentSettingsBookingLocationType: string
 6 | {
 7 |     case BusinessLocation = "BUSINESS_LOCATION";
 8 |     case CustomerLocation = "CUSTOMER_LOCATION";
 9 |     case Phone = "PHONE";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/GiftCardActivityDeactivateReason.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum GiftCardActivityDeactivateReason: string
 6 | {
 7 |     case SuspiciousActivity = "SUSPICIOUS_ACTIVITY";
 8 |     case UnknownReason = "UNKNOWN_REASON";
 9 |     case ChargebackDeactivate = "CHARGEBACK_DEACTIVATE";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Core/Types/Constant.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Core\Types;
 4 | 
 5 | use DateTimeInterface;
 6 | 
 7 | class Constant
 8 | {
 9 |     public const DateFormat = 'Y-m-d';
10 |     public const DateDeserializationFormat = "!" . self::DateFormat;
11 |     public const DateTimeFormat = DateTimeInterface::RFC3339;
12 | }
13 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/TransactionType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The transaction type used in the disputed payment.
 9 |  */
10 | class TransactionType
11 | {
12 |     public const DEBIT = 'DEBIT';
13 | 
14 |     public const CREDIT = 'CREDIT';
15 | }
16 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/V1UpdateOrderRequestAction.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | class V1UpdateOrderRequestAction
 8 | {
 9 |     public const COMPLETE = 'COMPLETE';
10 | 
11 |     public const CANCEL = 'CANCEL';
12 | 
13 |     public const REFUND = 'REFUND';
14 | }
15 | 


--------------------------------------------------------------------------------
/src/Types/TransferOrderStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TransferOrderStatus: string
 6 | {
 7 |     case Draft = "DRAFT";
 8 |     case Started = "STARTED";
 9 |     case PartiallyReceived = "PARTIALLY_RECEIVED";
10 |     case Completed = "COMPLETED";
11 |     case Canceled = "CANCELED";
12 | }
13 | 


--------------------------------------------------------------------------------
/src/Types/V1OrderState.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum V1OrderState: string
 6 | {
 7 |     case Pending = "PENDING";
 8 |     case Open = "OPEN";
 9 |     case Completed = "COMPLETED";
10 |     case Canceled = "CANCELED";
11 |     case Refunded = "REFUNDED";
12 |     case Rejected = "REJECTED";
13 | }
14 | 


--------------------------------------------------------------------------------
/src/Types/CatalogDiscountType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CatalogDiscountType: string
 6 | {
 7 |     case FixedPercentage = "FIXED_PERCENTAGE";
 8 |     case FixedAmount = "FIXED_AMOUNT";
 9 |     case VariablePercentage = "VARIABLE_PERCENTAGE";
10 |     case VariableAmount = "VARIABLE_AMOUNT";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/DeviceStatusCategory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | class DeviceStatusCategory
 8 | {
 9 |     public const AVAILABLE = 'AVAILABLE';
10 | 
11 |     public const NEEDS_ATTENTION = 'NEEDS_ATTENTION';
12 | 
13 |     public const OFFLINE = 'OFFLINE';
14 | }
15 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/PaymentSortField.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | class PaymentSortField
 8 | {
 9 |     public const CREATED_AT = 'CREATED_AT';
10 | 
11 |     public const OFFLINE_CREATED_AT = 'OFFLINE_CREATED_AT';
12 | 
13 |     public const UPDATED_AT = 'UPDATED_AT';
14 | }
15 | 


--------------------------------------------------------------------------------
/src/Types/CatalogCustomAttributeDefinitionSellerVisibility.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CatalogCustomAttributeDefinitionSellerVisibility: string
 6 | {
 7 |     case SellerVisibilityHidden = "SELLER_VISIBILITY_HIDDEN";
 8 |     case SellerVisibilityReadWriteValues = "SELLER_VISIBILITY_READ_WRITE_VALUES";
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/Types/FulfillmentState.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum FulfillmentState: string
 6 | {
 7 |     case Proposed = "PROPOSED";
 8 |     case Reserved = "RESERVED";
 9 |     case Prepared = "PREPARED";
10 |     case Completed = "COMPLETED";
11 |     case Canceled = "CANCELED";
12 |     case Failed = "FAILED";
13 | }
14 | 


--------------------------------------------------------------------------------
/src/Legacy/Environment.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy;
 6 | 
 7 | /**
 8 |  * Environments available for API
 9 |  */
10 | class Environment
11 | {
12 |     public const PRODUCTION = 'production';
13 | 
14 |     public const SANDBOX = 'sandbox';
15 | 
16 |     public const CUSTOM = 'custom';
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Types/BusinessAppointmentSettingsAlignmentTime.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum BusinessAppointmentSettingsAlignmentTime: string
 6 | {
 7 |     case ServiceDuration = "SERVICE_DURATION";
 8 |     case QuarterHourly = "QUARTER_HOURLY";
 9 |     case HalfHourly = "HALF_HOURLY";
10 |     case Hourly = "HOURLY";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Types/CustomAttributeDefinitionVisibility.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CustomAttributeDefinitionVisibility: string
 6 | {
 7 |     case VisibilityHidden = "VISIBILITY_HIDDEN";
 8 |     case VisibilityReadOnly = "VISIBILITY_READ_ONLY";
 9 |     case VisibilityReadWriteValues = "VISIBILITY_READ_WRITE_VALUES";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/SubscriptionStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum SubscriptionStatus: string
 6 | {
 7 |     case Pending = "PENDING";
 8 |     case Active = "ACTIVE";
 9 |     case Canceled = "CANCELED";
10 |     case Deactivated = "DEACTIVATED";
11 |     case Paused = "PAUSED";
12 |     case Completed = "COMPLETED";
13 | }
14 | 


--------------------------------------------------------------------------------
/src/Core/Types/Date.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Core\Types;
 4 | 
 5 | use Attribute;
 6 | 
 7 | #[Attribute(Attribute::TARGET_PROPERTY)]
 8 | class Date
 9 | {
10 |     public const TYPE_DATE = 'date';
11 |     public const TYPE_DATETIME = 'datetime';
12 | 
13 |     public function __construct(public string $type)
14 |     {
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/LoyaltyAccountMappingType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The type of mapping.
 9 |  */
10 | class LoyaltyAccountMappingType
11 | {
12 |     /**
13 |      * The loyalty account is mapped by phone.
14 |      */
15 |     public const PHONE = 'PHONE';
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Types/OrderFulfillmentState.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum OrderFulfillmentState: string
 6 | {
 7 |     case Proposed = "PROPOSED";
 8 |     case Reserved = "RESERVED";
 9 |     case Prepared = "PREPARED";
10 |     case Completed = "COMPLETED";
11 |     case Canceled = "CANCELED";
12 |     case Failed = "FAILED";
13 | }
14 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CheckoutLocationSettingsBrandingButtonShape.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | class CheckoutLocationSettingsBrandingButtonShape
 8 | {
 9 |     public const SQUARED = 'SQUARED';
10 | 
11 |     public const ROUNDED = 'ROUNDED';
12 | 
13 |     public const PILL = 'PILL';
14 | }
15 | 


--------------------------------------------------------------------------------
/src/Types/ComponentComponentType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum ComponentComponentType: string
 6 | {
 7 |     case Application = "APPLICATION";
 8 |     case CardReader = "CARD_READER";
 9 |     case Battery = "BATTERY";
10 |     case Wifi = "WIFI";
11 |     case Ethernet = "ETHERNET";
12 |     case Printer = "PRINTER";
13 | }
14 | 


--------------------------------------------------------------------------------
/src/Types/MeasurementUnitTime.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum MeasurementUnitTime: string
 6 | {
 7 |     case GenericMillisecond = "GENERIC_MILLISECOND";
 8 |     case GenericSecond = "GENERIC_SECOND";
 9 |     case GenericMinute = "GENERIC_MINUTE";
10 |     case GenericHour = "GENERIC_HOUR";
11 |     case GenericDay = "GENERIC_DAY";
12 | }
13 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CardCoBrand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates the brand for a co-branded card.
 9 |  */
10 | class CardCoBrand
11 | {
12 |     public const UNKNOWN = 'UNKNOWN';
13 | 
14 |     public const AFTERPAY = 'AFTERPAY';
15 | 
16 |     public const CLEARPAY = 'CLEARPAY';
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Types/BookingStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum BookingStatus: string
 6 | {
 7 |     case Pending = "PENDING";
 8 |     case CancelledByCustomer = "CANCELLED_BY_CUSTOMER";
 9 |     case CancelledBySeller = "CANCELLED_BY_SELLER";
10 |     case Declined = "DECLINED";
11 |     case Accepted = "ACCEPTED";
12 |     case NoShow = "NO_SHOW";
13 | }
14 | 


--------------------------------------------------------------------------------
/src/Types/SubscriptionActionType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum SubscriptionActionType: string
 6 | {
 7 |     case Cancel = "CANCEL";
 8 |     case Pause = "PAUSE";
 9 |     case Resume = "RESUME";
10 |     case SwapPlan = "SWAP_PLAN";
11 |     case ChangeBillingAnchorDate = "CHANGE_BILLING_ANCHOR_DATE";
12 |     case Complete = "COMPLETE";
13 | }
14 | 


--------------------------------------------------------------------------------
/src/Types/DeviceComponentDetailsExternalPower.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum DeviceComponentDetailsExternalPower: string
 6 | {
 7 |     case AvailableCharging = "AVAILABLE_CHARGING";
 8 |     case AvailableNotInUse = "AVAILABLE_NOT_IN_USE";
 9 |     case Unavailable = "UNAVAILABLE";
10 |     case AvailableInsufficient = "AVAILABLE_INSUFFICIENT";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CardType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates a card's type, such as `CREDIT` or `DEBIT`.
 9 |  */
10 | class CardType
11 | {
12 |     public const UNKNOWN_CARD_TYPE = 'UNKNOWN_CARD_TYPE';
13 | 
14 |     public const CREDIT = 'CREDIT';
15 | 
16 |     public const DEBIT = 'DEBIT';
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Types/CatalogCustomAttributeDefinitionAppVisibility.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CatalogCustomAttributeDefinitionAppVisibility: string
 6 | {
 7 |     case AppVisibilityHidden = "APP_VISIBILITY_HIDDEN";
 8 |     case AppVisibilityReadOnly = "APP_VISIBILITY_READ_ONLY";
 9 |     case AppVisibilityReadWriteValues = "APP_VISIBILITY_READ_WRITE_VALUES";
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Types/MeasurementUnitUnitType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum MeasurementUnitUnitType: string
 6 | {
 7 |     case TypeCustom = "TYPE_CUSTOM";
 8 |     case TypeArea = "TYPE_AREA";
 9 |     case TypeLength = "TYPE_LENGTH";
10 |     case TypeVolume = "TYPE_VOLUME";
11 |     case TypeWeight = "TYPE_WEIGHT";
12 |     case TypeGeneric = "TYPE_GENERIC";
13 | }
14 | 


--------------------------------------------------------------------------------
/src/Types/V1TenderEntryMethod.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum V1TenderEntryMethod: string
 6 | {
 7 |     case Manual = "MANUAL";
 8 |     case Scanned = "SCANNED";
 9 |     case SquareCash = "SQUARE_CASH";
10 |     case SquareWallet = "SQUARE_WALLET";
11 |     case Swiped = "SWIPED";
12 |     case WebForm = "WEB_FORM";
13 |     case Other = "OTHER";
14 | }
15 | 


--------------------------------------------------------------------------------
/src/Types/OrderServiceChargeCalculationPhase.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum OrderServiceChargeCalculationPhase: string
 6 | {
 7 |     case SubtotalPhase = "SUBTOTAL_PHASE";
 8 |     case TotalPhase = "TOTAL_PHASE";
 9 |     case ApportionedPercentagePhase = "APPORTIONED_PERCENTAGE_PHASE";
10 |     case ApportionedAmountPhase = "APPORTIONED_AMOUNT_PHASE";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CheckoutLocationSettingsBrandingHeaderType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | class CheckoutLocationSettingsBrandingHeaderType
 8 | {
 9 |     public const BUSINESS_NAME = 'BUSINESS_NAME';
10 | 
11 |     public const FRAMED_LOGO = 'FRAMED_LOGO';
12 | 
13 |     public const FULL_WIDTH_LOGO = 'FULL_WIDTH_LOGO';
14 | }
15 | 


--------------------------------------------------------------------------------
/src/Types/OrderLineItemDiscountType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum OrderLineItemDiscountType: string
 6 | {
 7 |     case UnknownDiscount = "UNKNOWN_DISCOUNT";
 8 |     case FixedPercentage = "FIXED_PERCENTAGE";
 9 |     case FixedAmount = "FIXED_AMOUNT";
10 |     case VariablePercentage = "VARIABLE_PERCENTAGE";
11 |     case VariableAmount = "VARIABLE_AMOUNT";
12 | }
13 | 


--------------------------------------------------------------------------------
/src/Core/Types/ArrayType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Core\Types;
 4 | 
 5 | use Attribute;
 6 | 
 7 | #[Attribute(Attribute::TARGET_PROPERTY)]
 8 | class ArrayType
 9 | {
10 |     /**
11 |      * @param mixed[] $type Array in the form ['keyType' => 'valueType'] for maps, or ['valueType'] for lists
12 |      */
13 |     public function __construct(public array $type)
14 |     {
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Types/GiftCardActivityAdjustDecrementReason.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum GiftCardActivityAdjustDecrementReason: string
 6 | {
 7 |     case SuspiciousActivity = "SUSPICIOUS_ACTIVITY";
 8 |     case BalanceAccidentallyIncreased = "BALANCE_ACCIDENTALLY_INCREASED";
 9 |     case SupportIssue = "SUPPORT_ISSUE";
10 |     case PurchaseWasRefunded = "PURCHASE_WAS_REFUNDED";
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Types/V1OrderHistoryEntryAction.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum V1OrderHistoryEntryAction: string
 6 | {
 7 |     case OrderPlaced = "ORDER_PLACED";
 8 |     case Declined = "DECLINED";
 9 |     case PaymentReceived = "PAYMENT_RECEIVED";
10 |     case Canceled = "CANCELED";
11 |     case Completed = "COMPLETED";
12 |     case Refunded = "REFUNDED";
13 |     case Expired = "EXPIRED";
14 | }
15 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/GiftCardType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates the gift card type.
 9 |  */
10 | class GiftCardType
11 | {
12 |     /**
13 |      * A plastic gift card.
14 |      */
15 |     public const PHYSICAL = 'PHYSICAL';
16 | 
17 |     /**
18 |      * A digital gift card.
19 |      */
20 |     public const DIGITAL = 'DIGITAL';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Types/MeasurementUnitWeight.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum MeasurementUnitWeight: string
 6 | {
 7 |     case ImperialWeightOunce = "IMPERIAL_WEIGHT_OUNCE";
 8 |     case ImperialPound = "IMPERIAL_POUND";
 9 |     case ImperialStone = "IMPERIAL_STONE";
10 |     case MetricMilligram = "METRIC_MILLIGRAM";
11 |     case MetricGram = "METRIC_GRAM";
12 |     case MetricKilogram = "METRIC_KILOGRAM";
13 | }
14 | 


--------------------------------------------------------------------------------
/src/Types/V1TenderType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum V1TenderType: string
 6 | {
 7 |     case CreditCard = "CREDIT_CARD";
 8 |     case Cash = "CASH";
 9 |     case ThirdPartyCard = "THIRD_PARTY_CARD";
10 |     case NoSale = "NO_SALE";
11 |     case SquareWallet = "SQUARE_WALLET";
12 |     case SquareGiftCard = "SQUARE_GIFT_CARD";
13 |     case Unknown = "UNKNOWN";
14 |     case Other = "OTHER";
15 | }
16 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CardPrepaidType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates a card's prepaid type, such as `NOT_PREPAID` or `PREPAID`.
 9 |  */
10 | class CardPrepaidType
11 | {
12 |     public const UNKNOWN_PREPAID_TYPE = 'UNKNOWN_PREPAID_TYPE';
13 | 
14 |     public const NOT_PREPAID = 'NOT_PREPAID';
15 | 
16 |     public const PREPAID = 'PREPAID';
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Types/TransactionProduct.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TransactionProduct: string
 6 | {
 7 |     case Register = "REGISTER";
 8 |     case ExternalApi = "EXTERNAL_API";
 9 |     case Billing = "BILLING";
10 |     case Appointments = "APPOINTMENTS";
11 |     case Invoices = "INVOICES";
12 |     case OnlineStore = "ONLINE_STORE";
13 |     case Payroll = "PAYROLL";
14 |     case Other = "OTHER";
15 | }
16 | 


--------------------------------------------------------------------------------
/src/Types/TerminalActionActionType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TerminalActionActionType: string
 6 | {
 7 |     case QrCode = "QR_CODE";
 8 |     case Ping = "PING";
 9 |     case SaveCard = "SAVE_CARD";
10 |     case Signature = "SIGNATURE";
11 |     case Confirmation = "CONFIRMATION";
12 |     case Receipt = "RECEIPT";
13 |     case DataCollection = "DATA_COLLECTION";
14 |     case Select = "SELECT";
15 | }
16 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/V1OrderState.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | class V1OrderState
 8 | {
 9 |     public const PENDING = 'PENDING';
10 | 
11 |     public const OPEN = 'OPEN';
12 | 
13 |     public const COMPLETED = 'COMPLETED';
14 | 
15 |     public const CANCELED = 'CANCELED';
16 | 
17 |     public const REFUNDED = 'REFUNDED';
18 | 
19 |     public const REJECTED = 'REJECTED';
20 | }
21 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/SearchEventsSortField.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Specifies the sort key for events returned from a search.
 9 |  */
10 | class SearchEventsSortField
11 | {
12 |     /**
13 |      * Use the default sort key. The default behavior is to sort events by when they were created
14 |      * (`created_at`).
15 |      */
16 |     public const DEFAULT_ = 'DEFAULT';
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/GiftCardActivityUnblockReason.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates the reason for unblocking a [gift card]($m/GiftCard).
 9 |  */
10 | class GiftCardActivityUnblockReason
11 | {
12 |     /**
13 |      * The gift card is unblocked because a chargeback was ruled in favor of the seller.
14 |      */
15 |     public const CHARGEBACK_UNBLOCK = 'CHARGEBACK_UNBLOCK';
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/SubscriptionPricingType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Determines the pricing of a [Subscription]($m/Subscription)
 9 |  */
10 | class SubscriptionPricingType
11 | {
12 |     /**
13 |      * Static pricing
14 |      */
15 |     public const STATIC_ = 'STATIC';
16 | 
17 |     /**
18 |      * Relative pricing
19 |      */
20 |     public const RELATIVE = 'RELATIVE';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/GiftCardActivityBlockReason.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates the reason for blocking a [gift card]($m/GiftCard).
 9 |  */
10 | class GiftCardActivityBlockReason
11 | {
12 |     /**
13 |      * The gift card is blocked because the buyer initiated a chargeback on the gift card purchase.
14 |      */
15 |     public const CHARGEBACK_BLOCK = 'CHARGEBACK_BLOCK';
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Types/DisputeState.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum DisputeState: string
 6 | {
 7 |     case InquiryEvidenceRequired = "INQUIRY_EVIDENCE_REQUIRED";
 8 |     case InquiryProcessing = "INQUIRY_PROCESSING";
 9 |     case InquiryClosed = "INQUIRY_CLOSED";
10 |     case EvidenceRequired = "EVIDENCE_REQUIRED";
11 |     case Processing = "PROCESSING";
12 |     case Won = "WON";
13 |     case Lost = "LOST";
14 |     case Accepted = "ACCEPTED";
15 | }
16 | 


--------------------------------------------------------------------------------
/src/Types/InvoiceRequestMethod.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum InvoiceRequestMethod: string
 6 | {
 7 |     case Email = "EMAIL";
 8 |     case ChargeCardOnFile = "CHARGE_CARD_ON_FILE";
 9 |     case ShareManually = "SHARE_MANUALLY";
10 |     case ChargeBankOnFile = "CHARGE_BANK_ON_FILE";
11 |     case Sms = "SMS";
12 |     case SmsChargeCardOnFile = "SMS_CHARGE_CARD_ON_FILE";
13 |     case SmsChargeBankOnFile = "SMS_CHARGE_BANK_ON_FILE";
14 | }
15 | 


--------------------------------------------------------------------------------
/src/Types/SubscriptionEventInfoCode.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum SubscriptionEventInfoCode: string
 6 | {
 7 |     case LocationNotActive = "LOCATION_NOT_ACTIVE";
 8 |     case LocationCannotAcceptPayment = "LOCATION_CANNOT_ACCEPT_PAYMENT";
 9 |     case CustomerDeleted = "CUSTOMER_DELETED";
10 |     case CustomerNoEmail = "CUSTOMER_NO_EMAIL";
11 |     case CustomerNoName = "CUSTOMER_NO_NAME";
12 |     case UserProvided = "USER_PROVIDED";
13 | }
14 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/LocationType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * A location's type.
 9 |  */
10 | class LocationType
11 | {
12 |     /**
13 |      * A place of business with a physical location.
14 |      */
15 |     public const PHYSICAL = 'PHYSICAL';
16 | 
17 |     /**
18 |      * A place of business that is mobile, such as a food truck or online store.
19 |      */
20 |     public const MOBILE = 'MOBILE';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/OrderServiceChargeTreatmentType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates whether the service charge will be treated as a value-holding line item or
 9 |  * apportioned toward a line item.
10 |  */
11 | class OrderServiceChargeTreatmentType
12 | {
13 |     public const LINE_ITEM_TREATMENT = 'LINE_ITEM_TREATMENT';
14 | 
15 |     public const APPORTIONED_TREATMENT = 'APPORTIONED_TREATMENT';
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/SearchCatalogItemsRequestStockLevel.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Defines supported stock levels of the item inventory.
 9 |  */
10 | class SearchCatalogItemsRequestStockLevel
11 | {
12 |     /**
13 |      * The item inventory is empty.
14 |      */
15 |     public const OUT = 'OUT';
16 | 
17 |     /**
18 |      * The item inventory is low.
19 |      */
20 |     public const LOW = 'LOW';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/ShiftStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Enumerates the possible status of a `Shift`.
 9 |  */
10 | class ShiftStatus
11 | {
12 |     /**
13 |      * Employee started a work shift and the shift is not complete
14 |      */
15 |     public const OPEN = 'OPEN';
16 | 
17 |     /**
18 |      * Employee started and ended a work shift.
19 |      */
20 |     public const CLOSED = 'CLOSED';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Types/CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference: string
 6 | {
 7 |     case DairyFree = "DAIRY_FREE";
 8 |     case GlutenFree = "GLUTEN_FREE";
 9 |     case Halal = "HALAL";
10 |     case Kosher = "KOSHER";
11 |     case NutFree = "NUT_FREE";
12 |     case Vegan = "VEGAN";
13 |     case Vegetarian = "VEGETARIAN";
14 | }
15 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/ShiftFilterStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Specifies the `status` of `Shift` records to be returned.
 9 |  */
10 | class ShiftFilterStatus
11 | {
12 |     /**
13 |      * Shifts that have been started and not ended.
14 |      */
15 |     public const OPEN = 'OPEN';
16 | 
17 |     /**
18 |      * Shifts that have been started and ended.
19 |      */
20 |     public const CLOSED = 'CLOSED';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Types/V1TenderCardBrand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum V1TenderCardBrand: string
 6 | {
 7 |     case OtherBrand = "OTHER_BRAND";
 8 |     case Visa = "VISA";
 9 |     case MasterCard = "MASTER_CARD";
10 |     case AmericanExpress = "AMERICAN_EXPRESS";
11 |     case Discover = "DISCOVER";
12 |     case DiscoverDiners = "DISCOVER_DINERS";
13 |     case Jcb = "JCB";
14 |     case ChinaUnionpay = "CHINA_UNIONPAY";
15 |     case SquareGiftCard = "SQUARE_GIFT_CARD";
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Types/CheckoutOptionsPaymentType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CheckoutOptionsPaymentType: string
 6 | {
 7 |     case CardPresent = "CARD_PRESENT";
 8 |     case ManualCardEntry = "MANUAL_CARD_ENTRY";
 9 |     case FelicaId = "FELICA_ID";
10 |     case FelicaQuicpay = "FELICA_QUICPAY";
11 |     case FelicaTransportationGroup = "FELICA_TRANSPORTATION_GROUP";
12 |     case FelicaAll = "FELICA_ALL";
13 |     case Paypay = "PAYPAY";
14 |     case QrCode = "QR_CODE";
15 | }
16 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/BookingCreatorDetailsCreatorType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Supported types of a booking creator.
 9 |  */
10 | class BookingCreatorDetailsCreatorType
11 | {
12 |     /**
13 |      * The creator is of the seller type.
14 |      */
15 |     public const TEAM_MEMBER = 'TEAM_MEMBER';
16 | 
17 |     /**
18 |      * The creator is of the buyer type.
19 |      */
20 |     public const CUSTOMER = 'CUSTOMER';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Types/InvoiceStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum InvoiceStatus: string
 6 | {
 7 |     case Draft = "DRAFT";
 8 |     case Unpaid = "UNPAID";
 9 |     case Scheduled = "SCHEDULED";
10 |     case PartiallyPaid = "PARTIALLY_PAID";
11 |     case Paid = "PAID";
12 |     case PartiallyRefunded = "PARTIALLY_REFUNDED";
13 |     case Refunded = "REFUNDED";
14 |     case Canceled = "CANCELED";
15 |     case Failed = "FAILED";
16 |     case PaymentPending = "PAYMENT_PENDING";
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Types/LoyaltyEventType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum LoyaltyEventType: string
 6 | {
 7 |     case AccumulatePoints = "ACCUMULATE_POINTS";
 8 |     case CreateReward = "CREATE_REWARD";
 9 |     case RedeemReward = "REDEEM_REWARD";
10 |     case DeleteReward = "DELETE_REWARD";
11 |     case AdjustPoints = "ADJUST_POINTS";
12 |     case ExpirePoints = "EXPIRE_POINTS";
13 |     case Other = "OTHER";
14 |     case AccumulatePromotionPoints = "ACCUMULATE_PROMOTION_POINTS";
15 | }
16 | 


--------------------------------------------------------------------------------
/src/Types/Product.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum Product: string
 6 | {
 7 |     case SquarePos = "SQUARE_POS";
 8 |     case ExternalApi = "EXTERNAL_API";
 9 |     case Billing = "BILLING";
10 |     case Appointments = "APPOINTMENTS";
11 |     case Invoices = "INVOICES";
12 |     case OnlineStore = "ONLINE_STORE";
13 |     case Payroll = "PAYROLL";
14 |     case Dashboard = "DASHBOARD";
15 |     case ItemLibraryImport = "ITEM_LIBRARY_IMPORT";
16 |     case Other = "OTHER";
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Types/TenderType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum TenderType: string
 6 | {
 7 |     case Card = "CARD";
 8 |     case Cash = "CASH";
 9 |     case ThirdPartyCard = "THIRD_PARTY_CARD";
10 |     case SquareGiftCard = "SQUARE_GIFT_CARD";
11 |     case NoSale = "NO_SALE";
12 |     case BankAccount = "BANK_ACCOUNT";
13 |     case Wallet = "WALLET";
14 |     case BuyNowPayLater = "BUY_NOW_PAY_LATER";
15 |     case SquareAccount = "SQUARE_ACCOUNT";
16 |     case Other = "OTHER";
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Core/Json/JsonEncoder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Core\Json;
 4 | 
 5 | use JsonException;
 6 | 
 7 | class JsonEncoder
 8 | {
 9 |     /**
10 |      * Encodes a PHP value into JSON string.
11 |      *
12 |      * @param mixed $value The PHP value to encode.
13 |      * @return string The encoded string.
14 |      * @throws JsonException
15 |      */
16 |     public static function encode(mixed $value): string
17 |     {
18 |         return json_encode($value, JSON_THROW_ON_ERROR);
19 |     }
20 | }
21 | 


--------------------------------------------------------------------------------
/src/Types/MeasurementUnitLength.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum MeasurementUnitLength: string
 6 | {
 7 |     case ImperialInch = "IMPERIAL_INCH";
 8 |     case ImperialFoot = "IMPERIAL_FOOT";
 9 |     case ImperialYard = "IMPERIAL_YARD";
10 |     case ImperialMile = "IMPERIAL_MILE";
11 |     case MetricMillimeter = "METRIC_MILLIMETER";
12 |     case MetricCentimeter = "METRIC_CENTIMETER";
13 |     case MetricMeter = "METRIC_METER";
14 |     case MetricKilometer = "METRIC_KILOMETER";
15 | }
16 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CatalogDiscountModifyTaxBasis.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | class CatalogDiscountModifyTaxBasis
 8 | {
 9 |     /**
10 |      * Application of the discount will modify the tax basis.
11 |      */
12 |     public const MODIFY_TAX_BASIS = 'MODIFY_TAX_BASIS';
13 | 
14 |     /**
15 |      * Application of the discount will not modify the tax basis.
16 |      */
17 |     public const DO_NOT_MODIFY_TAX_BASIS = 'DO_NOT_MODIFY_TAX_BASIS';
18 | }
19 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/V1TenderEntryMethod.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | class V1TenderEntryMethod
 8 | {
 9 |     public const MANUAL = 'MANUAL';
10 | 
11 |     public const SCANNED = 'SCANNED';
12 | 
13 |     public const SQUARE_CASH = 'SQUARE_CASH';
14 | 
15 |     public const SQUARE_WALLET = 'SQUARE_WALLET';
16 | 
17 |     public const SWIPED = 'SWIPED';
18 | 
19 |     public const WEB_FORM = 'WEB_FORM';
20 | 
21 |     public const OTHER = 'OTHER';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/ComponentComponentType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * An enum for ComponentType.
 9 |  */
10 | class ComponentComponentType
11 | {
12 |     public const APPLICATION = 'APPLICATION';
13 | 
14 |     public const CARD_READER = 'CARD_READER';
15 | 
16 |     public const BATTERY = 'BATTERY';
17 | 
18 |     public const WIFI = 'WIFI';
19 | 
20 |     public const ETHERNET = 'ETHERNET';
21 | 
22 |     public const PRINTER = 'PRINTER';
23 | }
24 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/PayoutFeeType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Represents the type of payout fee that can incur as part of a payout.
 9 |  */
10 | class PayoutFeeType
11 | {
12 |     /**
13 |      * Fee type associated with transfers.
14 |      */
15 |     public const TRANSFER_FEE = 'TRANSFER_FEE';
16 | 
17 |     /**
18 |      * Taxes associated with the transfer fee.
19 |      */
20 |     public const TAX_ON_TRANSFER_FEE = 'TAX_ON_TRANSFER_FEE';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/RegisterDomainResponseStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The status of the domain registration.
 9 |  */
10 | class RegisterDomainResponseStatus
11 | {
12 |     /**
13 |      * The domain is added, but not verified.
14 |      */
15 |     public const PENDING = 'PENDING';
16 | 
17 |     /**
18 |      * The domain is added and verified. It can be used to accept Apple Pay transactions.
19 |      */
20 |     public const VERIFIED = 'VERIFIED';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/ChangeTiming.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Supported timings when a pending change, as an action, takes place to a subscription.
 9 |  */
10 | class ChangeTiming
11 | {
12 |     /**
13 |      * The action occurs immediately.
14 |      */
15 |     public const IMMEDIATE = 'IMMEDIATE';
16 | 
17 |     /**
18 |      * The action occurs at the end of the billing cycle.
19 |      */
20 |     public const END_OF_BILLING_CYCLE = 'END_OF_BILLING_CYCLE';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/LoyaltyRewardStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The status of the loyalty reward.
 9 |  */
10 | class LoyaltyRewardStatus
11 | {
12 |     /**
13 |      * The reward is issued.
14 |      */
15 |     public const ISSUED = 'ISSUED';
16 | 
17 |     /**
18 |      * The reward is redeemed.
19 |      */
20 |     public const REDEEMED = 'REDEEMED';
21 | 
22 |     /**
23 |      * The reward is deleted.
24 |      */
25 |     public const DELETED = 'DELETED';
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/TaxCalculationPhase.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * When to calculate the taxes due on a cart.
 9 |  */
10 | class TaxCalculationPhase
11 | {
12 |     /**
13 |      * The fee is calculated based on the payment's subtotal.
14 |      */
15 |     public const TAX_SUBTOTAL_PHASE = 'TAX_SUBTOTAL_PHASE';
16 | 
17 |     /**
18 |      * The fee is calculated based on the payment's total.
19 |      */
20 |     public const TAX_TOTAL_PHASE = 'TAX_TOTAL_PHASE';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/VendorStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The status of the [Vendor]($m/Vendor),
 9 |  * whether a [Vendor]($m/Vendor) is active or inactive.
10 |  */
11 | class VendorStatus
12 | {
13 |     /**
14 |      * Vendor is active and can receive purchase orders.
15 |      */
16 |     public const ACTIVE = 'ACTIVE';
17 | 
18 |     /**
19 |      * Vendor is inactive and cannot receive purchase orders.
20 |      */
21 |     public const INACTIVE = 'INACTIVE';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Legacy/Http/HttpMethod.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Http;
 6 | 
 7 | use CoreInterfaces\Core\Request\RequestMethod;
 8 | 
 9 | /**
10 |  * HTTP Methods Enumeration
11 |  */
12 | class HttpMethod
13 | {
14 |     public const GET = RequestMethod::GET;
15 |     public const POST = RequestMethod::POST;
16 |     public const PUT = RequestMethod::PUT;
17 |     public const PATCH = RequestMethod::PATCH;
18 |     public const DELETE = RequestMethod::DELETE;
19 |     public const HEAD = RequestMethod::HEAD;
20 | }
21 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/V1OrderHistoryEntryAction.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | class V1OrderHistoryEntryAction
 8 | {
 9 |     public const ORDER_PLACED = 'ORDER_PLACED';
10 | 
11 |     public const DECLINED = 'DECLINED';
12 | 
13 |     public const PAYMENT_RECEIVED = 'PAYMENT_RECEIVED';
14 | 
15 |     public const CANCELED = 'CANCELED';
16 | 
17 |     public const COMPLETED = 'COMPLETED';
18 | 
19 |     public const REFUNDED = 'REFUNDED';
20 | 
21 |     public const EXPIRED = 'EXPIRED';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Types/DisputeReason.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum DisputeReason: string
 6 | {
 7 |     case AmountDiffers = "AMOUNT_DIFFERS";
 8 |     case Cancelled = "CANCELLED";
 9 |     case Duplicate = "DUPLICATE";
10 |     case NoKnowledge = "NO_KNOWLEDGE";
11 |     case NotAsDescribed = "NOT_AS_DESCRIBED";
12 |     case NotReceived = "NOT_RECEIVED";
13 |     case PaidByOtherMeans = "PAID_BY_OTHER_MEANS";
14 |     case CustomerRequestsCredit = "CUSTOMER_REQUESTS_CREDIT";
15 |     case EmvLiabilityShift = "EMV_LIABILITY_SHIFT";
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Types/ErrorCategory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum ErrorCategory: string
 6 | {
 7 |     case ApiError = "API_ERROR";
 8 |     case AuthenticationError = "AUTHENTICATION_ERROR";
 9 |     case InvalidRequestError = "INVALID_REQUEST_ERROR";
10 |     case RateLimitError = "RATE_LIMIT_ERROR";
11 |     case PaymentMethodError = "PAYMENT_METHOD_ERROR";
12 |     case RefundError = "REFUND_ERROR";
13 |     case MerchantSubscriptionError = "MERCHANT_SUBSCRIPTION_ERROR";
14 |     case ExternalVendorError = "EXTERNAL_VENDOR_ERROR";
15 | }
16 | 


--------------------------------------------------------------------------------
/src/Types/CatalogItemProductType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CatalogItemProductType: string
 6 | {
 7 |     case Regular = "REGULAR";
 8 |     case GiftCard = "GIFT_CARD";
 9 |     case AppointmentsService = "APPOINTMENTS_SERVICE";
10 |     case FoodAndBev = "FOOD_AND_BEV";
11 |     case Event = "EVENT";
12 |     case Digital = "DIGITAL";
13 |     case Donation = "DONATION";
14 |     case LegacySquareOnlineService = "LEGACY_SQUARE_ONLINE_SERVICE";
15 |     case LegacySquareOnlineMembership = "LEGACY_SQUARE_ONLINE_MEMBERSHIP";
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/BusinessBookingProfileBookingPolicy.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Policies for accepting bookings.
 9 |  */
10 | class BusinessBookingProfileBookingPolicy
11 | {
12 |     /**
13 |      * The seller accepts all booking requests automatically.
14 |      */
15 |     public const ACCEPT_ALL = 'ACCEPT_ALL';
16 | 
17 |     /**
18 |      * The seller must accept requests to complete bookings.
19 |      */
20 |     public const REQUIRES_ACCEPTANCE = 'REQUIRES_ACCEPTANCE';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Types/SubscriptionEventSubscriptionEventType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum SubscriptionEventSubscriptionEventType: string
 6 | {
 7 |     case StartSubscription = "START_SUBSCRIPTION";
 8 |     case PlanChange = "PLAN_CHANGE";
 9 |     case StopSubscription = "STOP_SUBSCRIPTION";
10 |     case DeactivateSubscription = "DEACTIVATE_SUBSCRIPTION";
11 |     case ResumeSubscription = "RESUME_SUBSCRIPTION";
12 |     case PauseSubscription = "PAUSE_SUBSCRIPTION";
13 |     case BillingAnchorDateChanged = "BILLING_ANCHOR_DATE_CHANGED";
14 | }
15 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CatalogModifierListModifierType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Defines the type of `CatalogModifierList`.
 9 |  */
10 | class CatalogModifierListModifierType
11 | {
12 |     /**
13 |      * The `CatalogModifierList` instance is a non-empty list of non text-based modifiers.
14 |      */
15 |     public const LIST_ = 'LIST';
16 | 
17 |     /**
18 |      * The `CatalogModifierList` instance is a single text-based modifier.
19 |      */
20 |     public const TEXT = 'TEXT';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/SortOrder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The order (e.g., chronological or alphabetical) in which results from a request are returned.
 9 |  */
10 | class SortOrder
11 | {
12 |     /**
13 |      * The results are returned in descending (e.g., newest-first or Z-A) order.
14 |      */
15 |     public const DESC = 'DESC';
16 | 
17 |     /**
18 |      * The results are returned in ascending (e.g., oldest-first or A-Z) order.
19 |      */
20 |     public const ASC = 'ASC';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Types/ApplicationDetailsExternalSquareProduct.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum ApplicationDetailsExternalSquareProduct: string
 6 | {
 7 |     case Appointments = "APPOINTMENTS";
 8 |     case EcommerceApi = "ECOMMERCE_API";
 9 |     case Invoices = "INVOICES";
10 |     case OnlineStore = "ONLINE_STORE";
11 |     case Other = "OTHER";
12 |     case Restaurants = "RESTAURANTS";
13 |     case Retail = "RETAIL";
14 |     case SquarePos = "SQUARE_POS";
15 |     case TerminalApi = "TERMINAL_API";
16 |     case VirtualTerminal = "VIRTUAL_TERMINAL";
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/InventoryAlertType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates whether Square should alert the merchant when the inventory quantity of a
 9 |  * CatalogItemVariation is low.
10 |  */
11 | class InventoryAlertType
12 | {
13 |     /**
14 |      * The variation does not display an alert.
15 |      */
16 |     public const NONE = 'NONE';
17 | 
18 |     /**
19 |      * The variation generates an alert when its quantity is low.
20 |      */
21 |     public const LOW_QUANTITY = 'LOW_QUANTITY';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/LocationStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * A location's status.
 9 |  */
10 | class LocationStatus
11 | {
12 |     /**
13 |      * A location that is active for business.
14 |      */
15 |     public const ACTIVE = 'ACTIVE';
16 | 
17 |     /**
18 |      * A location that is not active for business. Inactive locations provide historical
19 |      * information. Hide inactive locations unless the user has requested to see them.
20 |      */
21 |     public const INACTIVE = 'INACTIVE';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/LoyaltyProgramStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates whether the program is currently active.
 9 |  */
10 | class LoyaltyProgramStatus
11 | {
12 |     /**
13 |      * The loyalty program does not have an active subscription.
14 |      * Loyalty API requests fail.
15 |      */
16 |     public const INACTIVE = 'INACTIVE';
17 | 
18 |     /**
19 |      * The program is fully functional. The program has an active subscription.
20 |      */
21 |     public const ACTIVE = 'ACTIVE';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/SearchVendorsRequestSortField.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The field to sort the returned [Vendor]($m/Vendor) objects by.
 9 |  */
10 | class SearchVendorsRequestSortField
11 | {
12 |     /**
13 |      * To sort the result by the name of the [Vendor]($m/Vendor) objects.
14 |      */
15 |     public const NAME = 'NAME';
16 | 
17 |     /**
18 |      * To sort the result by the creation time of the [Vendor]($m/Vendor) objects.
19 |      */
20 |     public const CREATED_AT = 'CREATED_AT';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/V1TenderType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | class V1TenderType
 8 | {
 9 |     public const CREDIT_CARD = 'CREDIT_CARD';
10 | 
11 |     public const CASH = 'CASH';
12 | 
13 |     public const THIRD_PARTY_CARD = 'THIRD_PARTY_CARD';
14 | 
15 |     public const NO_SALE = 'NO_SALE';
16 | 
17 |     public const SQUARE_WALLET = 'SQUARE_WALLET';
18 | 
19 |     public const SQUARE_GIFT_CARD = 'SQUARE_GIFT_CARD';
20 | 
21 |     public const UNKNOWN = 'UNKNOWN';
22 | 
23 |     public const OTHER = 'OTHER';
24 | }
25 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CatalogItemFoodAndBeverageDetailsDietaryPreferenceType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The type of dietary preference for the `FOOD_AND_BEV` type of items and integredients.
 9 |  */
10 | class CatalogItemFoodAndBeverageDetailsDietaryPreferenceType
11 | {
12 |     /**
13 |      * A standard value from a pre-determined list.
14 |      */
15 |     public const STANDARD = 'STANDARD';
16 | 
17 |     /**
18 |      * A user-defined custom value.
19 |      */
20 |     public const CUSTOM = 'CUSTOM';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/LoyaltyEventSource.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Defines whether the event was generated by the Square Point of Sale.
 9 |  */
10 | class LoyaltyEventSource
11 | {
12 |     /**
13 |      * The event is generated by the Square Point of Sale (POS).
14 |      */
15 |     public const SQUARE = 'SQUARE';
16 | 
17 |     /**
18 |      * The event is generated by something other than the Square Point of Sale that used the Loyalty API.
19 |      */
20 |     public const LOYALTY_API = 'LOYALTY_API';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/MerchantStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | class MerchantStatus
 8 | {
 9 |     /**
10 |      * A fully operational merchant account. The merchant can interact with Square products and APIs.
11 |      */
12 |     public const ACTIVE = 'ACTIVE';
13 | 
14 |     /**
15 |      * A functionally limited merchant account. The merchant can only have limited interaction
16 |      * via Square APIs. The merchant cannot log in or access the seller dashboard.
17 |      */
18 |     public const INACTIVE = 'INACTIVE';
19 | }
20 | 


--------------------------------------------------------------------------------
/src/Types/MeasurementUnitArea.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum MeasurementUnitArea: string
 6 | {
 7 |     case ImperialAcre = "IMPERIAL_ACRE";
 8 |     case ImperialSquareInch = "IMPERIAL_SQUARE_INCH";
 9 |     case ImperialSquareFoot = "IMPERIAL_SQUARE_FOOT";
10 |     case ImperialSquareYard = "IMPERIAL_SQUARE_YARD";
11 |     case ImperialSquareMile = "IMPERIAL_SQUARE_MILE";
12 |     case MetricSquareCentimeter = "METRIC_SQUARE_CENTIMETER";
13 |     case MetricSquareMeter = "METRIC_SQUARE_METER";
14 |     case MetricSquareKilometer = "METRIC_SQUARE_KILOMETER";
15 | }
16 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CatalogQuickAmountType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Determines the type of a specific Quick Amount.
 9 |  */
10 | class CatalogQuickAmountType
11 | {
12 |     /**
13 |      * Quick Amount is created manually by the seller.
14 |      */
15 |     public const QUICK_AMOUNT_TYPE_MANUAL = 'QUICK_AMOUNT_TYPE_MANUAL';
16 | 
17 |     /**
18 |      * Quick Amount is generated automatically by machine learning algorithms.
19 |      */
20 |     public const QUICK_AMOUNT_TYPE_AUTO = 'QUICK_AMOUNT_TYPE_AUTO';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CatalogPricingType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates whether the price of a CatalogItemVariation should be entered manually at the time of sale.
 9 |  */
10 | class CatalogPricingType
11 | {
12 |     /**
13 |      * The catalog item variation's price is fixed.
14 |      */
15 |     public const FIXED_PRICING = 'FIXED_PRICING';
16 | 
17 |     /**
18 |      * The catalog item variation's price is entered at the time of sale.
19 |      */
20 |     public const VARIABLE_PRICING = 'VARIABLE_PRICING';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/JobAssignmentPayType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Enumerates the possible pay types that a job can be assigned.
 9 |  */
10 | class JobAssignmentPayType
11 | {
12 |     /**
13 |      * The job does not have a defined pay type.
14 |      */
15 |     public const NONE = 'NONE';
16 | 
17 |     /**
18 |      * The job pays an hourly rate.
19 |      */
20 |     public const HOURLY = 'HOURLY';
21 | 
22 |     /**
23 |      * The job pays an annual salary.
24 |      */
25 |     public const SALARY = 'SALARY';
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/EmployeeStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The status of the Employee being retrieved.
 9 |  *
10 |  * DEPRECATED at version 2020-08-26. Replaced by [TeamMemberStatus](entity:TeamMemberStatus).
11 |  */
12 | class EmployeeStatus
13 | {
14 |     /**
15 |      * Specifies that the employee is in the Active state.
16 |      */
17 |     public const ACTIVE = 'ACTIVE';
18 | 
19 |     /**
20 |      * Specifies that the employee is in the Inactive state.
21 |      */
22 |     public const INACTIVE = 'INACTIVE';
23 | }
24 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/InvoiceSortField.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The field to use for sorting.
 9 |  */
10 | class InvoiceSortField
11 | {
12 |     /**
13 |      * The field works as follows:
14 |      *
15 |      * - If the invoice is a draft, it uses the invoice `created_at` date.
16 |      * - If the invoice is scheduled for publication, it uses the `scheduled_at` date.
17 |      * - If the invoice is published, it uses the invoice publication date.
18 |      */
19 |     public const INVOICE_SORT_DATE = 'INVOICE_SORT_DATE';
20 | }
21 | 


--------------------------------------------------------------------------------
/src/Types/CashDrawerEventType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CashDrawerEventType: string
 6 | {
 7 |     case NoSale = "NO_SALE";
 8 |     case CashTenderPayment = "CASH_TENDER_PAYMENT";
 9 |     case OtherTenderPayment = "OTHER_TENDER_PAYMENT";
10 |     case CashTenderCancelledPayment = "CASH_TENDER_CANCELLED_PAYMENT";
11 |     case OtherTenderCancelledPayment = "OTHER_TENDER_CANCELLED_PAYMENT";
12 |     case CashTenderRefund = "CASH_TENDER_REFUND";
13 |     case OtherTenderRefund = "OTHER_TENDER_REFUND";
14 |     case PaidIn = "PAID_IN";
15 |     case PaidOut = "PAID_OUT";
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Legacy/BearerAuthCredentials.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy;
 6 | 
 7 | /**
 8 |  * Interface for defining the behavior of Authentication.
 9 |  */
10 | interface BearerAuthCredentials
11 | {
12 |     /**
13 |      * String value for accessToken.
14 |      */
15 |     public function getAccessToken(): string;
16 | 
17 |     /**
18 |      * Checks if provided credentials match with existing ones.
19 |      *
20 |      * @param string $accessToken The OAuth 2.0 Access Token to use for API requests.
21 |      */
22 |     public function equals(string $accessToken): bool;
23 | }
24 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/BusinessBookingProfileCustomerTimezoneChoice.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Choices of customer-facing time zone used for bookings.
 9 |  */
10 | class BusinessBookingProfileCustomerTimezoneChoice
11 | {
12 |     /**
13 |      * Use the time zone of the business location for bookings.
14 |      */
15 |     public const BUSINESS_LOCATION_TIMEZONE = 'BUSINESS_LOCATION_TIMEZONE';
16 | 
17 |     /**
18 |      * Use the customer-chosen time zone for bookings.
19 |      */
20 |     public const CUSTOMER_CHOICE = 'CUSTOMER_CHOICE';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Legacy/Utils/FileWrapper.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Utils;
 6 | 
 7 | use Core\Types\Sdk\CoreFileWrapper;
 8 | 
 9 | /**
10 |  * Wraps file with mime-type and filename to be sent as part of an HTTP request.
11 |  */
12 | class FileWrapper extends CoreFileWrapper
13 | {
14 |     /**
15 |      * Create FileWrapper instance from a file on disk
16 |      */
17 |     public static function createFromPath(string $realFilePath, ?string $mimeType = null, ?string $filename = ''): self
18 |     {
19 |         return new self($realFilePath, $mimeType, $filename);
20 |     }
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/FulfillmentPickupDetailsScheduleType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The schedule type of the pickup fulfillment.
 9 |  */
10 | class FulfillmentPickupDetailsScheduleType
11 | {
12 |     /**
13 |      * Indicates that the fulfillment will be picked up at a scheduled pickup time.
14 |      */
15 |     public const SCHEDULED = 'SCHEDULED';
16 | 
17 |     /**
18 |      * Indicates that the fulfillment will be picked up as soon as possible and
19 |      * should be prepared immediately.
20 |      */
21 |     public const ASAP = 'ASAP';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/FulfillmentType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The type of fulfillment.
 9 |  */
10 | class FulfillmentType
11 | {
12 |     /**
13 |      * A recipient to pick up the fulfillment from a physical [location]($m/Location).
14 |      */
15 |     public const PICKUP = 'PICKUP';
16 | 
17 |     /**
18 |      * A shipping carrier to ship the fulfillment.
19 |      */
20 |     public const SHIPMENT = 'SHIPMENT';
21 | 
22 |     /**
23 |      * A courier to deliver the fulfillment.
24 |      */
25 |     public const DELIVERY = 'DELIVERY';
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/OrderFulfillmentDeliveryDetailsScheduleType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The schedule type of the delivery fulfillment.
 9 |  */
10 | class OrderFulfillmentDeliveryDetailsScheduleType
11 | {
12 |     /**
13 |      * Indicates the fulfillment to deliver at a scheduled deliver time.
14 |      */
15 |     public const SCHEDULED = 'SCHEDULED';
16 | 
17 |     /**
18 |      * Indicates that the fulfillment to deliver as soon as possible and should be prepared
19 |      * immediately.
20 |      */
21 |     public const ASAP = 'ASAP';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/PayoutStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Payout status types
 9 |  */
10 | class PayoutStatus
11 | {
12 |     /**
13 |      * Indicates that the payout was successfully sent to the banking destination.
14 |      */
15 |     public const SENT = 'SENT';
16 | 
17 |     /**
18 |      * Indicates that the payout was rejected by the banking destination.
19 |      */
20 |     public const FAILED = 'FAILED';
21 | 
22 |     /**
23 |      * Indicates that the payout has successfully completed.
24 |      */
25 |     public const PAID = 'PAID';
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/OrderFulfillmentPickupDetailsScheduleType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The schedule type of the pickup fulfillment.
 9 |  */
10 | class OrderFulfillmentPickupDetailsScheduleType
11 | {
12 |     /**
13 |      * Indicates that the fulfillment will be picked up at a scheduled pickup time.
14 |      */
15 |     public const SCHEDULED = 'SCHEDULED';
16 | 
17 |     /**
18 |      * Indicates that the fulfillment will be picked up as soon as possible and
19 |      * should be prepared immediately.
20 |      */
21 |     public const ASAP = 'ASAP';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/OrderFulfillmentType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The type of fulfillment.
 9 |  */
10 | class OrderFulfillmentType
11 | {
12 |     /**
13 |      * A recipient to pick up the fulfillment from a physical [location]($m/Location).
14 |      */
15 |     public const PICKUP = 'PICKUP';
16 | 
17 |     /**
18 |      * A shipping carrier to ship the fulfillment.
19 |      */
20 |     public const SHIPMENT = 'SHIPMENT';
21 | 
22 |     /**
23 |      * A courier to deliver the fulfillment.
24 |      */
25 |     public const DELIVERY = 'DELIVERY';
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Types of daily appointment limits.
 9 |  */
10 | class BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType
11 | {
12 |     /**
13 |      * The maximum number of daily appointments is set on a per team member basis.
14 |      */
15 |     public const PER_TEAM_MEMBER = 'PER_TEAM_MEMBER';
16 | 
17 |     /**
18 |      * The maximum number of daily appointments is set on a per location basis.
19 |      */
20 |     public const PER_LOCATION = 'PER_LOCATION';
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/DataCollectionOptionsInputType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Describes the input type of the data.
 9 |  */
10 | class DataCollectionOptionsInputType
11 | {
12 |     /**
13 |      * This value is used to represent an input text that contains a email validation on the
14 |      * client.
15 |      */
16 |     public const EMAIL = 'EMAIL';
17 | 
18 |     /**
19 |      * This value is used to represent an input text that contains a phone number validation on
20 |      * the client.
21 |      */
22 |     public const PHONE_NUMBER = 'PHONE_NUMBER';
23 | }
24 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/TenderBankAccountDetailsStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates the bank account payment's current status.
 9 |  */
10 | class TenderBankAccountDetailsStatus
11 | {
12 |     /**
13 |      * The bank account payment is in progress.
14 |      */
15 |     public const PENDING = 'PENDING';
16 | 
17 |     /**
18 |      * The bank account payment has been completed.
19 |      */
20 |     public const COMPLETED = 'COMPLETED';
21 | 
22 |     /**
23 |      * The bank account payment failed.
24 |      */
25 |     public const FAILED = 'FAILED';
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/InvoiceCustomFieldPlacement.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates where to render a custom field on the Square-hosted invoice page and in emailed or PDF
 9 |  * copies of the invoice.
10 |  */
11 | class InvoiceCustomFieldPlacement
12 | {
13 |     /**
14 |      * Render the custom field above the invoice line items.
15 |      */
16 |     public const ABOVE_LINE_ITEMS = 'ABOVE_LINE_ITEMS';
17 | 
18 |     /**
19 |      * Render the custom field below the invoice line items.
20 |      */
21 |     public const BELOW_LINE_ITEMS = 'BELOW_LINE_ITEMS';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/TeamMemberStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Enumerates the possible statuses the team member can have within a business.
 9 |  */
10 | class TeamMemberStatus
11 | {
12 |     /**
13 |      * The team member can sign in to Point of Sale and the Seller Dashboard.
14 |      */
15 |     public const ACTIVE = 'ACTIVE';
16 | 
17 |     /**
18 |      * The team member can no longer sign in to Point of Sale or the Seller Dashboard,
19 |      * but the team member's sales reports remain available.
20 |      */
21 |     public const INACTIVE = 'INACTIVE';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CatalogModifierListSelectionType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates whether a CatalogModifierList supports multiple selections.
 9 |  */
10 | class CatalogModifierListSelectionType
11 | {
12 |     /**
13 |      * Indicates that a CatalogModifierList allows only a
14 |      * single CatalogModifier to be selected.
15 |      */
16 |     public const SINGLE = 'SINGLE';
17 | 
18 |     /**
19 |      * Indicates that a CatalogModifierList allows multiple
20 |      * CatalogModifier to be selected.
21 |      */
22 |     public const MULTIPLE = 'MULTIPLE';
23 | }
24 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/FulfillmentFulfillmentLineItemApplication.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The `line_item_application` describes what order line items this fulfillment applies
 9 |  * to. It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries.
10 |  */
11 | class FulfillmentFulfillmentLineItemApplication
12 | {
13 |     /**
14 |      * If `ALL`, `entries` must be unset.
15 |      */
16 |     public const ALL = 'ALL';
17 | 
18 |     /**
19 |      * If `ENTRY_LIST`, supply a list of `entries`.
20 |      */
21 |     public const ENTRY_LIST = 'ENTRY_LIST';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/ActionCancelReason.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | class ActionCancelReason
 8 | {
 9 |     /**
10 |      * A person canceled the `TerminalCheckout` from a Square device.
11 |      */
12 |     public const BUYER_CANCELED = 'BUYER_CANCELED';
13 | 
14 |     /**
15 |      * A client canceled the `TerminalCheckout` using the API.
16 |      */
17 |     public const SELLER_CANCELED = 'SELLER_CANCELED';
18 | 
19 |     /**
20 |      * The `TerminalCheckout` timed out (see `deadline_duration` on the `TerminalCheckout`).
21 |      */
22 |     public const TIMED_OUT = 'TIMED_OUT';
23 | }
24 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CatalogCategoryType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates the type of a category.
 9 |  */
10 | class CatalogCategoryType
11 | {
12 |     /**
13 |      * The regular category.
14 |      */
15 |     public const REGULAR_CATEGORY = 'REGULAR_CATEGORY';
16 | 
17 |     /**
18 |      * The menu category.
19 |      */
20 |     public const MENU_CATEGORY = 'MENU_CATEGORY';
21 | 
22 |     /**
23 |      * Kitchen categories are used by KDS (Kitchen Display System) to route items to specific clients
24 |      */
25 |     public const KITCHEN_CATEGORY = 'KITCHEN_CATEGORY';
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/OrderFulfillmentFulfillmentLineItemApplication.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The `line_item_application` describes what order line items this fulfillment applies
 9 |  * to. It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries.
10 |  */
11 | class OrderFulfillmentFulfillmentLineItemApplication
12 | {
13 |     /**
14 |      * If `ALL`, `entries` must be unset.
15 |      */
16 |     public const ALL = 'ALL';
17 | 
18 |     /**
19 |      * If `ENTRY_LIST`, supply a list of `entries`.
20 |      */
21 |     public const ENTRY_LIST = 'ENTRY_LIST';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Types/CardBrand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CardBrand: string
 6 | {
 7 |     case OtherBrand = "OTHER_BRAND";
 8 |     case Visa = "VISA";
 9 |     case Mastercard = "MASTERCARD";
10 |     case AmericanExpress = "AMERICAN_EXPRESS";
11 |     case Discover = "DISCOVER";
12 |     case DiscoverDiners = "DISCOVER_DINERS";
13 |     case Jcb = "JCB";
14 |     case ChinaUnionpay = "CHINA_UNIONPAY";
15 |     case SquareGiftCard = "SQUARE_GIFT_CARD";
16 |     case SquareCapitalCard = "SQUARE_CAPITAL_CARD";
17 |     case Interac = "INTERAC";
18 |     case Eftpos = "EFTPOS";
19 |     case Felica = "FELICA";
20 |     case Ebt = "EBT";
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Types/SubscriptionCadence.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum SubscriptionCadence: string
 6 | {
 7 |     case Daily = "DAILY";
 8 |     case Weekly = "WEEKLY";
 9 |     case EveryTwoWeeks = "EVERY_TWO_WEEKS";
10 |     case ThirtyDays = "THIRTY_DAYS";
11 |     case SixtyDays = "SIXTY_DAYS";
12 |     case NinetyDays = "NINETY_DAYS";
13 |     case Monthly = "MONTHLY";
14 |     case EveryTwoMonths = "EVERY_TWO_MONTHS";
15 |     case Quarterly = "QUARTERLY";
16 |     case EveryFourMonths = "EVERY_FOUR_MONTHS";
17 |     case EverySixMonths = "EVERY_SIX_MONTHS";
18 |     case Annual = "ANNUAL";
19 |     case EveryTwoYears = "EVERY_TWO_YEARS";
20 | }
21 | 


--------------------------------------------------------------------------------
/src/Types/CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CatalogItemFoodAndBeverageDetailsIngredientStandardIngredient: string
 6 | {
 7 |     case Celery = "CELERY";
 8 |     case Crustaceans = "CRUSTACEANS";
 9 |     case Eggs = "EGGS";
10 |     case Fish = "FISH";
11 |     case Gluten = "GLUTEN";
12 |     case Lupin = "LUPIN";
13 |     case Milk = "MILK";
14 |     case Molluscs = "MOLLUSCS";
15 |     case Mustard = "MUSTARD";
16 |     case Peanuts = "PEANUTS";
17 |     case Sesame = "SESAME";
18 |     case Soy = "SOY";
19 |     case Sulphites = "SULPHITES";
20 |     case TreeNuts = "TREE_NUTS";
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Types/MeasurementUnitVolume.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum MeasurementUnitVolume: string
 6 | {
 7 |     case GenericFluidOunce = "GENERIC_FLUID_OUNCE";
 8 |     case GenericShot = "GENERIC_SHOT";
 9 |     case GenericCup = "GENERIC_CUP";
10 |     case GenericPint = "GENERIC_PINT";
11 |     case GenericQuart = "GENERIC_QUART";
12 |     case GenericGallon = "GENERIC_GALLON";
13 |     case ImperialCubicInch = "IMPERIAL_CUBIC_INCH";
14 |     case ImperialCubicFoot = "IMPERIAL_CUBIC_FOOT";
15 |     case ImperialCubicYard = "IMPERIAL_CUBIC_YARD";
16 |     case MetricMilliliter = "METRIC_MILLILITER";
17 |     case MetricLiter = "METRIC_LITER";
18 | }
19 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The schedule type of the delivery fulfillment.
 9 |  */
10 | class FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType
11 | {
12 |     /**
13 |      * Indicates the fulfillment to deliver at a scheduled deliver time.
14 |      */
15 |     public const SCHEDULED = 'SCHEDULED';
16 | 
17 |     /**
18 |      * Indicates that the fulfillment to deliver as soon as possible and should be prepared
19 |      * immediately.
20 |      */
21 |     public const ASAP = 'ASAP';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/RefundStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates a refund's current status.
 9 |  */
10 | class RefundStatus
11 | {
12 |     /**
13 |      * The refund is pending.
14 |      */
15 |     public const PENDING = 'PENDING';
16 | 
17 |     /**
18 |      * The refund has been approved by Square.
19 |      */
20 |     public const APPROVED = 'APPROVED';
21 | 
22 |     /**
23 |      * The refund has been rejected by Square.
24 |      */
25 |     public const REJECTED = 'REJECTED';
26 | 
27 |     /**
28 |      * The refund failed.
29 |      */
30 |     public const FAILED = 'FAILED';
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/ShiftWorkdayMatcher.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Defines the logic used to apply a workday filter.
 9 |  */
10 | class ShiftWorkdayMatcher
11 | {
12 |     /**
13 |      * All shifts that start on or after the specified workday
14 |      */
15 |     public const START_AT = 'START_AT';
16 | 
17 |     /**
18 |      * All shifts that end on or before the specified workday
19 |      */
20 |     public const END_AT = 'END_AT';
21 | 
22 |     /**
23 |      * All shifts that start between the start and end workdays (inclusive)
24 |      */
25 |     public const INTERSECTION = 'INTERSECTION';
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CatalogQuickAmountsSettingsOption.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Determines a seller's option on Quick Amounts feature.
 9 |  */
10 | class CatalogQuickAmountsSettingsOption
11 | {
12 |     /**
13 |      * Option for seller to disable Quick Amounts.
14 |      */
15 |     public const DISABLED = 'DISABLED';
16 | 
17 |     /**
18 |      * Option for seller to choose manually created Quick Amounts.
19 |      */
20 |     public const MANUAL = 'MANUAL';
21 | 
22 |     /**
23 |      * Option for seller to choose automatically created Quick Amounts.
24 |      */
25 |     public const AUTO = 'AUTO';
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/PaymentOptionsDelayAction.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Describes the action to be applied to a delayed capture payment when the delay_duration
 9 |  * has elapsed.
10 |  */
11 | class PaymentOptionsDelayAction
12 | {
13 |     /**
14 |      * Indicates that the payment should be automatically canceled when the delay duration
15 |      * elapses.
16 |      */
17 |     public const CANCEL = 'CANCEL';
18 | 
19 |     /**
20 |      * Indicates that the payment should be automatically completed when the delay duration
21 |      * elapses.
22 |      */
23 |     public const COMPLETE = 'COMPLETE';
24 | }
25 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CashDrawerShiftState.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The current state of a cash drawer shift.
 9 |  */
10 | class CashDrawerShiftState
11 | {
12 |     /**
13 |      * An open cash drawer shift.
14 |      */
15 |     public const OPEN = 'OPEN';
16 | 
17 |     /**
18 |      * A cash drawer shift that is ended but has not yet had an employee content audit.
19 |      */
20 |     public const ENDED = 'ENDED';
21 | 
22 |     /**
23 |      * An ended cash drawer shift that is closed with a completed employee
24 |      * content audit and recorded result.
25 |      */
26 |     public const CLOSED = 'CLOSED';
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CustomerInclusionExclusion.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates whether customers should be included in, or excluded from,
 9 |  * the result set when they match the filtering criteria.
10 |  */
11 | class CustomerInclusionExclusion
12 | {
13 |     /**
14 |      * Customers should be included in the result set when they match the
15 |      * filtering criteria.
16 |      */
17 |     public const INCLUDE_ = 'INCLUDE';
18 | 
19 |     /**
20 |      * Customers should be excluded from the result set when they match
21 |      * the filtering criteria.
22 |      */
23 |     public const EXCLUDE = 'EXCLUDE';
24 | }
25 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/V1TenderCardBrand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The brand of a credit card.
 9 |  */
10 | class V1TenderCardBrand
11 | {
12 |     public const OTHER_BRAND = 'OTHER_BRAND';
13 | 
14 |     public const VISA = 'VISA';
15 | 
16 |     public const MASTER_CARD = 'MASTER_CARD';
17 | 
18 |     public const AMERICAN_EXPRESS = 'AMERICAN_EXPRESS';
19 | 
20 |     public const DISCOVER = 'DISCOVER';
21 | 
22 |     public const DISCOVER_DINERS = 'DISCOVER_DINERS';
23 | 
24 |     public const JCB = 'JCB';
25 | 
26 |     public const CHINA_UNIONPAY = 'CHINA_UNIONPAY';
27 | 
28 |     public const SQUARE_GIFT_CARD = 'SQUARE_GIFT_CARD';
29 | }
30 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/BusinessAppointmentSettingsBookingLocationType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Supported types of location where service is provided.
 9 |  */
10 | class BusinessAppointmentSettingsBookingLocationType
11 | {
12 |     /**
13 |      * The service is provided at a seller location.
14 |      */
15 |     public const BUSINESS_LOCATION = 'BUSINESS_LOCATION';
16 | 
17 |     /**
18 |      * The service is provided at a customer location.
19 |      */
20 |     public const CUSTOMER_LOCATION = 'CUSTOMER_LOCATION';
21 | 
22 |     /**
23 |      * The service is provided over the phone.
24 |      */
25 |     public const PHONE = 'PHONE';
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Legacy/Http/HttpContext.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Http;
 6 | 
 7 | use Core\Types\Sdk\CoreContext;
 8 | 
 9 | /**
10 |  * Represents an HTTP call in context
11 |  */
12 | class HttpContext extends CoreContext
13 | {
14 |     /**
15 |      * Returns the HTTP Request
16 |      *
17 |      * @return HttpRequest request
18 |      */
19 |     public function getRequest(): HttpRequest
20 |     {
21 |         return $this->request;
22 |     }
23 | 
24 |     /**
25 |      * Returns the HTTP Response
26 |      *
27 |      * @return HttpResponse response
28 |      */
29 |     public function getResponse(): HttpResponse
30 |     {
31 |         return $this->response;
32 |     }
33 | }
34 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/LocationCapability.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The capabilities a location might have.
 9 |  */
10 | class LocationCapability
11 | {
12 |     /**
13 |      * The capability to process credit card transactions with Square.
14 |      */
15 |     public const CREDIT_CARD_PROCESSING = 'CREDIT_CARD_PROCESSING';
16 | 
17 |     /**
18 |      * The capability to receive automatic transfers from Square.
19 |      */
20 |     public const AUTOMATIC_TRANSFERS = 'AUTOMATIC_TRANSFERS';
21 | 
22 |     /**
23 |      * The capability to process unlinked refunds with Square.
24 |      */
25 |     public const UNLINKED_REFUNDS = 'UNLINKED_REFUNDS';
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/RiskEvaluationRiskLevel.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | class RiskEvaluationRiskLevel
 8 | {
 9 |     /**
10 |      * Indicates Square is still evaluating the payment.
11 |      */
12 |     public const PENDING = 'PENDING';
13 | 
14 |     /**
15 |      * Indicates payment risk is within the normal range.
16 |      */
17 |     public const NORMAL = 'NORMAL';
18 | 
19 |     /**
20 |      * Indicates elevated risk level associated with the payment.
21 |      */
22 |     public const MODERATE = 'MODERATE';
23 | 
24 |     /**
25 |      * Indicates significantly elevated risk level with the payment.
26 |      */
27 |     public const HIGH = 'HIGH';
28 | }
29 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/ShiftSortField.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Enumerates the `Shift` fields to sort on.
 9 |  */
10 | class ShiftSortField
11 | {
12 |     /**
13 |      * The start date/time of a `Shift`
14 |      */
15 |     public const START_AT = 'START_AT';
16 | 
17 |     /**
18 |      * The end date/time of a `Shift`
19 |      */
20 |     public const END_AT = 'END_AT';
21 | 
22 |     /**
23 |      * The date/time that a `Shift` is created
24 |      */
25 |     public const CREATED_AT = 'CREATED_AT';
26 | 
27 |     /**
28 |      * The most recent date/time that a `Shift` is updated
29 |      */
30 |     public const UPDATED_AT = 'UPDATED_AT';
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/TeamMemberInvitationStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Enumerates the possible invitation statuses the team member can have within a business.
 9 |  */
10 | class TeamMemberInvitationStatus
11 | {
12 |     /**
13 |      * The team member has not received an invitation.
14 |      */
15 |     public const UNINVITED = 'UNINVITED';
16 | 
17 |     /**
18 |      * The team member has received an invitation, but had not accepted it.
19 |      */
20 |     public const PENDING = 'PENDING';
21 | 
22 |     /**
23 |      * The team member has both received and accepted an invitation.
24 |      */
25 |     public const ACCEPTED = 'ACCEPTED';
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Standard dietary preferences for food and beverage items that are recommended on item creation.
 9 |  */
10 | class CatalogItemFoodAndBeverageDetailsDietaryPreferenceStandardDietaryPreference
11 | {
12 |     public const DAIRY_FREE = 'DAIRY_FREE';
13 | 
14 |     public const GLUTEN_FREE = 'GLUTEN_FREE';
15 | 
16 |     public const HALAL = 'HALAL';
17 | 
18 |     public const KOSHER = 'KOSHER';
19 | 
20 |     public const NUT_FREE = 'NUT_FREE';
21 | 
22 |     public const VEGAN = 'VEGAN';
23 | 
24 |     public const VEGETARIAN = 'VEGETARIAN';
25 | }
26 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/BusinessAppointmentSettingsCancellationPolicy.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The category of the seller’s cancellation policy.
 9 |  */
10 | class BusinessAppointmentSettingsCancellationPolicy
11 | {
12 |     /**
13 |      * Cancellations are treated as no shows and may incur a fee as specified by `cancellation_fee_money`.
14 |      */
15 |     public const CANCELLATION_TREATED_AS_NO_SHOW = 'CANCELLATION_TREATED_AS_NO_SHOW';
16 | 
17 |     /**
18 |      * Cancellations follow the seller-specified policy that is described in free-form text and not
19 |      * enforced automatically by Square.
20 |      */
21 |     public const CUSTOM_POLICY = 'CUSTOM_POLICY';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/DestinationType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * List of possible destinations against which a payout can be made.
 9 |  */
10 | class DestinationType
11 | {
12 |     /**
13 |      * An external bank account outside of Square.
14 |      */
15 |     public const BANK_ACCOUNT = 'BANK_ACCOUNT';
16 | 
17 |     /**
18 |      * An external card outside of Square used for the transfer.
19 |      */
20 |     public const CARD = 'CARD';
21 | 
22 |     public const SQUARE_BALANCE = 'SQUARE_BALANCE';
23 | 
24 |     /**
25 |      * Square Checking or Savings account (US), Square Card (CA)
26 |      */
27 |     public const SQUARE_STORED_BALANCE = 'SQUARE_STORED_BALANCE';
28 | }
29 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/InventoryChangeType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates how the inventory change was applied to a tracked product quantity.
 9 |  */
10 | class InventoryChangeType
11 | {
12 |     /**
13 |      * The change occurred as part of a physical count update.
14 |      */
15 |     public const PHYSICAL_COUNT = 'PHYSICAL_COUNT';
16 | 
17 |     /**
18 |      * The change occurred as part of the normal lifecycle of goods
19 |      * (e.g., as an inventory adjustment).
20 |      */
21 |     public const ADJUSTMENT = 'ADJUSTMENT';
22 | 
23 |     /**
24 |      * The change occurred as part of an inventory transfer.
25 |      */
26 |     public const TRANSFER = 'TRANSFER';
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/DeviceCodeStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * DeviceCode.Status enum.
 9 |  */
10 | class DeviceCodeStatus
11 | {
12 |     /**
13 |      * The status cannot be determined or does not exist.
14 |      */
15 |     public const UNKNOWN = 'UNKNOWN';
16 | 
17 |     /**
18 |      * The device code is just created and unpaired.
19 |      */
20 |     public const UNPAIRED = 'UNPAIRED';
21 | 
22 |     /**
23 |      * The device code has been signed in and paired to a device.
24 |      */
25 |     public const PAIRED = 'PAIRED';
26 | 
27 |     /**
28 |      * The device code was unpaired and expired before it was paired.
29 |      */
30 |     public const EXPIRED = 'EXPIRED';
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/GiftCardActivityAdjustIncrementReason.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates the reason for adding money to a [gift card]($m/GiftCard).
 9 |  */
10 | class GiftCardActivityAdjustIncrementReason
11 | {
12 |     /**
13 |      * The seller gifted a complimentary gift card balance increase.
14 |      */
15 |     public const COMPLIMENTARY = 'COMPLIMENTARY';
16 | 
17 |     /**
18 |      * The seller increased the gift card balance
19 |      * to accommodate support issues.
20 |      */
21 |     public const SUPPORT_ISSUE = 'SUPPORT_ISSUE';
22 | 
23 |     /**
24 |      * The transaction is voided.
25 |      */
26 |     public const TRANSACTION_VOIDED = 'TRANSACTION_VOIDED';
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/DeviceComponentDetailsExternalPower.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * An enum for ExternalPower.
 9 |  */
10 | class DeviceComponentDetailsExternalPower
11 | {
12 |     /**
13 |      * Plugged in and charging.
14 |      */
15 |     public const AVAILABLE_CHARGING = 'AVAILABLE_CHARGING';
16 | 
17 |     /**
18 |      * Fully charged.
19 |      */
20 |     public const AVAILABLE_NOT_IN_USE = 'AVAILABLE_NOT_IN_USE';
21 | 
22 |     /**
23 |      * On battery power.
24 |      */
25 |     public const UNAVAILABLE = 'UNAVAILABLE';
26 | 
27 |     /**
28 |      * Not providing enough power for the device.
29 |      */
30 |     public const AVAILABLE_INSUFFICIENT = 'AVAILABLE_INSUFFICIENT';
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Types/GiftCardActivityType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum GiftCardActivityType: string
 6 | {
 7 |     case Activate = "ACTIVATE";
 8 |     case Load = "LOAD";
 9 |     case Redeem = "REDEEM";
10 |     case ClearBalance = "CLEAR_BALANCE";
11 |     case Deactivate = "DEACTIVATE";
12 |     case AdjustIncrement = "ADJUST_INCREMENT";
13 |     case AdjustDecrement = "ADJUST_DECREMENT";
14 |     case Refund = "REFUND";
15 |     case UnlinkedActivityRefund = "UNLINKED_ACTIVITY_REFUND";
16 |     case Import = "IMPORT";
17 |     case Block = "BLOCK";
18 |     case Unblock = "UNBLOCK";
19 |     case ImportReversal = "IMPORT_REVERSAL";
20 |     case TransferBalanceFrom = "TRANSFER_BALANCE_FROM";
21 |     case TransferBalanceTo = "TRANSFER_BALANCE_TO";
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/GiftCardGANSource.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates the source that generated the gift card
 9 |  * account number (GAN).
10 |  */
11 | class GiftCardGANSource
12 | {
13 |     /**
14 |      * The GAN is generated by Square.
15 |      */
16 |     public const SQUARE = 'SQUARE';
17 | 
18 |     /**
19 |      * The GAN is provided by a non-Square system. For more information, see
20 |      * [Custom GANs](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#custom-gans) or
21 |      * [Third-party gift cards](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#third-
22 |      * party-gift-cards).
23 |      */
24 |     public const OTHER = 'OTHER';
25 | }
26 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/LoyaltyProgramAccrualRuleTaxMode.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates how taxes should be treated when calculating the purchase amount used for loyalty points
 9 |  * accrual.
10 |  * This setting applies only to `SPEND` accrual rules or `VISIT` accrual rules that have a minimum
11 |  * spend requirement.
12 |  */
13 | class LoyaltyProgramAccrualRuleTaxMode
14 | {
15 |     /**
16 |      * Exclude taxes from the purchase amount used for loyalty points accrual.
17 |      */
18 |     public const BEFORE_TAX = 'BEFORE_TAX';
19 | 
20 |     /**
21 |      * Include taxes in the purchase amount used for loyalty points accrual.
22 |      */
23 |     public const AFTER_TAX = 'AFTER_TAX';
24 | }
25 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/Weekday.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The days of the week.
 9 |  */
10 | class Weekday
11 | {
12 |     /**
13 |      * Monday
14 |      */
15 |     public const MON = 'MON';
16 | 
17 |     /**
18 |      * Tuesday
19 |      */
20 |     public const TUE = 'TUE';
21 | 
22 |     /**
23 |      * Wednesday
24 |      */
25 |     public const WED = 'WED';
26 | 
27 |     /**
28 |      * Thursday
29 |      */
30 |     public const THU = 'THU';
31 | 
32 |     /**
33 |      * Friday
34 |      */
35 |     public const FRI = 'FRI';
36 | 
37 |     /**
38 |      * Saturday
39 |      */
40 |     public const SAT = 'SAT';
41 | 
42 |     /**
43 |      * Sunday
44 |      */
45 |     public const SUN = 'SUN';
46 | }
47 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/OrderLineItemTaxScope.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates whether this is a line-item or order-level tax.
 9 |  */
10 | class OrderLineItemTaxScope
11 | {
12 |     /**
13 |      * Used for reporting only.
14 |      * The original transaction tax scope is currently not supported by the API.
15 |      */
16 |     public const OTHER_TAX_SCOPE = 'OTHER_TAX_SCOPE';
17 | 
18 |     /**
19 |      * The tax should be applied only to line items specified by
20 |      * the `OrderLineItemAppliedTax` reference records.
21 |      */
22 |     public const LINE_ITEM = 'LINE_ITEM';
23 | 
24 |     /**
25 |      * The tax should be applied to the entire order.
26 |      */
27 |     public const ORDER = 'ORDER';
28 | }
29 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/OrderLineItemItemType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Represents the line item type.
 9 |  */
10 | class OrderLineItemItemType
11 | {
12 |     /**
13 |      * Indicates that the line item is an itemized sale.
14 |      */
15 |     public const ITEM = 'ITEM';
16 | 
17 |     /**
18 |      * Indicates that the line item is a non-itemized sale.
19 |      */
20 |     public const CUSTOM_AMOUNT = 'CUSTOM_AMOUNT';
21 | 
22 |     /**
23 |      * Indicates that the line item is a gift card sale. Gift cards sold through
24 |      * the Orders API are sold in an unactivated state and can be activated through the
25 |      * Gift Cards API using the line item `uid`.
26 |      */
27 |     public const GIFT_CARD = 'GIFT_CARD';
28 | }
29 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/TenderSquareAccountDetailsStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | class TenderSquareAccountDetailsStatus
 8 | {
 9 |     /**
10 |      * The Square Account payment has been authorized but not yet captured.
11 |      */
12 |     public const AUTHORIZED = 'AUTHORIZED';
13 | 
14 |     /**
15 |      * The Square Account payment was authorized and subsequently captured (i.e., completed).
16 |      */
17 |     public const CAPTURED = 'CAPTURED';
18 | 
19 |     /**
20 |      * The Square Account payment was authorized and subsequently voided (i.e., canceled).
21 |      */
22 |     public const VOIDED = 'VOIDED';
23 | 
24 |     /**
25 |      * The Square Account payment failed.
26 |      */
27 |     public const FAILED = 'FAILED';
28 | }
29 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/DayOfWeek.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates the specific day  of the week.
 9 |  */
10 | class DayOfWeek
11 | {
12 |     /**
13 |      * Sunday
14 |      */
15 |     public const SUN = 'SUN';
16 | 
17 |     /**
18 |      * Monday
19 |      */
20 |     public const MON = 'MON';
21 | 
22 |     /**
23 |      * Tuesday
24 |      */
25 |     public const TUE = 'TUE';
26 | 
27 |     /**
28 |      * Wednesday
29 |      */
30 |     public const WED = 'WED';
31 | 
32 |     /**
33 |      * Thursday
34 |      */
35 |     public const THU = 'THU';
36 | 
37 |     /**
38 |      * Friday
39 |      */
40 |     public const FRI = 'FRI';
41 | 
42 |     /**
43 |      * Saturday
44 |      */
45 |     public const SAT = 'SAT';
46 | }
47 | 


--------------------------------------------------------------------------------
/src/Types/InventoryState.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum InventoryState: string
 6 | {
 7 |     case Custom = "CUSTOM";
 8 |     case InStock = "IN_STOCK";
 9 |     case Sold = "SOLD";
10 |     case ReturnedByCustomer = "RETURNED_BY_CUSTOMER";
11 |     case ReservedForSale = "RESERVED_FOR_SALE";
12 |     case SoldOnline = "SOLD_ONLINE";
13 |     case OrderedFromVendor = "ORDERED_FROM_VENDOR";
14 |     case ReceivedFromVendor = "RECEIVED_FROM_VENDOR";
15 |     case InTransitTo = "IN_TRANSIT_TO";
16 |     case None = "NONE";
17 |     case Waste = "WASTE";
18 |     case UnlinkedReturn = "UNLINKED_RETURN";
19 |     case Composed = "COMPOSED";
20 |     case Decomposed = "DECOMPOSED";
21 |     case SupportedByNewerVersion = "SUPPORTED_BY_NEWER_VERSION";
22 |     case InTransit = "IN_TRANSIT";
23 | }
24 | 


--------------------------------------------------------------------------------
/src/Types/ReferenceType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum ReferenceType: string
 6 | {
 7 |     case UnknownType = "UNKNOWN_TYPE";
 8 |     case Location = "LOCATION";
 9 |     case FirstPartyIntegration = "FIRST_PARTY_INTEGRATION";
10 |     case OauthApplication = "OAUTH_APPLICATION";
11 |     case OnlineSite = "ONLINE_SITE";
12 |     case OnlineCheckout = "ONLINE_CHECKOUT";
13 |     case Invoice = "INVOICE";
14 |     case GiftCard = "GIFT_CARD";
15 |     case GiftCardMarketplace = "GIFT_CARD_MARKETPLACE";
16 |     case RecurringSubscription = "RECURRING_SUBSCRIPTION";
17 |     case OnlineBookingFlow = "ONLINE_BOOKING_FLOW";
18 |     case SquareAssistant = "SQUARE_ASSISTANT";
19 |     case CashLocal = "CASH_LOCAL";
20 |     case PointOfSale = "POINT_OF_SALE";
21 |     case Kiosk = "KIOSK";
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/LoyaltyProgramRewardDefinitionType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The type of discount the reward tier offers. DEPRECATED at version 2020-12-16. Discount details
 9 |  * are now defined using a catalog pricing rule and other catalog objects. For more information, see
10 |  * [Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-
11 |  * rewards#get-discount-details).
12 |  */
13 | class LoyaltyProgramRewardDefinitionType
14 | {
15 |     /**
16 |      * The fixed amount discounted.
17 |      */
18 |     public const FIXED_AMOUNT = 'FIXED_AMOUNT';
19 | 
20 |     /**
21 |      * The fixed percentage discounted.
22 |      */
23 |     public const FIXED_PERCENTAGE = 'FIXED_PERCENTAGE';
24 | }
25 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/SubscriptionStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Supported subscription statuses.
 9 |  */
10 | class SubscriptionStatus
11 | {
12 |     /**
13 |      * The subscription is pending to start in the future.
14 |      */
15 |     public const PENDING = 'PENDING';
16 | 
17 |     /**
18 |      * The subscription is active.
19 |      */
20 |     public const ACTIVE = 'ACTIVE';
21 | 
22 |     /**
23 |      * The subscription is canceled.
24 |      */
25 |     public const CANCELED = 'CANCELED';
26 | 
27 |     /**
28 |      * The subscription is deactivated.
29 |      */
30 |     public const DEACTIVATED = 'DEACTIVATED';
31 | 
32 |     /**
33 |      * The subscription is paused.
34 |      */
35 |     public const PAUSED = 'PAUSED';
36 | }
37 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/TenderBuyNowPayLaterDetailsStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | class TenderBuyNowPayLaterDetailsStatus
 8 | {
 9 |     /**
10 |      * The buy now pay later payment has been authorized but not yet captured.
11 |      */
12 |     public const AUTHORIZED = 'AUTHORIZED';
13 | 
14 |     /**
15 |      * The buy now pay later payment was authorized and subsequently captured (i.e., completed).
16 |      */
17 |     public const CAPTURED = 'CAPTURED';
18 | 
19 |     /**
20 |      * The buy now pay later payment was authorized and subsequently voided (i.e., canceled).
21 |      */
22 |     public const VOIDED = 'VOIDED';
23 | 
24 |     /**
25 |      * The buy now pay later payment failed.
26 |      */
27 |     public const FAILED = 'FAILED';
28 | }
29 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/ApplicationDetailsExternalSquareProduct.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * A list of products to return to external callers.
 9 |  */
10 | class ApplicationDetailsExternalSquareProduct
11 | {
12 |     public const APPOINTMENTS = 'APPOINTMENTS';
13 | 
14 |     public const ECOMMERCE_API = 'ECOMMERCE_API';
15 | 
16 |     public const INVOICES = 'INVOICES';
17 | 
18 |     public const ONLINE_STORE = 'ONLINE_STORE';
19 | 
20 |     public const OTHER = 'OTHER';
21 | 
22 |     public const RESTAURANTS = 'RESTAURANTS';
23 | 
24 |     public const RETAIL = 'RETAIL';
25 | 
26 |     public const SQUARE_POS = 'SQUARE_POS';
27 | 
28 |     public const TERMINAL_API = 'TERMINAL_API';
29 | 
30 |     public const VIRTUAL_TERMINAL = 'VIRTUAL_TERMINAL';
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/LoyaltyPromotionIncentiveType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates the type of points incentive for a [loyalty promotion]($m/LoyaltyPromotion),
 9 |  * which is used to determine how buyers can earn points from the promotion.
10 |  */
11 | class LoyaltyPromotionIncentiveType
12 | {
13 |     /**
14 |      * Multiply the number of points earned from the base loyalty program.
15 |      * For example, "Earn double points."
16 |      */
17 |     public const POINTS_MULTIPLIER = 'POINTS_MULTIPLIER';
18 | 
19 |     /**
20 |      * Add a specified number of points to those earned from the base loyalty program.
21 |      * For example, "Earn 10 additional points."
22 |      */
23 |     public const POINTS_ADDITION = 'POINTS_ADDITION';
24 | }
25 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CatalogCustomAttributeDefinitionType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Defines the possible types for a custom attribute.
 9 |  */
10 | class CatalogCustomAttributeDefinitionType
11 | {
12 |     /**
13 |      * A free-form string containing up to 255 characters.
14 |      */
15 |     public const STRING = 'STRING';
16 | 
17 |     /**
18 |      * A `true` or `false` value.
19 |      */
20 |     public const BOOLEAN = 'BOOLEAN';
21 | 
22 |     /**
23 |      * A decimal string representation of a number. Can support up to 5 digits after the decimal point.
24 |      */
25 |     public const NUMBER = 'NUMBER';
26 | 
27 |     /**
28 |      * One or more choices from `allowed_selections`.
29 |      */
30 |     public const SELECTION = 'SELECTION';
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/OrderLineItemDiscountScope.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates whether this is a line-item or order-level discount.
 9 |  */
10 | class OrderLineItemDiscountScope
11 | {
12 |     /**
13 |      * Used for reporting only.
14 |      * The original transaction discount scope is currently not supported by the API.
15 |      */
16 |     public const OTHER_DISCOUNT_SCOPE = 'OTHER_DISCOUNT_SCOPE';
17 | 
18 |     /**
19 |      * The discount should be applied to only line items specified by
20 |      * `OrderLineItemAppliedDiscount` reference records.
21 |      */
22 |     public const LINE_ITEM = 'LINE_ITEM';
23 | 
24 |     /**
25 |      * The discount should be applied to the entire order.
26 |      */
27 |     public const ORDER = 'ORDER';
28 | }
29 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/PayoutType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * The type of payout: “BATCH” or “SIMPLE”.
 9 |  * BATCH payouts include a list of payout entries that can be considered settled.
10 |  * SIMPLE payouts do not have any payout entries associated with them
11 |  * and will show up as one of the payout entries in a future BATCH payout.
12 |  */
13 | class PayoutType
14 | {
15 |     /**
16 |      * Payouts that include a list of payout entries that can be considered settled.
17 |      */
18 |     public const BATCH = 'BATCH';
19 | 
20 |     /**
21 |      * Payouts that do not have any payout entries associated with them and will
22 |      * show up as one of the payout entries in a future BATCH payout.
23 |      */
24 |     public const SIMPLE = 'SIMPLE';
25 | }
26 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/TenderCardDetailsStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates the card transaction's current status.
 9 |  */
10 | class TenderCardDetailsStatus
11 | {
12 |     /**
13 |      * The card transaction has been authorized but not yet captured.
14 |      */
15 |     public const AUTHORIZED = 'AUTHORIZED';
16 | 
17 |     /**
18 |      * The card transaction was authorized and subsequently captured (i.e., completed).
19 |      */
20 |     public const CAPTURED = 'CAPTURED';
21 | 
22 |     /**
23 |      * The card transaction was authorized and subsequently voided (i.e., canceled).
24 |      */
25 |     public const VOIDED = 'VOIDED';
26 | 
27 |     /**
28 |      * The card transaction failed.
29 |      */
30 |     public const FAILED = 'FAILED';
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Core/Client/BaseApiRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Core\Client;
 4 | 
 5 | abstract class BaseApiRequest
 6 | {
 7 |     /**
 8 |      * @param string $baseUrl The base URL for the request
 9 |      * @param string $path The path for the request
10 |      * @param HttpMethod $method The HTTP method for the request
11 |      * @param array<string, string> $headers Additional headers for the request (optional)
12 |      * @param array<string, mixed> $query Query parameters for the request (optional)
13 |      */
14 |     public function __construct(
15 |         public readonly string      $baseUrl,
16 |         public readonly string      $path,
17 |         public readonly HttpMethod  $method,
18 |         public readonly array       $headers = [],
19 |         public readonly array       $query = [],
20 |     ) {
21 |     }
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/TeamMemberAssignedLocationsAssignmentType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Enumerates the possible assignment types that the team member can have.
 9 |  */
10 | class TeamMemberAssignedLocationsAssignmentType
11 | {
12 |     /**
13 |      * The team member is assigned to all current and future locations. The `location_ids` field
14 |      * is empty if the team member has this assignment type.
15 |      */
16 |     public const ALL_CURRENT_AND_FUTURE_LOCATIONS = 'ALL_CURRENT_AND_FUTURE_LOCATIONS';
17 | 
18 |     /**
19 |      * The team member is assigned to an explicit subset of locations. The `location_ids` field
20 |      * is the list of locations that the team member is assigned to.
21 |      */
22 |     public const EXPLICIT_LOCATIONS = 'EXPLICIT_LOCATIONS';
23 | }
24 | 


--------------------------------------------------------------------------------
/tests/Integration/LocationsTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Tests\Integration;
 4 | 
 5 | use PHPUnit\Framework\TestCase;
 6 | use Square\Exceptions\SquareApiException;
 7 | use Square\Exceptions\SquareException;
 8 | use Square\SquareClient;
 9 | 
10 | class LocationsTest extends TestCase
11 | {
12 |     private static SquareClient $client;
13 | 
14 |     public static function setUpBeforeClass(): void
15 |     {
16 |         self::$client = Helpers::createClient();
17 |     }
18 | 
19 |     /**
20 |      * @throws SquareException
21 |      * @throws SquareApiException
22 |      */
23 |     public function testListLocations() : void
24 |     {
25 |         $response = self::$client->locations->list();
26 | 
27 |         $this->assertNotNull($response->getLocations());
28 |         $this->assertGreaterThan(0, count($response->getLocations()));
29 |     }
30 | }
31 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CustomerSortField.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Specifies customer attributes as the sort key to customer profiles returned from a search.
 9 |  */
10 | class CustomerSortField
11 | {
12 |     /**
13 |      * Use the default sort key. By default, customers are sorted
14 |      * alphanumerically by concatenating their `given_name` and `family_name`. If
15 |      * neither name field is set, string comparison is performed using one of the
16 |      * remaining fields in the following order: `company_name`, `email`,
17 |      * `phone_number`.
18 |      */
19 |     public const DEFAULT_ = 'DEFAULT';
20 | 
21 |     /**
22 |      * Use the creation date attribute (`created_at`) of customer profiles as the sort key.
23 |      */
24 |     public const CREATED_AT = 'CREATED_AT';
25 | }
26 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/OrderServiceChargeScope.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates whether this is a line-item or order-level apportioned
 9 |  * service charge.
10 |  */
11 | class OrderServiceChargeScope
12 | {
13 |     /**
14 |      * Used for reporting only.
15 |      * The original transaction service charge scope is currently not supported by the API.
16 |      */
17 |     public const OTHER_SERVICE_CHARGE_SCOPE = 'OTHER_SERVICE_CHARGE_SCOPE';
18 | 
19 |     /**
20 |      * The service charge should be applied to only line items specified by
21 |      * `OrderLineItemAppliedServiceCharge` reference records.
22 |      */
23 |     public const LINE_ITEM = 'LINE_ITEM';
24 | 
25 |     /**
26 |      * The service charge should be applied to the entire order.
27 |      */
28 |     public const ORDER = 'ORDER';
29 | }
30 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/EcomVisibility.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Determines item visibility in Ecom (Online Store) and Online Checkout.
 9 |  */
10 | class EcomVisibility
11 | {
12 |     /**
13 |      * Item is not synced with Ecom (Weebly). This is the default state
14 |      */
15 |     public const UNINDEXED = 'UNINDEXED';
16 | 
17 |     /**
18 |      * Item is synced but is unavailable within Ecom (Weebly) and Online Checkout
19 |      */
20 |     public const UNAVAILABLE = 'UNAVAILABLE';
21 | 
22 |     /**
23 |      * Option for seller to choose manually created Quick Amounts.
24 |      */
25 |     public const HIDDEN = 'HIDDEN';
26 | 
27 |     /**
28 |      * Item is synced but available within Ecom (Weebly) and Online Checkout but is hidden from Ecom Store.
29 |      */
30 |     public const VISIBLE = 'VISIBLE';
31 | }
32 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/MeasurementUnitTime.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Unit of time used to measure a quantity (a duration).
 9 |  */
10 | class MeasurementUnitTime
11 | {
12 |     /**
13 |      * The time is measured in milliseconds.
14 |      */
15 |     public const GENERIC_MILLISECOND = 'GENERIC_MILLISECOND';
16 | 
17 |     /**
18 |      * The time is measured in seconds.
19 |      */
20 |     public const GENERIC_SECOND = 'GENERIC_SECOND';
21 | 
22 |     /**
23 |      * The time is measured in minutes.
24 |      */
25 |     public const GENERIC_MINUTE = 'GENERIC_MINUTE';
26 | 
27 |     /**
28 |      * The time is measured in hours.
29 |      */
30 |     public const GENERIC_HOUR = 'GENERIC_HOUR';
31 | 
32 |     /**
33 |      * The time is measured in days.
34 |      */
35 |     public const GENERIC_DAY = 'GENERIC_DAY';
36 | }
37 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/VisibilityFilter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Enumeration of visibility-filter values used to set the ability to view custom attributes or custom
 9 |  * attribute definitions.
10 |  */
11 | class VisibilityFilter
12 | {
13 |     /**
14 |      * All custom attributes or custom attribute definitions.
15 |      */
16 |     public const ALL = 'ALL';
17 | 
18 |     /**
19 |      * All custom attributes or custom attribute definitions with the `visibility` field set to
20 |      * `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
21 |      */
22 |     public const READ = 'READ';
23 | 
24 |     /**
25 |      * All custom attributes or custom attribute definitions with the `visibility` field set to
26 |      * `VISIBILITY_READ_WRITE_VALUES`.
27 |      */
28 |     public const READ_WRITE = 'READ_WRITE';
29 | }
30 | 


--------------------------------------------------------------------------------
/src/Types/CustomerCreationSource.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CustomerCreationSource: string
 6 | {
 7 |     case Other = "OTHER";
 8 |     case Appointments = "APPOINTMENTS";
 9 |     case Coupon = "COUPON";
10 |     case DeletionRecovery = "DELETION_RECOVERY";
11 |     case Directory = "DIRECTORY";
12 |     case Egifting = "EGIFTING";
13 |     case EmailCollection = "EMAIL_COLLECTION";
14 |     case Feedback = "FEEDBACK";
15 |     case Import = "IMPORT";
16 |     case Invoices = "INVOICES";
17 |     case Loyalty = "LOYALTY";
18 |     case Marketing = "MARKETING";
19 |     case Merge = "MERGE";
20 |     case OnlineStore = "ONLINE_STORE";
21 |     case InstantProfile = "INSTANT_PROFILE";
22 |     case Terminal = "TERMINAL";
23 |     case ThirdParty = "THIRD_PARTY";
24 |     case ThirdPartyImport = "THIRD_PARTY_IMPORT";
25 |     case UnmergeRecovery = "UNMERGE_RECOVERY";
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/GiftCardActivityClearBalanceReason.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates the reason for clearing the balance of a [gift card]($m/GiftCard).
 9 |  */
10 | class GiftCardActivityClearBalanceReason
11 | {
12 |     /**
13 |      * The seller suspects suspicious activity.
14 |      */
15 |     public const SUSPICIOUS_ACTIVITY = 'SUSPICIOUS_ACTIVITY';
16 | 
17 |     /**
18 |      * The seller cleared the balance to reuse the gift card.
19 |      */
20 |     public const REUSE_GIFTCARD = 'REUSE_GIFTCARD';
21 | 
22 |     /**
23 |      * The gift card balance was cleared for an unknown reason.
24 |      *
25 |      * This reason is read-only and cannot be used to create a `CLEAR_BALANCE` activity using the Gift Card
26 |      * Activities API.
27 |      */
28 |     public const UNKNOWN_REASON = 'UNKNOWN_REASON';
29 | }
30 | 


--------------------------------------------------------------------------------
/src/GiftCards/Requests/GetGiftCardsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\GiftCards\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetGiftCardsRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $id The ID of the gift card to retrieve.
11 |      */
12 |     private string $id;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   id: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->id = $values['id'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getId(): string
29 |     {
30 |         return $this->id;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setId(string $value): self
37 |     {
38 |         $this->id = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Employees/Requests/GetEmployeesRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Employees\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetEmployeesRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $id UUID for the employee that was requested.
11 |      */
12 |     private string $id;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   id: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->id = $values['id'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getId(): string
29 |     {
30 |         return $this->id;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setId(string $value): self
37 |     {
38 |         $this->id = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Labor/Requests/DeleteTimecardRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Labor\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class DeleteTimecardRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $id The UUID for the `Timecard` being deleted.
11 |      */
12 |     private string $id;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   id: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->id = $values['id'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getId(): string
29 |     {
30 |         return $this->id;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setId(string $value): self
37 |     {
38 |         $this->id = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Labor/Shifts/Requests/GetShiftsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Labor\Shifts\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetShiftsRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $id The UUID for the `Shift` being retrieved.
11 |      */
12 |     private string $id;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   id: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->id = $values['id'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getId(): string
29 |     {
30 |         return $this->id;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setId(string $value): self
37 |     {
38 |         $this->id = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Devices/Codes/Requests/GetCodesRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Devices\Codes\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetCodesRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $id The unique identifier for the device code.
11 |      */
12 |     private string $id;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   id: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->id = $values['id'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getId(): string
29 |     {
30 |         return $this->id;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setId(string $value): self
37 |     {
38 |         $this->id = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Labor/Requests/RetrieveTimecardRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Labor\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class RetrieveTimecardRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $id The UUID for the `Timecard` being retrieved.
11 |      */
12 |     private string $id;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   id: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->id = $values['id'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getId(): string
29 |     {
30 |         return $this->id;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setId(string $value): self
37 |     {
38 |         $this->id = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Labor/Shifts/Requests/DeleteShiftsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Labor\Shifts\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class DeleteShiftsRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $id The UUID for the `Shift` being deleted.
11 |      */
12 |     private string $id;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   id: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->id = $values['id'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getId(): string
29 |     {
30 |         return $this->id;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setId(string $value): self
37 |     {
38 |         $this->id = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Team/Requests/RetrieveJobRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Team\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class RetrieveJobRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $jobId The ID of the job to retrieve.
11 |      */
12 |     private string $jobId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   jobId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->jobId = $values['jobId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getJobId(): string
29 |     {
30 |         return $this->jobId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setJobId(string $value): self
37 |     {
38 |         $this->jobId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Cards/Requests/GetCardsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Cards\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetCardsRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $cardId Unique ID for the desired Card.
11 |      */
12 |     private string $cardId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   cardId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->cardId = $values['cardId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getCardId(): string
29 |     {
30 |         return $this->cardId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setCardId(string $value): self
37 |     {
38 |         $this->cardId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/ArchivedState.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Defines the values for the `archived_state` query expression
 9 |  * used in [SearchCatalogItems]($e/Catalog/SearchCatalogItems)
10 |  * to return the archived, not archived or either type of catalog items.
11 |  */
12 | class ArchivedState
13 | {
14 |     /**
15 |      * Requested items are not archived with the `is_archived` attribute set to `false`.
16 |      */
17 |     public const ARCHIVED_STATE_NOT_ARCHIVED = 'ARCHIVED_STATE_NOT_ARCHIVED';
18 | 
19 |     /**
20 |      * Requested items are archived with the `is_archived` attribute set to `true`.
21 |      */
22 |     public const ARCHIVED_STATE_ARCHIVED = 'ARCHIVED_STATE_ARCHIVED';
23 | 
24 |     /**
25 |      * Requested items can be archived or not archived.
26 |      */
27 |     public const ARCHIVED_STATE_ALL = 'ARCHIVED_STATE_ALL';
28 | }
29 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CatalogCustomAttributeDefinitionSellerVisibility.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Defines the visibility of a custom attribute to sellers in Square
 9 |  * client applications, Square APIs or in Square UIs (including Square Point
10 |  * of Sale applications and Square Dashboard).
11 |  */
12 | class CatalogCustomAttributeDefinitionSellerVisibility
13 | {
14 |     /**
15 |      * Sellers cannot read this custom attribute in Square client
16 |      * applications or Square APIs.
17 |      */
18 |     public const SELLER_VISIBILITY_HIDDEN = 'SELLER_VISIBILITY_HIDDEN';
19 | 
20 |     /**
21 |      * Sellers can read and write this custom attribute value in catalog objects,
22 |      * but cannot edit the custom attribute definition.
23 |      */
24 |     public const SELLER_VISIBILITY_READ_WRITE_VALUES = 'SELLER_VISIBILITY_READ_WRITE_VALUES';
25 | }
26 | 


--------------------------------------------------------------------------------
/src/Labor/Requests/RetrieveScheduledShiftRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Labor\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class RetrieveScheduledShiftRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $id The ID of the scheduled shift to retrieve.
11 |      */
12 |     private string $id;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   id: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->id = $values['id'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getId(): string
29 |     {
30 |         return $this->id;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setId(string $value): self
37 |     {
38 |         $this->id = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Cards/Requests/DisableCardsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Cards\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class DisableCardsRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $cardId Unique ID for the desired Card.
11 |      */
12 |     private string $cardId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   cardId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->cardId = $values['cardId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getCardId(): string
29 |     {
30 |         return $this->cardId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setCardId(string $value): self
37 |     {
38 |         $this->cardId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Checkout/PaymentLinks/Requests/GetPaymentLinksRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Checkout\PaymentLinks\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetPaymentLinksRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $id The ID of link to retrieve.
11 |      */
12 |     private string $id;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   id: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->id = $values['id'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getId(): string
29 |     {
30 |         return $this->id;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setId(string $value): self
37 |     {
38 |         $this->id = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Labor/BreakTypes/Requests/GetBreakTypesRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Labor\BreakTypes\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetBreakTypesRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $id The UUID for the `BreakType` being retrieved.
11 |      */
12 |     private string $id;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   id: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->id = $values['id'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getId(): string
29 |     {
30 |         return $this->id;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setId(string $value): self
37 |     {
38 |         $this->id = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/.fern/metadata.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "cliVersion": "2.8.1",
 3 |   "generatorName": "fernapi/fern-php-sdk",
 4 |   "generatorVersion": "1.22.3",
 5 |   "generatorConfig": {
 6 |     "clientName": "SquareClient",
 7 |     "namespace": "Square",
 8 |     "packageName": "square/square",
 9 |     "propertyAccess": "private",
10 |     "inlinePathParameters": true,
11 |     "composerJson": {
12 |       "description": "Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.",
13 |       "author": {
14 |         "name": "Square Developer Platform",
15 |         "url": "https://developer.squareup.com",
16 |         "email": "developers@squareup.com"
17 |       },
18 |       "homepage": "https://squareup.com/developers",
19 |       "require": {
20 |         "apimatic/unirest-php": "^4.0.0",
21 |         "apimatic/core-interfaces": "~0.1.5",
22 |         "apimatic/core": "~0.3.12"
23 |       }
24 |     }
25 |   }
26 | }


--------------------------------------------------------------------------------
/src/Labor/BreakTypes/Requests/DeleteBreakTypesRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Labor\BreakTypes\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class DeleteBreakTypesRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $id The UUID for the `BreakType` being deleted.
11 |      */
12 |     private string $id;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   id: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->id = $values['id'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getId(): string
29 |     {
30 |         return $this->id;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setId(string $value): self
37 |     {
38 |         $this->id = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Orders/Requests/GetOrdersRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Orders\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetOrdersRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $orderId The ID of the order to retrieve.
11 |      */
12 |     private string $orderId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   orderId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->orderId = $values['orderId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getOrderId(): string
29 |     {
30 |         return $this->orderId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setOrderId(string $value): self
37 |     {
38 |         $this->orderId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Channels/Requests/GetChannelsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Channels\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetChannelsRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $channelId A channel id
11 |      */
12 |     private string $channelId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   channelId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->channelId = $values['channelId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getChannelId(): string
29 |     {
30 |         return $this->channelId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setChannelId(string $value): self
37 |     {
38 |         $this->channelId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Checkout/PaymentLinks/Requests/DeletePaymentLinksRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Checkout\PaymentLinks\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class DeletePaymentLinksRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $id The ID of the payment link to delete.
11 |      */
12 |     private string $id;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   id: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->id = $values['id'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getId(): string
29 |     {
30 |         return $this->id;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setId(string $value): self
37 |     {
38 |         $this->id = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Labor/EmployeeWages/Requests/GetEmployeeWagesRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Labor\EmployeeWages\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetEmployeeWagesRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $id The UUID for the `EmployeeWage` being retrieved.
11 |      */
12 |     private string $id;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   id: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->id = $values['id'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getId(): string
29 |     {
30 |         return $this->id;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setId(string $value): self
37 |     {
38 |         $this->id = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Snippets/Requests/GetSnippetsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Snippets\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetSnippetsRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $siteId The ID of the site that contains the snippet.
11 |      */
12 |     private string $siteId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   siteId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->siteId = $values['siteId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getSiteId(): string
29 |     {
30 |         return $this->siteId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setSiteId(string $value): self
37 |     {
38 |         $this->siteId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Devices/Requests/GetDevicesRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Devices\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetDevicesRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $deviceId The unique ID for the desired `Device`.
11 |      */
12 |     private string $deviceId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   deviceId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->deviceId = $values['deviceId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getDeviceId(): string
29 |     {
30 |         return $this->deviceId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setDeviceId(string $value): self
37 |     {
38 |         $this->deviceId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Labor/TeamMemberWages/Requests/GetTeamMemberWagesRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Labor\TeamMemberWages\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetTeamMemberWagesRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $id The UUID for the `TeamMemberWage` being retrieved.
11 |      */
12 |     private string $id;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   id: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->id = $values['id'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getId(): string
29 |     {
30 |         return $this->id;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setId(string $value): self
37 |     {
38 |         $this->id = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Snippets/Requests/DeleteSnippetsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Snippets\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class DeleteSnippetsRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $siteId The ID of the site that contains the snippet.
11 |      */
12 |     private string $siteId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   siteId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->siteId = $values['siteId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getSiteId(): string
29 |     {
30 |         return $this->siteId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setSiteId(string $value): self
37 |     {
38 |         $this->siteId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/TaxInclusionType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Whether to the tax amount should be additional to or included in the CatalogItem price.
 9 |  */
10 | class TaxInclusionType
11 | {
12 |     /**
13 |      * The tax is an additive tax. The tax amount is added on top of the
14 |      * CatalogItemVariation price. For example, a $1.00 item with a 10% additive
15 |      * tax would have a total cost to the buyer of $1.10.
16 |      */
17 |     public const ADDITIVE = 'ADDITIVE';
18 | 
19 |     /**
20 |      * The tax is an inclusive tax. The tax amount is included in the
21 |      * CatalogItemVariation price. For example, a $1.00 item with a 10% inclusive
22 |      * tax would have a total cost to the buyer of $1.00, with $0.91 (91 cents) of
23 |      * that total being the cost of the item and $0.09 (9 cents) being tax.
24 |      */
25 |     public const INCLUSIVE = 'INCLUSIVE';
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Merchants/Requests/ListMerchantsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Merchants\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class ListMerchantsRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var ?int $cursor The cursor generated by the previous response.
11 |      */
12 |     private ?int $cursor;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   cursor?: ?int,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values = [],
21 |     ) {
22 |         $this->cursor = $values['cursor'] ?? null;
23 |     }
24 | 
25 |     /**
26 |      * @return ?int
27 |      */
28 |     public function getCursor(): ?int
29 |     {
30 |         return $this->cursor;
31 |     }
32 | 
33 |     /**
34 |      * @param ?int $value
35 |      */
36 |     public function setCursor(?int $value = null): self
37 |     {
38 |         $this->cursor = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Customers/Groups/Requests/GetGroupsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Customers\Groups\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetGroupsRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $groupId The ID of the customer group to retrieve.
11 |      */
12 |     private string $groupId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   groupId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->groupId = $values['groupId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getGroupId(): string
29 |     {
30 |         return $this->groupId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setGroupId(string $value): self
37 |     {
38 |         $this->groupId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Invoices/Requests/GetInvoicesRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Invoices\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetInvoicesRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $invoiceId The ID of the invoice to retrieve.
11 |      */
12 |     private string $invoiceId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   invoiceId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->invoiceId = $values['invoiceId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getInvoiceId(): string
29 |     {
30 |         return $this->invoiceId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setInvoiceId(string $value): self
37 |     {
38 |         $this->invoiceId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CardBrand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates a card's brand, such as `VISA` or `MASTERCARD`.
 9 |  */
10 | class CardBrand
11 | {
12 |     public const OTHER_BRAND = 'OTHER_BRAND';
13 | 
14 |     public const VISA = 'VISA';
15 | 
16 |     public const MASTERCARD = 'MASTERCARD';
17 | 
18 |     public const AMERICAN_EXPRESS = 'AMERICAN_EXPRESS';
19 | 
20 |     public const DISCOVER = 'DISCOVER';
21 | 
22 |     public const DISCOVER_DINERS = 'DISCOVER_DINERS';
23 | 
24 |     public const JCB = 'JCB';
25 | 
26 |     public const CHINA_UNIONPAY = 'CHINA_UNIONPAY';
27 | 
28 |     public const SQUARE_GIFT_CARD = 'SQUARE_GIFT_CARD';
29 | 
30 |     public const SQUARE_CAPITAL_CARD = 'SQUARE_CAPITAL_CARD';
31 | 
32 |     public const INTERAC = 'INTERAC';
33 | 
34 |     public const EFTPOS = 'EFTPOS';
35 | 
36 |     public const FELICA = 'FELICA';
37 | 
38 |     public const EBT = 'EBT';
39 | }
40 | 


--------------------------------------------------------------------------------
/src/Payments/Requests/GetPaymentsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Payments\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetPaymentsRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $paymentId A unique ID for the desired payment.
11 |      */
12 |     private string $paymentId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   paymentId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->paymentId = $values['paymentId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getPaymentId(): string
29 |     {
30 |         return $this->paymentId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setPaymentId(string $value): self
37 |     {
38 |         $this->paymentId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Refunds/Requests/GetRefundsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Refunds\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetRefundsRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $refundId The unique ID for the desired `PaymentRefund`.
11 |      */
12 |     private string $refundId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   refundId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->refundId = $values['refundId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getRefundId(): string
29 |     {
30 |         return $this->refundId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setRefundId(string $value): self
37 |     {
38 |         $this->refundId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Vendors/Requests/GetVendorsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Vendors\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetVendorsRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $vendorId ID of the [Vendor](entity:Vendor) to retrieve.
11 |      */
12 |     private string $vendorId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   vendorId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->vendorId = $values['vendorId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getVendorId(): string
29 |     {
30 |         return $this->vendorId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setVendorId(string $value): self
37 |     {
38 |         $this->vendorId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Customers/Groups/Requests/DeleteGroupsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Customers\Groups\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class DeleteGroupsRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $groupId The ID of the customer group to delete.
11 |      */
12 |     private string $groupId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   groupId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->groupId = $values['groupId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getGroupId(): string
29 |     {
30 |         return $this->groupId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setGroupId(string $value): self
37 |     {
38 |         $this->groupId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/LoyaltyProgramRewardDefinitionScope.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates the scope of the reward tier. DEPRECATED at version 2020-12-16. Discount details
 9 |  * are now defined using a catalog pricing rule and other catalog objects. For more information, see
10 |  * [Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-
11 |  * rewards#get-discount-details).
12 |  */
13 | class LoyaltyProgramRewardDefinitionScope
14 | {
15 |     /**
16 |      * The discount applies to the entire order.
17 |      */
18 |     public const ORDER = 'ORDER';
19 | 
20 |     /**
21 |      * The discount applies only to specific item variations.
22 |      */
23 |     public const ITEM_VARIATION = 'ITEM_VARIATION';
24 | 
25 |     /**
26 |      * The discount applies only to items in the given categories.
27 |      */
28 |     public const CATEGORY = 'CATEGORY';
29 | }
30 | 


--------------------------------------------------------------------------------
/src/Payments/Requests/CancelPaymentsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Payments\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class CancelPaymentsRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $paymentId The ID of the payment to cancel.
11 |      */
12 |     private string $paymentId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   paymentId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->paymentId = $values['paymentId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getPaymentId(): string
29 |     {
30 |         return $this->paymentId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setPaymentId(string $value): self
37 |     {
38 |         $this->paymentId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Payouts/Requests/GetPayoutsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Payouts\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetPayoutsRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $payoutId The ID of the payout to retrieve the information for.
11 |      */
12 |     private string $payoutId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   payoutId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->payoutId = $values['payoutId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getPayoutId(): string
29 |     {
30 |         return $this->payoutId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setPayoutId(string $value): self
37 |     {
38 |         $this->payoutId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Disputes/Requests/AcceptDisputesRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Disputes\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class AcceptDisputesRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $disputeId The ID of the dispute you want to accept.
11 |      */
12 |     private string $disputeId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   disputeId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->disputeId = $values['disputeId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getDisputeId(): string
29 |     {
30 |         return $this->disputeId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setDisputeId(string $value): self
37 |     {
38 |         $this->disputeId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Types/CatalogObjectType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Types;
 4 | 
 5 | enum CatalogObjectType: string
 6 | {
 7 |     case Item = "ITEM";
 8 |     case Image = "IMAGE";
 9 |     case Category = "CATEGORY";
10 |     case ItemVariation = "ITEM_VARIATION";
11 |     case Tax = "TAX";
12 |     case Discount = "DISCOUNT";
13 |     case ModifierList = "MODIFIER_LIST";
14 |     case Modifier = "MODIFIER";
15 |     case PricingRule = "PRICING_RULE";
16 |     case ProductSet = "PRODUCT_SET";
17 |     case TimePeriod = "TIME_PERIOD";
18 |     case MeasurementUnit = "MEASUREMENT_UNIT";
19 |     case SubscriptionPlanVariation = "SUBSCRIPTION_PLAN_VARIATION";
20 |     case ItemOption = "ITEM_OPTION";
21 |     case ItemOptionVal = "ITEM_OPTION_VAL";
22 |     case CustomAttributeDefinition = "CUSTOM_ATTRIBUTE_DEFINITION";
23 |     case QuickAmountsSettings = "QUICK_AMOUNTS_SETTINGS";
24 |     case SubscriptionPlan = "SUBSCRIPTION_PLAN";
25 |     case AvailabilityPeriod = "AVAILABILITY_PERIOD";
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Core/Pagination/Pager.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Core\Pagination;
 4 | 
 5 | use Generator;
 6 | use IteratorAggregate;
 7 | 
 8 | /**
 9 |  * A collection of values that may take multiple service requests to
10 |  * iterate over.
11 |  *
12 |  * @template TItem
13 |  * @implements IteratorAggregate<int, TItem>
14 |  */
15 | abstract class Pager implements IteratorAggregate
16 | {
17 |     /**
18 |      * Enumerate the values a Page at a time. This may
19 |      * make multiple service requests.
20 |      *
21 |      * @return Generator<int, Page<TItem>>
22 |      */
23 |     abstract public function getPages(): Generator;
24 | 
25 |     /**
26 |      * Enumerate the values one at a time. This may make multiple service requests.
27 |      *
28 |      * @return Generator<int, TItem>
29 |      */
30 |     public function getIterator(): Generator
31 |     {
32 |         foreach ($this->getPages() as $page) {
33 |             yield from $page->getItems();
34 |         }
35 |     }
36 | }
37 | 


--------------------------------------------------------------------------------
/src/Customers/Requests/GetCustomersRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Customers\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetCustomersRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $customerId The ID of the customer to retrieve.
11 |      */
12 |     private string $customerId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   customerId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->customerId = $values['customerId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getCustomerId(): string
29 |     {
30 |         return $this->customerId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setCustomerId(string $value): self
37 |     {
38 |         $this->customerId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Disputes/Requests/GetDisputesRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Disputes\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetDisputesRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $disputeId The ID of the dispute you want more details about.
11 |      */
12 |     private string $disputeId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   disputeId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->disputeId = $values['disputeId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getDisputeId(): string
29 |     {
30 |         return $this->disputeId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setDisputeId(string $value): self
37 |     {
38 |         $this->disputeId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/BankAccountStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Indicates the current verification status of a `BankAccount` object.
 9 |  */
10 | class BankAccountStatus
11 | {
12 |     /**
13 |      * Indicates that the verification process has started. Some features
14 |      * (for example, creditable or debitable) may be provisionally enabled on the bank
15 |      * account.
16 |      */
17 |     public const VERIFICATION_IN_PROGRESS = 'VERIFICATION_IN_PROGRESS';
18 | 
19 |     /**
20 |      * Indicates that the bank account was successfully verified.
21 |      */
22 |     public const VERIFIED = 'VERIFIED';
23 | 
24 |     /**
25 |      * Indicates that the bank account is disabled and is permanently unusable
26 |      * for funds transfer. A bank account can be disabled because of a failed verification
27 |      * attempt or a failed deposit attempt.
28 |      */
29 |     public const DISABLED = 'DISABLED';
30 | }
31 | 


--------------------------------------------------------------------------------
/src/Terminal/Actions/Requests/GetActionsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Terminal\Actions\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetActionsRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $actionId Unique ID for the desired `TerminalAction`.
11 |      */
12 |     private string $actionId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   actionId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->actionId = $values['actionId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getActionId(): string
29 |     {
30 |         return $this->actionId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setActionId(string $value): self
37 |     {
38 |         $this->actionId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Legacy/Models/CatalogCustomAttributeDefinitionAppVisibility.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Square\Legacy\Models;
 6 | 
 7 | /**
 8 |  * Defines the visibility of a custom attribute to applications other than their
 9 |  * creating application.
10 |  */
11 | class CatalogCustomAttributeDefinitionAppVisibility
12 | {
13 |     /**
14 |      * Other applications cannot read this custom attribute.
15 |      */
16 |     public const APP_VISIBILITY_HIDDEN = 'APP_VISIBILITY_HIDDEN';
17 | 
18 |     /**
19 |      * Other applications can read this custom attribute definition and
20 |      * values.
21 |      */
22 |     public const APP_VISIBILITY_READ_ONLY = 'APP_VISIBILITY_READ_ONLY';
23 | 
24 |     /**
25 |      * Other applications can read and write custom attribute values on objects.
26 |      * They can read but cannot edit the custom attribute definition.
27 |      */
28 |     public const APP_VISIBILITY_READ_WRITE_VALUES = 'APP_VISIBILITY_READ_WRITE_VALUES';
29 | }
30 | 


--------------------------------------------------------------------------------
/src/Terminal/Actions/Requests/CancelActionsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Terminal\Actions\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class CancelActionsRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $actionId Unique ID for the desired `TerminalAction`.
11 |      */
12 |     private string $actionId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   actionId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->actionId = $values['actionId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getActionId(): string
29 |     {
30 |         return $this->actionId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setActionId(string $value): self
37 |     {
38 |         $this->actionId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Customers/Segments/Requests/GetSegmentsRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Square\Customers\Segments\Requests;
 4 | 
 5 | use Square\Core\Json\JsonSerializableType;
 6 | 
 7 | class GetSegmentsRequest extends JsonSerializableType
 8 | {
 9 |     /**
10 |      * @var string $segmentId The Square-issued ID of the customer segment.
11 |      */
12 |     private string $segmentId;
13 | 
14 |     /**
15 |      * @param array{
16 |      *   segmentId: string,
17 |      * } $values
18 |      */
19 |     public function __construct(
20 |         array $values,
21 |     ) {
22 |         $this->segmentId = $values['segmentId'];
23 |     }
24 | 
25 |     /**
26 |      * @return string
27 |      */
28 |     public function getSegmentId(): string
29 |     {
30 |         return $this->segmentId;
31 |     }
32 | 
33 |     /**
34 |      * @param string $value
35 |      */
36 |     public function setSegmentId(string $value): self
37 |     {
38 |         $this->segmentId = $value;
39 |         return $this;
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------