├── .gitignore ├── .travis.yml ├── .vscode └── settings.json ├── CHANGES.md ├── LICENSE ├── README.md ├── build.gradle ├── docs ├── AdditionalRecipient.md ├── AdditionalRecipientReceivable.md ├── AdditionalRecipientReceivableRefund.md ├── Address.md ├── ApplePayApi.md ├── BalancePaymentDetails.md ├── BatchChangeInventoryRequest.md ├── BatchChangeInventoryResponse.md ├── BatchDeleteCatalogObjectsRequest.md ├── BatchDeleteCatalogObjectsResponse.md ├── BatchRetrieveCatalogObjectsRequest.md ├── BatchRetrieveCatalogObjectsResponse.md ├── BatchRetrieveInventoryChangesRequest.md ├── BatchRetrieveInventoryChangesResponse.md ├── BatchRetrieveInventoryCountsRequest.md ├── BatchRetrieveInventoryCountsResponse.md ├── BatchRetrieveOrdersRequest.md ├── BatchRetrieveOrdersResponse.md ├── BatchUpsertCatalogObjectsRequest.md ├── BatchUpsertCatalogObjectsResponse.md ├── BreakType.md ├── BusinessHours.md ├── BusinessHoursPeriod.md ├── CancelPaymentByIdempotencyKeyRequest.md ├── CancelPaymentByIdempotencyKeyResponse.md ├── CancelPaymentRequest.md ├── CancelPaymentResponse.md ├── CaptureTransactionRequest.md ├── CaptureTransactionResponse.md ├── Card.md ├── CardBrand.md ├── CardPaymentDetails.md ├── CashPaymentDetails.md ├── CatalogApi.md ├── CatalogCategory.md ├── CatalogDiscount.md ├── CatalogDiscountModifyTaxBasis.md ├── CatalogDiscountType.md ├── CatalogIdMapping.md ├── CatalogImage.md ├── CatalogInfoRequest.md ├── CatalogInfoResponse.md ├── CatalogInfoResponseLimits.md ├── CatalogItem.md ├── CatalogItemModifierListInfo.md ├── CatalogItemOption.md ├── CatalogItemOptionForItem.md ├── CatalogItemOptionValue.md ├── CatalogItemOptionValueForItemVariation.md ├── CatalogItemProductType.md ├── CatalogItemVariation.md ├── CatalogMeasurementUnit.md ├── CatalogModifier.md ├── CatalogModifierList.md ├── CatalogModifierListSelectionType.md ├── CatalogModifierOverride.md ├── CatalogObject.md ├── CatalogObjectBatch.md ├── CatalogObjectType.md ├── CatalogPricingRule.md ├── CatalogPricingType.md ├── CatalogProductSet.md ├── CatalogQuery.md ├── CatalogQueryCustomAttributeUsage.md ├── CatalogQueryExact.md ├── CatalogQueryFilteredItems.md ├── CatalogQueryFilteredItemsCustomAttributeFilter.md ├── CatalogQueryFilteredItemsCustomAttributeFilterFilterType.md ├── CatalogQueryFilteredItemsNullableAttribute.md ├── CatalogQueryFilteredItemsStockLevel.md ├── CatalogQueryItemVariationsForItemOptionValues.md ├── CatalogQueryItemsForItemOptions.md ├── CatalogQueryItemsForModifierList.md ├── CatalogQueryItemsForTax.md ├── CatalogQueryPrefix.md ├── CatalogQueryRange.md ├── CatalogQuerySortedAttribute.md ├── CatalogQueryText.md ├── CatalogTax.md ├── CatalogTimePeriod.md ├── CatalogV1Id.md ├── ChargeRequest.md ├── ChargeRequestAdditionalRecipient.md ├── ChargeResponse.md ├── Checkout.md ├── CheckoutApi.md ├── CompletePaymentRequest.md ├── CompletePaymentResponse.md ├── Coordinates.md ├── Country.md ├── CreateBreakTypeRequest.md ├── CreateBreakTypeResponse.md ├── CreateCatalogImageRequest.md ├── CreateCatalogImageResponse.md ├── CreateCheckoutRequest.md ├── CreateCheckoutResponse.md ├── CreateCustomerCardRequest.md ├── CreateCustomerCardResponse.md ├── CreateCustomerRequest.md ├── CreateCustomerResponse.md ├── CreateLocationRequest.md ├── CreateLocationResponse.md ├── CreateMobileAuthorizationCodeRequest.md ├── CreateMobileAuthorizationCodeResponse.md ├── CreateOrderRequest.md ├── CreateOrderRequestDiscount.md ├── CreateOrderRequestLineItem.md ├── CreateOrderRequestModifier.md ├── CreateOrderRequestTax.md ├── CreateOrderResponse.md ├── CreatePaymentRequest.md ├── CreatePaymentResponse.md ├── CreateRefundRequest.md ├── CreateRefundResponse.md ├── CreateShiftRequest.md ├── CreateShiftResponse.md ├── Currency.md ├── Customer.md ├── CustomerCreationSource.md ├── CustomerCreationSourceFilter.md ├── CustomerFilter.md ├── CustomerGroupInfo.md ├── CustomerInclusionExclusion.md ├── CustomerPreferences.md ├── CustomerQuery.md ├── CustomerSort.md ├── CustomerSortField.md ├── CustomersApi.md ├── DateRange.md ├── DayOfWeek.md ├── DeleteBreakTypeRequest.md ├── DeleteBreakTypeResponse.md ├── DeleteCatalogObjectRequest.md ├── DeleteCatalogObjectResponse.md ├── DeleteCustomerCardRequest.md ├── DeleteCustomerCardResponse.md ├── DeleteCustomerRequest.md ├── DeleteCustomerResponse.md ├── DeleteShiftRequest.md ├── DeleteShiftResponse.md ├── Device.md ├── Employee.md ├── EmployeeStatus.md ├── EmployeeWage.md ├── EmployeesApi.md ├── Error.md ├── ErrorCategory.md ├── ErrorCode.md ├── ExcludeStrategy.md ├── ExternalPaymentDetails.md ├── GetBreakTypeRequest.md ├── GetBreakTypeResponse.md ├── GetEmployeeWageRequest.md ├── GetEmployeeWageResponse.md ├── GetPaymentRefundRequest.md ├── GetPaymentRefundResponse.md ├── GetPaymentRequest.md ├── GetPaymentResponse.md ├── GetShiftRequest.md ├── GetShiftResponse.md ├── InventoryAdjustment.md ├── InventoryAlertType.md ├── InventoryApi.md ├── InventoryChange.md ├── InventoryChangeType.md ├── InventoryCount.md ├── InventoryPhysicalCount.md ├── InventoryState.md ├── InventoryTransfer.md ├── ItemVariationLocationOverrides.md ├── LaborApi.md ├── ListAdditionalRecipientReceivableRefundsRequest.md ├── ListAdditionalRecipientReceivableRefundsResponse.md ├── ListAdditionalRecipientReceivablesRequest.md ├── ListAdditionalRecipientReceivablesResponse.md ├── ListBreakTypesRequest.md ├── ListBreakTypesResponse.md ├── ListCatalogRequest.md ├── ListCatalogResponse.md ├── ListCustomersRequest.md ├── ListCustomersResponse.md ├── ListEmployeeWagesRequest.md ├── ListEmployeeWagesResponse.md ├── ListEmployeesRequest.md ├── ListEmployeesResponse.md ├── ListLocationsRequest.md ├── ListLocationsResponse.md ├── ListMerchantsRequest.md ├── ListMerchantsResponse.md ├── ListPaymentRefundsRequest.md ├── ListPaymentRefundsResponse.md ├── ListPaymentsRequest.md ├── ListPaymentsResponse.md ├── ListRefundsRequest.md ├── ListRefundsResponse.md ├── ListTransactionsRequest.md ├── ListTransactionsResponse.md ├── ListWorkweekConfigsRequest.md ├── ListWorkweekConfigsResponse.md ├── Location.md ├── LocationCapability.md ├── LocationStatus.md ├── LocationType.md ├── LocationsApi.md ├── MeasurementUnit.md ├── MeasurementUnitArea.md ├── MeasurementUnitCustom.md ├── MeasurementUnitGeneric.md ├── MeasurementUnitLength.md ├── MeasurementUnitTime.md ├── MeasurementUnitUnitType.md ├── MeasurementUnitVolume.md ├── MeasurementUnitWeight.md ├── Merchant.md ├── MerchantStatus.md ├── MerchantsApi.md ├── MobileAuthorizationApi.md ├── ModelBreak.md ├── Money.md ├── OAuthApi.md ├── ObtainTokenRequest.md ├── ObtainTokenResponse.md ├── Order.md ├── OrderEntry.md ├── OrderFulfillment.md ├── OrderFulfillmentPickupDetails.md ├── OrderFulfillmentPickupDetailsScheduleType.md ├── OrderFulfillmentRecipient.md ├── OrderFulfillmentShipmentDetails.md ├── OrderFulfillmentState.md ├── OrderFulfillmentType.md ├── OrderLineItem.md ├── OrderLineItemAppliedDiscount.md ├── OrderLineItemAppliedTax.md ├── OrderLineItemDiscount.md ├── OrderLineItemDiscountScope.md ├── OrderLineItemDiscountType.md ├── OrderLineItemModifier.md ├── OrderLineItemTax.md ├── OrderLineItemTaxScope.md ├── OrderLineItemTaxType.md ├── OrderMoneyAmounts.md ├── OrderQuantityUnit.md ├── OrderReturn.md ├── OrderReturnDiscount.md ├── OrderReturnLineItem.md ├── OrderReturnLineItemModifier.md ├── OrderReturnServiceCharge.md ├── OrderReturnTax.md ├── OrderRoundingAdjustment.md ├── OrderServiceCharge.md ├── OrderServiceChargeCalculationPhase.md ├── OrderSource.md ├── OrderState.md ├── OrdersApi.md ├── PayOrderRequest.md ├── PayOrderResponse.md ├── Payment.md ├── PaymentRefund.md ├── PaymentsApi.md ├── ProcessingFee.md ├── Product.md ├── README.md ├── Refund.md ├── RefundPaymentRequest.md ├── RefundPaymentResponse.md ├── RefundStatus.md ├── RefundsApi.md ├── RegisterDomainRequest.md ├── RegisterDomainResponse.md ├── RegisterDomainResponseStatus.md ├── RenewTokenRequest.md ├── RenewTokenResponse.md ├── ReportingApi.md ├── RetrieveCatalogObjectRequest.md ├── RetrieveCatalogObjectResponse.md ├── RetrieveCustomerRequest.md ├── RetrieveCustomerResponse.md ├── RetrieveEmployeeRequest.md ├── RetrieveEmployeeResponse.md ├── RetrieveInventoryAdjustmentRequest.md ├── RetrieveInventoryAdjustmentResponse.md ├── RetrieveInventoryChangesRequest.md ├── RetrieveInventoryChangesResponse.md ├── RetrieveInventoryCountRequest.md ├── RetrieveInventoryCountResponse.md ├── RetrieveInventoryPhysicalCountRequest.md ├── RetrieveInventoryPhysicalCountResponse.md ├── RetrieveLocationRequest.md ├── RetrieveLocationResponse.md ├── RetrieveMerchantRequest.md ├── RetrieveMerchantResponse.md ├── RetrieveTransactionRequest.md ├── RetrieveTransactionResponse.md ├── RevokeTokenRequest.md ├── RevokeTokenResponse.md ├── SearchCatalogObjectsRequest.md ├── SearchCatalogObjectsResponse.md ├── SearchCustomersRequest.md ├── SearchCustomersResponse.md ├── SearchOrdersCustomerFilter.md ├── SearchOrdersDateTimeFilter.md ├── SearchOrdersFilter.md ├── SearchOrdersFulfillmentFilter.md ├── SearchOrdersQuery.md ├── SearchOrdersRequest.md ├── SearchOrdersResponse.md ├── SearchOrdersSort.md ├── SearchOrdersSortField.md ├── SearchOrdersSourceFilter.md ├── SearchOrdersStateFilter.md ├── SearchShiftsRequest.md ├── SearchShiftsResponse.md ├── Shift.md ├── ShiftFilter.md ├── ShiftFilterStatus.md ├── ShiftQuery.md ├── ShiftSort.md ├── ShiftSortField.md ├── ShiftStatus.md ├── ShiftWage.md ├── ShiftWorkday.md ├── ShiftWorkdayMatcher.md ├── SortOrder.md ├── SourceApplication.md ├── StandardUnitDescription.md ├── StandardUnitDescriptionGroup.md ├── TaxCalculationPhase.md ├── TaxInclusionType.md ├── Tender.md ├── TenderCardDetails.md ├── TenderCardDetailsEntryMethod.md ├── TenderCardDetailsStatus.md ├── TenderCashDetails.md ├── TenderType.md ├── TimeRange.md ├── Transaction.md ├── TransactionProduct.md ├── TransactionsApi.md ├── UpdateBreakTypeRequest.md ├── UpdateBreakTypeResponse.md ├── UpdateCustomerRequest.md ├── UpdateCustomerResponse.md ├── UpdateItemModifierListsRequest.md ├── UpdateItemModifierListsResponse.md ├── UpdateItemTaxesRequest.md ├── UpdateItemTaxesResponse.md ├── UpdateLocationRequest.md ├── UpdateLocationResponse.md ├── UpdateOrderRequest.md ├── UpdateOrderResponse.md ├── UpdateShiftRequest.md ├── UpdateShiftResponse.md ├── UpdateWorkweekConfigRequest.md ├── UpdateWorkweekConfigResponse.md ├── UpsertCatalogObjectRequest.md ├── UpsertCatalogObjectResponse.md ├── V1AdjustInventoryRequest.md ├── V1AdjustInventoryRequestAdjustmentType.md ├── V1ApplyFeeRequest.md ├── V1ApplyModifierListRequest.md ├── V1BankAccount.md ├── V1BankAccountType.md ├── V1CashDrawerEvent.md ├── V1CashDrawerEventEventType.md ├── V1CashDrawerShift.md ├── V1CashDrawerShiftEventType.md ├── V1Category.md ├── V1CreateCategoryRequest.md ├── V1CreateDiscountRequest.md ├── V1CreateEmployeeRoleRequest.md ├── V1CreateFeeRequest.md ├── V1CreateItemRequest.md ├── V1CreateModifierListRequest.md ├── V1CreateModifierOptionRequest.md ├── V1CreatePageRequest.md ├── V1CreateRefundRequest.md ├── V1CreateRefundRequestType.md ├── V1CreateVariationRequest.md ├── V1DeleteCategoryRequest.md ├── V1DeleteDiscountRequest.md ├── V1DeleteFeeRequest.md ├── V1DeleteItemRequest.md ├── V1DeleteModifierListRequest.md ├── V1DeleteModifierOptionRequest.md ├── V1DeletePageCellRequest.md ├── V1DeletePageRequest.md ├── V1DeleteTimecardRequest.md ├── V1DeleteTimecardResponse.md ├── V1DeleteVariationRequest.md ├── V1Discount.md ├── V1DiscountColor.md ├── V1DiscountDiscountType.md ├── V1Employee.md ├── V1EmployeeRole.md ├── V1EmployeeRolePermissions.md ├── V1EmployeeStatus.md ├── V1EmployeesApi.md ├── V1Fee.md ├── V1FeeAdjustmentType.md ├── V1FeeCalculationPhase.md ├── V1FeeInclusionType.md ├── V1FeeType.md ├── V1InventoryEntry.md ├── V1Item.md ├── V1ItemColor.md ├── V1ItemImage.md ├── V1ItemType.md ├── V1ItemVisibility.md ├── V1ItemsApi.md ├── V1ListBankAccountsRequest.md ├── V1ListBankAccountsResponse.md ├── V1ListCashDrawerShiftsRequest.md ├── V1ListCashDrawerShiftsResponse.md ├── V1ListCategoriesRequest.md ├── V1ListCategoriesResponse.md ├── V1ListDiscountsRequest.md ├── V1ListDiscountsResponse.md ├── V1ListEmployeeRolesRequest.md ├── V1ListEmployeeRolesResponse.md ├── V1ListEmployeesRequest.md ├── V1ListEmployeesRequestStatus.md ├── V1ListEmployeesResponse.md ├── V1ListFeesRequest.md ├── V1ListFeesResponse.md ├── V1ListInventoryRequest.md ├── V1ListInventoryResponse.md ├── V1ListItemsRequest.md ├── V1ListItemsResponse.md ├── V1ListLocationsRequest.md ├── V1ListLocationsResponse.md ├── V1ListModifierListsRequest.md ├── V1ListModifierListsResponse.md ├── V1ListOrdersRequest.md ├── V1ListOrdersResponse.md ├── V1ListPagesRequest.md ├── V1ListPagesResponse.md ├── V1ListPaymentsRequest.md ├── V1ListPaymentsResponse.md ├── V1ListRefundsRequest.md ├── V1ListRefundsResponse.md ├── V1ListSettlementsRequest.md ├── V1ListSettlementsRequestStatus.md ├── V1ListSettlementsResponse.md ├── V1ListTimecardEventsRequest.md ├── V1ListTimecardEventsResponse.md ├── V1ListTimecardsRequest.md ├── V1ListTimecardsResponse.md ├── V1LocationsApi.md ├── V1Merchant.md ├── V1MerchantAccountType.md ├── V1MerchantBusinessType.md ├── V1MerchantLocationDetails.md ├── V1ModifierList.md ├── V1ModifierListSelectionType.md ├── V1ModifierOption.md ├── V1Money.md ├── V1Order.md ├── V1OrderHistoryEntry.md ├── V1OrderHistoryEntryAction.md ├── V1OrderState.md ├── V1Page.md ├── V1PageCell.md ├── V1PageCellObjectType.md ├── V1PageCellPlaceholderType.md ├── V1Payment.md ├── V1PaymentDiscount.md ├── V1PaymentItemDetail.md ├── V1PaymentItemization.md ├── V1PaymentItemizationItemizationType.md ├── V1PaymentModifier.md ├── V1PaymentSurcharge.md ├── V1PaymentSurchargeType.md ├── V1PaymentTax.md ├── V1PaymentTaxInclusionType.md ├── V1PhoneNumber.md ├── V1Refund.md ├── V1RefundType.md ├── V1RemoveFeeRequest.md ├── V1RemoveModifierListRequest.md ├── V1RetrieveBankAccountRequest.md ├── V1RetrieveBusinessRequest.md ├── V1RetrieveCashDrawerShiftRequest.md ├── V1RetrieveEmployeeRequest.md ├── V1RetrieveEmployeeRoleRequest.md ├── V1RetrieveItemRequest.md ├── V1RetrieveModifierListRequest.md ├── V1RetrieveOrderRequest.md ├── V1RetrievePaymentRequest.md ├── V1RetrieveSettlementRequest.md ├── V1RetrieveTimecardRequest.md ├── V1Settlement.md ├── V1SettlementEntry.md ├── V1SettlementEntryType.md ├── V1SettlementStatus.md ├── V1Tender.md ├── V1TenderCardBrand.md ├── V1TenderEntryMethod.md ├── V1TenderType.md ├── V1Timecard.md ├── V1TimecardEvent.md ├── V1TimecardEventEventType.md ├── V1TransactionsApi.md ├── V1UpdateCategoryRequest.md ├── V1UpdateDiscountRequest.md ├── V1UpdateEmployeeRequest.md ├── V1UpdateEmployeeRoleRequest.md ├── V1UpdateFeeRequest.md ├── V1UpdateItemRequest.md ├── V1UpdateModifierListRequest.md ├── V1UpdateModifierListRequestSelectionType.md ├── V1UpdateModifierOptionRequest.md ├── V1UpdateOrderRequest.md ├── V1UpdateOrderRequestAction.md ├── V1UpdatePageCellRequest.md ├── V1UpdatePageRequest.md ├── V1UpdateTimecardRequest.md ├── V1UpdateVariationRequest.md ├── V1Variation.md ├── V1VariationInventoryAlertType.md ├── V1VariationPricingType.md ├── VoidTransactionRequest.md ├── VoidTransactionResponse.md ├── Weekday.md └── WorkweekConfig.md ├── gradle.properties ├── gradle ├── gradle-mvn-push.gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── maven ├── before_deploy.sh ├── codesigning.asc.enc ├── deploy.sh └── mvnsettings.xml ├── pom.xml ├── settings.gradle ├── src ├── main │ └── java │ │ └── com │ │ └── squareup │ │ └── connect │ │ ├── ApiClient.java │ │ ├── ApiException.java │ │ ├── CompleteResponse.java │ │ ├── Configuration.java │ │ ├── JSON.java │ │ ├── Pair.java │ │ ├── RFC3339DateFormat.java │ │ ├── StringUtil.java │ │ ├── api │ │ ├── ApplePayApi.java │ │ ├── CatalogApi.java │ │ ├── CheckoutApi.java │ │ ├── CustomersApi.java │ │ ├── EmployeesApi.java │ │ ├── InventoryApi.java │ │ ├── LaborApi.java │ │ ├── LocationsApi.java │ │ ├── MerchantsApi.java │ │ ├── MobileAuthorizationApi.java │ │ ├── OAuthApi.java │ │ ├── OrdersApi.java │ │ ├── PaymentsApi.java │ │ ├── RefundsApi.java │ │ ├── ReportingApi.java │ │ ├── TransactionsApi.java │ │ ├── V1EmployeesApi.java │ │ ├── V1ItemsApi.java │ │ ├── V1LocationsApi.java │ │ └── V1TransactionsApi.java │ │ ├── auth │ │ ├── ApiKeyAuth.java │ │ ├── Authentication.java │ │ ├── HttpBasicAuth.java │ │ └── OAuth.java │ │ └── models │ │ ├── AdditionalRecipient.java │ │ ├── AdditionalRecipientReceivable.java │ │ ├── AdditionalRecipientReceivableRefund.java │ │ ├── Address.java │ │ ├── BalancePaymentDetails.java │ │ ├── BatchChangeInventoryRequest.java │ │ ├── BatchChangeInventoryResponse.java │ │ ├── BatchDeleteCatalogObjectsRequest.java │ │ ├── BatchDeleteCatalogObjectsResponse.java │ │ ├── BatchRetrieveCatalogObjectsRequest.java │ │ ├── BatchRetrieveCatalogObjectsResponse.java │ │ ├── BatchRetrieveInventoryChangesRequest.java │ │ ├── BatchRetrieveInventoryChangesResponse.java │ │ ├── BatchRetrieveInventoryCountsRequest.java │ │ ├── BatchRetrieveInventoryCountsResponse.java │ │ ├── BatchRetrieveOrdersRequest.java │ │ ├── BatchRetrieveOrdersResponse.java │ │ ├── BatchUpsertCatalogObjectsRequest.java │ │ ├── BatchUpsertCatalogObjectsResponse.java │ │ ├── BreakType.java │ │ ├── BusinessHours.java │ │ ├── BusinessHoursPeriod.java │ │ ├── CancelPaymentByIdempotencyKeyRequest.java │ │ ├── CancelPaymentByIdempotencyKeyResponse.java │ │ ├── CancelPaymentRequest.java │ │ ├── CancelPaymentResponse.java │ │ ├── CaptureTransactionRequest.java │ │ ├── CaptureTransactionResponse.java │ │ ├── Card.java │ │ ├── CardPaymentDetails.java │ │ ├── CashPaymentDetails.java │ │ ├── CatalogCategory.java │ │ ├── CatalogDiscount.java │ │ ├── CatalogIdMapping.java │ │ ├── CatalogImage.java │ │ ├── CatalogInfoRequest.java │ │ ├── CatalogInfoResponse.java │ │ ├── CatalogInfoResponseLimits.java │ │ ├── CatalogItem.java │ │ ├── CatalogItemModifierListInfo.java │ │ ├── CatalogItemOption.java │ │ ├── CatalogItemOptionForItem.java │ │ ├── CatalogItemOptionValue.java │ │ ├── CatalogItemOptionValueForItemVariation.java │ │ ├── CatalogItemVariation.java │ │ ├── CatalogMeasurementUnit.java │ │ ├── CatalogModifier.java │ │ ├── CatalogModifierList.java │ │ ├── CatalogModifierOverride.java │ │ ├── CatalogObject.java │ │ ├── CatalogObjectBatch.java │ │ ├── CatalogPricingRule.java │ │ ├── CatalogProductSet.java │ │ ├── CatalogQuery.java │ │ ├── CatalogQueryCustomAttributeUsage.java │ │ ├── CatalogQueryExact.java │ │ ├── CatalogQueryFilteredItems.java │ │ ├── CatalogQueryFilteredItemsCustomAttributeFilter.java │ │ ├── CatalogQueryItemVariationsForItemOptionValues.java │ │ ├── CatalogQueryItemsForItemOptions.java │ │ ├── CatalogQueryItemsForModifierList.java │ │ ├── CatalogQueryItemsForTax.java │ │ ├── CatalogQueryPrefix.java │ │ ├── CatalogQueryRange.java │ │ ├── CatalogQuerySortedAttribute.java │ │ ├── CatalogQueryText.java │ │ ├── CatalogTax.java │ │ ├── CatalogTimePeriod.java │ │ ├── CatalogV1Id.java │ │ ├── ChargeRequest.java │ │ ├── ChargeRequestAdditionalRecipient.java │ │ ├── ChargeResponse.java │ │ ├── Checkout.java │ │ ├── CompletePaymentRequest.java │ │ ├── CompletePaymentResponse.java │ │ ├── Coordinates.java │ │ ├── CreateBreakTypeRequest.java │ │ ├── CreateBreakTypeResponse.java │ │ ├── CreateCatalogImageRequest.java │ │ ├── CreateCatalogImageResponse.java │ │ ├── CreateCheckoutRequest.java │ │ ├── CreateCheckoutResponse.java │ │ ├── CreateCustomerCardRequest.java │ │ ├── CreateCustomerCardResponse.java │ │ ├── CreateCustomerRequest.java │ │ ├── CreateCustomerResponse.java │ │ ├── CreateLocationRequest.java │ │ ├── CreateLocationResponse.java │ │ ├── CreateMobileAuthorizationCodeRequest.java │ │ ├── CreateMobileAuthorizationCodeResponse.java │ │ ├── CreateOrderRequest.java │ │ ├── CreateOrderRequestDiscount.java │ │ ├── CreateOrderRequestLineItem.java │ │ ├── CreateOrderRequestModifier.java │ │ ├── CreateOrderRequestTax.java │ │ ├── CreateOrderResponse.java │ │ ├── CreatePaymentRequest.java │ │ ├── CreatePaymentResponse.java │ │ ├── CreateRefundRequest.java │ │ ├── CreateRefundResponse.java │ │ ├── CreateShiftRequest.java │ │ ├── CreateShiftResponse.java │ │ ├── Customer.java │ │ ├── CustomerCreationSourceFilter.java │ │ ├── CustomerFilter.java │ │ ├── CustomerGroupInfo.java │ │ ├── CustomerPreferences.java │ │ ├── CustomerQuery.java │ │ ├── CustomerSort.java │ │ ├── DateRange.java │ │ ├── DeleteBreakTypeRequest.java │ │ ├── DeleteBreakTypeResponse.java │ │ ├── DeleteCatalogObjectRequest.java │ │ ├── DeleteCatalogObjectResponse.java │ │ ├── DeleteCustomerCardRequest.java │ │ ├── DeleteCustomerCardResponse.java │ │ ├── DeleteCustomerRequest.java │ │ ├── DeleteCustomerResponse.java │ │ ├── DeleteShiftRequest.java │ │ ├── DeleteShiftResponse.java │ │ ├── Device.java │ │ ├── Employee.java │ │ ├── EmployeeWage.java │ │ ├── Error.java │ │ ├── ExternalPaymentDetails.java │ │ ├── GetBreakTypeRequest.java │ │ ├── GetBreakTypeResponse.java │ │ ├── GetEmployeeWageRequest.java │ │ ├── GetEmployeeWageResponse.java │ │ ├── GetPaymentRefundRequest.java │ │ ├── GetPaymentRefundResponse.java │ │ ├── GetPaymentRequest.java │ │ ├── GetPaymentResponse.java │ │ ├── GetShiftRequest.java │ │ ├── GetShiftResponse.java │ │ ├── InventoryAdjustment.java │ │ ├── InventoryChange.java │ │ ├── InventoryCount.java │ │ ├── InventoryPhysicalCount.java │ │ ├── InventoryTransfer.java │ │ ├── ItemVariationLocationOverrides.java │ │ ├── ListAdditionalRecipientReceivableRefundsRequest.java │ │ ├── ListAdditionalRecipientReceivableRefundsResponse.java │ │ ├── ListAdditionalRecipientReceivablesRequest.java │ │ ├── ListAdditionalRecipientReceivablesResponse.java │ │ ├── ListBreakTypesRequest.java │ │ ├── ListBreakTypesResponse.java │ │ ├── ListCatalogRequest.java │ │ ├── ListCatalogResponse.java │ │ ├── ListCustomersRequest.java │ │ ├── ListCustomersResponse.java │ │ ├── ListEmployeeWagesRequest.java │ │ ├── ListEmployeeWagesResponse.java │ │ ├── ListEmployeesRequest.java │ │ ├── ListEmployeesResponse.java │ │ ├── ListLocationsRequest.java │ │ ├── ListLocationsResponse.java │ │ ├── ListMerchantsRequest.java │ │ ├── ListMerchantsResponse.java │ │ ├── ListPaymentRefundsRequest.java │ │ ├── ListPaymentRefundsResponse.java │ │ ├── ListPaymentsRequest.java │ │ ├── ListPaymentsResponse.java │ │ ├── ListRefundsRequest.java │ │ ├── ListRefundsResponse.java │ │ ├── ListTransactionsRequest.java │ │ ├── ListTransactionsResponse.java │ │ ├── ListWorkweekConfigsRequest.java │ │ ├── ListWorkweekConfigsResponse.java │ │ ├── Location.java │ │ ├── MeasurementUnit.java │ │ ├── MeasurementUnitCustom.java │ │ ├── Merchant.java │ │ ├── ModelBreak.java │ │ ├── Money.java │ │ ├── ObtainTokenRequest.java │ │ ├── ObtainTokenResponse.java │ │ ├── Order.java │ │ ├── OrderEntry.java │ │ ├── OrderFulfillment.java │ │ ├── OrderFulfillmentPickupDetails.java │ │ ├── OrderFulfillmentRecipient.java │ │ ├── OrderFulfillmentShipmentDetails.java │ │ ├── OrderLineItem.java │ │ ├── OrderLineItemAppliedDiscount.java │ │ ├── OrderLineItemAppliedTax.java │ │ ├── OrderLineItemDiscount.java │ │ ├── OrderLineItemModifier.java │ │ ├── OrderLineItemTax.java │ │ ├── OrderMoneyAmounts.java │ │ ├── OrderQuantityUnit.java │ │ ├── OrderReturn.java │ │ ├── OrderReturnDiscount.java │ │ ├── OrderReturnLineItem.java │ │ ├── OrderReturnLineItemModifier.java │ │ ├── OrderReturnServiceCharge.java │ │ ├── OrderReturnTax.java │ │ ├── OrderRoundingAdjustment.java │ │ ├── OrderServiceCharge.java │ │ ├── OrderSource.java │ │ ├── PayOrderRequest.java │ │ ├── PayOrderResponse.java │ │ ├── Payment.java │ │ ├── PaymentRefund.java │ │ ├── ProcessingFee.java │ │ ├── Refund.java │ │ ├── RefundPaymentRequest.java │ │ ├── RefundPaymentResponse.java │ │ ├── RegisterDomainRequest.java │ │ ├── RegisterDomainResponse.java │ │ ├── RenewTokenRequest.java │ │ ├── RenewTokenResponse.java │ │ ├── RetrieveCatalogObjectRequest.java │ │ ├── RetrieveCatalogObjectResponse.java │ │ ├── RetrieveCustomerRequest.java │ │ ├── RetrieveCustomerResponse.java │ │ ├── RetrieveEmployeeRequest.java │ │ ├── RetrieveEmployeeResponse.java │ │ ├── RetrieveInventoryAdjustmentRequest.java │ │ ├── RetrieveInventoryAdjustmentResponse.java │ │ ├── RetrieveInventoryChangesRequest.java │ │ ├── RetrieveInventoryChangesResponse.java │ │ ├── RetrieveInventoryCountRequest.java │ │ ├── RetrieveInventoryCountResponse.java │ │ ├── RetrieveInventoryPhysicalCountRequest.java │ │ ├── RetrieveInventoryPhysicalCountResponse.java │ │ ├── RetrieveLocationRequest.java │ │ ├── RetrieveLocationResponse.java │ │ ├── RetrieveMerchantRequest.java │ │ ├── RetrieveMerchantResponse.java │ │ ├── RetrieveTransactionRequest.java │ │ ├── RetrieveTransactionResponse.java │ │ ├── RevokeTokenRequest.java │ │ ├── RevokeTokenResponse.java │ │ ├── SearchCatalogObjectsRequest.java │ │ ├── SearchCatalogObjectsResponse.java │ │ ├── SearchCustomersRequest.java │ │ ├── SearchCustomersResponse.java │ │ ├── SearchOrdersCustomerFilter.java │ │ ├── SearchOrdersDateTimeFilter.java │ │ ├── SearchOrdersFilter.java │ │ ├── SearchOrdersFulfillmentFilter.java │ │ ├── SearchOrdersQuery.java │ │ ├── SearchOrdersRequest.java │ │ ├── SearchOrdersResponse.java │ │ ├── SearchOrdersSort.java │ │ ├── SearchOrdersSourceFilter.java │ │ ├── SearchOrdersStateFilter.java │ │ ├── SearchShiftsRequest.java │ │ ├── SearchShiftsResponse.java │ │ ├── Shift.java │ │ ├── ShiftFilter.java │ │ ├── ShiftQuery.java │ │ ├── ShiftSort.java │ │ ├── ShiftWage.java │ │ ├── ShiftWorkday.java │ │ ├── SourceApplication.java │ │ ├── StandardUnitDescription.java │ │ ├── StandardUnitDescriptionGroup.java │ │ ├── Tender.java │ │ ├── TenderCardDetails.java │ │ ├── TenderCashDetails.java │ │ ├── TimeRange.java │ │ ├── Transaction.java │ │ ├── UpdateBreakTypeRequest.java │ │ ├── UpdateBreakTypeResponse.java │ │ ├── UpdateCustomerRequest.java │ │ ├── UpdateCustomerResponse.java │ │ ├── UpdateItemModifierListsRequest.java │ │ ├── UpdateItemModifierListsResponse.java │ │ ├── UpdateItemTaxesRequest.java │ │ ├── UpdateItemTaxesResponse.java │ │ ├── UpdateLocationRequest.java │ │ ├── UpdateLocationResponse.java │ │ ├── UpdateOrderRequest.java │ │ ├── UpdateOrderResponse.java │ │ ├── UpdateShiftRequest.java │ │ ├── UpdateShiftResponse.java │ │ ├── UpdateWorkweekConfigRequest.java │ │ ├── UpdateWorkweekConfigResponse.java │ │ ├── UpsertCatalogObjectRequest.java │ │ ├── UpsertCatalogObjectResponse.java │ │ ├── V1AdjustInventoryRequest.java │ │ ├── V1ApplyFeeRequest.java │ │ ├── V1ApplyModifierListRequest.java │ │ ├── V1BankAccount.java │ │ ├── V1CashDrawerEvent.java │ │ ├── V1CashDrawerShift.java │ │ ├── V1Category.java │ │ ├── V1CreateCategoryRequest.java │ │ ├── V1CreateDiscountRequest.java │ │ ├── V1CreateEmployeeRoleRequest.java │ │ ├── V1CreateFeeRequest.java │ │ ├── V1CreateItemRequest.java │ │ ├── V1CreateModifierListRequest.java │ │ ├── V1CreateModifierOptionRequest.java │ │ ├── V1CreatePageRequest.java │ │ ├── V1CreateRefundRequest.java │ │ ├── V1CreateVariationRequest.java │ │ ├── V1DeleteCategoryRequest.java │ │ ├── V1DeleteDiscountRequest.java │ │ ├── V1DeleteFeeRequest.java │ │ ├── V1DeleteItemRequest.java │ │ ├── V1DeleteModifierListRequest.java │ │ ├── V1DeleteModifierOptionRequest.java │ │ ├── V1DeletePageCellRequest.java │ │ ├── V1DeletePageRequest.java │ │ ├── V1DeleteTimecardRequest.java │ │ ├── V1DeleteTimecardResponse.java │ │ ├── V1DeleteVariationRequest.java │ │ ├── V1Discount.java │ │ ├── V1Employee.java │ │ ├── V1EmployeeRole.java │ │ ├── V1Fee.java │ │ ├── V1InventoryEntry.java │ │ ├── V1Item.java │ │ ├── V1ItemImage.java │ │ ├── V1ListBankAccountsRequest.java │ │ ├── V1ListBankAccountsResponse.java │ │ ├── V1ListCashDrawerShiftsRequest.java │ │ ├── V1ListCashDrawerShiftsResponse.java │ │ ├── V1ListCategoriesRequest.java │ │ ├── V1ListCategoriesResponse.java │ │ ├── V1ListDiscountsRequest.java │ │ ├── V1ListDiscountsResponse.java │ │ ├── V1ListEmployeeRolesRequest.java │ │ ├── V1ListEmployeeRolesResponse.java │ │ ├── V1ListEmployeesRequest.java │ │ ├── V1ListEmployeesResponse.java │ │ ├── V1ListFeesRequest.java │ │ ├── V1ListFeesResponse.java │ │ ├── V1ListInventoryRequest.java │ │ ├── V1ListInventoryResponse.java │ │ ├── V1ListItemsRequest.java │ │ ├── V1ListItemsResponse.java │ │ ├── V1ListLocationsRequest.java │ │ ├── V1ListLocationsResponse.java │ │ ├── V1ListModifierListsRequest.java │ │ ├── V1ListModifierListsResponse.java │ │ ├── V1ListOrdersRequest.java │ │ ├── V1ListOrdersResponse.java │ │ ├── V1ListPagesRequest.java │ │ ├── V1ListPagesResponse.java │ │ ├── V1ListPaymentsRequest.java │ │ ├── V1ListPaymentsResponse.java │ │ ├── V1ListRefundsRequest.java │ │ ├── V1ListRefundsResponse.java │ │ ├── V1ListSettlementsRequest.java │ │ ├── V1ListSettlementsResponse.java │ │ ├── V1ListTimecardEventsRequest.java │ │ ├── V1ListTimecardEventsResponse.java │ │ ├── V1ListTimecardsRequest.java │ │ ├── V1ListTimecardsResponse.java │ │ ├── V1Merchant.java │ │ ├── V1MerchantLocationDetails.java │ │ ├── V1ModifierList.java │ │ ├── V1ModifierOption.java │ │ ├── V1Money.java │ │ ├── V1Order.java │ │ ├── V1OrderHistoryEntry.java │ │ ├── V1Page.java │ │ ├── V1PageCell.java │ │ ├── V1Payment.java │ │ ├── V1PaymentDiscount.java │ │ ├── V1PaymentItemDetail.java │ │ ├── V1PaymentItemization.java │ │ ├── V1PaymentModifier.java │ │ ├── V1PaymentSurcharge.java │ │ ├── V1PaymentTax.java │ │ ├── V1PhoneNumber.java │ │ ├── V1Refund.java │ │ ├── V1RemoveFeeRequest.java │ │ ├── V1RemoveModifierListRequest.java │ │ ├── V1RetrieveBankAccountRequest.java │ │ ├── V1RetrieveBusinessRequest.java │ │ ├── V1RetrieveCashDrawerShiftRequest.java │ │ ├── V1RetrieveEmployeeRequest.java │ │ ├── V1RetrieveEmployeeRoleRequest.java │ │ ├── V1RetrieveItemRequest.java │ │ ├── V1RetrieveModifierListRequest.java │ │ ├── V1RetrieveOrderRequest.java │ │ ├── V1RetrievePaymentRequest.java │ │ ├── V1RetrieveSettlementRequest.java │ │ ├── V1RetrieveTimecardRequest.java │ │ ├── V1Settlement.java │ │ ├── V1SettlementEntry.java │ │ ├── V1Tender.java │ │ ├── V1Timecard.java │ │ ├── V1TimecardEvent.java │ │ ├── V1UpdateCategoryRequest.java │ │ ├── V1UpdateDiscountRequest.java │ │ ├── V1UpdateEmployeeRequest.java │ │ ├── V1UpdateEmployeeRoleRequest.java │ │ ├── V1UpdateFeeRequest.java │ │ ├── V1UpdateItemRequest.java │ │ ├── V1UpdateModifierListRequest.java │ │ ├── V1UpdateModifierOptionRequest.java │ │ ├── V1UpdateOrderRequest.java │ │ ├── V1UpdatePageCellRequest.java │ │ ├── V1UpdatePageRequest.java │ │ ├── V1UpdateTimecardRequest.java │ │ ├── V1UpdateVariationRequest.java │ │ ├── V1Variation.java │ │ ├── VoidTransactionRequest.java │ │ ├── VoidTransactionResponse.java │ │ └── WorkweekConfig.java └── test │ └── java │ └── com │ └── squareup │ └── connect │ ├── api │ ├── ApplePayApiTest.java │ ├── CatalogApiTest.java │ ├── CheckoutApiTest.java │ ├── CustomersApiTest.java │ ├── EmployeesApiTest.java │ ├── InventoryApiTest.java │ ├── LaborApiTest.java │ ├── LocationsApiTest.java │ ├── MerchantsApiTest.java │ ├── MobileAuthorizationApiTest.java │ ├── OAuthApiTest.java │ ├── OrdersApiTest.java │ ├── PaymentsApiTest.java │ ├── RefundsApiTest.java │ ├── ReportingApiTest.java │ ├── TransactionsApiTest.java │ ├── V1EmployeesApiTest.java │ ├── V1ItemsApiTest.java │ ├── V1LocationsApiTest.java │ └── V1TransactionsApiTest.java │ ├── models │ ├── CreateCheckoutRequestTest.java │ └── RefundTest.java │ └── utils │ ├── APITest.java │ └── Account.java └── travis-ci └── accounts.enc /.gitignore: -------------------------------------------------------------------------------- 1 | *.class 2 | 3 | # Mobile Tools for Java (J2ME) 4 | .mtj.tmp/ 5 | 6 | # Package Files # 7 | *.war 8 | *.ear 9 | 10 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 11 | hs_err_pid* 12 | 13 | target 14 | build 15 | .gradle 16 | .settings 17 | .classpath 18 | .project 19 | git_push.sh 20 | build.sbt 21 | AndroidManifest.xml 22 | 23 | travis-ci/accounts.json 24 | .vscode -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "java.configuration.updateBuildConfiguration": "disabled" 3 | } 4 | -------------------------------------------------------------------------------- /docs/AdditionalRecipient.md: -------------------------------------------------------------------------------- 1 | 2 | # AdditionalRecipient 3 | 4 | ### Description 5 | 6 | Represents an additional recipient (other than the merchant) receiving a portion of this tender. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **locationId** | **String** | The location ID for a recipient (other than the merchant) receiving a portion of this tender. | 12 | **description** | **String** | The description of the additional recipient. | 13 | **amountMoney** | [**Money**](Money.md) | The amount of money distributed to the recipient. | 14 | **receivableId** | **String** | The unique ID for this `AdditionalRecipientReceivable`, assigned by the server. | [optional] 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/BalancePaymentDetails.md: -------------------------------------------------------------------------------- 1 | 2 | # BalancePaymentDetails 3 | 4 | ### Description 5 | 6 | Reflects the current status of a balance payment. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **accountId** | **String** | ID for the account used to fund the payment. | [optional] 12 | **status** | **String** | The balance payment’s current state. Can be `COMPLETED` or `FAILED`. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/BatchChangeInventoryResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # BatchChangeInventoryResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 12 | **counts** | [**List<InventoryCount>**](InventoryCount.md) | The current counts for all objects referenced in the request. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/BatchDeleteCatalogObjectsRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # BatchDeleteCatalogObjectsRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **objectIds** | **List<String>** | The IDs of the CatalogObjects to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a CatalogItem will delete its CatalogItemVariation. | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/BatchDeleteCatalogObjectsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # BatchDeleteCatalogObjectsResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | The set of Errors encountered. | [optional] 12 | **deletedObjectIds** | **List<String>** | The IDs of all CatalogObjects deleted by this request. | [optional] 13 | **deletedAt** | **String** | The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/BatchRetrieveCatalogObjectsRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # BatchRetrieveCatalogObjectsRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **objectIds** | **List<String>** | The IDs of the CatalogObjects to be retrieved. | 12 | **includeRelatedObjects** | **Boolean** | If `true`, the response will include additional objects that are related to the requested objects, as follows: If the `objects` field of the response contains a CatalogItem, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/BatchRetrieveCatalogObjectsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # BatchRetrieveCatalogObjectsResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. | [optional] 12 | **objects** | [**List<CatalogObject>**](CatalogObject.md) | A list of `CatalogObject`s returned. | [optional] 13 | **relatedObjects** | [**List<CatalogObject>**](CatalogObject.md) | A list of `CatalogObject`s referenced by the object in the `objects` field. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/BatchRetrieveInventoryChangesResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # BatchRetrieveInventoryChangesResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 12 | **changes** | [**List<InventoryChange>**](InventoryChange.md) | The current calculated inventory changes for the requested objects and locations. | [optional] 13 | **cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/BatchRetrieveInventoryCountsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # BatchRetrieveInventoryCountsResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 12 | **counts** | [**List<InventoryCount>**](InventoryCount.md) | The current calculated inventory counts for the requested objects and locations. | [optional] 13 | **cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/BatchRetrieveOrdersRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # BatchRetrieveOrdersRequest 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in requests to the BatchRetrieveOrders endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **orderIds** | **List<String>** | The IDs of the orders to retrieve. A maximum of 100 orders can be retrieved per request. | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/BatchRetrieveOrdersResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # BatchRetrieveOrdersResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the BatchRetrieveOrders endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **orders** | [**List<Order>**](Order.md) | The requested orders. This will omit any requested orders that do not exist. | [optional] 12 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/BatchUpsertCatalogObjectsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # BatchUpsertCatalogObjectsResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Information on any errors that encountered. | [optional] 12 | **objects** | [**List<CatalogObject>**](CatalogObject.md) | The created successfully created CatalogObjects. | [optional] 13 | **updatedAt** | **String** | The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] 14 | **idMappings** | [**List<CatalogIdMapping>**](CatalogIdMapping.md) | The mapping between client and server IDs for this upsert. | [optional] 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/BusinessHours.md: -------------------------------------------------------------------------------- 1 | 2 | # BusinessHours 3 | 4 | ### Description 5 | 6 | Represents the hours of operation for a business location. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **periods** | [**List<BusinessHoursPeriod>**](BusinessHoursPeriod.md) | The list of time periods during which the business is open. There may be at most 10 periods per day. | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/BusinessHoursPeriod.md: -------------------------------------------------------------------------------- 1 | 2 | # BusinessHoursPeriod 3 | 4 | ### Description 5 | 6 | Represents a period of time during which a business location is open. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **dayOfWeek** | **String** | The day of week for this time period. See [DayOfWeek](#type-dayofweek) for possible values | [optional] 12 | **startLocalTime** | **String** | The start time of a business hours period, specified in local time using partial-time RFC3339 format. | [optional] 13 | **endLocalTime** | **String** | The end time of a business hours period, specified in local time using partial-time RFC3339 format. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CancelPaymentByIdempotencyKeyRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # CancelPaymentByIdempotencyKeyRequest 3 | 4 | ### Description 5 | 6 | Specifies idempotency key of a payment to cancel. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **idempotencyKey** | **String** | `idempotency_key` identifying the payment to be canceled. | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CancelPaymentByIdempotencyKeyResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # CancelPaymentByIdempotencyKeyResponse 3 | 4 | ### Description 5 | 6 | Return value from the [CancelPaymentByIdempotencyKey](#endpoint-payments-cancelpaymentbyidempotencykey) endpoint. On success, `errors` will be empty. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CancelPaymentRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # CancelPaymentRequest 3 | 4 | ### Description 5 | 6 | Cancels (voids) a payment before it has been completed. Note: only payments created with `autocomplete` set to false can be canceled. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CancelPaymentResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # CancelPaymentResponse 3 | 4 | ### Description 5 | 6 | Return value from the [CancelPayment](#endpoint-payments-cancelpayment) endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request. | [optional] 12 | **payment** | [**Payment**](Payment.md) | The successfully canceled `Payment` object. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CaptureTransactionRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # CaptureTransactionRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CaptureTransactionResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # CaptureTransactionResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the [CaptureTransaction](#endpoint-capturetransaction) endpoint. 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CardBrand.md: -------------------------------------------------------------------------------- 1 | 2 | # CardBrand 3 | 4 | 5 | * `"OTHER_BRAND"` 6 | 7 | * `"VISA"` 8 | 9 | * `"MASTERCARD"` 10 | 11 | * `"AMERICAN_EXPRESS"` 12 | 13 | * `"DISCOVER"` 14 | 15 | * `"DISCOVER_DINERS"` 16 | 17 | * `"JCB"` 18 | 19 | * `"CHINA_UNIONPAY"` 20 | 21 | * `"SQUARE_GIFT_CARD"` 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/CashPaymentDetails.md: -------------------------------------------------------------------------------- 1 | 2 | # CashPaymentDetails 3 | 4 | ### Description 5 | 6 | Additional details about CASH type payments. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **buyerSuppliedMoney** | [**Money**](Money.md) | The amount and currency of the money supplied by the buyer. | 12 | **changeBackMoney** | [**Money**](Money.md) | The amount of change due back to the buyer. Read Only field calculated from the amount_money and buyer_supplied_money fields. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CatalogCategory.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogCategory 3 | 4 | ### Description 5 | 6 | A category to which a `CatalogItem` belongs in the `Catalog` object model. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **name** | **String** | The category name. Searchable. This field has max length of 255 Unicode code points. | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CatalogDiscountModifyTaxBasis.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogDiscountModifyTaxBasis 3 | 4 | 5 | * `"MODIFY_TAX_BASIS"` 6 | 7 | * `"DO_NOT_MODIFY_TAX_BASIS"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CatalogDiscountType.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogDiscountType 3 | 4 | 5 | * `"FIXED_PERCENTAGE"` 6 | 7 | * `"FIXED_AMOUNT"` 8 | 9 | * `"VARIABLE_PERCENTAGE"` 10 | 11 | * `"VARIABLE_AMOUNT"` 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CatalogIdMapping.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogIdMapping 3 | 4 | ### Description 5 | 6 | A mapping between a client-supplied temporary ID and a permanent server ID. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **clientObjectId** | **String** | The client-supplied, temporary `#`-prefixed ID for a new `CatalogObject`. | [optional] 12 | **objectId** | **String** | The permanent ID for the CatalogObject created by the server. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CatalogImage.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogImage 3 | 4 | ### Description 5 | 6 | An image file to use in Square catalogs. Can be associated with catalog items, item variations, and categories. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **name** | **String** | The internal name of this image. Identifies this image in calls to the Connect APIs. | [optional] 12 | **url** | **String** | The URL of this image. Generated by Square after an image is uploaded to the CreateCatalogImage endpoint. | [optional] 13 | **caption** | **String** | A caption that describes what is shown in the image. Displayed in the Square Online Store. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CatalogInfoRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogInfoRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CatalogInfoResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogInfoResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | The set of errors encountered. | [optional] 12 | **limits** | [**CatalogInfoResponseLimits**](CatalogInfoResponseLimits.md) | | [optional] 13 | **standardUnitDescriptionGroup** | [**StandardUnitDescriptionGroup**](StandardUnitDescriptionGroup.md) | Names and abbreviations for standard units. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CatalogItemOptionForItem.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogItemOptionForItem 3 | 4 | ### Description 5 | 6 | A list of item option values that can be assigned to item variations. For example, a t-shirt item may offer a color option or a size option. 7 | **Note: This model is in beta.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **itemOptionId** | **String** | The unique id of the item option, used to form the dimensions of the item option matrix in a specified order. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CatalogItemOptionValueForItemVariation.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogItemOptionValueForItemVariation 3 | 4 | ### Description 5 | 6 | A `CatalogItemOptionValue` links an item variation to an item option as an item option value. For example, a t-shirt item may offer a color option and a size option. An item option value would represent each variation of t-shirt: For example, \"Color:Red, Size:Small\" or \"Color:Blue, Size:Medium\". 7 | **Note: This model is in beta.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **itemOptionId** | **String** | The unique id of an item option. | [optional] 13 | **itemOptionValueId** | **String** | The unique id of the selected value for the item option. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CatalogItemProductType.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogItemProductType 3 | 4 | 5 | * `"REGULAR"` 6 | 7 | * `"GIFT_CARD"` 8 | 9 | * `"APPOINTMENTS_SERVICE"` 10 | 11 | * `"RETAIL_ITEM"` 12 | 13 | * `"RESTAURANT_ITEM"` 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CatalogMeasurementUnit.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogMeasurementUnit 3 | 4 | ### Description 5 | 6 | Represents the unit used to measure a `CatalogItemVariation` and specifies the precision for decimal quantities. 7 | **Note: This model is in beta.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **measurementUnit** | [**MeasurementUnit**](MeasurementUnit.md) | Indicates the unit used to measure the quantity of a catalog item variation. | [optional] 13 | **precision** | **Integer** | An integer between 0 and 5 that represents the maximum number of positions allowed after the decimal in quantities measured with this unit. For example: - if the precision is 0, the quantity can be 1, 2, 3, etc. - if the precision is 1, the quantity can be 0.1, 0.2, etc. - if the precision is 2, the quantity can be 0.01, 0.12, etc. Default: 3 | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CatalogModifier.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogModifier 3 | 4 | ### Description 5 | 6 | A modifier in the Catalog object model. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **name** | **String** | The modifier name. Searchable. This field has max length of 255 Unicode code points. | [optional] 12 | **priceMoney** | [**Money**](Money.md) | The modifier price. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CatalogModifierListSelectionType.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogModifierListSelectionType 3 | 4 | 5 | * `"SINGLE"` 6 | 7 | * `"MULTIPLE"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CatalogModifierOverride.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogModifierOverride 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **modifierId** | **String** | The ID of the `CatalogModifier` whose default behavior is being overridden. | 12 | **onByDefault** | **Boolean** | If `true`, this `CatalogModifier` should be selected by default for this `CatalogItem`. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CatalogObjectBatch.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogObjectBatch 3 | 4 | ### Description 5 | 6 | A batch of catalog objects. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **objects** | [**List<CatalogObject>**](CatalogObject.md) | A list of CatalogObjects belonging to this batch. | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CatalogObjectType.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogObjectType 3 | 4 | 5 | * `"ITEM"` 6 | 7 | * `"IMAGE"` 8 | 9 | * `"CATEGORY"` 10 | 11 | * `"ITEM_VARIATION"` 12 | 13 | * `"TAX"` 14 | 15 | * `"DISCOUNT"` 16 | 17 | * `"MODIFIER_LIST"` 18 | 19 | * `"MODIFIER"` 20 | 21 | * `"PRICING_RULE"` 22 | 23 | * `"PRODUCT_SET"` 24 | 25 | * `"TIME_PERIOD"` 26 | 27 | * `"MEASUREMENT_UNIT"` 28 | 29 | * `"ITEM_OPTION"` 30 | 31 | * `"ITEM_OPTION_VAL"` 32 | 33 | 34 | 35 | -------------------------------------------------------------------------------- /docs/CatalogPricingType.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogPricingType 3 | 4 | 5 | * `"FIXED_PRICING"` 6 | 7 | * `"VARIABLE_PRICING"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CatalogQueryCustomAttributeUsage.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogQueryCustomAttributeUsage 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **customAttributeDefinitionIds** | **List<String>** | | [optional] 12 | **hasValue** | **Boolean** | | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CatalogQueryExact.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogQueryExact 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **attributeName** | **String** | The name of the attribute to be searched. | 12 | **attributeValue** | **String** | The desired value of the search attribute. | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CatalogQueryFilteredItemsCustomAttributeFilter.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogQueryFilteredItemsCustomAttributeFilter 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **filterType** | **String** | See [CatalogQueryFilteredItemsCustomAttributeFilterFilterType](#type-catalogqueryfiltereditemscustomattributefilterfiltertype) for possible values | [optional] 12 | **customAttributeDefinitionIds** | **List<String>** | | [optional] 13 | **customAttributeValueExact** | **String** | | [optional] 14 | **customAttributeValuePrefix** | **String** | | [optional] 15 | **customAttributeMinValue** | **String** | | [optional] 16 | **customAttributeMaxValue** | **String** | | [optional] 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/CatalogQueryFilteredItemsCustomAttributeFilterFilterType.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogQueryFilteredItemsCustomAttributeFilterFilterType 3 | 4 | 5 | * `"CUSTOM_ATTRIBUTE_FILTER_TYPE_DO_NOT_USE"` 6 | 7 | * `"EXACT"` 8 | 9 | * `"PREFIX"` 10 | 11 | * `"RANGE"` 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CatalogQueryFilteredItemsNullableAttribute.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogQueryFilteredItemsNullableAttribute 3 | 4 | 5 | * `"VENDOR_TOKEN"` 6 | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/CatalogQueryFilteredItemsStockLevel.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogQueryFilteredItemsStockLevel 3 | 4 | 5 | * `"OUT"` 6 | 7 | * `"LOW"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CatalogQueryItemVariationsForItemOptionValues.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogQueryItemVariationsForItemOptionValues 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is in beta.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **itemOptionValueIds** | **List<String>** | A set of `CatalogItemOptionValue` IDs to be used to find associated `CatalogItemVariation`s. All ItemVariations that contain all of the given Item Option Values (in any order) will be returned. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CatalogQueryItemsForItemOptions.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogQueryItemsForItemOptions 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is in beta.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **itemOptionIds** | **List<String>** | A set of `CatalogItemOption` IDs to be used to find associated `CatalogItem`s. All Items that contain all of the given Item Options (in any order) will be returned. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CatalogQueryItemsForModifierList.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogQueryItemsForModifierList 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **modifierListIds** | **List<String>** | A set of `CatalogModifierList` IDs to be used to find associated `CatalogItem`s. | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CatalogQueryItemsForTax.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogQueryItemsForTax 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **taxIds** | **List<String>** | A set of `CatalogTax` IDs to be used to find associated `CatalogItem`s. | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CatalogQueryPrefix.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogQueryPrefix 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **attributeName** | **String** | The name of the attribute to be searched. | 12 | **attributePrefix** | **String** | The desired prefix of the search attribute value. | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CatalogQueryRange.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogQueryRange 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **attributeName** | **String** | The name of the attribute to be searched. | 12 | **attributeMinValue** | **Long** | The desired minimum value for the search attribute (inclusive). | [optional] 13 | **attributeMaxValue** | **Long** | The desired maximum value for the search attribute (inclusive). | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CatalogQuerySortedAttribute.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogQuerySortedAttribute 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **attributeName** | **String** | The attribute whose value should be used as the sort key. | 12 | **initialAttributeValue** | **String** | The first attribute value to be returned by the query. Ascending sorts will return only objects with this value or greater, while descending sorts will return only objects with this value or less. If unset, start at the beginning (for ascending sorts) or end (for descending sorts). | [optional] 13 | **sortOrder** | **String** | The desired sort order, `\"ASC\"` (ascending) or `\"DESC\"` (descending). See [SortOrder](#type-sortorder) for possible values | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CatalogQueryText.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogQueryText 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **keywords** | **List<String>** | A list of 1, 2, or 3 search keywords. Keywords with fewer than 3 characters are ignored. | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CatalogTimePeriod.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogTimePeriod 3 | 4 | ### Description 5 | 6 | Represents a time period - either a single period or a repeating period. 7 | **Note: This model is in beta.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **event** | **String** | An iCalendar (RFC5545) [event](https://tools.ietf.org/html/rfc5545#section-3.6.1), which specifies the name, timing, duration and recurrence of this time period. Example: ``` DTSTART:20190707T180000 DURATION:P2H RRULE:FREQ=WEEKLY;BYDAY=MO,WE,FR ``` Only `SUMMARY`, `DTSTART`, `DURATION` and `RRULE` fields are supported. `DTSTART` must be in local (unzoned) time format. Note that while `BEGIN:VEVENT` and `END:VEVENT` is not required in the request. The response will always include them. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CatalogV1Id.md: -------------------------------------------------------------------------------- 1 | 2 | # CatalogV1Id 3 | 4 | ### Description 5 | 6 | An Items Connect V1 object ID along with its associated location ID. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **catalogV1Id** | **String** | The ID for an object in Connect V1, if different from its Connect V2 ID. | [optional] 12 | **locationId** | **String** | The ID of the `Location` this Connect V1 ID is associated with. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/ChargeRequestAdditionalRecipient.md: -------------------------------------------------------------------------------- 1 | 2 | # ChargeRequestAdditionalRecipient 3 | 4 | ### Description 5 | 6 | Represents an additional recipient (other than the merchant) entitled to a portion of the tender. Support is currently limited to USD, CAD and GBP currencies 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **locationId** | **String** | The location ID for a recipient (other than the merchant) receiving a portion of the tender. | 13 | **description** | **String** | The description of the additional recipient. | 14 | **amountMoney** | [**Money**](Money.md) | The amount of money distributed to the recipient. | 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/ChargeResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # ChargeResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the [Charge](#endpoint-charge) endpoint. One of `errors` or `transaction` is present in a given response (never both). 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 13 | **transaction** | [**Transaction**](Transaction.md) | The created transaction. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CompletePaymentRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # CompletePaymentRequest 3 | 4 | ### Description 5 | 6 | Completes (captures) a payment. By default, payments are set to autocomplete immediately after they are created. To complete payments manually, set `autocomplete` to false. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CompletePaymentResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # CompletePaymentResponse 3 | 4 | ### Description 5 | 6 | Return value from a [CompletePayment](#endpoint-payments-completepayment) call. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request | [optional] 12 | **payment** | [**Payment**](Payment.md) | The successfully completed `Payment`. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/Coordinates.md: -------------------------------------------------------------------------------- 1 | 2 | # Coordinates 3 | 4 | ### Description 5 | 6 | Latitude and longitude coordinates. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **latitude** | [**BigDecimal**](BigDecimal.md) | The latitude of the coordinate expressed in degrees. | [optional] 12 | **longitude** | [**BigDecimal**](BigDecimal.md) | The longitude of the coordinate expressed in degrees. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CreateBreakTypeRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateBreakTypeRequest 3 | 4 | ### Description 5 | 6 | A request to create a new `BreakType` 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **idempotencyKey** | **String** | Unique string value to insure idempotency of the operation | [optional] 12 | **breakType** | [**BreakType**](BreakType.md) | The `BreakType` to be created. | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CreateBreakTypeResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateBreakTypeResponse 3 | 4 | ### Description 5 | 6 | The response to the request to create a `BreakType`. Contains the created `BreakType` object. May contain a set of `Error` objects if the request resulted in errors. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **breakType** | [**BreakType**](BreakType.md) | The `BreakType` that was created by the request. | [optional] 12 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CreateCatalogImageResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateCatalogImageResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] 12 | **image** | [**CatalogObject**](CatalogObject.md) | The newly created `CatalogImage` including a Square-generated URL for each image. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CreateCheckoutResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateCheckoutResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **checkout** | [**Checkout**](Checkout.md) | The newly created checkout. If the same request was made with the same idempotency_key, this will be the checkout created with the idempotency_key. | [optional] 12 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CreateCustomerCardResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateCustomerCardResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the CreateCustomerCard endpoint. One of `errors` or `card` is present in a given response (never both). 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 12 | **card** | [**Card**](Card.md) | The created card on file. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CreateCustomerResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateCustomerResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the CreateCustomer endpoint. One of `errors` or `customer` is present in a given response (never both). 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 12 | **customer** | [**Customer**](Customer.md) | The created customer. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CreateLocationRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateLocationRequest 3 | 4 | ### Description 5 | 6 | Request object for the [CreateLocation](#endpoint-createlocation) endpoint. 7 | **Note: This model is in beta.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **location** | [**Location**](Location.md) | The initial values of the location being created. The `name` field is required. All other fields are optional. Unspecified fields will be set to default values using existing location data. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CreateLocationResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateLocationResponse 3 | 4 | ### Description 5 | 6 | Response object returned by the [CreateLocation](#endpoint-createlocation) endpoint. 7 | **Note: This model is in beta.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request. | [optional] 13 | **location** | [**Location**](Location.md) | The newly created `Location`. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CreateMobileAuthorizationCodeRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateMobileAuthorizationCodeRequest 3 | 4 | ### Description 5 | 6 | Defines the body parameters that can be provided in a request to the __CreateMobileAuthorizationCode__ endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **locationId** | **String** | The Square location ID the authorization code should be tied to. | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CreateMobileAuthorizationCodeResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateMobileAuthorizationCodeResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the __CreateMobileAuthorizationCode__ endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **authorizationCode** | **String** | Generated authorization code that connects a mobile application instance to a Square account. | [optional] 12 | **expiresAt** | **String** | The timestamp when `authorization_code` expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] 13 | **error** | [**Error**](Error.md) | An error object that provides details about how creation of authorization code failed. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CreateOrderResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateOrderResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the CreateOrder endpoint. One of `errors` or `order` is present in a given response (never both). 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **order** | [**Order**](Order.md) | The newly created order. | [optional] 12 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CreatePaymentResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # CreatePaymentResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the [CreatePayment](#endpoint-payments-createpayment) endpoint. Note: if there are errors processing the request, the payment field may not be present, or it may be present with a status of `FAILED`. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request. | [optional] 12 | **payment** | [**Payment**](Payment.md) | The newly created payment. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CreateRefundResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateRefundResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the [CreateRefund](#endpoint-createrefund) endpoint. One of `errors` or `refund` is present in a given response (never both). 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 13 | **refund** | [**Refund**](Refund.md) | The created refund. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CreateShiftRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateShiftRequest 3 | 4 | ### Description 5 | 6 | Represents a request to create a `Shift` 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **idempotencyKey** | **String** | Unique string value to insure the idempotency of the operation. | [optional] 12 | **shift** | [**Shift**](Shift.md) | The `Shift` to be created | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CreateShiftResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # CreateShiftResponse 3 | 4 | ### Description 5 | 6 | The response to the request to create a `Shift`. Contains the created `Shift` object. May contain a set of `Error` objects if the request resulted in errors. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **shift** | [**Shift**](Shift.md) | The `Shift` that was created on the request. | [optional] 12 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CustomerCreationSource.md: -------------------------------------------------------------------------------- 1 | 2 | # CustomerCreationSource 3 | 4 | 5 | * `"OTHER"` 6 | 7 | * `"APPOINTMENTS"` 8 | 9 | * `"COUPON"` 10 | 11 | * `"DELETION_RECOVERY"` 12 | 13 | * `"DIRECTORY"` 14 | 15 | * `"EGIFTING"` 16 | 17 | * `"EMAIL_COLLECTION"` 18 | 19 | * `"FEEDBACK"` 20 | 21 | * `"IMPORT"` 22 | 23 | * `"INVOICES"` 24 | 25 | * `"LOYALTY"` 26 | 27 | * `"MARKETING"` 28 | 29 | * `"MERGE"` 30 | 31 | * `"ONLINE_STORE"` 32 | 33 | * `"INSTANT_PROFILE"` 34 | 35 | * `"TERMINAL"` 36 | 37 | * `"THIRD_PARTY"` 38 | 39 | * `"THIRD_PARTY_IMPORT"` 40 | 41 | * `"UNMERGE_RECOVERY"` 42 | 43 | 44 | 45 | -------------------------------------------------------------------------------- /docs/CustomerCreationSourceFilter.md: -------------------------------------------------------------------------------- 1 | 2 | # CustomerCreationSourceFilter 3 | 4 | ### Description 5 | 6 | Creation source filter. If one or more creation sources are set, customer profiles are included in, or excluded from, the result if they match at least one of the filter criteria. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **values** | **List<String>** | The list of creation sources used as filtering criteria. See [CustomerCreationSource](#type-customercreationsource) for possible values | [optional] 12 | **rule** | **String** | Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CustomerFilter.md: -------------------------------------------------------------------------------- 1 | 2 | # CustomerFilter 3 | 4 | ### Description 5 | 6 | Represents a set of `CustomerQuery` filters used to limit the set of `Customers` returned by SearchCustomers. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **creationSource** | [**CustomerCreationSourceFilter**](CustomerCreationSourceFilter.md) | A filter to select customers based on their creation source. | [optional] 12 | **createdAt** | [**TimeRange**](TimeRange.md) | A filter to select customers based on when they were created. | [optional] 13 | **updatedAt** | [**TimeRange**](TimeRange.md) | A filter to select customers based on when they were updated. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CustomerGroupInfo.md: -------------------------------------------------------------------------------- 1 | 2 | # CustomerGroupInfo 3 | 4 | ### Description 5 | 6 | Contains some brief information about a customer group with its identifier included. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **id** | **String** | The ID of the customer group. | 12 | **name** | **String** | The name of the customer group. | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CustomerInclusionExclusion.md: -------------------------------------------------------------------------------- 1 | 2 | # CustomerInclusionExclusion 3 | 4 | 5 | * `"INCLUDE"` 6 | 7 | * `"EXCLUDE"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CustomerPreferences.md: -------------------------------------------------------------------------------- 1 | 2 | # CustomerPreferences 3 | 4 | ### Description 5 | 6 | Represents communication preferences for the customer profile. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **emailUnsubscribed** | **Boolean** | The customer has unsubscribed from receiving marketing campaign emails. | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CustomerQuery.md: -------------------------------------------------------------------------------- 1 | 2 | # CustomerQuery 3 | 4 | ### Description 5 | 6 | Represents a query (filtering and sorting criteria) used to search for customer profiles. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **filter** | [**CustomerFilter**](CustomerFilter.md) | A list of filter criteria. | [optional] 12 | **sort** | [**CustomerSort**](CustomerSort.md) | Sort criteria for query results. The default sort behavior is to order customers alphabetically by `given_name` and `last_name`. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CustomerSort.md: -------------------------------------------------------------------------------- 1 | 2 | # CustomerSort 3 | 4 | ### Description 5 | 6 | Indicates the field to use for sorting customer profiles. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **field** | **String** | Indicates the information used to sort the results. For example, by creation date. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values | [optional] 12 | **order** | **String** | Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CustomerSortField.md: -------------------------------------------------------------------------------- 1 | 2 | # CustomerSortField 3 | 4 | 5 | * `"DEFAULT"` 6 | 7 | * `"CREATED_AT"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/DateRange.md: -------------------------------------------------------------------------------- 1 | 2 | # DateRange 3 | 4 | ### Description 5 | 6 | A range defined by two dates. Used for filtering a query for Connect v2 objects that have date properties. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **startDate** | **String** | String in `YYYY-MM-DD` format, e.g. `2017-10-31` per the ISO 8601 extended format for calendar dates. The beginning of a date range (inclusive) | [optional] 12 | **endDate** | **String** | String in `YYYY-MM-DD` format, e.g. `2017-10-31` per the ISO 8601 extended format for calendar dates. The end of a date range (inclusive) | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/DayOfWeek.md: -------------------------------------------------------------------------------- 1 | 2 | # DayOfWeek 3 | 4 | 5 | * `"SUN"` 6 | 7 | * `"MON"` 8 | 9 | * `"TUE"` 10 | 11 | * `"WED"` 12 | 13 | * `"THU"` 14 | 15 | * `"FRI"` 16 | 17 | * `"SAT"` 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/DeleteBreakTypeRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # DeleteBreakTypeRequest 3 | 4 | ### Description 5 | 6 | A request to delete a `BreakType` 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/DeleteBreakTypeResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # DeleteBreakTypeResponse 3 | 4 | ### Description 5 | 6 | The response to a request to delete a `BreakType`. May contain a set of `Error` objects if the request resulted in errors. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/DeleteCatalogObjectRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # DeleteCatalogObjectRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/DeleteCatalogObjectResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # DeleteCatalogObjectResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] 12 | **deletedObjectIds** | **List<String>** | The IDs of all catalog objects deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a catalog item variation will be deleted (and its ID included in this field) when its parent catalog item is deleted. | [optional] 13 | **deletedAt** | **String** | The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/DeleteCustomerCardRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # DeleteCustomerCardRequest 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in requests to the DeleteCustomerCard endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/DeleteCustomerCardResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # DeleteCustomerCardResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the DeleteCustomerCard endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/DeleteCustomerRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # DeleteCustomerRequest 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in a request to the DeleteCustomer endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/DeleteCustomerResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # DeleteCustomerResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the DeleteCustomer endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/DeleteShiftRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # DeleteShiftRequest 3 | 4 | ### Description 5 | 6 | A request to delete a `Shift` 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/DeleteShiftResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # DeleteShiftResponse 3 | 4 | ### Description 5 | 6 | The response to a request to delete a `Shift`. May contain a set of `Error` objects if the request resulted in errors. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/Device.md: -------------------------------------------------------------------------------- 1 | 2 | # Device 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **id** | **String** | The device's Square-issued ID. | [optional] 13 | **name** | **String** | The device's merchant-specified name. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/EmployeeStatus.md: -------------------------------------------------------------------------------- 1 | 2 | # EmployeeStatus 3 | 4 | 5 | * `"ACTIVE"` 6 | 7 | * `"INACTIVE"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/EmployeeWage.md: -------------------------------------------------------------------------------- 1 | 2 | # EmployeeWage 3 | 4 | ### Description 5 | 6 | The hourly wage rate that an employee will earn on a `Shift` for doing the job specified by the `title` property of this object. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **id** | **String** | UUID for this object. | [optional] 12 | **employeeId** | **String** | The `Employee` that this wage is assigned to. | 13 | **title** | **String** | The job title that this wage relates to. | [optional] 14 | **hourlyRate** | [**Money**](Money.md) | Can be a custom-set hourly wage or the calculated effective hourly wage based on annual wage and hours worked per week. | [optional] 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/Error.md: -------------------------------------------------------------------------------- 1 | 2 | # Error 3 | 4 | ### Description 5 | 6 | Represents an error encountered during a request to the Connect API. See [Handling errors](#handlingerrors) for more information. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **category** | **String** | The high-level category for the error. See `ErrorCategory` for possible values. See [ErrorCategory](#type-errorcategory) for possible values | 12 | **code** | **String** | The specific code of the error. See `ErrorCode` for possible values See [ErrorCode](#type-errorcode) for possible values | 13 | **detail** | **String** | A human-readable description of the error for debugging purposes. | [optional] 14 | **field** | **String** | The name of the field provided in the original request (if any) that the error pertains to. | [optional] 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/ErrorCategory.md: -------------------------------------------------------------------------------- 1 | 2 | # ErrorCategory 3 | 4 | 5 | * `"API_ERROR"` 6 | 7 | * `"AUTHENTICATION_ERROR"` 8 | 9 | * `"INVALID_REQUEST_ERROR"` 10 | 11 | * `"RATE_LIMIT_ERROR"` 12 | 13 | * `"PAYMENT_METHOD_ERROR"` 14 | 15 | * `"REFUND_ERROR"` 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/ExcludeStrategy.md: -------------------------------------------------------------------------------- 1 | 2 | # ExcludeStrategy 3 | 4 | 5 | * `"LEAST_EXPENSIVE"` 6 | 7 | * `"MOST_EXPENSIVE"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/GetBreakTypeRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # GetBreakTypeRequest 3 | 4 | ### Description 5 | 6 | A request to GET a `BreakType` by ID 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetBreakTypeResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # GetBreakTypeResponse 3 | 4 | ### Description 5 | 6 | The response to a request to get a `BreakType`. Contains the requested `BreakType` objects. May contain a set of `Error` objects if the request resulted in errors. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **breakType** | [**BreakType**](BreakType.md) | The response object. | [optional] 12 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/GetEmployeeWageRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # GetEmployeeWageRequest 3 | 4 | ### Description 5 | 6 | A request to get an `EmployeeWage` 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetEmployeeWageResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # GetEmployeeWageResponse 3 | 4 | ### Description 5 | 6 | A response to a request to get an `EmployeeWage`. Contains the requested `EmployeeWage` objects. May contain a set of `Error` objects if the request resulted in errors. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **employeeWage** | [**EmployeeWage**](EmployeeWage.md) | The requested `EmployeeWage` object. | [optional] 12 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/GetPaymentRefundRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # GetPaymentRefundRequest 3 | 4 | ### Description 5 | 6 | Retrieves a specific `Refund` using the `refund_id`. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetPaymentRefundResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # GetPaymentRefundResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the [GetRefund](#endpoint-refunds-getpaymentrefund) endpoint. Note: if there are errors processing the request, the refund field may not be present, or it may be present in a FAILED state. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request. | [optional] 12 | **refund** | [**PaymentRefund**](PaymentRefund.md) | The requested `PaymentRefund`. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/GetPaymentRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # GetPaymentRequest 3 | 4 | ### Description 5 | 6 | Retrieve details for a specific Payment. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetPaymentResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # GetPaymentResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the [GetPayment](#endpoint-payments-getpayment) endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request. | [optional] 12 | **payment** | [**Payment**](Payment.md) | The requested `Payment`. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/GetShiftRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # GetShiftRequest 3 | 4 | ### Description 5 | 6 | A request to get a `Shift` by ID 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/GetShiftResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # GetShiftResponse 3 | 4 | ### Description 5 | 6 | A response to request to get a `Shift`. Contains the requested `Shift` object. May contain a set of `Error` objects if the request resulted in errors. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **shift** | [**Shift**](Shift.md) | The requested `Shift`. | [optional] 12 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/InventoryAlertType.md: -------------------------------------------------------------------------------- 1 | 2 | # InventoryAlertType 3 | 4 | 5 | * `"NONE"` 6 | 7 | * `"LOW_QUANTITY"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/InventoryChangeType.md: -------------------------------------------------------------------------------- 1 | 2 | # InventoryChangeType 3 | 4 | 5 | * `"PHYSICAL_COUNT"` 6 | 7 | * `"ADJUSTMENT"` 8 | 9 | * `"TRANSFER"` 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/InventoryState.md: -------------------------------------------------------------------------------- 1 | 2 | # InventoryState 3 | 4 | 5 | * `"CUSTOM"` 6 | 7 | * `"IN_STOCK"` 8 | 9 | * `"SOLD"` 10 | 11 | * `"RETURNED_BY_CUSTOMER"` 12 | 13 | * `"RESERVED_FOR_SALE"` 14 | 15 | * `"SOLD_ONLINE"` 16 | 17 | * `"ORDERED_FROM_VENDOR"` 18 | 19 | * `"RECEIVED_FROM_VENDOR"` 20 | 21 | * `"IN_TRANSIT_TO"` 22 | 23 | * `"NONE"` 24 | 25 | * `"WASTE"` 26 | 27 | * `"UNLINKED_RETURN"` 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/ListBreakTypesRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # ListBreakTypesRequest 3 | 4 | ### Description 5 | 6 | A request for a filtered set of `BreakType` objects 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **locationId** | **String** | Filter Break Types returned to only those that are associated with the specified location. | [optional] 12 | **limit** | **Integer** | Maximum number of Break Types to return per page. Can range between 1 and 200. The default is the maximum at 200. | [optional] 13 | **cursor** | **String** | Pointer to the next page of Break Type results to fetch. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ListBreakTypesResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # ListBreakTypesResponse 3 | 4 | ### Description 5 | 6 | The response to a request for a set of `BreakTypes`. Contains the requested `BreakType` objects. May contain a set of `Error` objects if the request resulted in errors. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **breakTypes** | [**List<BreakType>**](BreakType.md) | A page of `BreakType` results. | [optional] 12 | **cursor** | **String** | Value supplied in the subsequent request to fetch the next next page of Break Type results. | [optional] 13 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ListCatalogRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # ListCatalogRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **cursor** | **String** | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] 12 | **types** | **String** | An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/ListCatalogResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # ListCatalogResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] 12 | **cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] 13 | **objects** | [**List<CatalogObject>**](CatalogObject.md) | The CatalogObjects returned. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ListCustomersResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # ListCustomersResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the ListCustomers endpoint. One of `errors` or `customers` is present in a given response (never both). 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 12 | **customers** | [**List<Customer>**](Customer.md) | An array of `Customer` objects that match the provided query. | [optional] 13 | **cursor** | **String** | A pagination cursor to retrieve the next set of results for the original query. Only present if the request succeeded and additional results are available. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ListEmployeeWagesRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # ListEmployeeWagesRequest 3 | 4 | ### Description 5 | 6 | A request for a set of `EmployeeWage` objects 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **employeeId** | **String** | Filter wages returned to only those that are associated with the specified employee. | [optional] 12 | **limit** | **Integer** | Maximum number of Employee Wages to return per page. Can range between 1 and 200. The default is the maximum at 200. | [optional] 13 | **cursor** | **String** | Pointer to the next page of Employee Wage results to fetch. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ListEmployeeWagesResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # ListEmployeeWagesResponse 3 | 4 | ### Description 5 | 6 | The response to a request for a set of `EmployeeWage` objects. Contains a set of `EmployeeWage`. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **employeeWages** | [**List<EmployeeWage>**](EmployeeWage.md) | A page of Employee Wage results. | [optional] 12 | **cursor** | **String** | Value supplied in the subsequent request to fetch the next next page of Employee Wage results. | [optional] 13 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ListEmployeesRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # ListEmployeesRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **locationId** | **String** | Filter employees returned to only those that are associated with the specified location. | [optional] 12 | **status** | **String** | Specifies the EmployeeStatus to filter the employee by. See [EmployeeStatus](#type-employeestatus) for possible values | [optional] 13 | **limit** | **Integer** | The number of employees to be returned on each page. | [optional] 14 | **cursor** | **String** | The token required to retrieve the specified page of results. | [optional] 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/ListEmployeesResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # ListEmployeesResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **employees** | [**List<Employee>**](Employee.md) | List of employees returned from the request. | [optional] 12 | **cursor** | **String** | The token to be used to retrieve the next page of results. | [optional] 13 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ListLocationsRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # ListLocationsRequest 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in requests to the __ListLocations__ endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ListLocationsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # ListLocationsResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the __ListLocations__ endpoint. One of `errors` or `locations` is present in a given response (never both). 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 12 | **locations** | [**List<Location>**](Location.md) | The business locations. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/ListMerchantsRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # ListMerchantsRequest 3 | 4 | ### Description 5 | 6 | Request object for the [ListMerchant](#endpoint-listmerchant) endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **cursor** | **Integer** | The cursor generated by the previous response. | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/ListMerchantsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # ListMerchantsResponse 3 | 4 | ### Description 5 | 6 | The response object returned by the [ListMerchant](#endpoint-listmerchant) endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request. | [optional] 12 | **merchant** | [**List<Merchant>**](Merchant.md) | The requested `Merchant` entities. | [optional] 13 | **cursor** | **Integer** | If the response is truncated, the cursor to use in next request to fetch next set of objects. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ListPaymentRefundsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # ListPaymentRefundsResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the [ListPaymentRefunds](#endpoint-refunds-listpaymentrefunds) endpoint. One of `errors` or `refunds` is present in a given response (never both). 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request. | [optional] 12 | **refunds** | [**List<PaymentRefund>**](PaymentRefund.md) | The list of requested refunds. | [optional] 13 | **cursor** | **String** | The pagination cursor to be used in a subsequent request. If empty, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ListPaymentsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # ListPaymentsResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the [ListPayments](#endpoint-payments-listpayments) endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request. | [optional] 12 | **payments** | [**List<Payment>**](Payment.md) | The requested list of `Payment`s. | [optional] 13 | **cursor** | **String** | The pagination cursor to be used in a subsequent request. If empty, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ListRefundsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # ListRefundsResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the [ListRefunds](#endpoint-listrefunds) endpoint. One of `errors` or `refunds` is present in a given response (never both). 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 13 | **refunds** | [**List<Refund>**](Refund.md) | An array of refunds that match your query. | [optional] 14 | **cursor** | **String** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. | [optional] 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/ListTransactionsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # ListTransactionsResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the [ListTransactions](#endpoint-listtransactions) endpoint. One of `errors` or `transactions` is present in a given response (never both). 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 13 | **transactions** | [**List<Transaction>**](Transaction.md) | An array of transactions that match your query. | [optional] 14 | **cursor** | **String** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. | [optional] 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/ListWorkweekConfigsRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # ListWorkweekConfigsRequest 3 | 4 | ### Description 5 | 6 | A request for a set of `WorkweekConfig` objects 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **limit** | **Integer** | Maximum number of Workweek Configs to return per page. | [optional] 12 | **cursor** | **String** | Pointer to the next page of Workweek Config results to fetch. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/ListWorkweekConfigsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # ListWorkweekConfigsResponse 3 | 4 | ### Description 5 | 6 | The response to a request for a set of `WorkweekConfig` objects. Contains the requested `WorkweekConfig` objects. May contain a set of `Error` objects if the request resulted in errors. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **workweekConfigs** | [**List<WorkweekConfig>**](WorkweekConfig.md) | A page of Employee Wage results. | [optional] 12 | **cursor** | **String** | Value supplied in the subsequent request to fetch the next page of Employee Wage results. | [optional] 13 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/LocationCapability.md: -------------------------------------------------------------------------------- 1 | 2 | # LocationCapability 3 | 4 | 5 | * `"CREDIT_CARD_PROCESSING"` 6 | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/LocationStatus.md: -------------------------------------------------------------------------------- 1 | 2 | # LocationStatus 3 | 4 | 5 | * `"ACTIVE"` 6 | 7 | * `"INACTIVE"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/LocationType.md: -------------------------------------------------------------------------------- 1 | 2 | # LocationType 3 | 4 | 5 | * `"PHYSICAL"` 6 | 7 | * `"MOBILE"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/MeasurementUnitArea.md: -------------------------------------------------------------------------------- 1 | 2 | # MeasurementUnitArea 3 | 4 | 5 | * `"IMPERIAL_ACRE"` 6 | 7 | * `"IMPERIAL_SQUARE_INCH"` 8 | 9 | * `"IMPERIAL_SQUARE_FOOT"` 10 | 11 | * `"IMPERIAL_SQUARE_YARD"` 12 | 13 | * `"IMPERIAL_SQUARE_MILE"` 14 | 15 | * `"METRIC_SQUARE_CENTIMETER"` 16 | 17 | * `"METRIC_SQUARE_METER"` 18 | 19 | * `"METRIC_SQUARE_KILOMETER"` 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/MeasurementUnitCustom.md: -------------------------------------------------------------------------------- 1 | 2 | # MeasurementUnitCustom 3 | 4 | ### Description 5 | 6 | The information needed to define a custom unit, provided by the seller. 7 | **Note: This model is in beta.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **name** | **String** | The name of the custom unit, for example \"bushel\". | 13 | **abbreviation** | **String** | The abbreviation of the custom unit, such as \"bsh\" (bushel). This appears in the cart for the Point of Sale app, and in reports. | 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/MeasurementUnitGeneric.md: -------------------------------------------------------------------------------- 1 | 2 | # MeasurementUnitGeneric 3 | 4 | 5 | * `"UNIT"` 6 | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/MeasurementUnitLength.md: -------------------------------------------------------------------------------- 1 | 2 | # MeasurementUnitLength 3 | 4 | 5 | * `"IMPERIAL_INCH"` 6 | 7 | * `"IMPERIAL_FOOT"` 8 | 9 | * `"IMPERIAL_YARD"` 10 | 11 | * `"IMPERIAL_MILE"` 12 | 13 | * `"METRIC_MILLIMETER"` 14 | 15 | * `"METRIC_CENTIMETER"` 16 | 17 | * `"METRIC_METER"` 18 | 19 | * `"METRIC_KILOMETER"` 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/MeasurementUnitTime.md: -------------------------------------------------------------------------------- 1 | 2 | # MeasurementUnitTime 3 | 4 | 5 | * `"GENERIC_MILLISECOND"` 6 | 7 | * `"GENERIC_SECOND"` 8 | 9 | * `"GENERIC_MINUTE"` 10 | 11 | * `"GENERIC_HOUR"` 12 | 13 | * `"GENERIC_DAY"` 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/MeasurementUnitUnitType.md: -------------------------------------------------------------------------------- 1 | 2 | # MeasurementUnitUnitType 3 | 4 | 5 | * `"TYPE_CUSTOM"` 6 | 7 | * `"TYPE_AREA"` 8 | 9 | * `"TYPE_LENGTH"` 10 | 11 | * `"TYPE_VOLUME"` 12 | 13 | * `"TYPE_WEIGHT"` 14 | 15 | * `"TYPE_GENERIC"` 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/MeasurementUnitVolume.md: -------------------------------------------------------------------------------- 1 | 2 | # MeasurementUnitVolume 3 | 4 | 5 | * `"GENERIC_FLUID_OUNCE"` 6 | 7 | * `"GENERIC_SHOT"` 8 | 9 | * `"GENERIC_CUP"` 10 | 11 | * `"GENERIC_PINT"` 12 | 13 | * `"GENERIC_QUART"` 14 | 15 | * `"GENERIC_GALLON"` 16 | 17 | * `"IMPERIAL_CUBIC_INCH"` 18 | 19 | * `"IMPERIAL_CUBIC_FOOT"` 20 | 21 | * `"IMPERIAL_CUBIC_YARD"` 22 | 23 | * `"METRIC_MILLILITER"` 24 | 25 | * `"METRIC_LITER"` 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/MeasurementUnitWeight.md: -------------------------------------------------------------------------------- 1 | 2 | # MeasurementUnitWeight 3 | 4 | 5 | * `"IMPERIAL_WEIGHT_OUNCE"` 6 | 7 | * `"IMPERIAL_POUND"` 8 | 9 | * `"IMPERIAL_STONE"` 10 | 11 | * `"METRIC_MILLIGRAM"` 12 | 13 | * `"METRIC_GRAM"` 14 | 15 | * `"METRIC_KILOGRAM"` 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/Merchant.md: -------------------------------------------------------------------------------- 1 | 2 | # Merchant 3 | 4 | ### Description 5 | 6 | Represents a Square seller. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **id** | **String** | The Square-issued ID of the merchant. | [optional] 12 | **businessName** | **String** | The business name of the merchant. | [optional] 13 | **country** | **String** | The country code associated with the merchant account, in ISO 3166-1-alpha-2 format. See [Country](#type-country) for possible values | 14 | **languageCode** | **String** | The language code associated with the merchant account, in BCP 47 format. | [optional] 15 | **currency** | **String** | The currency associated with the merchant account, in ISO 4217 format. See [Currency](#type-currency) for possible values | [optional] 16 | **status** | **String** | The merchant status, active or inactive. See [MerchantStatus](#type-merchantstatus) for possible values | [optional] 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/MerchantStatus.md: -------------------------------------------------------------------------------- 1 | 2 | # MerchantStatus 3 | 4 | 5 | * `"ACTIVE"` 6 | 7 | * `"INACTIVE"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/OrderEntry.md: -------------------------------------------------------------------------------- 1 | 2 | # OrderEntry 3 | 4 | ### Description 5 | 6 | A lightweight description of an [Order](#type-order) that is returned when `returned_entries` is true on a [SearchOrderRequest](#type-searchorderrequest) 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **orderId** | **String** | The id of the Order | [optional] 12 | **version** | **Integer** | Version number which is incremented each time an update is committed to the order. Orders that were not created through the API will not include a version and thus cannot be updated. [Read more about working with versions](https://developer.squareup.com/docs/orders-api/manage-orders#update-orders). | [optional] [beta] 13 | **locationId** | **String** | The location id the Order belongs to. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/OrderFulfillmentPickupDetailsScheduleType.md: -------------------------------------------------------------------------------- 1 | 2 | # OrderFulfillmentPickupDetailsScheduleType 3 | 4 | 5 | * `"SCHEDULED"` 6 | 7 | * `"ASAP"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/OrderFulfillmentState.md: -------------------------------------------------------------------------------- 1 | 2 | # OrderFulfillmentState 3 | 4 | 5 | * `"PROPOSED"` 6 | 7 | * `"RESERVED"` 8 | 9 | * `"PREPARED"` 10 | 11 | * `"COMPLETED"` 12 | 13 | * `"CANCELED"` 14 | 15 | * `"FAILED"` 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/OrderFulfillmentType.md: -------------------------------------------------------------------------------- 1 | 2 | # OrderFulfillmentType 3 | 4 | 5 | * `"PICKUP"` 6 | 7 | * `"SHIPMENT"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/OrderLineItemDiscountScope.md: -------------------------------------------------------------------------------- 1 | 2 | # OrderLineItemDiscountScope 3 | 4 | 5 | * `"OTHER_DISCOUNT_SCOPE"` 6 | 7 | * `"LINE_ITEM"` 8 | 9 | * `"ORDER"` 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/OrderLineItemDiscountType.md: -------------------------------------------------------------------------------- 1 | 2 | # OrderLineItemDiscountType 3 | 4 | 5 | * `"UNKNOWN_DISCOUNT"` 6 | 7 | * `"FIXED_PERCENTAGE"` 8 | 9 | * `"FIXED_AMOUNT"` 10 | 11 | * `"VARIABLE_PERCENTAGE"` 12 | 13 | * `"VARIABLE_AMOUNT"` 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/OrderLineItemTaxScope.md: -------------------------------------------------------------------------------- 1 | 2 | # OrderLineItemTaxScope 3 | 4 | 5 | * `"OTHER_TAX_SCOPE"` 6 | 7 | * `"LINE_ITEM"` 8 | 9 | * `"ORDER"` 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/OrderLineItemTaxType.md: -------------------------------------------------------------------------------- 1 | 2 | # OrderLineItemTaxType 3 | 4 | 5 | * `"UNKNOWN_TAX"` 6 | 7 | * `"ADDITIVE"` 8 | 9 | * `"INCLUSIVE"` 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/OrderMoneyAmounts.md: -------------------------------------------------------------------------------- 1 | 2 | # OrderMoneyAmounts 3 | 4 | ### Description 5 | 6 | A collection of various money amounts. 7 | **Note: This model is in beta.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **totalMoney** | [**Money**](Money.md) | Total money. | [optional] 13 | **taxMoney** | [**Money**](Money.md) | Money associated with taxes. | [optional] 14 | **discountMoney** | [**Money**](Money.md) | Money associated with discounts. | [optional] 15 | **tipMoney** | [**Money**](Money.md) | Money associated with tips. | [optional] 16 | **serviceChargeMoney** | [**Money**](Money.md) | Money associated with service charges. | [optional] 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/OrderQuantityUnit.md: -------------------------------------------------------------------------------- 1 | 2 | # OrderQuantityUnit 3 | 4 | ### Description 5 | 6 | Contains the measurement unit for a quantity and a precision which specifies the number of digits after the decimal point for decimal quantities. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **measurementUnit** | [**MeasurementUnit**](MeasurementUnit.md) | A `MeasurementUnit` that represents the unit of measure for the quantity. | [optional] 12 | **precision** | **Integer** | For non-integer quantities, represents the number of digits after the decimal point that are recorded for this quantity. For example, a precision of 1 allows quantities like `\"1.0\"` and `\"1.1\"`, but not `\"1.01\"`. Min: 0. Max: 5. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/OrderRoundingAdjustment.md: -------------------------------------------------------------------------------- 1 | 2 | # OrderRoundingAdjustment 3 | 4 | ### Description 5 | 6 | A rounding adjustment of the money being returned. Commonly used to apply Cash Rounding when the minimum unit of account is smaller than the lowest physical denomination of currency. 7 | **Note: This model is in beta.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **uid** | **String** | Unique ID that identifies the rounding adjustment only within this order. | [optional] 13 | **name** | **String** | The name of the rounding adjustment from the original sale Order. | [optional] 14 | **amountMoney** | [**Money**](Money.md) | Actual rounding adjustment amount. | [optional] 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/OrderServiceChargeCalculationPhase.md: -------------------------------------------------------------------------------- 1 | 2 | # OrderServiceChargeCalculationPhase 3 | 4 | 5 | * `"SUBTOTAL_PHASE"` 6 | 7 | * `"TOTAL_PHASE"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/OrderSource.md: -------------------------------------------------------------------------------- 1 | 2 | # OrderSource 3 | 4 | ### Description 5 | 6 | Represents the origination details of an order. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **name** | **String** | The name used to identify the place (physical or digital) that an order originates. If unset, the name defaults to the name of the application that created the order. | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/OrderState.md: -------------------------------------------------------------------------------- 1 | 2 | # OrderState 3 | 4 | 5 | * `"OPEN"` 6 | 7 | * `"COMPLETED"` 8 | 9 | * `"CANCELED"` 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PayOrderRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # PayOrderRequest 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in requests to the [PayOrder](#endpoint-payorder) endpoint. 7 | **Note: This model is in beta.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **idempotencyKey** | **String** | A value you specify that uniquely identifies this request among requests you've sent. If you're unsure whether a particular payment request was completed successfully, you can reattempt it with the same idempotency key without worrying about duplicate payments. See [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency) for more information. | 13 | **orderVersion** | **Integer** | The version of the order being paid. If not supplied, the latest version will be paid. | [optional] 14 | **paymentIds** | **List<String>** | | [optional] 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/PayOrderResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # PayOrderResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the [PayOrder](#endpoint-payorder) endpoint. 7 | **Note: This model is in beta.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 13 | **order** | [**Order**](Order.md) | The paid, updated `order`. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ProcessingFee.md: -------------------------------------------------------------------------------- 1 | 2 | # ProcessingFee 3 | 4 | ### Description 5 | 6 | Represents Square processing fee. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **effectiveAt** | **String** | Timestamp of when the fee takes effect, in RFC 3339 format. | [optional] 12 | **type** | **String** | The type of fee assessed or adjusted. Can be one of: `INITIAL`, `ADJUSTMENT`. | [optional] 13 | **amountMoney** | [**Money**](Money.md) | The fee amount assessed or adjusted by Square. May be negative. Positive values represent funds being assessed, while negative values represent funds being returned. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/Product.md: -------------------------------------------------------------------------------- 1 | 2 | # Product 3 | 4 | 5 | * `"SQUARE_POS"` 6 | 7 | * `"EXTERNAL_API"` 8 | 9 | * `"BILLING"` 10 | 11 | * `"APPOINTMENTS"` 12 | 13 | * `"INVOICES"` 14 | 15 | * `"ONLINE_STORE"` 16 | 17 | * `"PAYROLL"` 18 | 19 | * `"DASHBOARD"` 20 | 21 | * `"ITEM_LIBRARY_IMPORT"` 22 | 23 | * `"OTHER"` 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/RefundPaymentResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # RefundPaymentResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the [RefundPayment](#endpoint-refunds-refundpayment) endpoint. Note: if there are errors processing the request, the refund field may not be present, or it may be present in a FAILED state. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request. | [optional] 12 | **refund** | [**PaymentRefund**](PaymentRefund.md) | The successfully created `PaymentRefund`. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/RefundStatus.md: -------------------------------------------------------------------------------- 1 | 2 | # RefundStatus 3 | 4 | 5 | * `"PENDING"` 6 | 7 | * `"APPROVED"` 8 | 9 | * `"REJECTED"` 10 | 11 | * `"FAILED"` 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/RegisterDomainRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # RegisterDomainRequest 3 | 4 | ### Description 5 | 6 | Defines the parameters that can be included in the body of a request to the __RegisterDomain__ endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **domainName** | **String** | A domain name as described in RFC-1034 that will be registered with ApplePay | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/RegisterDomainResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # RegisterDomainResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the __RegisterDomain__ endpoint. Either `errors` or `status` will be present in a given response (never both). 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 12 | **status** | **String** | Status of the domain registration. See `RegisterDomainResponseStatus` for possible values. See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/RegisterDomainResponseStatus.md: -------------------------------------------------------------------------------- 1 | 2 | # RegisterDomainResponseStatus 3 | 4 | 5 | * `"PENDING"` 6 | 7 | * `"VERIFIED"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/RenewTokenRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # RenewTokenRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **accessToken** | **String** | The token you want to renew. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/RetrieveCatalogObjectRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # RetrieveCatalogObjectRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **includeRelatedObjects** | **Boolean** | If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a CatalogItem, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false` | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/RetrieveCatalogObjectResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # RetrieveCatalogObjectResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] 12 | **object** | [**CatalogObject**](CatalogObject.md) | The CatalogObjects returned. | [optional] 13 | **relatedObjects** | [**List<CatalogObject>**](CatalogObject.md) | A list of CatalogObjects referenced by the object in the `object` field. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/RetrieveCustomerRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # RetrieveCustomerRequest 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in requests to the RetrieveCustomer endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/RetrieveCustomerResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # RetrieveCustomerResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the RetrieveCustomer endpoint. One of `errors` or `customer` is present in a given response (never both). 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 12 | **customer** | [**Customer**](Customer.md) | The requested customer. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/RetrieveEmployeeRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # RetrieveEmployeeRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/RetrieveEmployeeResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # RetrieveEmployeeResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **employee** | [**Employee**](Employee.md) | The response object. | [optional] 12 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/RetrieveInventoryAdjustmentRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # RetrieveInventoryAdjustmentRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/RetrieveInventoryAdjustmentResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # RetrieveInventoryAdjustmentResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 12 | **adjustment** | [**InventoryAdjustment**](InventoryAdjustment.md) | The requested `InventoryAdjustment`. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/RetrieveInventoryChangesRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # RetrieveInventoryChangesRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **locationIds** | **String** | The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. | [optional] 12 | **cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/RetrieveInventoryChangesResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # RetrieveInventoryChangesResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 12 | **changes** | [**List<InventoryChange>**](InventoryChange.md) | The set of inventory changes for the requested object and locations. | [optional] 13 | **cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/RetrieveInventoryCountRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # RetrieveInventoryCountRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **locationIds** | **String** | The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. | [optional] 12 | **cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/RetrieveInventoryCountResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # RetrieveInventoryCountResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 12 | **counts** | [**List<InventoryCount>**](InventoryCount.md) | The current calculated inventory counts for the requested object and locations. | [optional] 13 | **cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/RetrieveInventoryPhysicalCountRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # RetrieveInventoryPhysicalCountRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/RetrieveInventoryPhysicalCountResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # RetrieveInventoryPhysicalCountResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 12 | **count** | [**InventoryPhysicalCount**](InventoryPhysicalCount.md) | The requested `InventoryPhysicalCount`. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/RetrieveLocationRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # RetrieveLocationRequest 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the request body for the __RetrieveLocation__ endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/RetrieveLocationResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # RetrieveLocationResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that the [RetrieveLocation](#endpoint-retrievelocation) endpoint returns in a response. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request. | [optional] 12 | **location** | [**Location**](Location.md) | The requested location. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/RetrieveMerchantRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # RetrieveMerchantRequest 3 | 4 | ### Description 5 | 6 | Request object for the [RetrieveMerchant](#endpoint-retrievemerchant) endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/RetrieveMerchantResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # RetrieveMerchantResponse 3 | 4 | ### Description 5 | 6 | The response object returned by the [RetrieveMerchant](#endpoint-retrieveMerchant) endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request. | [optional] 12 | **merchant** | [**Merchant**](Merchant.md) | The requested `Merchant` object. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/RetrieveTransactionRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # RetrieveTransactionRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/RetrieveTransactionResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # RetrieveTransactionResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the [RetrieveTransaction](#endpont-retrievetransaction) endpoint. One of `errors` or `transaction` is present in a given response (never both). 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 13 | **transaction** | [**Transaction**](Transaction.md) | The requested transaction. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/RevokeTokenRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # RevokeTokenRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **clientId** | **String** | The Square issued ID for your application, available from the [application dashboard](https://connect.squareup.com/apps). | [optional] 12 | **accessToken** | **String** | The access token of the merchant whose token you want to revoke. Do not provide a value for merchant_id if you provide this parameter. | [optional] 13 | **merchantId** | **String** | The ID of the merchant whose token you want to revoke. Do not provide a value for access_token if you provide this parameter. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/RevokeTokenResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # RevokeTokenResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **success** | **Boolean** | If the request is successful, this is true. | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/SearchOrdersCustomerFilter.md: -------------------------------------------------------------------------------- 1 | 2 | # SearchOrdersCustomerFilter 3 | 4 | ### Description 5 | 6 | Filter based on Order `customer_id` and any Tender `customer_id` associated with the Order. Does not filter based on the [FulfillmentRecipient](#type-orderfulfillmentrecipient) `customer_id`. 7 | **Note: This model is in beta.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **customerIds** | **List<String>** | List of customer IDs to filter by. Max: 10 customer IDs. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/SearchOrdersFulfillmentFilter.md: -------------------------------------------------------------------------------- 1 | 2 | # SearchOrdersFulfillmentFilter 3 | 4 | ### Description 5 | 6 | Filter based on [Order Fulfillment](#type-orderfulfillment) information. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **fulfillmentTypes** | **List<String>** | List of `fulfillment types` to filter for. Will return orders if any of its fulfillments match any of the fulfillment types listed in this field. See [OrderFulfillmentType](#type-orderfulfillmenttype) for possible values | 12 | **fulfillmentStates** | **List<String>** | List of `fulfillment states` to filter for. Will return orders if any of its fulfillments match any of the fulfillment states listed in this field. See [OrderFulfillmentState](#type-orderfulfillmentstate) for possible values | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/SearchOrdersQuery.md: -------------------------------------------------------------------------------- 1 | 2 | # SearchOrdersQuery 3 | 4 | ### Description 5 | 6 | Contains query criteria for the search. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **filter** | [**SearchOrdersFilter**](SearchOrdersFilter.md) | Criteria to filter results by. | [optional] 12 | **sort** | [**SearchOrdersSort**](SearchOrdersSort.md) | Criteria to sort results by. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/SearchOrdersSortField.md: -------------------------------------------------------------------------------- 1 | 2 | # SearchOrdersSortField 3 | 4 | 5 | * `"CREATED_AT"` 6 | 7 | * `"UPDATED_AT"` 8 | 9 | * `"CLOSED_AT"` 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SearchOrdersSourceFilter.md: -------------------------------------------------------------------------------- 1 | 2 | # SearchOrdersSourceFilter 3 | 4 | ### Description 5 | 6 | Filter based on order `source` information. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **sourceNames** | **List<String>** | Filters by `Source` `name`. Will return any orders with with a `source.name` that matches any of the listed source names. Max: 10 source names. | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/SearchOrdersStateFilter.md: -------------------------------------------------------------------------------- 1 | 2 | # SearchOrdersStateFilter 3 | 4 | ### Description 5 | 6 | Filter by current Order `state`. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **states** | **List<String>** | States to filter for. See [OrderState](#type-orderstate) for possible values | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/SearchShiftsRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # SearchShiftsRequest 3 | 4 | ### Description 5 | 6 | A request for a filtered and sorted set of `Shift` objects. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **query** | [**ShiftQuery**](ShiftQuery.md) | Query filters. | [optional] 12 | **limit** | **Integer** | number of resources in a page (200 by default). | [optional] 13 | **cursor** | **String** | opaque cursor for fetching the next page. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/SearchShiftsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # SearchShiftsResponse 3 | 4 | ### Description 5 | 6 | The response to a request for `Shift` objects. Contains the requested `Shift` objects. May contain a set of `Error` objects if the request resulted in errors. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **shifts** | [**List<Shift>**](Shift.md) | Shifts | [optional] 12 | **cursor** | **String** | Opaque cursor for fetching the next page. | [optional] 13 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ShiftFilterStatus.md: -------------------------------------------------------------------------------- 1 | 2 | # ShiftFilterStatus 3 | 4 | 5 | * `"OPEN"` 6 | 7 | * `"CLOSED"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ShiftQuery.md: -------------------------------------------------------------------------------- 1 | 2 | # ShiftQuery 3 | 4 | ### Description 5 | 6 | The parameters of a `Shift` search query. Includes filter and sort options. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **filter** | [**ShiftFilter**](ShiftFilter.md) | Query filter options | [optional] 12 | **sort** | [**ShiftSort**](ShiftSort.md) | Sort order details | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/ShiftSort.md: -------------------------------------------------------------------------------- 1 | 2 | # ShiftSort 3 | 4 | ### Description 5 | 6 | Sets the sort order of search results. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **field** | **String** | The field to sort on. See [ShiftSortField](#type-shiftsortfield) for possible values | [optional] 12 | **order** | **String** | The order in which results are returned. Defaults to DESC. See [SortOrder](#type-sortorder) for possible values | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/ShiftSortField.md: -------------------------------------------------------------------------------- 1 | 2 | # ShiftSortField 3 | 4 | 5 | * `"START_AT"` 6 | 7 | * `"END_AT"` 8 | 9 | * `"CREATED_AT"` 10 | 11 | * `"UPDATED_AT"` 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/ShiftStatus.md: -------------------------------------------------------------------------------- 1 | 2 | # ShiftStatus 3 | 4 | 5 | * `"OPEN"` 6 | 7 | * `"CLOSED"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ShiftWage.md: -------------------------------------------------------------------------------- 1 | 2 | # ShiftWage 3 | 4 | ### Description 5 | 6 | The hourly wage rate used to compensate an employee for this shift. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **title** | **String** | The name of the job performed during this shift. Square labor-reporting UIs may group shifts together by title. | [optional] 12 | **hourlyRate** | [**Money**](Money.md) | Can be a custom-set hourly wage or the calculated effective hourly wage based on annual wage and hours worked per week. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/ShiftWorkday.md: -------------------------------------------------------------------------------- 1 | 2 | # ShiftWorkday 3 | 4 | ### Description 5 | 6 | A `Shift` search query filter parameter that sets a range of days that a `Shift` must start or end in before passing the filter condition. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **dateRange** | [**DateRange**](DateRange.md) | Dates for fetching the shifts | [optional] 12 | **matchShiftsBy** | **String** | The strategy on which the dates are applied. See [ShiftWorkdayMatcher](#type-shiftworkdaymatcher) for possible values | [optional] 13 | **defaultTimezone** | **String** | Location-specific timezones convert workdays to datetime filters. Every location included in the query must have a timezone, or this field must be provided as a fallback. Format: the IANA timezone database identifier for the relevant timezone. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ShiftWorkdayMatcher.md: -------------------------------------------------------------------------------- 1 | 2 | # ShiftWorkdayMatcher 3 | 4 | 5 | * `"START_AT"` 6 | 7 | * `"END_AT"` 8 | 9 | * `"INTERSECTION"` 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SortOrder.md: -------------------------------------------------------------------------------- 1 | 2 | # SortOrder 3 | 4 | 5 | * `"DESC"` 6 | 7 | * `"ASC"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/SourceApplication.md: -------------------------------------------------------------------------------- 1 | 2 | # SourceApplication 3 | 4 | ### Description 5 | 6 | Provides information about the application used to generate an inventory change. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **product** | **String** | Read-only `Product` type for the application. See [Product](#type-product) for possible values | [optional] 12 | **applicationId** | **String** | Read-only Square ID assigned to the application. Only used for `Product` type `EXTERNAL_API`. | [optional] 13 | **name** | **String** | Read-only display name assigned to the application (e.g. `\"Custom Application\"`, `\"Square POS 4.74 for Android\"`). | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/StandardUnitDescription.md: -------------------------------------------------------------------------------- 1 | 2 | # StandardUnitDescription 3 | 4 | ### Description 5 | 6 | Contains the name and abbreviation for standard measurement unit. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **unit** | [**MeasurementUnit**](MeasurementUnit.md) | Identifies the measurement unit being described. | [optional] 12 | **name** | **String** | UI display name of the measurement unit. For example, 'Pound'. | [optional] 13 | **abbreviation** | **String** | UI display abbreviation for the measurement unit. For example, 'lb'. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/StandardUnitDescriptionGroup.md: -------------------------------------------------------------------------------- 1 | 2 | # StandardUnitDescriptionGroup 3 | 4 | ### Description 5 | 6 | Group of standard measurement units. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **standardUnitDescriptions** | [**List<StandardUnitDescription>**](StandardUnitDescription.md) | List of standard (non-custom) measurement units in this description group. | [optional] 12 | **languageCode** | **String** | IETF language tag. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/TaxCalculationPhase.md: -------------------------------------------------------------------------------- 1 | 2 | # TaxCalculationPhase 3 | 4 | 5 | * `"TAX_SUBTOTAL_PHASE"` 6 | 7 | * `"TAX_TOTAL_PHASE"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/TaxInclusionType.md: -------------------------------------------------------------------------------- 1 | 2 | # TaxInclusionType 3 | 4 | 5 | * `"ADDITIVE"` 6 | 7 | * `"INCLUSIVE"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/TenderCardDetails.md: -------------------------------------------------------------------------------- 1 | 2 | # TenderCardDetails 3 | 4 | ### Description 5 | 6 | Represents additional details of a tender with `type` `CARD` or `SQUARE_GIFT_CARD` 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **status** | **String** | The credit card payment's current state (such as `AUTHORIZED` or `CAPTURED`). See `TenderCardDetailsStatus` for possible values. See [TenderCardDetailsStatus](#type-tendercarddetailsstatus) for possible values | [optional] 12 | **card** | [**Card**](Card.md) | The credit card's non-confidential details. | [optional] 13 | **entryMethod** | **String** | The method used to enter the card's details for the transaction. See [TenderCardDetailsEntryMethod](#type-tendercarddetailsentrymethod) for possible values | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/TenderCardDetailsEntryMethod.md: -------------------------------------------------------------------------------- 1 | 2 | # TenderCardDetailsEntryMethod 3 | 4 | 5 | * `"SWIPED"` 6 | 7 | * `"KEYED"` 8 | 9 | * `"EMV"` 10 | 11 | * `"ON_FILE"` 12 | 13 | * `"CONTACTLESS"` 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/TenderCardDetailsStatus.md: -------------------------------------------------------------------------------- 1 | 2 | # TenderCardDetailsStatus 3 | 4 | 5 | * `"AUTHORIZED"` 6 | 7 | * `"CAPTURED"` 8 | 9 | * `"VOIDED"` 10 | 11 | * `"FAILED"` 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/TenderCashDetails.md: -------------------------------------------------------------------------------- 1 | 2 | # TenderCashDetails 3 | 4 | ### Description 5 | 6 | Represents the details of a tender with `type` `CASH`. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **buyerTenderedMoney** | [**Money**](Money.md) | The total amount of cash provided by the buyer, before change is given. | [optional] 12 | **changeBackMoney** | [**Money**](Money.md) | The amount of change returned to the buyer. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/TenderType.md: -------------------------------------------------------------------------------- 1 | 2 | # TenderType 3 | 4 | 5 | * `"CARD"` 6 | 7 | * `"CASH"` 8 | 9 | * `"THIRD_PARTY_CARD"` 10 | 11 | * `"SQUARE_GIFT_CARD"` 12 | 13 | * `"NO_SALE"` 14 | 15 | * `"OTHER"` 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/TimeRange.md: -------------------------------------------------------------------------------- 1 | 2 | # TimeRange 3 | 4 | ### Description 5 | 6 | Represents a generic time range. The start and end values are represented in RFC-3339 format. Time ranges are customized to be inclusive or exclusive based on the needs of a particular endpoint. Refer to the relevent endpoint-specific documentation to determine how time ranges are handled. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **startAt** | **String** | A datetime value in RFC-3339 format indicating when the time range starts. | [optional] 12 | **endAt** | **String** | A datetime value in RFC-3339 format indicating when the time range ends. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/TransactionProduct.md: -------------------------------------------------------------------------------- 1 | 2 | # TransactionProduct 3 | 4 | 5 | * `"REGISTER"` 6 | 7 | * `"EXTERNAL_API"` 8 | 9 | * `"BILLING"` 10 | 11 | * `"APPOINTMENTS"` 12 | 13 | * `"INVOICES"` 14 | 15 | * `"ONLINE_STORE"` 16 | 17 | * `"PAYROLL"` 18 | 19 | * `"OTHER"` 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/UpdateBreakTypeRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateBreakTypeRequest 3 | 4 | ### Description 5 | 6 | A request to update a `BreakType` 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **breakType** | [**BreakType**](BreakType.md) | The updated `BreakType`. | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/UpdateBreakTypeResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateBreakTypeResponse 3 | 4 | ### Description 5 | 6 | A response to a request to update a `BreakType`. Contains the requested `BreakType` objects. May contain a set of `Error` objects if the request resulted in errors. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **breakType** | [**BreakType**](BreakType.md) | The response object. | [optional] 12 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/UpdateCustomerResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateCustomerResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the UpdateCustomer endpoint. One of `errors` or `customer` is present in a given response (never both). 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 12 | **customer** | [**Customer**](Customer.md) | The updated customer. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/UpdateItemModifierListsRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateItemModifierListsRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **itemIds** | **List<String>** | The IDs of the catalog items associated with the CatalogModifierList objects being updated. | 12 | **modifierListsToEnable** | **List<String>** | The IDs of the CatalogModifierList objects to enable for the CatalogItem. | [optional] 13 | **modifierListsToDisable** | **List<String>** | The IDs of the CatalogModifierList objects to disable for the CatalogItem. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/UpdateItemModifierListsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateItemModifierListsResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] 12 | **updatedAt** | **String** | | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/UpdateItemTaxesRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateItemTaxesRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **itemIds** | **List<String>** | IDs for the CatalogItems associated with the CatalogTax objects being updated. | 12 | **taxesToEnable** | **List<String>** | IDs of the CatalogTax objects to enable. | [optional] 13 | **taxesToDisable** | **List<String>** | IDs of the CatalogTax objects to disable. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/UpdateItemTaxesResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateItemTaxesResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] 12 | **updatedAt** | **String** | The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-date) of this update in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/UpdateLocationRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateLocationRequest 3 | 4 | ### Description 5 | 6 | Request object for the [UpdateLocation](#endpoint-updatelocation) endpoint. 7 | **Note: This model is in beta.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **location** | [**Location**](Location.md) | The `Location` object with only the fields to update. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/UpdateLocationResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateLocationResponse 3 | 4 | ### Description 5 | 6 | Response object returned by the [UpdateLocation](#endpoint-updatelocation) endpoint. 7 | **Note: This model is in beta.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **errors** | [**List<Error>**](Error.md) | Information on errors encountered during the request. | [optional] 13 | **location** | [**Location**](Location.md) | The updated `Location`. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/UpdateOrderResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateOrderResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the [UpdateOrder](#endpoint-orders-updateorder) endpoint. 7 | **Note: This model is in beta.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **order** | [**Order**](Order.md) | The updated Order. | [optional] 13 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/UpdateShiftRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateShiftRequest 3 | 4 | ### Description 5 | 6 | A request to update a `Shift` object. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **shift** | [**Shift**](Shift.md) | The updated `Shift` object. | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/UpdateShiftResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateShiftResponse 3 | 4 | ### Description 5 | 6 | The response to a request to update a `Shift`. Contains the updated `Shift` object. May contain a set of `Error` objects if the request resulted in errors. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **shift** | [**Shift**](Shift.md) | The updated `Shift`. | [optional] 12 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/UpdateWorkweekConfigRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateWorkweekConfigRequest 3 | 4 | ### Description 5 | 6 | A request to update a `WorkweekConfig` object 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **workweekConfig** | [**WorkweekConfig**](WorkweekConfig.md) | The updated `WorkweekConfig` object. | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/UpdateWorkweekConfigResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # UpdateWorkweekConfigResponse 3 | 4 | ### Description 5 | 6 | The response to a request to update a `WorkweekConfig` object. Contains the updated `WorkweekConfig` object. May contain a set of `Error` objects if the request resulted in errors. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **workweekConfig** | [**WorkweekConfig**](WorkweekConfig.md) | The response object. | [optional] 12 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/UpsertCatalogObjectResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # UpsertCatalogObjectResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**List<Error>**](Error.md) | Information on any errors encountered. | [optional] 12 | **catalogObject** | [**CatalogObject**](CatalogObject.md) | The successfully created or updated CatalogObject. | [optional] 13 | **idMappings** | [**List<CatalogIdMapping>**](CatalogIdMapping.md) | The mapping between client and server IDs for this upsert. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1AdjustInventoryRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1AdjustInventoryRequest 3 | 4 | ### Description 5 | 6 | V1AdjustInventoryRequest 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **quantityDelta** | [**BigDecimal**](BigDecimal.md) | The number to adjust the variation's quantity by. | [optional] 13 | **adjustmentType** | **String** | The reason for the inventory adjustment. See [V1AdjustInventoryRequestAdjustmentType](#type-v1adjustinventoryrequestadjustmenttype) for possible values | [optional] 14 | **memo** | **String** | A note about the inventory adjustment. | [optional] 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/V1AdjustInventoryRequestAdjustmentType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1AdjustInventoryRequestAdjustmentType 3 | 4 | 5 | * `"SALE"` 6 | 7 | * `"RECEIVE_STOCK"` 8 | 9 | * `"MANUAL_ADJUST"` 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/V1ApplyFeeRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ApplyFeeRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ApplyModifierListRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ApplyModifierListRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1BankAccountType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1BankAccountType 3 | 4 | 5 | * `"BUSINESS_CHECKING"` 6 | 7 | * `"CHECKING"` 8 | 9 | * `"INVESTMENT"` 10 | 11 | * `"LOAN"` 12 | 13 | * `"SAVINGS"` 14 | 15 | * `"OTHER"` 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/V1CashDrawerEvent.md: -------------------------------------------------------------------------------- 1 | 2 | # V1CashDrawerEvent 3 | 4 | ### Description 5 | 6 | V1CashDrawerEvent 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **id** | **String** | The event's unique ID. | [optional] 12 | **employeeId** | **String** | The ID of the employee that created the event. | [optional] 13 | **eventType** | **String** | The type of event that occurred. See [V1CashDrawerEventEventType](#type-v1cashdrawereventeventtype) for possible values | [optional] 14 | **eventMoney** | [**V1Money**](V1Money.md) | The amount of money that was added to or removed from the cash drawer because of the event. This value can be positive (for added money) or negative (for removed money). | [optional] 15 | **createdAt** | **String** | The time when the event occurred, in ISO 8601 format. | [optional] 16 | **description** | **String** | An optional description of the event, entered by the employee that created it. | [optional] 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/V1CashDrawerEventEventType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1CashDrawerEventEventType 3 | 4 | 5 | * `"NO_SALE"` 6 | 7 | * `"CASH_TENDER_PAYMENT"` 8 | 9 | * `"OTHER_TENDER_PAYMENT"` 10 | 11 | * `"CASH_TENDER_CANCELED_PAYMENT"` 12 | 13 | * `"OTHER_TENDER_CANCELED_PAYMENT"` 14 | 15 | * `"CASH_TENDER_REFUND"` 16 | 17 | * `"OTHER_TENDER_REFUND"` 18 | 19 | * `"PAID_IN"` 20 | 21 | * `"PAID_OUT"` 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/V1CashDrawerShiftEventType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1CashDrawerShiftEventType 3 | 4 | 5 | * `"OPEN"` 6 | 7 | * `"ENDED"` 8 | 9 | * `"CLOSED"` 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/V1Category.md: -------------------------------------------------------------------------------- 1 | 2 | # V1Category 3 | 4 | ### Description 5 | 6 | V1Category 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **id** | **String** | The category's unique ID. | [optional] 13 | **name** | **String** | The category's name. | [optional] 14 | **v2Id** | **String** | The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID. | [optional] 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/V1CreateCategoryRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1CreateCategoryRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **body** | [**V1Category**](V1Category.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1CreateDiscountRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1CreateDiscountRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **body** | [**V1Discount**](V1Discount.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1CreateEmployeeRoleRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1CreateEmployeeRoleRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **employeeRole** | [**V1EmployeeRole**](V1EmployeeRole.md) | An EmployeeRole object with a name and permissions, and an optional owner flag. | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1CreateFeeRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1CreateFeeRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **body** | [**V1Fee**](V1Fee.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1CreateItemRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1CreateItemRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **body** | [**V1Item**](V1Item.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1CreateModifierListRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1CreateModifierListRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **body** | [**V1ModifierList**](V1ModifierList.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1CreateModifierOptionRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1CreateModifierOptionRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **body** | [**V1ModifierOption**](V1ModifierOption.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1CreatePageRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1CreatePageRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **body** | [**V1Page**](V1Page.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1CreateRefundRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1CreateRefundRequest 3 | 4 | ### Description 5 | 6 | V1CreateRefundRequest 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **paymentId** | **String** | The ID of the payment to refund. If you are creating a `PARTIAL` refund for a split tender payment, instead provide the id of the particular tender you want to refund. | 12 | **type** | **String** | TThe type of refund (FULL or PARTIAL). See [V1CreateRefundRequestType](#type-v1createrefundrequesttype) for possible values | 13 | **reason** | **String** | The reason for the refund. | 14 | **refundedMoney** | [**V1Money**](V1Money.md) | The amount of money to refund. Required only for PARTIAL refunds. | [optional] 15 | **requestIdempotenceKey** | **String** | An optional key to ensure idempotence if you issue the same PARTIAL refund request more than once. | [optional] 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/V1CreateRefundRequestType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1CreateRefundRequestType 3 | 4 | 5 | * `"FULL"` 6 | 7 | * `"PARTIAL"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/V1CreateVariationRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1CreateVariationRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **body** | [**V1Variation**](V1Variation.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1DeleteCategoryRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1DeleteCategoryRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1DeleteDiscountRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1DeleteDiscountRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1DeleteFeeRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1DeleteFeeRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1DeleteItemRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1DeleteItemRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1DeleteModifierListRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1DeleteModifierListRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1DeleteModifierOptionRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1DeleteModifierOptionRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1DeletePageCellRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1DeletePageCellRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **row** | **String** | The row of the cell to clear. Always an integer between 0 and 4, inclusive. Row 0 is the top row. | [optional] 13 | **column** | **String** | The column of the cell to clear. Always an integer between 0 and 4, inclusive. Column 0 is the leftmost column. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1DeletePageRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1DeletePageRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1DeleteTimecardRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1DeleteTimecardRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/V1DeleteTimecardResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # V1DeleteTimecardResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/V1DeleteVariationRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1DeleteVariationRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1DiscountColor.md: -------------------------------------------------------------------------------- 1 | 2 | # V1DiscountColor 3 | 4 | 5 | * `"9da2a6"` 6 | 7 | * `"4ab200"` 8 | 9 | * `"0b8000"` 10 | 11 | * `"2952cc"` 12 | 13 | * `"a82ee5"` 14 | 15 | * `"e5457a"` 16 | 17 | * `"b21212"` 18 | 19 | * `"593c00"` 20 | 21 | * `"e5BF00"` 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/V1DiscountDiscountType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1DiscountDiscountType 3 | 4 | 5 | * `"FIXED"` 6 | 7 | * `"VARIABLE_PERCENTAGE"` 8 | 9 | * `"VARIABLE_AMOUNT"` 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/V1EmployeeRolePermissions.md: -------------------------------------------------------------------------------- 1 | 2 | # V1EmployeeRolePermissions 3 | 4 | 5 | * `"REGISTER_ACCESS_SALES_HISTORY"` 6 | 7 | * `"REGISTER_APPLY_RESTRICTED_DISCOUNTS"` 8 | 9 | * `"REGISTER_CHANGE_SETTINGS"` 10 | 11 | * `"REGISTER_EDIT_ITEM"` 12 | 13 | * `"REGISTER_ISSUE_REFUNDS"` 14 | 15 | * `"REGISTER_OPEN_CASH_DRAWER_OUTSIDE_SALE"` 16 | 17 | * `"REGISTER_VIEW_SUMMARY_REPORTS"` 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/V1EmployeeStatus.md: -------------------------------------------------------------------------------- 1 | 2 | # V1EmployeeStatus 3 | 4 | 5 | * `"ACTIVE"` 6 | 7 | * `"INACTIVE"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/V1FeeAdjustmentType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1FeeAdjustmentType 3 | 4 | 5 | * `"TAX"` 6 | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/V1FeeCalculationPhase.md: -------------------------------------------------------------------------------- 1 | 2 | # V1FeeCalculationPhase 3 | 4 | 5 | * `"FEE_SUBTOTAL_PHASE"` 6 | 7 | * `"OTHER"` 8 | 9 | * `"FEE_TOTAL_PHASE"` 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/V1FeeInclusionType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1FeeInclusionType 3 | 4 | 5 | * `"ADDITIVE"` 6 | 7 | * `"INCLUSIVE"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/V1FeeType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1FeeType 3 | 4 | 5 | * `"CA_GST"` 6 | 7 | * `"CA_HST"` 8 | 9 | * `"CA_PST"` 10 | 11 | * `"CA_QST"` 12 | 13 | * `"JP_CONSUMPTION_TAX"` 14 | 15 | * `"CA_PEI_PST"` 16 | 17 | * `"US_SALES_TAX"` 18 | 19 | * `"OTHER"` 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/V1InventoryEntry.md: -------------------------------------------------------------------------------- 1 | 2 | # V1InventoryEntry 3 | 4 | ### Description 5 | 6 | V1InventoryEntry 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **variationId** | **String** | The variation that the entry corresponds to. | [optional] 13 | **quantityOnHand** | [**BigDecimal**](BigDecimal.md) | The current available quantity of the item variation. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1ItemColor.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ItemColor 3 | 4 | 5 | * `"9da2a6"` 6 | 7 | * `"4ab200"` 8 | 9 | * `"0b8000"` 10 | 11 | * `"2952cc"` 12 | 13 | * `"a82ee5"` 14 | 15 | * `"e5457a"` 16 | 17 | * `"b21212"` 18 | 19 | * `"593c00"` 20 | 21 | * `"e5BF00"` 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/V1ItemImage.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ItemImage 3 | 4 | ### Description 5 | 6 | V1ItemImage 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **id** | **String** | The image's unique ID. | [optional] 13 | **url** | **String** | The image's publicly accessible URL. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1ItemType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ItemType 3 | 4 | 5 | * `"NORMAL"` 6 | 7 | * `"GIFT_CARD"` 8 | 9 | * `"OTHER"` 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/V1ItemVisibility.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ItemVisibility 3 | 4 | 5 | * `"PUBLIC"` 6 | 7 | * `"PRIVATE"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/V1ListBankAccountsRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListBankAccountsRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/V1ListBankAccountsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListBankAccountsResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**List<V1BankAccount>**](V1BankAccount.md) | | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListCashDrawerShiftsRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListCashDrawerShiftsRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **order** | **String** | The order in which cash drawer shifts are listed in the response, based on their created_at field. Default value: ASC See [SortOrder](#type-sortorder) for possible values | [optional] 12 | **beginTime** | **String** | The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time minus 90 days. | [optional] 13 | **endTime** | **String** | The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1ListCashDrawerShiftsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListCashDrawerShiftsResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**List<V1CashDrawerShift>**](V1CashDrawerShift.md) | | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListCategoriesRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListCategoriesRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListCategoriesResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListCategoriesResponse 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **items** | [**List<V1Category>**](V1Category.md) | | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ListDiscountsRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListDiscountsRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListDiscountsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListDiscountsResponse 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **items** | [**List<V1Discount>**](V1Discount.md) | | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ListEmployeeRolesRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListEmployeeRolesRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **order** | **String** | The order in which employees are listed in the response, based on their created_at field.Default value: ASC See [SortOrder](#type-sortorder) for possible values | [optional] 12 | **limit** | **Integer** | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. | [optional] 13 | **batchToken** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1ListEmployeeRolesResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListEmployeeRolesResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**List<V1EmployeeRole>**](V1EmployeeRole.md) | | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListEmployeesRequestStatus.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListEmployeesRequestStatus 3 | 4 | 5 | * `"ACTIVE"` 6 | 7 | * `"INACTIVE"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/V1ListEmployeesResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListEmployeesResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**List<V1Employee>**](V1Employee.md) | | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListFeesRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListFeesRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListFeesResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListFeesResponse 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **items** | [**List<V1Fee>**](V1Fee.md) | | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ListInventoryRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListInventoryRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **limit** | **Integer** | The maximum number of inventory entries to return in a single response. This value cannot exceed 1000. | [optional] 13 | **batchToken** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1ListInventoryResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListInventoryResponse 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **items** | [**List<V1InventoryEntry>**](V1InventoryEntry.md) | | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ListItemsRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListItemsRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **batchToken** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ListItemsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListItemsResponse 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **items** | [**List<V1Item>**](V1Item.md) | | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ListLocationsRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListLocationsRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListLocationsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListLocationsResponse 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **items** | [**List<V1Merchant>**](V1Merchant.md) | | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ListModifierListsRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListModifierListsRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListModifierListsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListModifierListsResponse 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **items** | [**List<V1ModifierList>**](V1ModifierList.md) | | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ListOrdersRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListOrdersRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **order** | **String** | TThe order in which payments are listed in the response. See [SortOrder](#type-sortorder) for possible values | [optional] 12 | **limit** | **Integer** | The maximum number of payments to return in a single response. This value cannot exceed 200. | [optional] 13 | **batchToken** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1ListOrdersResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListOrdersResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**List<V1Order>**](V1Order.md) | | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListPagesRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListPagesRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListPagesResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListPagesResponse 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **items** | [**List<V1Page>**](V1Page.md) | | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ListPaymentsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListPaymentsResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**List<V1Payment>**](V1Payment.md) | | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListRefundsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListRefundsResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**List<V1Refund>**](V1Refund.md) | | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListSettlementsRequestStatus.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListSettlementsRequestStatus 3 | 4 | 5 | * `"SENT"` 6 | 7 | * `"FAILED"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/V1ListSettlementsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListSettlementsResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**List<V1Settlement>**](V1Settlement.md) | | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListTimecardEventsRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListTimecardEventsRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/V1ListTimecardEventsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListTimecardEventsResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**List<V1TimecardEvent>**](V1TimecardEvent.md) | | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListTimecardsResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ListTimecardsResponse 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**List<V1Timecard>**](V1Timecard.md) | | [optional] 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1MerchantAccountType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1MerchantAccountType 3 | 4 | 5 | * `"LOCATION"` 6 | 7 | * `"BUSINESS"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/V1MerchantLocationDetails.md: -------------------------------------------------------------------------------- 1 | 2 | # V1MerchantLocationDetails 3 | 4 | ### Description 5 | 6 | Additional information for a single-location account specified by its associated business account, if it has one. 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **nickname** | **String** | The nickname assigned to the single-location account by the parent business. This value appears in the parent business's multi-location dashboard. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ModifierList.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ModifierList 3 | 4 | ### Description 5 | 6 | V1ModifierList 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **id** | **String** | The modifier list's unique ID. | [optional] 13 | **name** | **String** | The modifier list's name. | [optional] 14 | **selectionType** | **String** | Indicates whether MULTIPLE options or a SINGLE option from the modifier list can be applied to a single item. See [V1ModifierListSelectionType](#type-v1modifierlistselectiontype) for possible values | [optional] 15 | **modifierOptions** | [**List<V1ModifierOption>**](V1ModifierOption.md) | The options included in the modifier list. | [optional] 16 | **v2Id** | **String** | The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID. | [optional] 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/V1ModifierListSelectionType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1ModifierListSelectionType 3 | 4 | 5 | * `"SINGLE"` 6 | 7 | * `"MULTIPLE"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/V1Money.md: -------------------------------------------------------------------------------- 1 | 2 | # V1Money 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **amount** | **Integer** | Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). | [optional] 13 | **currencyCode** | **String** | See [Currency](#type-currency) for possible values | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1OrderHistoryEntry.md: -------------------------------------------------------------------------------- 1 | 2 | # V1OrderHistoryEntry 3 | 4 | ### Description 5 | 6 | V1OrderHistoryEntry 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **action** | **String** | The type of action performed on the order. See [V1OrderHistoryEntryAction](#type-v1orderhistoryentryaction) for possible values | [optional] 12 | **createdAt** | **String** | The time when the action was performed, in ISO 8601 format. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1OrderHistoryEntryAction.md: -------------------------------------------------------------------------------- 1 | 2 | # V1OrderHistoryEntryAction 3 | 4 | 5 | * `"ORDER_PLACED"` 6 | 7 | * `"DECLINED"` 8 | 9 | * `"PAYMENT_RECEIVED"` 10 | 11 | * `"CANCELED"` 12 | 13 | * `"COMPLETED"` 14 | 15 | * `"REFUNDED"` 16 | 17 | * `"EXPIRED"` 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/V1OrderState.md: -------------------------------------------------------------------------------- 1 | 2 | # V1OrderState 3 | 4 | 5 | * `"PENDING"` 6 | 7 | * `"OPEN"` 8 | 9 | * `"COMPLETED"` 10 | 11 | * `"CANCELED"` 12 | 13 | * `"REFUNDED"` 14 | 15 | * `"REJECTED"` 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/V1Page.md: -------------------------------------------------------------------------------- 1 | 2 | # V1Page 3 | 4 | ### Description 5 | 6 | V1Page 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **id** | **String** | The page's unique identifier. | [optional] 13 | **name** | **String** | The page's name, if any. | [optional] 14 | **pageIndex** | **Integer** | The page's position in the merchant's list of pages. Always an integer between 0 and 6, inclusive. | [optional] 15 | **cells** | [**List<V1PageCell>**](V1PageCell.md) | The cells included on the page. | [optional] 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/V1PageCellObjectType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1PageCellObjectType 3 | 4 | 5 | * `"ITEM"` 6 | 7 | * `"DISCOUNT"` 8 | 9 | * `"CATEGORY"` 10 | 11 | * `"PLACEHOLDER"` 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1PageCellPlaceholderType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1PageCellPlaceholderType 3 | 4 | 5 | * `"ALL_ITEMS"` 6 | 7 | * `"DISCOUNTS_CATEGORY"` 8 | 9 | * `"REWARDS_FINDER"` 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/V1PaymentDiscount.md: -------------------------------------------------------------------------------- 1 | 2 | # V1PaymentDiscount 3 | 4 | ### Description 5 | 6 | V1PaymentDiscount 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **name** | **String** | The discount's name. | [optional] 12 | **appliedMoney** | [**V1Money**](V1Money.md) | The amount of money that this discount adds to the payment (note that this value is always negative or zero). | [optional] 13 | **discountId** | **String** | The ID of the applied discount, if available. Discounts applied in older versions of Square Register might not have an ID. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1PaymentItemDetail.md: -------------------------------------------------------------------------------- 1 | 2 | # V1PaymentItemDetail 3 | 4 | ### Description 5 | 6 | V1PaymentItemDetail 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **categoryName** | **String** | The name of the item's merchant-defined category, if any. | [optional] 12 | **sku** | **String** | The item's merchant-defined SKU, if any. | [optional] 13 | **itemId** | **String** | The unique ID of the item purchased, if any. | [optional] 14 | **itemVariationId** | **String** | The unique ID of the item variation purchased, if any. | [optional] 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/V1PaymentItemizationItemizationType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1PaymentItemizationItemizationType 3 | 4 | 5 | * `"ITEM"` 6 | 7 | * `"CUSTOM_AMOUNT"` 8 | 9 | * `"GIFT_CARD_ACTIVATION"` 10 | 11 | * `"GIFT_CARD_RELOAD"` 12 | 13 | * `"GIFT_CARD_UNKNOWN"` 14 | 15 | * `"OTHER"` 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/V1PaymentModifier.md: -------------------------------------------------------------------------------- 1 | 2 | # V1PaymentModifier 3 | 4 | ### Description 5 | 6 | V1PaymentModifier 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **name** | **String** | The modifier option's name. | [optional] 12 | **appliedMoney** | [**V1Money**](V1Money.md) | The amount of money that this modifier option adds to the payment. | [optional] 13 | **modifierOptionId** | **String** | TThe ID of the applied modifier option, if available. Modifier options applied in older versions of Square Register might not have an ID. | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1PaymentSurchargeType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1PaymentSurchargeType 3 | 4 | 5 | * `"UNKNOWN"` 6 | 7 | * `"AUTO_GRATUITY"` 8 | 9 | * `"CUSTOM"` 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/V1PaymentTaxInclusionType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1PaymentTaxInclusionType 3 | 4 | 5 | * `"ADDITIVE"` 6 | 7 | * `"INCLUSIVE"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/V1PhoneNumber.md: -------------------------------------------------------------------------------- 1 | 2 | # V1PhoneNumber 3 | 4 | ### Description 5 | 6 | Represents a phone number. 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **callingCode** | **String** | The phone number's international calling code. For US phone numbers, this value is +1. | 13 | **number** | **String** | The phone number. | 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1RefundType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1RefundType 3 | 4 | 5 | * `"FULL"` 6 | 7 | * `"PARTIAL"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/V1RemoveFeeRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1RemoveFeeRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1RemoveModifierListRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1RemoveModifierListRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1RetrieveBankAccountRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1RetrieveBankAccountRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/V1RetrieveBusinessRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1RetrieveBusinessRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1RetrieveCashDrawerShiftRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1RetrieveCashDrawerShiftRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/V1RetrieveEmployeeRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1RetrieveEmployeeRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/V1RetrieveEmployeeRoleRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1RetrieveEmployeeRoleRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/V1RetrieveItemRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1RetrieveItemRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1RetrieveModifierListRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1RetrieveModifierListRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1RetrieveOrderRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1RetrieveOrderRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/V1RetrievePaymentRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1RetrievePaymentRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/V1RetrieveSettlementRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1RetrieveSettlementRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/V1RetrieveTimecardRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1RetrieveTimecardRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/V1SettlementEntry.md: -------------------------------------------------------------------------------- 1 | 2 | # V1SettlementEntry 3 | 4 | ### Description 5 | 6 | V1SettlementEntry 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **paymentId** | **String** | The settlement's unique identifier. | [optional] 12 | **type** | **String** | The settlement's current status. See [V1SettlementEntryType](#type-v1settlemententrytype) for possible values | [optional] 13 | **amountMoney** | [**V1Money**](V1Money.md) | The total amount of money this entry contributes to the total settlement amount. | [optional] 14 | **feeMoney** | [**V1Money**](V1Money.md) | The amount of all Square fees associated with this settlement entry. This value is always negative or zero. | [optional] 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/V1SettlementEntryType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1SettlementEntryType 3 | 4 | 5 | * `"ADJUSTMENT"` 6 | 7 | * `"BALANCE_CHARGE"` 8 | 9 | * `"CHARGE"` 10 | 11 | * `"FREE_PROCESSING"` 12 | 13 | * `"HOLD_ADJUSTMENT"` 14 | 15 | * `"PAID_SERVICE_FEE"` 16 | 17 | * `"PAID_SERVICE_FEE_REFUND"` 18 | 19 | * `"REDEMPTION_CODE"` 20 | 21 | * `"REFUND"` 22 | 23 | * `"RETURNED_PAYOUT"` 24 | 25 | * `"SQUARE_CAPITAL_ADVANCE"` 26 | 27 | * `"SQUARE_CAPITAL_PAYMENT"` 28 | 29 | * `"SQUARE_CAPITAL_REVERSED_PAYMENT"` 30 | 31 | * `"SUBSCRIPTION_FEE"` 32 | 33 | * `"SUBSCRIPTION_FEE_REFUND"` 34 | 35 | * `"OTHER"` 36 | 37 | * `"INCENTED_PAYMENT"` 38 | 39 | * `"RETURNED_ACH_ENTRY"` 40 | 41 | * `"RETURNED_SQUARE_275"` 42 | 43 | * `"SQUARE_275"` 44 | 45 | * `"SQUARE_CARD"` 46 | 47 | 48 | 49 | -------------------------------------------------------------------------------- /docs/V1SettlementStatus.md: -------------------------------------------------------------------------------- 1 | 2 | # V1SettlementStatus 3 | 4 | 5 | * `"FAILED"` 6 | 7 | * `"SENT"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/V1TenderCardBrand.md: -------------------------------------------------------------------------------- 1 | 2 | # V1TenderCardBrand 3 | 4 | 5 | * `"OTHER_BRAND"` 6 | 7 | * `"VISA"` 8 | 9 | * `"MASTER_CARD"` 10 | 11 | * `"AMERICAN_EXPRESS"` 12 | 13 | * `"DISCOVER"` 14 | 15 | * `"DISCOVER_DINERS"` 16 | 17 | * `"JCB"` 18 | 19 | * `"CHINA_UNIONPAY"` 20 | 21 | * `"SQUARE_GIFT_CARD"` 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/V1TenderEntryMethod.md: -------------------------------------------------------------------------------- 1 | 2 | # V1TenderEntryMethod 3 | 4 | 5 | * `"MANUAL"` 6 | 7 | * `"SCANNED"` 8 | 9 | * `"SQUARE_CASH"` 10 | 11 | * `"SQUARE_WALLET"` 12 | 13 | * `"SWIPED"` 14 | 15 | * `"WEB_FORM"` 16 | 17 | * `"OTHER"` 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/V1TenderType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1TenderType 3 | 4 | 5 | * `"CREDIT_CARD"` 6 | 7 | * `"CASH"` 8 | 9 | * `"THIRD_PARTY_CARD"` 10 | 11 | * `"NO_SALE"` 12 | 13 | * `"SQUARE_WALLET"` 14 | 15 | * `"SQUARE_GIFT_CARD"` 16 | 17 | * `"UNKNOWN"` 18 | 19 | * `"OTHER"` 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/V1TimecardEvent.md: -------------------------------------------------------------------------------- 1 | 2 | # V1TimecardEvent 3 | 4 | ### Description 5 | 6 | V1TimecardEvent 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **id** | **String** | The event's unique ID. | [optional] 12 | **eventType** | **String** | The ID of the timecard to list events for. See [V1TimecardEventEventType](#type-v1timecardeventeventtype) for possible values | [optional] 13 | **clockinTime** | **String** | The time the employee clocked in, in ISO 8601 format. | [optional] 14 | **clockoutTime** | **String** | The time the employee clocked out, in ISO 8601 format. | [optional] 15 | **createdAt** | **String** | The time when the event was created, in ISO 8601 format. | [optional] 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/V1TimecardEventEventType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1TimecardEventEventType 3 | 4 | 5 | * `"API_CREATE"` 6 | 7 | * `"API_EDIT"` 8 | 9 | * `"API_DELETE"` 10 | 11 | * `"REGISTER_CLOCKIN"` 12 | 13 | * `"REGISTER_CLOCKOUT"` 14 | 15 | * `"DASHBOARD_SUPERVISOR_CLOSE"` 16 | 17 | * `"DASHBOARD_EDIT"` 18 | 19 | * `"DASHBOARD_DELETE"` 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/V1UpdateCategoryRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1UpdateCategoryRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **body** | [**V1Category**](V1Category.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1UpdateDiscountRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1UpdateDiscountRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **body** | [**V1Discount**](V1Discount.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1UpdateEmployeeRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1UpdateEmployeeRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **body** | [**V1Employee**](V1Employee.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1UpdateEmployeeRoleRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1UpdateEmployeeRoleRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **body** | [**V1EmployeeRole**](V1EmployeeRole.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1UpdateFeeRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1UpdateFeeRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **body** | [**V1Fee**](V1Fee.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1UpdateItemRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1UpdateItemRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **body** | [**V1Item**](V1Item.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1UpdateModifierListRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1UpdateModifierListRequest 3 | 4 | ### Description 5 | 6 | V1UpdateModifierListRequest 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **name** | **String** | The modifier list's name. | [optional] 13 | **selectionType** | **String** | Indicates whether multiple options from the modifier list can be applied to a single item. See [V1UpdateModifierListRequestSelectionType](#type-v1updatemodifierlistrequestselectiontype) for possible values | [optional] 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1UpdateModifierListRequestSelectionType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1UpdateModifierListRequestSelectionType 3 | 4 | 5 | * `"SINGLE"` 6 | 7 | * `"MULTIPLE"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/V1UpdateModifierOptionRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1UpdateModifierOptionRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **body** | [**V1ModifierOption**](V1ModifierOption.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1UpdateOrderRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1UpdateOrderRequest 3 | 4 | ### Description 5 | 6 | V1UpdateOrderRequest 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **action** | **String** | The action to perform on the order (COMPLETE, CANCEL, or REFUND). See [V1UpdateOrderRequestAction](#type-v1updateorderrequestaction) for possible values | 12 | **shippedTrackingNumber** | **String** | The tracking number of the shipment associated with the order. Only valid if action is COMPLETE. | [optional] 13 | **completedNote** | **String** | A merchant-specified note about the completion of the order. Only valid if action is COMPLETE. | [optional] 14 | **refundedNote** | **String** | A merchant-specified note about the refunding of the order. Only valid if action is REFUND. | [optional] 15 | **canceledNote** | **String** | A merchant-specified note about the canceling of the order. Only valid if action is CANCEL. | [optional] 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/V1UpdateOrderRequestAction.md: -------------------------------------------------------------------------------- 1 | 2 | # V1UpdateOrderRequestAction 3 | 4 | 5 | * `"COMPLETE"` 6 | 7 | * `"CANCEL"` 8 | 9 | * `"REFUND"` 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/V1UpdatePageCellRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1UpdatePageCellRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **body** | [**V1PageCell**](V1PageCell.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1UpdatePageRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1UpdatePageRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **body** | [**V1Page**](V1Page.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1UpdateTimecardRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1UpdateTimecardRequest 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **body** | [**V1Timecard**](V1Timecard.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1UpdateVariationRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # V1UpdateVariationRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **body** | [**V1Variation**](V1Variation.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1VariationInventoryAlertType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1VariationInventoryAlertType 3 | 4 | 5 | * `"LOW_QUANTITY"` 6 | 7 | * `"NONE"` 8 | 9 | * `"INVESTMENT"` 10 | 11 | * `"LOAN"` 12 | 13 | * `"SAVINGS"` 14 | 15 | * `"OTHER"` 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/V1VariationPricingType.md: -------------------------------------------------------------------------------- 1 | 2 | # V1VariationPricingType 3 | 4 | 5 | * `"FIXED_PRICING"` 6 | 7 | * `"VARIABLE_PRICING"` 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/VoidTransactionRequest.md: -------------------------------------------------------------------------------- 1 | 2 | # VoidTransactionRequest 3 | 4 | ### Description 5 | 6 | 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/VoidTransactionResponse.md: -------------------------------------------------------------------------------- 1 | 2 | # VoidTransactionResponse 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the [VoidTransaction](#endpoint-voidtransaction) endpoint. 7 | **Note: This model is deprecated.** 8 | 9 | ## Properties 10 | Name | Type | Description | Notes 11 | ------------ | ------------- | ------------- | ------------- 12 | **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/Weekday.md: -------------------------------------------------------------------------------- 1 | 2 | # Weekday 3 | 4 | 5 | * `"MON"` 6 | 7 | * `"TUE"` 8 | 9 | * `"WED"` 10 | 11 | * `"THU"` 12 | 13 | * `"FRI"` 14 | 15 | * `"SAT"` 16 | 17 | * `"SUN"` 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | POM_ARTIFACT_ID=connect 2 | POM_NAME=Square Connect Java SDK -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/square/connect-java-sdk/2d88b9c6233979f8123058567e425b9ea9d70fcc/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Tue May 17 23:08:05 CST 2016 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-2.6-bin.zip 7 | -------------------------------------------------------------------------------- /maven/before_deploy.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | if [ "$TRAVIS_BRANCH" = 'master' ] && [ "$TRAVIS_PULL_REQUEST" == 'false' ]; then 3 | openssl aes-256-cbc -K $encrypted_cef8742a9861_key -iv $encrypted_cef8742a9861_iv -in maven/codesigning.asc.enc -out maven/codesigning.asc -d 4 | gpg --fast-import maven/codesigning.asc 5 | fi 6 | -------------------------------------------------------------------------------- /maven/codesigning.asc.enc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/square/connect-java-sdk/2d88b9c6233979f8123058567e425b9ea9d70fcc/maven/codesigning.asc.enc -------------------------------------------------------------------------------- /maven/deploy.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | if [ "$TRAVIS_BRANCH" = 'master' ] && [ "$TRAVIS_PULL_REQUEST" == 'false' ]; then 3 | mvn deploy -P sign,build-extras --settings maven/mvnsettings.xml 4 | fi 5 | -------------------------------------------------------------------------------- /maven/mvnsettings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | ossrh 5 | ${env.OSSRH_JIRA_USERNAME} 6 | ${env.OSSRH_JIRA_PASSWORD} 7 | 8 | 9 | 10 | 11 | 12 | ossrh 13 | 14 | true 15 | 16 | 17 | gpg 18 | ${env.GPG_KEY_NAME} 19 | ${env.GPG_PASSPHRASE} 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = "connect" -------------------------------------------------------------------------------- /src/main/java/com/squareup/connect/auth/Authentication.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Square Connect API 3 | * Client library for accessing the Square Connect APIs 4 | * 5 | * OpenAPI spec version: 2.0 6 | * Contact: developers@squareup.com 7 | * 8 | * NOTE: This class is auto generated by the swagger code generator program. 9 | * https://github.com/swagger-api/swagger-codegen.git 10 | * Do not edit the class manually. 11 | */ 12 | 13 | 14 | package com.squareup.connect.auth; 15 | 16 | import com.squareup.connect.Pair; 17 | 18 | import java.util.Map; 19 | import java.util.List; 20 | 21 | public interface Authentication { 22 | /** 23 | * Apply authentication settings to header and query params. 24 | * 25 | * @param queryParams List of query parameters 26 | * @param headerParams Map of header parameters 27 | */ 28 | void applyToParams(List queryParams, Map headerParams); 29 | } 30 | -------------------------------------------------------------------------------- /src/test/java/com/squareup/connect/models/CreateCheckoutRequestTest.java: -------------------------------------------------------------------------------- 1 | package com.squareup.connect.models; 2 | 3 | import java.util.ArrayList; 4 | import java.util.Arrays; 5 | import org.junit.Test; 6 | 7 | public class CreateCheckoutRequestTest { 8 | /** 9 | * additionalRecipientsTest 10 | * 11 | * Tests that the CreateCheckoutRequest object has an AdditionalRecipients field. 12 | */ 13 | @Test 14 | public void additionalRecipientsTest() { 15 | ChargeRequestAdditionalRecipient recipient = new ChargeRequestAdditionalRecipient(); 16 | recipient.setLocationId("location"); 17 | recipient.setDescription("description"); 18 | Money money = new Money(); 19 | money.setAmount(1L); 20 | money.setCurrency("USD"); 21 | recipient.setAmountMoney(money); 22 | new CreateCheckoutRequest().setAdditionalRecipients(new ArrayList<>( 23 | Arrays.asList(recipient) 24 | )); 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /src/test/java/com/squareup/connect/models/RefundTest.java: -------------------------------------------------------------------------------- 1 | package com.squareup.connect.models; 2 | 3 | import java.util.ArrayList; 4 | import java.util.Arrays; 5 | import org.junit.Test; 6 | 7 | public class RefundTest { 8 | /** 9 | * additionalRecipientsTest 10 | * 11 | * Tests that the refund object has an AdditionalRecipients field. 12 | */ 13 | @Test 14 | public void additionalRecipientsTest() { 15 | AdditionalRecipient recipient = new AdditionalRecipient(); 16 | recipient.setLocationId("location"); 17 | recipient.setDescription("description"); 18 | Money money = new Money(); 19 | money.setAmount(1L); 20 | money.setCurrency("USD"); 21 | recipient.setAmountMoney(money); 22 | new Refund().setAdditionalRecipients(new ArrayList<>( 23 | Arrays.asList(recipient) 24 | )); 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /src/test/java/com/squareup/connect/utils/APITest.java: -------------------------------------------------------------------------------- 1 | package com.squareup.connect.utils; 2 | 3 | import java.io.IOException; 4 | import java.nio.file.Files; 5 | import java.nio.file.Paths; 6 | import java.util.Map; 7 | 8 | import org.junit.BeforeClass; 9 | 10 | import com.fasterxml.jackson.core.type.TypeReference; 11 | import com.fasterxml.jackson.databind.ObjectMapper; 12 | 13 | public class APITest { 14 | 15 | protected static Map accounts; 16 | 17 | @BeforeClass 18 | public static void loadAccounts() throws IOException { 19 | ObjectMapper mapper = new ObjectMapper(); 20 | byte[] jsonData = Files.readAllBytes(Paths.get("./travis-ci/accounts.json")); 21 | accounts = mapper.readValue(jsonData, new TypeReference>() { }); 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /src/test/java/com/squareup/connect/utils/Account.java: -------------------------------------------------------------------------------- 1 | package com.squareup.connect.utils; 2 | 3 | import com.fasterxml.jackson.annotation.JsonProperty; 4 | 5 | // Represent the account info 6 | public class Account { 7 | @JsonProperty("email") 8 | public String email; 9 | @JsonProperty("access_token") 10 | public String accessToken; 11 | @JsonProperty("location_id") 12 | public String locationId; 13 | @JsonProperty("application_id") 14 | public String applicationId; 15 | } 16 | -------------------------------------------------------------------------------- /travis-ci/accounts.enc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/square/connect-java-sdk/2d88b9c6233979f8123058567e425b9ea9d70fcc/travis-ci/accounts.enc --------------------------------------------------------------------------------