├── test ├── __init__.py └── utils │ ├── __init__.py │ └── api_test_case.py ├── .gitignore ├── travis-ci └── accounts.enc ├── test-requirements.txt ├── requirements.txt ├── CONTRIBUTING.md ├── tox.ini ├── docs ├── V1FeeAdjustmentType.md ├── V1RefundType.md ├── V1EmployeeStatus.md ├── V1ItemVisibility.md ├── V1SettlementStatus.md ├── OrderFulfillmentType.md ├── V1FeeInclusionType.md ├── V1CreateRefundRequestType.md ├── V1ItemType.md ├── V1MerchantAccountType.md ├── V1PaymentTaxInclusionType.md ├── LocationType.md ├── V1ListEmployeesRequestStatus.md ├── V1ListSettlementsRequestStatus.md ├── V1ModifierListSelectionType.md ├── LocationStatus.md ├── ShiftStatus.md ├── V1VariationPricingType.md ├── EmployeeStatus.md ├── OrderState.md ├── V1CashDrawerShiftEventType.md ├── V1PaymentSurchargeType.md ├── V1UpdateOrderRequestAction.md ├── CatalogInfoRequest.md ├── V1ApplyFeeRequest.md ├── V1DeleteFeeRequest.md ├── V1ListFeesRequest.md ├── V1ListPagesRequest.md ├── V1RemoveFeeRequest.md ├── V1UpdateModifierListRequestSelectionType.md ├── ShiftFilterStatus.md ├── V1DeleteItemRequest.md ├── V1DeletePageRequest.md ├── V1DiscountDiscountType.md ├── V1FeeCalculationPhase.md ├── CustomerSortField.md ├── RegisterDomainResponseStatus.md ├── V1RetrieveItemRequest.md ├── WebhookEvents.md ├── V1DeleteCategoryRequest.md ├── V1DeleteDiscountRequest.md ├── V1DeleteTimecardRequest.md ├── V1ListCategoriesRequest.md ├── V1ListDiscountsRequest.md ├── V1ListLocationsRequest.md ├── V1PageCellObjectType.md ├── V1PageCellPlaceholderType.md ├── V1RetrieveOrderRequest.md ├── MeasurementUnitGeneric.md ├── TaxCalculationPhase.md ├── V1DeleteTimecardResponse.md ├── V1DeleteVariationRequest.md ├── V1RetrieveBusinessRequest.md ├── V1RetrieveEmployeeRequest.md ├── V1RetrievePaymentRequest.md ├── V1RetrieveTimecardRequest.md ├── DeleteCatalogObjectRequest.md ├── GetShiftRequest.md ├── SortOrder.md ├── V1ApplyModifierListRequest.md ├── V1ListBankAccountsRequest.md ├── V1ListModifierListsRequest.md ├── DeleteShiftRequest.md ├── RefundStatus.md ├── V1AdjustInventoryRequestAdjustmentType.md ├── V1DeleteModifierListRequest.md ├── V1ListTimecardEventsRequest.md ├── V1RemoveModifierListRequest.md ├── V1RetrieveBankAccountRequest.md ├── V1RetrieveSettlementRequest.md ├── LocationCapability.md ├── ShiftWorkdayMatcher.md ├── V1DeleteModifierOptionRequest.md ├── V1RetrieveEmployeeRoleRequest.md ├── V1RetrieveModifierListRequest.md ├── GetBreakTypeRequest.md ├── DeleteBreakTypeRequest.md ├── GetEmployeeWageRequest.md ├── OrderFulfillmentPickupDetailsScheduleType.md ├── ShiftSortField.md ├── V1RetrieveCashDrawerShiftRequest.md ├── OrderLineItemTaxScope.md ├── RetrieveEmployeeRequest.md ├── RetrieveInventoryAdjustmentRequest.md ├── V1OrderState.md ├── SearchOrdersSortField.md ├── Weekday.md ├── OrderLineItemTaxType.md ├── RetrieveInventoryPhysicalCountRequest.md ├── TaxInclusionType.md ├── TenderCardDetailsStatus.md ├── V1BankAccountType.md ├── V1ListFeesResponse.md ├── InventoryChangeType.md ├── OrderLineItemDiscountScope.md ├── V1ListItemsResponse.md ├── V1ListPagesResponse.md ├── RenewTokenRequest.md ├── V1ListOrdersResponse.md ├── CatalogModifierListSelectionType.md ├── DayOfWeek.md ├── TenderType.md ├── V1ListRefundsResponse.md ├── V1VariationInventoryAlertType.md ├── VoidTransactionRequest.md ├── ListLocationsRequest.md ├── V1ListPaymentsResponse.md ├── DeleteCustomerRequest.md ├── RevokeTokenResponse.md ├── V1ListCategoriesResponse.md ├── V1ListDiscountsResponse.md ├── V1ListEmployeesResponse.md ├── V1ListLocationsResponse.md ├── V1ListTimecardsResponse.md ├── CaptureTransactionRequest.md ├── CustomerInclusionExclusion.md ├── RetrieveCustomerRequest.md ├── V1TenderEntryMethod.md ├── CatalogPricingType.md ├── InventoryAlertType.md ├── OrderFulfillmentState.md ├── RetrieveTransactionRequest.md ├── V1ListInventoryResponse.md ├── V1ListSettlementsResponse.md ├── DeleteCustomerCardRequest.md ├── TenderCardDetailsEntryMethod.md ├── V1FeeType.md ├── V1ListBankAccountsResponse.md ├── V1ListEmployeeRolesResponse.md ├── V1ListModifierListsResponse.md ├── Device.md ├── V1ItemColor.md ├── V1ListTimecardEventsResponse.md ├── UpdateShiftRequest.md ├── V1DiscountColor.md ├── V1OrderHistoryEntryAction.md ├── V1TenderType.md ├── V1ListCashDrawerShiftsResponse.md ├── V1PaymentItemizationItemizationType.md ├── CatalogDiscountType.md ├── CatalogQueryText.md ├── V1ItemImage.md ├── V1ListItemsRequest.md ├── UpdateBreakTypeRequest.md ├── MeasurementUnitWeight.md ├── CatalogQueryExact.md ├── SearchOrdersStateFilter.md ├── V1UpdateFeeRequest.md ├── CatalogQueryItemsForTax.md ├── OrderLineItemDiscountType.md ├── V1UpdateItemRequest.md ├── V1UpdatePageRequest.md ├── CatalogQueryPrefix.md ├── V1CreateFeeRequest.md ├── CustomerPreferences.md ├── V1CreateItemRequest.md ├── V1CreatePageRequest.md ├── TransactionProduct.md ├── V1UpdateCategoryRequest.md ├── V1UpdateDiscountRequest.md ├── V1UpdateEmployeeRequest.md ├── V1UpdatePageCellRequest.md ├── V1UpdateTimecardRequest.md ├── V1CreateEmployeeRoleRequest.md ├── V1PhoneNumber.md ├── V1UpdateVariationRequest.md ├── V1CreateCategoryRequest.md ├── V1CreateDiscountRequest.md ├── V1TenderCardBrand.md ├── CatalogItemProductType.md ├── CatalogObjectBatch.md ├── CustomerGroupInfo.md ├── ErrorCategory.md ├── V1CreateVariationRequest.md ├── UpdateWorkweekConfigRequest.md ├── V1UpdateEmployeeRoleRequest.md ├── CardBrand.md ├── Coordinates.md ├── V1InventoryEntry.md ├── CatalogCategory.md ├── V1UpdateModifierOptionRequest.md ├── CatalogQueryItemsForModifierList.md ├── DeleteCustomerResponse.md ├── MeasurementUnitLength.md ├── RegisterDomainRequest.md ├── ShiftQuery.md ├── V1CreateModifierListRequest.md ├── OrderServiceChargeCalculationPhase.md ├── VoidTransactionResponse.md ├── DeleteShiftResponse.md ├── OrderSource.md ├── V1CreateModifierOptionRequest.md ├── BusinessHours.md ├── CaptureTransactionResponse.md ├── CreateShiftRequest.md ├── BatchRetrieveOrdersRequest.md ├── DeleteCustomerCardResponse.md ├── Product.md ├── CatalogModifier.md ├── DeleteBreakTypeResponse.md ├── V1CashDrawerEventEventType.md ├── V1EmployeeRolePermissions.md ├── MeasurementUnitArea.md ├── SearchOrdersQuery.md ├── CreateBreakTypeRequest.md ├── V1Money.md ├── ListWorkweekConfigsRequest.md ├── CreateMobileAuthorizationCodeRequest.md ├── OrderEntry.md ├── BatchChangeInventoryResponse.md ├── V1Category.md ├── ShiftSort.md ├── UpdateItemTaxesResponse.md ├── V1ListInventoryRequest.md ├── V1OrderHistoryEntry.md ├── StandardUnitDescriptionGroup.md ├── TenderCashDetails.md ├── CatalogQueryItemsForItemOptions.md ├── RetrieveInventoryAdjustmentResponse.md ├── SearchOrdersSourceFilter.md ├── V1DeletePageCellRequest.md ├── CatalogQueryRange.md ├── CatalogV1Id.md ├── SearchShiftsRequest.md ├── CatalogItemOptionForItem.md ├── UpdateItemModifierListsResponse.md ├── V1TimecardEventEventType.md ├── MeasurementUnitVolume.md ├── RetrieveInventoryPhysicalCountResponse.md ├── V1MerchantLocationDetails.md ├── CatalogModifierOverride.md ├── GetShiftResponse.md ├── InventoryState.md ├── MeasurementUnitCustom.md ├── UpdateShiftResponse.md ├── CatalogIdMapping.md ├── CreateOrderResponse.md ├── ChargeResponse.md ├── CreateRefundResponse.md ├── GetBreakTypeResponse.md ├── V1Page.md ├── SearchOrdersCustomerFilter.md ├── CreateShiftResponse.md ├── ShiftWage.md ├── UpdateBreakTypeResponse.md ├── CatalogInfoResponse.md ├── V1UpdateModifierListRequest.md ├── CreateCustomerResponse.md ├── UpdateCustomerResponse.md ├── CreateCustomerCardResponse.md ├── CustomerQuery.md ├── RetrieveEmployeeResponse.md ├── BatchDeleteCatalogObjectsRequest.md ├── ListLocationsResponse.md ├── RetrieveCustomerResponse.md ├── CatalogQueryItemVariationsForItemOptionValues.md ├── V1PaymentModifier.md ├── CreateBreakTypeResponse.md ├── GetEmployeeWageResponse.md ├── UpsertCatalogObjectResponse.md ├── V1PaymentItemDetail.md ├── RetrieveTransactionResponse.md ├── UpdateWorkweekConfigResponse.md ├── SearchShiftsResponse.md ├── StandardUnitDescription.md ├── V1PaymentDiscount.md ├── V1AdjustInventoryRequest.md ├── CreateCheckoutResponse.md ├── V1ListOrdersRequest.md ├── RetrieveInventoryCountRequest.md ├── ListCatalogResponse.md ├── RetrieveInventoryChangesRequest.md ├── ListBreakTypesRequest.md ├── ListEmployeeWagesRequest.md ├── RetrieveCatalogObjectResponse.md ├── BatchDeleteCatalogObjectsResponse.md ├── RegisterDomainResponse.md ├── ListEmployeeWagesResponse.md ├── CatalogObjectType.md ├── BatchRetrieveCatalogObjectsResponse.md ├── DateRange.md ├── OrderMoneyAmounts.md ├── CatalogImage.md ├── TimeRange.md ├── RetrieveInventoryChangesResponse.md ├── RevokeTokenRequest.md ├── ChargeRequestAdditionalRecipient.md ├── Error.md ├── ListEmployeesResponse.md ├── RetrieveInventoryCountResponse.md ├── UpdateItemTaxesRequest.md ├── BusinessHoursPeriod.md ├── V1ListEmployeeRolesRequest.md ├── CustomerCreationSource.md ├── EmployeeWage.md ├── BatchRetrieveInventoryCountsResponse.md ├── OrderFulfillment.md ├── BatchRetrieveInventoryChangesResponse.md ├── ListBreakTypesResponse.md └── OrderRoundingAdjustment.md └── squareconnect └── apis └── __init__.py /test/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.py[cod] 2 | travis-ci/accounts.json 3 | -------------------------------------------------------------------------------- /travis-ci/accounts.enc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/square/connect-python-sdk/HEAD/travis-ci/accounts.enc -------------------------------------------------------------------------------- /test/utils/__init__.py: -------------------------------------------------------------------------------- 1 | from __future__ import absolute_import 2 | 3 | from .api_test_case import APITestCase 4 | -------------------------------------------------------------------------------- /test-requirements.txt: -------------------------------------------------------------------------------- 1 | coverage>=4.0.3 2 | Faker>=0.8.16 3 | nose>=1.3.7 4 | pluggy>=0.3.1 5 | py>=1.4.31 6 | randomize>=0.13 7 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | certifi >= 14.05.14 2 | six >= 1.10 3 | python_dateutil >= 2.5.3 4 | setuptools >= 21.0.0 5 | urllib3 >= 1.15.1 6 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | Contributing 2 | ============ 3 | 4 | We are not be accepting bug reports, feature requests, or code contributions to 5 | this repository. 6 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = py27, py3 3 | 4 | [testenv] 5 | deps=-r{toxinidir}/requirements.txt 6 | -r{toxinidir}/test-requirements.txt 7 | 8 | commands= 9 | nosetests \ 10 | [] -------------------------------------------------------------------------------- /test/utils/api_test_case.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | import json 3 | 4 | class APITestCase(unittest.TestCase): 5 | accounts = None 6 | 7 | @classmethod 8 | def setUpClass(cls): 9 | with open('./travis-ci/accounts.json') as json_data: 10 | cls.accounts = json.load(json_data) 11 | -------------------------------------------------------------------------------- /docs/V1FeeAdjustmentType.md: -------------------------------------------------------------------------------- 1 | # V1FeeAdjustmentType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **TAX** | string 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1RefundType.md: -------------------------------------------------------------------------------- 1 | # V1RefundType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **FULL** | string 12 | **PARTIAL** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1EmployeeStatus.md: -------------------------------------------------------------------------------- 1 | # V1EmployeeStatus 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **ACTIVE** | string 12 | **INACTIVE** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1ItemVisibility.md: -------------------------------------------------------------------------------- 1 | # V1ItemVisibility 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **PUBLIC** | string 12 | **PRIVATE** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1SettlementStatus.md: -------------------------------------------------------------------------------- 1 | # V1SettlementStatus 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **FAILED** | string 12 | **SENT** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/OrderFulfillmentType.md: -------------------------------------------------------------------------------- 1 | # OrderFulfillmentType 2 | 3 | 4 | ### Description 5 | 6 | The type of fulfillment. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **PICKUP** | string 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1FeeInclusionType.md: -------------------------------------------------------------------------------- 1 | # V1FeeInclusionType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **ADDITIVE** | string 12 | **INCLUSIVE** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1CreateRefundRequestType.md: -------------------------------------------------------------------------------- 1 | # V1CreateRefundRequestType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **FULL** | string 12 | **PARTIAL** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1ItemType.md: -------------------------------------------------------------------------------- 1 | # V1ItemType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **NORMAL** | string 12 | **GIFT_CARD** | string 13 | **OTHER** | string 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/V1MerchantAccountType.md: -------------------------------------------------------------------------------- 1 | # V1MerchantAccountType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **LOCATION** | string 12 | **BUSINESS** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1PaymentTaxInclusionType.md: -------------------------------------------------------------------------------- 1 | # V1PaymentTaxInclusionType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **ADDITIVE** | string 12 | **INCLUSIVE** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/LocationType.md: -------------------------------------------------------------------------------- 1 | # LocationType 2 | 3 | 4 | ### Description 5 | 6 | Indicates the location's type. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **PHYSICAL** | string 12 | **MOBILE** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1ListEmployeesRequestStatus.md: -------------------------------------------------------------------------------- 1 | # V1ListEmployeesRequestStatus 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **ACTIVE** | string 12 | **INACTIVE** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1ListSettlementsRequestStatus.md: -------------------------------------------------------------------------------- 1 | # V1ListSettlementsRequestStatus 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **SENT** | string 12 | **FAILED** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1ModifierListSelectionType.md: -------------------------------------------------------------------------------- 1 | # V1ModifierListSelectionType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **SINGLE** | string 12 | **MULTIPLE** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/LocationStatus.md: -------------------------------------------------------------------------------- 1 | # LocationStatus 2 | 3 | 4 | ### Description 5 | 6 | Indicates the location's status. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **ACTIVE** | string 12 | **INACTIVE** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ShiftStatus.md: -------------------------------------------------------------------------------- 1 | # ShiftStatus 2 | 3 | 4 | ### Description 5 | 6 | Enumerates the possible status of a `Shift` 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **OPEN** | string 12 | **CLOSED** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1VariationPricingType.md: -------------------------------------------------------------------------------- 1 | # V1VariationPricingType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **FIXED_PRICING** | string 12 | **VARIABLE_PRICING** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/EmployeeStatus.md: -------------------------------------------------------------------------------- 1 | # EmployeeStatus 2 | 3 | 4 | ### Description 5 | 6 | The status of the Employee being retrieved. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **ACTIVE** | string 12 | **INACTIVE** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/OrderState.md: -------------------------------------------------------------------------------- 1 | # OrderState 2 | 3 | 4 | ### Description 5 | 6 | The state of the order. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **OPEN** | string 12 | **COMPLETED** | string 13 | **CANCELED** | string 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/V1CashDrawerShiftEventType.md: -------------------------------------------------------------------------------- 1 | # V1CashDrawerShiftEventType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **OPEN** | string 12 | **ENDED** | string 13 | **CLOSED** | string 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/V1PaymentSurchargeType.md: -------------------------------------------------------------------------------- 1 | # V1PaymentSurchargeType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **UNKNOWN** | string 12 | **AUTO_GRATUITY** | string 13 | **CUSTOM** | string 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/V1UpdateOrderRequestAction.md: -------------------------------------------------------------------------------- 1 | # V1UpdateOrderRequestAction 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **COMPLETE** | string 12 | **CANCEL** | string 13 | **REFUND** | string 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/CatalogInfoRequest.md: -------------------------------------------------------------------------------- 1 | # CatalogInfoRequest 2 | > squareconnect.models.catalog_info_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ApplyFeeRequest.md: -------------------------------------------------------------------------------- 1 | # V1ApplyFeeRequest 2 | > squareconnect.models.v1_apply_fee_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1DeleteFeeRequest.md: -------------------------------------------------------------------------------- 1 | # V1DeleteFeeRequest 2 | > squareconnect.models.v1_delete_fee_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListFeesRequest.md: -------------------------------------------------------------------------------- 1 | # V1ListFeesRequest 2 | > squareconnect.models.v1_list_fees_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListPagesRequest.md: -------------------------------------------------------------------------------- 1 | # V1ListPagesRequest 2 | > squareconnect.models.v1_list_pages_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1RemoveFeeRequest.md: -------------------------------------------------------------------------------- 1 | # V1RemoveFeeRequest 2 | > squareconnect.models.v1_remove_fee_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1UpdateModifierListRequestSelectionType.md: -------------------------------------------------------------------------------- 1 | # V1UpdateModifierListRequestSelectionType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **SINGLE** | string 12 | **MULTIPLE** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ShiftFilterStatus.md: -------------------------------------------------------------------------------- 1 | # ShiftFilterStatus 2 | 3 | 4 | ### Description 5 | 6 | Specifies the `status` of `Shift` records to be returned. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **OPEN** | string 12 | **CLOSED** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1DeleteItemRequest.md: -------------------------------------------------------------------------------- 1 | # V1DeleteItemRequest 2 | > squareconnect.models.v1_delete_item_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1DeletePageRequest.md: -------------------------------------------------------------------------------- 1 | # V1DeletePageRequest 2 | > squareconnect.models.v1_delete_page_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1DiscountDiscountType.md: -------------------------------------------------------------------------------- 1 | # V1DiscountDiscountType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **FIXED** | string 12 | **VARIABLE_PERCENTAGE** | string 13 | **VARIABLE_AMOUNT** | string 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/V1FeeCalculationPhase.md: -------------------------------------------------------------------------------- 1 | # V1FeeCalculationPhase 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **FEE_SUBTOTAL_PHASE** | string 12 | **OTHER** | string 13 | **FEE_TOTAL_PHASE** | string 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/CustomerSortField.md: -------------------------------------------------------------------------------- 1 | # CustomerSortField 2 | 3 | 4 | ### Description 5 | 6 | Indicates the sort criteria for a list of Customers. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **DEFAULT** | string 12 | **CREATED_AT** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/RegisterDomainResponseStatus.md: -------------------------------------------------------------------------------- 1 | # RegisterDomainResponseStatus 2 | 3 | 4 | ### Description 5 | 6 | The status of domain registration. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **PENDING** | string 12 | **VERIFIED** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1RetrieveItemRequest.md: -------------------------------------------------------------------------------- 1 | # V1RetrieveItemRequest 2 | > squareconnect.models.v1_retrieve_item_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/WebhookEvents.md: -------------------------------------------------------------------------------- 1 | # WebhookEvents 2 | 3 | 4 | ### Description 5 | 6 | The type of an event that triggers a webhook notification to an application. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **inventory.count.updated** | string 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1DeleteCategoryRequest.md: -------------------------------------------------------------------------------- 1 | # V1DeleteCategoryRequest 2 | > squareconnect.models.v1_delete_category_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1DeleteDiscountRequest.md: -------------------------------------------------------------------------------- 1 | # V1DeleteDiscountRequest 2 | > squareconnect.models.v1_delete_discount_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1DeleteTimecardRequest.md: -------------------------------------------------------------------------------- 1 | # V1DeleteTimecardRequest 2 | > squareconnect.models.v1_delete_timecard_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListCategoriesRequest.md: -------------------------------------------------------------------------------- 1 | # V1ListCategoriesRequest 2 | > squareconnect.models.v1_list_categories_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListDiscountsRequest.md: -------------------------------------------------------------------------------- 1 | # V1ListDiscountsRequest 2 | > squareconnect.models.v1_list_discounts_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListLocationsRequest.md: -------------------------------------------------------------------------------- 1 | # V1ListLocationsRequest 2 | > squareconnect.models.v1_list_locations_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1PageCellObjectType.md: -------------------------------------------------------------------------------- 1 | # V1PageCellObjectType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **ITEM** | string 12 | **DISCOUNT** | string 13 | **CATEGORY** | string 14 | **PLACEHOLDER** | string 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/V1PageCellPlaceholderType.md: -------------------------------------------------------------------------------- 1 | # V1PageCellPlaceholderType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **ALL_ITEMS** | string 12 | **DISCOUNTS_CATEGORY** | string 13 | **REWARDS_FINDER** | string 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/V1RetrieveOrderRequest.md: -------------------------------------------------------------------------------- 1 | # V1RetrieveOrderRequest 2 | > squareconnect.models.v1_retrieve_order_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/MeasurementUnitGeneric.md: -------------------------------------------------------------------------------- 1 | # MeasurementUnitGeneric 2 | 3 | 4 | ### Description 5 | 6 | A custom unit of measurement defined by the user. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **INVALID_GENERIC_UNIT** | string 12 | **UNIT** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/TaxCalculationPhase.md: -------------------------------------------------------------------------------- 1 | # TaxCalculationPhase 2 | 3 | 4 | ### Description 5 | 6 | When to calculate the taxes due on a cart. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **TAX_SUBTOTAL_PHASE** | string 12 | **TAX_TOTAL_PHASE** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1DeleteTimecardResponse.md: -------------------------------------------------------------------------------- 1 | # V1DeleteTimecardResponse 2 | > squareconnect.models.v1_delete_timecard_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1DeleteVariationRequest.md: -------------------------------------------------------------------------------- 1 | # V1DeleteVariationRequest 2 | > squareconnect.models.v1_delete_variation_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1RetrieveBusinessRequest.md: -------------------------------------------------------------------------------- 1 | # V1RetrieveBusinessRequest 2 | > squareconnect.models.v1_retrieve_business_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1RetrieveEmployeeRequest.md: -------------------------------------------------------------------------------- 1 | # V1RetrieveEmployeeRequest 2 | > squareconnect.models.v1_retrieve_employee_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1RetrievePaymentRequest.md: -------------------------------------------------------------------------------- 1 | # V1RetrievePaymentRequest 2 | > squareconnect.models.v1_retrieve_payment_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1RetrieveTimecardRequest.md: -------------------------------------------------------------------------------- 1 | # V1RetrieveTimecardRequest 2 | > squareconnect.models.v1_retrieve_timecard_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/DeleteCatalogObjectRequest.md: -------------------------------------------------------------------------------- 1 | # DeleteCatalogObjectRequest 2 | > squareconnect.models.delete_catalog_object_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/GetShiftRequest.md: -------------------------------------------------------------------------------- 1 | # GetShiftRequest 2 | > squareconnect.models.get_shift_request 3 | 4 | ### Description 5 | 6 | A request to get a `Shift` by ID 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/SortOrder.md: -------------------------------------------------------------------------------- 1 | # SortOrder 2 | 3 | 4 | ### Description 5 | 6 | The order (e.g., chronological or alphabetical) in which results from a request are returned. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **DESC** | string 12 | **ASC** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1ApplyModifierListRequest.md: -------------------------------------------------------------------------------- 1 | # V1ApplyModifierListRequest 2 | > squareconnect.models.v1_apply_modifier_list_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListBankAccountsRequest.md: -------------------------------------------------------------------------------- 1 | # V1ListBankAccountsRequest 2 | > squareconnect.models.v1_list_bank_accounts_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListModifierListsRequest.md: -------------------------------------------------------------------------------- 1 | # V1ListModifierListsRequest 2 | > squareconnect.models.v1_list_modifier_lists_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/DeleteShiftRequest.md: -------------------------------------------------------------------------------- 1 | # DeleteShiftRequest 2 | > squareconnect.models.delete_shift_request 3 | 4 | ### Description 5 | 6 | A request to delete a `Shift` 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/RefundStatus.md: -------------------------------------------------------------------------------- 1 | # RefundStatus 2 | 3 | 4 | ### Description 5 | 6 | Indicates a refund's current status. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **PENDING** | string 12 | **APPROVED** | string 13 | **REJECTED** | string 14 | **FAILED** | string 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/V1AdjustInventoryRequestAdjustmentType.md: -------------------------------------------------------------------------------- 1 | # V1AdjustInventoryRequestAdjustmentType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **SALE** | string 12 | **RECEIVE_STOCK** | string 13 | **MANUAL_ADJUST** | string 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/V1DeleteModifierListRequest.md: -------------------------------------------------------------------------------- 1 | # V1DeleteModifierListRequest 2 | > squareconnect.models.v1_delete_modifier_list_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListTimecardEventsRequest.md: -------------------------------------------------------------------------------- 1 | # V1ListTimecardEventsRequest 2 | > squareconnect.models.v1_list_timecard_events_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1RemoveModifierListRequest.md: -------------------------------------------------------------------------------- 1 | # V1RemoveModifierListRequest 2 | > squareconnect.models.v1_remove_modifier_list_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1RetrieveBankAccountRequest.md: -------------------------------------------------------------------------------- 1 | # V1RetrieveBankAccountRequest 2 | > squareconnect.models.v1_retrieve_bank_account_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1RetrieveSettlementRequest.md: -------------------------------------------------------------------------------- 1 | # V1RetrieveSettlementRequest 2 | > squareconnect.models.v1_retrieve_settlement_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/LocationCapability.md: -------------------------------------------------------------------------------- 1 | # LocationCapability 2 | 3 | 4 | ### Description 5 | 6 | Indicates payment capabilities that a business's location might or might not have enabled. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **CREDIT_CARD_PROCESSING** | string 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/ShiftWorkdayMatcher.md: -------------------------------------------------------------------------------- 1 | # ShiftWorkdayMatcher 2 | 3 | 4 | ### Description 5 | 6 | Defines the logic used to apply a workday filter. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **START_AT** | string 12 | **END_AT** | string 13 | **INTERSECTION** | string 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/V1DeleteModifierOptionRequest.md: -------------------------------------------------------------------------------- 1 | # V1DeleteModifierOptionRequest 2 | > squareconnect.models.v1_delete_modifier_option_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1RetrieveEmployeeRoleRequest.md: -------------------------------------------------------------------------------- 1 | # V1RetrieveEmployeeRoleRequest 2 | > squareconnect.models.v1_retrieve_employee_role_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1RetrieveModifierListRequest.md: -------------------------------------------------------------------------------- 1 | # V1RetrieveModifierListRequest 2 | > squareconnect.models.v1_retrieve_modifier_list_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/GetBreakTypeRequest.md: -------------------------------------------------------------------------------- 1 | # GetBreakTypeRequest 2 | > squareconnect.models.get_break_type_request 3 | 4 | ### Description 5 | 6 | A request to GET a `BreakType` by ID 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/DeleteBreakTypeRequest.md: -------------------------------------------------------------------------------- 1 | # DeleteBreakTypeRequest 2 | > squareconnect.models.delete_break_type_request 3 | 4 | ### Description 5 | 6 | A request to delete a `BreakType` 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/GetEmployeeWageRequest.md: -------------------------------------------------------------------------------- 1 | # GetEmployeeWageRequest 2 | > squareconnect.models.get_employee_wage_request 3 | 4 | ### Description 5 | 6 | A request to get an `EmployeeWage` 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/OrderFulfillmentPickupDetailsScheduleType.md: -------------------------------------------------------------------------------- 1 | # OrderFulfillmentPickupDetailsScheduleType 2 | 3 | 4 | ### Description 5 | 6 | The schedule type of the pickup fulfillment. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **SCHEDULED** | string 12 | **ASAP** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ShiftSortField.md: -------------------------------------------------------------------------------- 1 | # ShiftSortField 2 | 3 | 4 | ### Description 5 | 6 | Enumerates the `Shift` fields to sort on. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **START_AT** | string 12 | **END_AT** | string 13 | **CREATED_AT** | string 14 | **UPDATED_AT** | string 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/V1RetrieveCashDrawerShiftRequest.md: -------------------------------------------------------------------------------- 1 | # V1RetrieveCashDrawerShiftRequest 2 | > squareconnect.models.v1_retrieve_cash_drawer_shift_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/OrderLineItemTaxScope.md: -------------------------------------------------------------------------------- 1 | # OrderLineItemTaxScope 2 | 3 | 4 | ### Description 5 | 6 | Indicates whether this is a line item or order level tax. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **OTHER_TAX_SCOPE** | string 12 | **LINE_ITEM** | string 13 | **ORDER** | string 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/RetrieveEmployeeRequest.md: -------------------------------------------------------------------------------- 1 | # RetrieveEmployeeRequest 2 | > squareconnect.models.retrieve_employee_request 3 | 4 | ### Description 5 | 6 | Retrieve an employee by `Employee.id` 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/RetrieveInventoryAdjustmentRequest.md: -------------------------------------------------------------------------------- 1 | # RetrieveInventoryAdjustmentRequest 2 | > squareconnect.models.retrieve_inventory_adjustment_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1OrderState.md: -------------------------------------------------------------------------------- 1 | # V1OrderState 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **PENDING** | string 12 | **OPEN** | string 13 | **COMPLETED** | string 14 | **CANCELED** | string 15 | **REFUNDED** | string 16 | **REJECTED** | string 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/SearchOrdersSortField.md: -------------------------------------------------------------------------------- 1 | # SearchOrdersSortField 2 | 3 | 4 | ### Description 5 | 6 | Specifies which timestamp to use to sort SearchOrder results. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **CREATED_AT** | string 12 | **UPDATED_AT** | string 13 | **CLOSED_AT** | string 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/Weekday.md: -------------------------------------------------------------------------------- 1 | # Weekday 2 | 3 | 4 | ### Description 5 | 6 | The days of the week. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **MON** | string 12 | **TUE** | string 13 | **WED** | string 14 | **THU** | string 15 | **FRI** | string 16 | **SAT** | string 17 | **SUN** | string 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/OrderLineItemTaxType.md: -------------------------------------------------------------------------------- 1 | # OrderLineItemTaxType 2 | 3 | 4 | ### Description 5 | 6 | Indicates how the tax is applied to the associated line item or order. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **UNKNOWN_TAX** | string 12 | **ADDITIVE** | string 13 | **INCLUSIVE** | string 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/RetrieveInventoryPhysicalCountRequest.md: -------------------------------------------------------------------------------- 1 | # RetrieveInventoryPhysicalCountRequest 2 | > squareconnect.models.retrieve_inventory_physical_count_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/TaxInclusionType.md: -------------------------------------------------------------------------------- 1 | # TaxInclusionType 2 | 3 | 4 | ### Description 5 | 6 | Whether to the tax amount should be additional to or included in to the [CatalogItem](#type-catalogitem) price. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **ADDITIVE** | string 12 | **INCLUSIVE** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/TenderCardDetailsStatus.md: -------------------------------------------------------------------------------- 1 | # TenderCardDetailsStatus 2 | 3 | 4 | ### Description 5 | 6 | Indicates the card transaction's current status. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **AUTHORIZED** | string 12 | **CAPTURED** | string 13 | **VOIDED** | string 14 | **FAILED** | string 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/V1BankAccountType.md: -------------------------------------------------------------------------------- 1 | # V1BankAccountType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **BUSINESS_CHECKING** | string 12 | **CHECKING** | string 13 | **INVESTMENT** | string 14 | **LOAN** | string 15 | **SAVINGS** | string 16 | **OTHER** | string 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/V1ListFeesResponse.md: -------------------------------------------------------------------------------- 1 | # V1ListFeesResponse 2 | > squareconnect.models.v1_list_fees_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**list[V1Fee]**](V1Fee.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/InventoryChangeType.md: -------------------------------------------------------------------------------- 1 | # InventoryChangeType 2 | 3 | 4 | ### Description 5 | 6 | Indicates how the inventory change was applied to a tracked quantity of items. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **PHYSICAL_COUNT** | string 12 | **ADJUSTMENT** | string 13 | **TRANSFER** | string 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/OrderLineItemDiscountScope.md: -------------------------------------------------------------------------------- 1 | # OrderLineItemDiscountScope 2 | 3 | 4 | ### Description 5 | 6 | Indicates whether this is a line item or order level discount. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **OTHER_DISCOUNT_SCOPE** | string 12 | **LINE_ITEM** | string 13 | **ORDER** | string 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/V1ListItemsResponse.md: -------------------------------------------------------------------------------- 1 | # V1ListItemsResponse 2 | > squareconnect.models.v1_list_items_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**list[V1Item]**](V1Item.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ListPagesResponse.md: -------------------------------------------------------------------------------- 1 | # V1ListPagesResponse 2 | > squareconnect.models.v1_list_pages_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**list[V1Page]**](V1Page.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/RenewTokenRequest.md: -------------------------------------------------------------------------------- 1 | # RenewTokenRequest 2 | > squareconnect.models.renew_token_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **access_token** | **str** | The token you want to renew. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ListOrdersResponse.md: -------------------------------------------------------------------------------- 1 | # V1ListOrdersResponse 2 | > squareconnect.models.v1_list_orders_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**list[V1Order]**](V1Order.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CatalogModifierListSelectionType.md: -------------------------------------------------------------------------------- 1 | # CatalogModifierListSelectionType 2 | 3 | 4 | ### Description 5 | 6 | Indicates whether a [CatalogModifierList](#type-catalogmodifierlist) supports multiple selections. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **SINGLE** | string 12 | **MULTIPLE** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/DayOfWeek.md: -------------------------------------------------------------------------------- 1 | # DayOfWeek 2 | 3 | 4 | ### Description 5 | 6 | Indicates the specific day of the week. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **SUN** | string 12 | **MON** | string 13 | **TUE** | string 14 | **WED** | string 15 | **THU** | string 16 | **FRI** | string 17 | **SAT** | string 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/TenderType.md: -------------------------------------------------------------------------------- 1 | # TenderType 2 | 3 | 4 | ### Description 5 | 6 | Indicates a tender's type. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **CARD** | string 12 | **CASH** | string 13 | **THIRD_PARTY_CARD** | string 14 | **SQUARE_GIFT_CARD** | string 15 | **NO_SALE** | string 16 | **OTHER** | string 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/V1ListRefundsResponse.md: -------------------------------------------------------------------------------- 1 | # V1ListRefundsResponse 2 | > squareconnect.models.v1_list_refunds_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**list[V1Refund]**](V1Refund.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1VariationInventoryAlertType.md: -------------------------------------------------------------------------------- 1 | # V1VariationInventoryAlertType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **LOW_QUANTITY** | string 12 | **NONE** | string 13 | **INVESTMENT** | string 14 | **LOAN** | string 15 | **SAVINGS** | string 16 | **OTHER** | string 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/VoidTransactionRequest.md: -------------------------------------------------------------------------------- 1 | # VoidTransactionRequest 2 | > squareconnect.models.void_transaction_request 3 | 4 | ### Description 5 | 6 | Defines the request body for calls to the VoidTransaction endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/ListLocationsRequest.md: -------------------------------------------------------------------------------- 1 | # ListLocationsRequest 2 | > squareconnect.models.list_locations_request 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListPaymentsResponse.md: -------------------------------------------------------------------------------- 1 | # V1ListPaymentsResponse 2 | > squareconnect.models.v1_list_payments_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**list[V1Payment]**](V1Payment.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/DeleteCustomerRequest.md: -------------------------------------------------------------------------------- 1 | # DeleteCustomerRequest 2 | > squareconnect.models.delete_customer_request 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/RevokeTokenResponse.md: -------------------------------------------------------------------------------- 1 | # RevokeTokenResponse 2 | > squareconnect.models.revoke_token_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **success** | **bool** | If the request is successful, this is true. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ListCategoriesResponse.md: -------------------------------------------------------------------------------- 1 | # V1ListCategoriesResponse 2 | > squareconnect.models.v1_list_categories_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**list[V1Category]**](V1Category.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ListDiscountsResponse.md: -------------------------------------------------------------------------------- 1 | # V1ListDiscountsResponse 2 | > squareconnect.models.v1_list_discounts_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**list[V1Discount]**](V1Discount.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ListEmployeesResponse.md: -------------------------------------------------------------------------------- 1 | # V1ListEmployeesResponse 2 | > squareconnect.models.v1_list_employees_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**list[V1Employee]**](V1Employee.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ListLocationsResponse.md: -------------------------------------------------------------------------------- 1 | # V1ListLocationsResponse 2 | > squareconnect.models.v1_list_locations_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**list[V1Merchant]**](V1Merchant.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ListTimecardsResponse.md: -------------------------------------------------------------------------------- 1 | # V1ListTimecardsResponse 2 | > squareconnect.models.v1_list_timecards_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**list[V1Timecard]**](V1Timecard.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CaptureTransactionRequest.md: -------------------------------------------------------------------------------- 1 | # CaptureTransactionRequest 2 | > squareconnect.models.capture_transaction_request 3 | 4 | ### Description 5 | 6 | Defines the query parameters for calls to the CaptureTransaction endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CustomerInclusionExclusion.md: -------------------------------------------------------------------------------- 1 | # CustomerInclusionExclusion 2 | 3 | 4 | ### Description 5 | 6 | Indicates whether customers should be included in, or excluded from, the result set when they match the filtering criteria. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **INCLUDE** | string 12 | **EXCLUDE** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/RetrieveCustomerRequest.md: -------------------------------------------------------------------------------- 1 | # RetrieveCustomerRequest 2 | > squareconnect.models.retrieve_customer_request 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1TenderEntryMethod.md: -------------------------------------------------------------------------------- 1 | # V1TenderEntryMethod 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **MANUAL** | string 12 | **SCANNED** | string 13 | **SQUARE_CASH** | string 14 | **SQUARE_WALLET** | string 15 | **SWIPED** | string 16 | **WEB_FORM** | string 17 | **OTHER** | string 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/CatalogPricingType.md: -------------------------------------------------------------------------------- 1 | # CatalogPricingType 2 | 3 | 4 | ### Description 5 | 6 | Indicates whether the price of a [CatalogItemVariation](#type-catalogitemvariation) should be entered manually at the time of sale. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **FIXED_PRICING** | string 12 | **VARIABLE_PRICING** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/InventoryAlertType.md: -------------------------------------------------------------------------------- 1 | # InventoryAlertType 2 | 3 | 4 | ### Description 5 | 6 | Indicates whether Square should alert the merchant when the inventory quantity of a [CatalogItemVariation](#type-catalogitemvariation) is low. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **NONE** | string 12 | **LOW_QUANTITY** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/OrderFulfillmentState.md: -------------------------------------------------------------------------------- 1 | # OrderFulfillmentState 2 | 3 | 4 | ### Description 5 | 6 | The state of the fulfillment. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **PROPOSED** | string 12 | **RESERVED** | string 13 | **PREPARED** | string 14 | **COMPLETED** | string 15 | **CANCELED** | string 16 | **FAILED** | string 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/RetrieveTransactionRequest.md: -------------------------------------------------------------------------------- 1 | # RetrieveTransactionRequest 2 | > squareconnect.models.retrieve_transaction_request 3 | 4 | ### Description 5 | 6 | Defines the request body fields for calls to the RetrieveTransaction endpoint. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/V1ListInventoryResponse.md: -------------------------------------------------------------------------------- 1 | # V1ListInventoryResponse 2 | > squareconnect.models.v1_list_inventory_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**list[V1InventoryEntry]**](V1InventoryEntry.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ListSettlementsResponse.md: -------------------------------------------------------------------------------- 1 | # V1ListSettlementsResponse 2 | > squareconnect.models.v1_list_settlements_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**list[V1Settlement]**](V1Settlement.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/DeleteCustomerCardRequest.md: -------------------------------------------------------------------------------- 1 | # DeleteCustomerCardRequest 2 | > squareconnect.models.delete_customer_card_request 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/TenderCardDetailsEntryMethod.md: -------------------------------------------------------------------------------- 1 | # TenderCardDetailsEntryMethod 2 | 3 | 4 | ### Description 5 | 6 | Indicates the method used to enter the card's details. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **SWIPED** | string 12 | **KEYED** | string 13 | **EMV** | string 14 | **ON_FILE** | string 15 | **CONTACTLESS** | string 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/V1FeeType.md: -------------------------------------------------------------------------------- 1 | # V1FeeType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **CA_GST** | string 12 | **CA_HST** | string 13 | **CA_PST** | string 14 | **CA_QST** | string 15 | **JP_CONSUMPTION_TAX** | string 16 | **CA_PEI_PST** | string 17 | **US_SALES_TAX** | string 18 | **OTHER** | string 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/V1ListBankAccountsResponse.md: -------------------------------------------------------------------------------- 1 | # V1ListBankAccountsResponse 2 | > squareconnect.models.v1_list_bank_accounts_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**list[V1BankAccount]**](V1BankAccount.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ListEmployeeRolesResponse.md: -------------------------------------------------------------------------------- 1 | # V1ListEmployeeRolesResponse 2 | > squareconnect.models.v1_list_employee_roles_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**list[V1EmployeeRole]**](V1EmployeeRole.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ListModifierListsResponse.md: -------------------------------------------------------------------------------- 1 | # V1ListModifierListsResponse 2 | > squareconnect.models.v1_list_modifier_lists_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**list[V1ModifierList]**](V1ModifierList.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/Device.md: -------------------------------------------------------------------------------- 1 | # Device 2 | > squareconnect.models.device 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **id** | **str** | The device's Square-issued ID. | [optional] 12 | **name** | **str** | The device's merchant-specified name. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1ItemColor.md: -------------------------------------------------------------------------------- 1 | # V1ItemColor 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **9da2a6** | string 12 | **4ab200** | string 13 | **0b8000** | string 14 | **2952cc** | string 15 | **a82ee5** | string 16 | **e5457a** | string 17 | **b21212** | string 18 | **593c00** | string 19 | **e5BF00** | string 20 | 21 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/V1ListTimecardEventsResponse.md: -------------------------------------------------------------------------------- 1 | # V1ListTimecardEventsResponse 2 | > squareconnect.models.v1_list_timecard_events_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**list[V1TimecardEvent]**](V1TimecardEvent.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/UpdateShiftRequest.md: -------------------------------------------------------------------------------- 1 | # UpdateShiftRequest 2 | > squareconnect.models.update_shift_request 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1DiscountColor.md: -------------------------------------------------------------------------------- 1 | # V1DiscountColor 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **9da2a6** | string 12 | **4ab200** | string 13 | **0b8000** | string 14 | **2952cc** | string 15 | **a82ee5** | string 16 | **e5457a** | string 17 | **b21212** | string 18 | **593c00** | string 19 | **e5BF00** | string 20 | 21 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/V1OrderHistoryEntryAction.md: -------------------------------------------------------------------------------- 1 | # V1OrderHistoryEntryAction 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **ORDER_PLACED** | string 12 | **DECLINED** | string 13 | **PAYMENT_RECEIVED** | string 14 | **CANCELED** | string 15 | **COMPLETED** | string 16 | **REFUNDED** | string 17 | **EXPIRED** | string 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/V1TenderType.md: -------------------------------------------------------------------------------- 1 | # V1TenderType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **CREDIT_CARD** | string 12 | **CASH** | string 13 | **THIRD_PARTY_CARD** | string 14 | **NO_SALE** | string 15 | **SQUARE_WALLET** | string 16 | **SQUARE_GIFT_CARD** | string 17 | **UNKNOWN** | string 18 | **OTHER** | string 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/V1ListCashDrawerShiftsResponse.md: -------------------------------------------------------------------------------- 1 | # V1ListCashDrawerShiftsResponse 2 | > squareconnect.models.v1_list_cash_drawer_shifts_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **items** | [**list[V1CashDrawerShift]**](V1CashDrawerShift.md) | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1PaymentItemizationItemizationType.md: -------------------------------------------------------------------------------- 1 | # V1PaymentItemizationItemizationType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **ITEM** | string 12 | **CUSTOM_AMOUNT** | string 13 | **GIFT_CARD_ACTIVATION** | string 14 | **GIFT_CARD_RELOAD** | string 15 | **GIFT_CARD_UNKNOWN** | string 16 | **OTHER** | string 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/CatalogDiscountType.md: -------------------------------------------------------------------------------- 1 | # CatalogDiscountType 2 | 3 | 4 | ### Description 5 | 6 | How to apply a [CatalogDiscount](#type-catalogdiscount) to a [CatalogItem](#type-catalogitem). 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **FIXED_PERCENTAGE** | string 12 | **FIXED_AMOUNT** | string 13 | **VARIABLE_PERCENTAGE** | string 14 | **VARIABLE_AMOUNT** | string 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/CatalogQueryText.md: -------------------------------------------------------------------------------- 1 | # CatalogQueryText 2 | > squareconnect.models.catalog_query_text 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **keywords** | **list[str]** | A list of one, two, or three search keywords. Keywords with fewer than three characters are ignored. | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1ItemImage.md: -------------------------------------------------------------------------------- 1 | # V1ItemImage 2 | > squareconnect.models.v1_item_image 3 | 4 | ### Description 5 | 6 | V1ItemImage 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **id** | **str** | The image's unique ID. | [optional] 12 | **url** | **str** | The image's publicly accessible URL. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1ListItemsRequest.md: -------------------------------------------------------------------------------- 1 | # V1ListItemsRequest 2 | > squareconnect.models.v1_list_items_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **batch_token** | **str** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/UpdateBreakTypeRequest.md: -------------------------------------------------------------------------------- 1 | # UpdateBreakTypeRequest 2 | > squareconnect.models.update_break_type_request 3 | 4 | ### Description 5 | 6 | A request to update a `BreakType` 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **break_type** | [**BreakType**](BreakType.md) | The updated `BreakType`. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/MeasurementUnitWeight.md: -------------------------------------------------------------------------------- 1 | # MeasurementUnitWeight 2 | 3 | 4 | ### Description 5 | 6 | Unit of weight used to measure a quantity. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **IMPERIAL_WEIGHT_OUNCE** | string 12 | **IMPERIAL_POUND** | string 13 | **IMPERIAL_STONE** | string 14 | **METRIC_MILLIGRAM** | string 15 | **METRIC_GRAM** | string 16 | **METRIC_KILOGRAM** | string 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/CatalogQueryExact.md: -------------------------------------------------------------------------------- 1 | # CatalogQueryExact 2 | > squareconnect.models.catalog_query_exact 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **attribute_name** | **str** | The name of the attribute to be searched. | 12 | **attribute_value** | **str** | The desired value of the search attribute. | 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/SearchOrdersStateFilter.md: -------------------------------------------------------------------------------- 1 | # SearchOrdersStateFilter 2 | > squareconnect.models.search_orders_state_filter 3 | 4 | ### Description 5 | 6 | Filter by current Order `state`. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **states** | **list[str]** | States to filter for. See [OrderState](#type-orderstate) for possible values | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1UpdateFeeRequest.md: -------------------------------------------------------------------------------- 1 | # V1UpdateFeeRequest 2 | > squareconnect.models.v1_update_fee_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **body** | [**V1Fee**](V1Fee.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CatalogQueryItemsForTax.md: -------------------------------------------------------------------------------- 1 | # CatalogQueryItemsForTax 2 | > squareconnect.models.catalog_query_items_for_tax 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **tax_ids** | **list[str]** | A set of [CatalogTax](#type-catalogtax) IDs to be used to find associated [CatalogItem](#type-catalogitem)s. | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/OrderLineItemDiscountType.md: -------------------------------------------------------------------------------- 1 | # OrderLineItemDiscountType 2 | 3 | 4 | ### Description 5 | 6 | Indicates how the discount is applied to the associated line item or order. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **UNKNOWN_DISCOUNT** | string 12 | **FIXED_PERCENTAGE** | string 13 | **FIXED_AMOUNT** | string 14 | **VARIABLE_PERCENTAGE** | string 15 | **VARIABLE_AMOUNT** | string 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/V1UpdateItemRequest.md: -------------------------------------------------------------------------------- 1 | # V1UpdateItemRequest 2 | > squareconnect.models.v1_update_item_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **body** | [**V1Item**](V1Item.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1UpdatePageRequest.md: -------------------------------------------------------------------------------- 1 | # V1UpdatePageRequest 2 | > squareconnect.models.v1_update_page_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **body** | [**V1Page**](V1Page.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CatalogQueryPrefix.md: -------------------------------------------------------------------------------- 1 | # CatalogQueryPrefix 2 | > squareconnect.models.catalog_query_prefix 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **attribute_name** | **str** | The name of the attribute to be searched. | 12 | **attribute_prefix** | **str** | The desired prefix of the search attribute value. | 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1CreateFeeRequest.md: -------------------------------------------------------------------------------- 1 | # V1CreateFeeRequest 2 | > squareconnect.models.v1_create_fee_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **body** | [**V1Fee**](V1Fee.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CustomerPreferences.md: -------------------------------------------------------------------------------- 1 | # CustomerPreferences 2 | > squareconnect.models.customer_preferences 3 | 4 | ### Description 5 | 6 | Represents a particular customer's preferences. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **email_unsubscribed** | **bool** | The customer has unsubscribed from receiving marketing campaign emails. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1CreateItemRequest.md: -------------------------------------------------------------------------------- 1 | # V1CreateItemRequest 2 | > squareconnect.models.v1_create_item_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **body** | [**V1Item**](V1Item.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1CreatePageRequest.md: -------------------------------------------------------------------------------- 1 | # V1CreatePageRequest 2 | > squareconnect.models.v1_create_page_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **body** | [**V1Page**](V1Page.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/TransactionProduct.md: -------------------------------------------------------------------------------- 1 | # TransactionProduct 2 | 3 | 4 | ### Description 5 | 6 | Indicates the Square product used to process a transaction. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **REGISTER** | string 12 | **EXTERNAL_API** | string 13 | **BILLING** | string 14 | **APPOINTMENTS** | string 15 | **INVOICES** | string 16 | **ONLINE_STORE** | string 17 | **PAYROLL** | string 18 | **OTHER** | string 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/V1UpdateCategoryRequest.md: -------------------------------------------------------------------------------- 1 | # V1UpdateCategoryRequest 2 | > squareconnect.models.v1_update_category_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **body** | [**V1Category**](V1Category.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1UpdateDiscountRequest.md: -------------------------------------------------------------------------------- 1 | # V1UpdateDiscountRequest 2 | > squareconnect.models.v1_update_discount_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **body** | [**V1Discount**](V1Discount.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1UpdateEmployeeRequest.md: -------------------------------------------------------------------------------- 1 | # V1UpdateEmployeeRequest 2 | > squareconnect.models.v1_update_employee_request 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1UpdatePageCellRequest.md: -------------------------------------------------------------------------------- 1 | # V1UpdatePageCellRequest 2 | > squareconnect.models.v1_update_page_cell_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **body** | [**V1PageCell**](V1PageCell.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1UpdateTimecardRequest.md: -------------------------------------------------------------------------------- 1 | # V1UpdateTimecardRequest 2 | > squareconnect.models.v1_update_timecard_request 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1CreateEmployeeRoleRequest.md: -------------------------------------------------------------------------------- 1 | # V1CreateEmployeeRoleRequest 2 | > squareconnect.models.v1_create_employee_role_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **employee_role** | [**V1EmployeeRole**](V1EmployeeRole.md) | An EmployeeRole object with a name and permissions, and an optional owner flag. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1PhoneNumber.md: -------------------------------------------------------------------------------- 1 | # V1PhoneNumber 2 | > squareconnect.models.v1_phone_number 3 | 4 | ### Description 5 | 6 | Represents a phone number. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **calling_code** | **str** | The phone number's international calling code. For US phone numbers, this value is +1. | 12 | **number** | **str** | The phone number. | 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1UpdateVariationRequest.md: -------------------------------------------------------------------------------- 1 | # V1UpdateVariationRequest 2 | > squareconnect.models.v1_update_variation_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **body** | [**V1Variation**](V1Variation.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1CreateCategoryRequest.md: -------------------------------------------------------------------------------- 1 | # V1CreateCategoryRequest 2 | > squareconnect.models.v1_create_category_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **body** | [**V1Category**](V1Category.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1CreateDiscountRequest.md: -------------------------------------------------------------------------------- 1 | # V1CreateDiscountRequest 2 | > squareconnect.models.v1_create_discount_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **body** | [**V1Discount**](V1Discount.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1TenderCardBrand.md: -------------------------------------------------------------------------------- 1 | # V1TenderCardBrand 2 | 3 | 4 | ### Description 5 | 6 | The brand of a credit card. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **OTHER_BRAND** | string 12 | **VISA** | string 13 | **MASTER_CARD** | string 14 | **AMERICAN_EXPRESS** | string 15 | **DISCOVER** | string 16 | **DISCOVER_DINERS** | string 17 | **JCB** | string 18 | **CHINA_UNIONPAY** | string 19 | **SQUARE_GIFT_CARD** | string 20 | 21 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/CatalogItemProductType.md: -------------------------------------------------------------------------------- 1 | # CatalogItemProductType 2 | 3 | 4 | ### Description 5 | 6 | The type of a [CatalogItem](#type-catalogitem). Connect V2 only allows the creation of `REGULAR` or `APPOINTMENTS_SERVICE` items. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **REGULAR** | string 12 | **GIFT_CARD** | string 13 | **APPOINTMENTS_SERVICE** | string 14 | **RETAIL_ITEM** | string 15 | **RESTAURANT_ITEM** | string 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/CatalogObjectBatch.md: -------------------------------------------------------------------------------- 1 | # CatalogObjectBatch 2 | > squareconnect.models.catalog_object_batch 3 | 4 | ### Description 5 | 6 | A batch of [CatalogObject](#type-catalogobject)s. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **objects** | [**list[CatalogObject]**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s belonging to this batch. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CustomerGroupInfo.md: -------------------------------------------------------------------------------- 1 | # CustomerGroupInfo 2 | > squareconnect.models.customer_group_info 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** | **str** | The ID of the customer group. | 12 | **name** | **str** | The name of the customer group. | 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ErrorCategory.md: -------------------------------------------------------------------------------- 1 | # ErrorCategory 2 | 3 | 4 | ### Description 5 | 6 | Indicates which high-level category of error has occurred during a request to the Connect API. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **API_ERROR** | string 12 | **AUTHENTICATION_ERROR** | string 13 | **INVALID_REQUEST_ERROR** | string 14 | **RATE_LIMIT_ERROR** | string 15 | **PAYMENT_METHOD_ERROR** | string 16 | **REFUND_ERROR** | string 17 | 18 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/V1CreateVariationRequest.md: -------------------------------------------------------------------------------- 1 | # V1CreateVariationRequest 2 | > squareconnect.models.v1_create_variation_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **body** | [**V1Variation**](V1Variation.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/UpdateWorkweekConfigRequest.md: -------------------------------------------------------------------------------- 1 | # UpdateWorkweekConfigRequest 2 | > squareconnect.models.update_workweek_config_request 3 | 4 | ### Description 5 | 6 | A request to update a `WorkweekConfig` object 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **workweek_config** | [**WorkweekConfig**](WorkweekConfig.md) | The updated `WorkweekConfig` object. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1UpdateEmployeeRoleRequest.md: -------------------------------------------------------------------------------- 1 | # V1UpdateEmployeeRoleRequest 2 | > squareconnect.models.v1_update_employee_role_request 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CardBrand.md: -------------------------------------------------------------------------------- 1 | # CardBrand 2 | 3 | 4 | ### Description 5 | 6 | Indicates a card's brand, such as `VISA` or `MASTERCARD`. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **OTHER_BRAND** | string 12 | **VISA** | string 13 | **MASTERCARD** | string 14 | **AMERICAN_EXPRESS** | string 15 | **DISCOVER** | string 16 | **DISCOVER_DINERS** | string 17 | **JCB** | string 18 | **CHINA_UNIONPAY** | string 19 | **SQUARE_GIFT_CARD** | string 20 | 21 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/Coordinates.md: -------------------------------------------------------------------------------- 1 | # Coordinates 2 | > squareconnect.models.coordinates 3 | 4 | ### Description 5 | 6 | Latitude and longitude coordinates. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **latitude** | **float** | The coordinate's latitude expressed in degrees. | [optional] 12 | **longitude** | **float** | The coordinate's longitude expressed in degrees. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1InventoryEntry.md: -------------------------------------------------------------------------------- 1 | # V1InventoryEntry 2 | > squareconnect.models.v1_inventory_entry 3 | 4 | ### Description 5 | 6 | V1InventoryEntry 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **variation_id** | **str** | The variation that the entry corresponds to. | [optional] 12 | **quantity_on_hand** | **float** | The current available quantity of the item variation. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CatalogCategory.md: -------------------------------------------------------------------------------- 1 | # CatalogCategory 2 | > squareconnect.models.catalog_category 3 | 4 | ### Description 5 | 6 | A category to which an [CatalogItem](#type-catalogitem) belongs in the Catalog object model. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **name** | **str** | The category's name. Searchable. This field has max length of 255 Unicode code points. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1UpdateModifierOptionRequest.md: -------------------------------------------------------------------------------- 1 | # V1UpdateModifierOptionRequest 2 | > squareconnect.models.v1_update_modifier_option_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **body** | [**V1ModifierOption**](V1ModifierOption.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CatalogQueryItemsForModifierList.md: -------------------------------------------------------------------------------- 1 | # CatalogQueryItemsForModifierList 2 | > squareconnect.models.catalog_query_items_for_modifier_list 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **modifier_list_ids** | **list[str]** | A set of [CatalogModifierList](#type-catalogmodifierlist) IDs to be used to find associated [CatalogItem](#type-catalogitem)s. | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/DeleteCustomerResponse.md: -------------------------------------------------------------------------------- 1 | # DeleteCustomerResponse 2 | > squareconnect.models.delete_customer_response 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/MeasurementUnitLength.md: -------------------------------------------------------------------------------- 1 | # MeasurementUnitLength 2 | 3 | 4 | ### Description 5 | 6 | The unit of length used to measure a quantity. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **IMPERIAL_INCH** | string 12 | **IMPERIAL_FOOT** | string 13 | **IMPERIAL_YARD** | string 14 | **IMPERIAL_MILE** | string 15 | **METRIC_MILLIMETER** | string 16 | **METRIC_CENTIMETER** | string 17 | **METRIC_METER** | string 18 | **METRIC_KILOMETER** | string 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/RegisterDomainRequest.md: -------------------------------------------------------------------------------- 1 | # RegisterDomainRequest 2 | > squareconnect.models.register_domain_request 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 | **domain_name** | **str** | A domain name as described in RFC-1034 that will be registered with ApplePay | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/ShiftQuery.md: -------------------------------------------------------------------------------- 1 | # ShiftQuery 2 | > squareconnect.models.shift_query 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1CreateModifierListRequest.md: -------------------------------------------------------------------------------- 1 | # V1CreateModifierListRequest 2 | > squareconnect.models.v1_create_modifier_list_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **body** | [**V1ModifierList**](V1ModifierList.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/OrderServiceChargeCalculationPhase.md: -------------------------------------------------------------------------------- 1 | # OrderServiceChargeCalculationPhase 2 | 3 | 4 | ### Description 5 | 6 | Represents a phase in the process of calculating order totals. Service charges will be applied after the phase indicated. [Read more about how order totals are calculated.](/orders-api/how-it-works#how-totals-are-calculated) 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **SUBTOTAL_PHASE** | string 12 | **TOTAL_PHASE** | string 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/VoidTransactionResponse.md: -------------------------------------------------------------------------------- 1 | # VoidTransactionResponse 2 | > squareconnect.models.void_transaction_response 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the VoidTransaction 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/DeleteShiftResponse.md: -------------------------------------------------------------------------------- 1 | # DeleteShiftResponse 2 | > squareconnect.models.delete_shift_response 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/OrderSource.md: -------------------------------------------------------------------------------- 1 | # OrderSource 2 | > squareconnect.models.order_source 3 | 4 | ### Description 5 | 6 | Represents the origination details of an order. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **name** | **str** | 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1CreateModifierOptionRequest.md: -------------------------------------------------------------------------------- 1 | # V1CreateModifierOptionRequest 2 | > squareconnect.models.v1_create_modifier_option_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **body** | [**V1ModifierOption**](V1ModifierOption.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/BusinessHours.md: -------------------------------------------------------------------------------- 1 | # BusinessHours 2 | > squareconnect.models.business_hours 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CaptureTransactionResponse.md: -------------------------------------------------------------------------------- 1 | # CaptureTransactionResponse 2 | > squareconnect.models.capture_transaction_response 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the CaptureTransaction 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CreateShiftRequest.md: -------------------------------------------------------------------------------- 1 | # CreateShiftRequest 2 | > squareconnect.models.create_shift_request 3 | 4 | ### Description 5 | 6 | Represents a request to create a `Shift` 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **idempotency_key** | **str** | Unique string value to insure the idempotency of the operation. | [optional] 12 | **shift** | [**Shift**](Shift.md) | The `Shift` to be created | 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/BatchRetrieveOrdersRequest.md: -------------------------------------------------------------------------------- 1 | # BatchRetrieveOrdersRequest 2 | > squareconnect.models.batch_retrieve_orders_request 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 | **order_ids** | **list[str]** | The IDs of the orders to retrieve. A maximum of 100 orders can be retrieved per request. | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/DeleteCustomerCardResponse.md: -------------------------------------------------------------------------------- 1 | # DeleteCustomerCardResponse 2 | > squareconnect.models.delete_customer_card_response 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/Product.md: -------------------------------------------------------------------------------- 1 | # Product 2 | 3 | 4 | ### Description 5 | 6 | Indicates the Square product used to generate an inventory change. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **SQUARE_POS** | string 12 | **EXTERNAL_API** | string 13 | **BILLING** | string 14 | **APPOINTMENTS** | string 15 | **INVOICES** | string 16 | **ONLINE_STORE** | string 17 | **PAYROLL** | string 18 | **DASHBOARD** | string 19 | **ITEM_LIBRARY_IMPORT** | string 20 | **OTHER** | string 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/CatalogModifier.md: -------------------------------------------------------------------------------- 1 | # CatalogModifier 2 | > squareconnect.models.catalog_modifier 3 | 4 | ### Description 5 | 6 | A modifier in the Catalog object model. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **name** | **str** | The modifier's name. Searchable. This field has max length of 255 Unicode code points. | [optional] 12 | **price_money** | [**Money**](Money.md) | The modifier's price. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/DeleteBreakTypeResponse.md: -------------------------------------------------------------------------------- 1 | # DeleteBreakTypeResponse 2 | > squareconnect.models.delete_break_type_response 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1CashDrawerEventEventType.md: -------------------------------------------------------------------------------- 1 | # V1CashDrawerEventEventType 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **NO_SALE** | string 12 | **CASH_TENDER_PAYMENT** | string 13 | **OTHER_TENDER_PAYMENT** | string 14 | **CASH_TENDER_CANCELED_PAYMENT** | string 15 | **OTHER_TENDER_CANCELED_PAYMENT** | string 16 | **CASH_TENDER_REFUND** | string 17 | **OTHER_TENDER_REFUND** | string 18 | **PAID_IN** | string 19 | **PAID_OUT** | string 20 | 21 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/V1EmployeeRolePermissions.md: -------------------------------------------------------------------------------- 1 | # V1EmployeeRolePermissions 2 | 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **REGISTER_ACCESS_SALES_HISTORY** | string 12 | **REGISTER_APPLY_RESTRICTED_DISCOUNTS** | string 13 | **REGISTER_CHANGE_SETTINGS** | string 14 | **REGISTER_EDIT_ITEM** | string 15 | **REGISTER_ISSUE_REFUNDS** | string 16 | **REGISTER_OPEN_CASH_DRAWER_OUTSIDE_SALE** | string 17 | **REGISTER_VIEW_SUMMARY_REPORTS** | string 18 | 19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/MeasurementUnitArea.md: -------------------------------------------------------------------------------- 1 | # MeasurementUnitArea 2 | 3 | 4 | ### Description 5 | 6 | Unit of area used to measure a quantity. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **IMPERIAL_ACRE** | string 12 | **IMPERIAL_SQUARE_INCH** | string 13 | **IMPERIAL_SQUARE_FOOT** | string 14 | **IMPERIAL_SQUARE_YARD** | string 15 | **IMPERIAL_SQUARE_MILE** | string 16 | **METRIC_SQUARE_CENTIMETER** | string 17 | **METRIC_SQUARE_METER** | string 18 | **METRIC_SQUARE_KILOMETER** | string 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/SearchOrdersQuery.md: -------------------------------------------------------------------------------- 1 | # SearchOrdersQuery 2 | > squareconnect.models.search_orders_query 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CreateBreakTypeRequest.md: -------------------------------------------------------------------------------- 1 | # CreateBreakTypeRequest 2 | > squareconnect.models.create_break_type_request 3 | 4 | ### Description 5 | 6 | A request to create a new `BreakType` 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **idempotency_key** | **str** | Unique string value to insure idempotency of the operation | [optional] 12 | **break_type** | [**BreakType**](BreakType.md) | The `BreakType` to be created. | 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1Money.md: -------------------------------------------------------------------------------- 1 | # V1Money 2 | > squareconnect.models.v1_money 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **amount** | **int** | 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] 12 | **currency_code** | **str** | See [Currency](#type-currency) for possible values | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ListWorkweekConfigsRequest.md: -------------------------------------------------------------------------------- 1 | # ListWorkweekConfigsRequest 2 | > squareconnect.models.list_workweek_configs_request 3 | 4 | ### Description 5 | 6 | A request for a set of `WorkweekConfig` objects 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **limit** | **int** | Maximum number of Workweek Configs to return per page. | [optional] 12 | **cursor** | **str** | Pointer to the next page of Workweek Config results to fetch. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CreateMobileAuthorizationCodeRequest.md: -------------------------------------------------------------------------------- 1 | # CreateMobileAuthorizationCodeRequest 2 | > squareconnect.models.create_mobile_authorization_code_request 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 | **location_id** | **str** | The Square location ID the authorization code should be tied to. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/OrderEntry.md: -------------------------------------------------------------------------------- 1 | # OrderEntry 2 | > squareconnect.models.order_entry 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 | **order_id** | **str** | The id of the Order | [optional] 12 | **location_id** | **str** | The location id the Order belongs to. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/BatchChangeInventoryResponse.md: -------------------------------------------------------------------------------- 1 | # BatchChangeInventoryResponse 2 | > squareconnect.models.batch_change_inventory_response 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1Category.md: -------------------------------------------------------------------------------- 1 | # V1Category 2 | > squareconnect.models.v1_category 3 | 4 | ### Description 5 | 6 | V1Category 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **id** | **str** | The category's unique ID. | [optional] 12 | **name** | **str** | The category's name. | [optional] 13 | **v2_id** | **str** | The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/ShiftSort.md: -------------------------------------------------------------------------------- 1 | # ShiftSort 2 | > squareconnect.models.shift_sort 3 | 4 | ### Description 5 | 6 | Sets the sort order of search results. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **field** | **str** | The field to sort on. See [ShiftSortField](#type-shiftsortfield) for possible values | [optional] 12 | **order** | **str** | The order in which results are returned. Defaults to DESC. See [SortOrder](#type-sortorder) for possible values | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/UpdateItemTaxesResponse.md: -------------------------------------------------------------------------------- 1 | # UpdateItemTaxesResponse 2 | > squareconnect.models.update_item_taxes_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**list[Error]**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 12 | **updated_at** | **str** | The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1ListInventoryRequest.md: -------------------------------------------------------------------------------- 1 | # V1ListInventoryRequest 2 | > squareconnect.models.v1_list_inventory_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **limit** | **int** | The maximum number of inventory entries to return in a single response. This value cannot exceed 1000. | [optional] 12 | **batch_token** | **str** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1OrderHistoryEntry.md: -------------------------------------------------------------------------------- 1 | # V1OrderHistoryEntry 2 | > squareconnect.models.v1_order_history_entry 3 | 4 | ### Description 5 | 6 | V1OrderHistoryEntry 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **action** | **str** | The type of action performed on the order. See [V1OrderHistoryEntryAction](#type-v1orderhistoryentryaction) for possible values | [optional] 12 | **created_at** | **str** | The time when the action was performed, in ISO 8601 format. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/StandardUnitDescriptionGroup.md: -------------------------------------------------------------------------------- 1 | # StandardUnitDescriptionGroup 2 | > squareconnect.models.standard_unit_description_group 3 | 4 | ### Description 5 | 6 | Group of standard measurement units. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **standard_unit_descriptions** | [**list[StandardUnitDescription]**](StandardUnitDescription.md) | List of measurement units in this description group. | [optional] 12 | **language_code** | **str** | IETF language tag. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/TenderCashDetails.md: -------------------------------------------------------------------------------- 1 | # TenderCashDetails 2 | > squareconnect.models.tender_cash_details 3 | 4 | ### Description 5 | 6 | Represents the details of a tender with `type` `CASH`. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **buyer_tendered_money** | [**Money**](Money.md) | The total amount of cash provided by the buyer, before change is given. | [optional] 12 | **change_back_money** | [**Money**](Money.md) | The amount of change returned to the buyer. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CatalogQueryItemsForItemOptions.md: -------------------------------------------------------------------------------- 1 | # CatalogQueryItemsForItemOptions 2 | > squareconnect.models.catalog_query_items_for_item_options 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **item_option_ids** | **list[str]** | A set of [CatalogItemOption](#type-catalogitemoption) IDs to be used to find associated [CatalogItem](#type-catalogitem)s. All Items that contain all of the given Item Options (in any order) will be returned. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/RetrieveInventoryAdjustmentResponse.md: -------------------------------------------------------------------------------- 1 | # RetrieveInventoryAdjustmentResponse 2 | > squareconnect.models.retrieve_inventory_adjustment_response 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](#type-inventoryadjustment). | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/SearchOrdersSourceFilter.md: -------------------------------------------------------------------------------- 1 | # SearchOrdersSourceFilter 2 | > squareconnect.models.search_orders_source_filter 3 | 4 | ### Description 5 | 6 | Filter based on Order `source` information. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **source_names** | **list[str]** | Filters by [Source](#type-ordersource) `name`. Will return any orders with with `source.name`s that match any of the listed source names. Max: 10 `source_names`. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/V1DeletePageCellRequest.md: -------------------------------------------------------------------------------- 1 | # V1DeletePageCellRequest 2 | > squareconnect.models.v1_delete_page_cell_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **row** | **str** | The row of the cell to clear. Always an integer between 0 and 4, inclusive. Row 0 is the top row. | [optional] 12 | **column** | **str** | The column of the cell to clear. Always an integer between 0 and 4, inclusive. Column 0 is the leftmost column. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CatalogQueryRange.md: -------------------------------------------------------------------------------- 1 | # CatalogQueryRange 2 | > squareconnect.models.catalog_query_range 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **attribute_name** | **str** | The name of the attribute to be searched. | 12 | **attribute_min_value** | **int** | The desired minimum value for the search attribute (inclusive). | [optional] 13 | **attribute_max_value** | **int** | The desired maximum value for the search attribute (inclusive). | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/CatalogV1Id.md: -------------------------------------------------------------------------------- 1 | # CatalogV1Id 2 | > squareconnect.models.catalog_v1_id 3 | 4 | ### Description 5 | 6 | An Items Connect V1 object ID along with its associated [location](#type-location) ID. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **catalog_v1_id** | **str** | The ID for an object in Connect V1, if different from its Connect V2 ID. | [optional] 12 | **location_id** | **str** | The ID of the [location](#type-location) this Connect V1 ID is associated with. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/SearchShiftsRequest.md: -------------------------------------------------------------------------------- 1 | # SearchShiftsRequest 2 | > squareconnect.models.search_shifts_request 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** | **int** | number of resources in a page (200 by default). | [optional] 13 | **cursor** | **str** | opaque cursor for fetching the next page. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/CatalogItemOptionForItem.md: -------------------------------------------------------------------------------- 1 | # CatalogItemOptionForItem 2 | > squareconnect.models.catalog_item_option_for_item 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 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **item_option_id** | **str** | The unique id of the item option, used to form the dimensions of the item option matrix in a specified order. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/UpdateItemModifierListsResponse.md: -------------------------------------------------------------------------------- 1 | # UpdateItemModifierListsResponse 2 | > squareconnect.models.update_item_modifier_lists_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**list[Error]**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 12 | **updated_at** | **str** | The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1TimecardEventEventType.md: -------------------------------------------------------------------------------- 1 | # V1TimecardEventEventType 2 | 3 | 4 | ### Description 5 | 6 | Actions that resulted in a change to a timecard. All timecard events created with the Connect API have an event type that begins with `API`. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **API_CREATE** | string 12 | **API_EDIT** | string 13 | **API_DELETE** | string 14 | **REGISTER_CLOCKIN** | string 15 | **REGISTER_CLOCKOUT** | string 16 | **DASHBOARD_SUPERVISOR_CLOSE** | string 17 | **DASHBOARD_EDIT** | string 18 | **DASHBOARD_DELETE** | string 19 | 20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/MeasurementUnitVolume.md: -------------------------------------------------------------------------------- 1 | # MeasurementUnitVolume 2 | 3 | 4 | ### Description 5 | 6 | The unit of volume used to measure a quantity. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **GENERIC_FLUID_OUNCE** | string 12 | **GENERIC_SHOT** | string 13 | **GENERIC_CUP** | string 14 | **GENERIC_PINT** | string 15 | **GENERIC_QUART** | string 16 | **GENERIC_GALLON** | string 17 | **IMPERIAL_CUBIC_INCH** | string 18 | **IMPERIAL_CUBIC_FOOT** | string 19 | **IMPERIAL_CUBIC_YARD** | string 20 | **METRIC_MILLILITER** | string 21 | **METRIC_LITER** | string 22 | 23 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/RetrieveInventoryPhysicalCountResponse.md: -------------------------------------------------------------------------------- 1 | # RetrieveInventoryPhysicalCountResponse 2 | > squareconnect.models.retrieve_inventory_physical_count_response 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](#type-inventoryphysicalcount). | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1MerchantLocationDetails.md: -------------------------------------------------------------------------------- 1 | # V1MerchantLocationDetails 2 | > squareconnect.models.v1_merchant_location_details 3 | 4 | ### Description 5 | 6 | Additional information for a single-location account specified by its associated business account, if it has one. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **nickname** | **str** | The nickname assigned to the single-location account by the parent business. This value appears in the parent business's multi-location dashboard. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CatalogModifierOverride.md: -------------------------------------------------------------------------------- 1 | # CatalogModifierOverride 2 | > squareconnect.models.catalog_modifier_override 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **modifier_id** | **str** | The ID of the [CatalogModifier](#type-catalogmodifier) whose default behavior is being overridden. | 12 | **on_by_default** | **bool** | If `true`, this [CatalogModifier](#type-catalogmodifier) should be selected by default for this [CatalogItem](#type-catalogitem). | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/GetShiftResponse.md: -------------------------------------------------------------------------------- 1 | # GetShiftResponse 2 | > squareconnect.models.get_shift_response 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/InventoryState.md: -------------------------------------------------------------------------------- 1 | # InventoryState 2 | 3 | 4 | ### Description 5 | 6 | Indicates the state of a tracked item quantity in the lifecycle of goods. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **CUSTOM** | string 12 | **IN_STOCK** | string 13 | **SOLD** | string 14 | **RETURNED_BY_CUSTOMER** | string 15 | **RESERVED_FOR_SALE** | string 16 | **SOLD_ONLINE** | string 17 | **ORDERED_FROM_VENDOR** | string 18 | **RECEIVED_FROM_VENDOR** | string 19 | **IN_TRANSIT_TO** | string 20 | **NONE** | string 21 | **WASTE** | string 22 | **UNLINKED_RETURN** | string 23 | 24 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/MeasurementUnitCustom.md: -------------------------------------------------------------------------------- 1 | # MeasurementUnitCustom 2 | > squareconnect.models.measurement_unit_custom 3 | 4 | ### Description 5 | 6 | The information needed to define a custom unit, provided by the seller. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **name** | **str** | The name of the custom unit, for example \"bushel\". | 12 | **abbreviation** | **str** | The abbreviation of the custom unit, such as \"bsh\" (bushel). This appears in the cart for the Point of Sale app, and in reports. | 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/UpdateShiftResponse.md: -------------------------------------------------------------------------------- 1 | # UpdateShiftResponse 2 | > squareconnect.models.update_shift_response 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CatalogIdMapping.md: -------------------------------------------------------------------------------- 1 | # CatalogIdMapping 2 | > squareconnect.models.catalog_id_mapping 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 | **client_object_id** | **str** | The client-supplied, temporary `#`-prefixed ID for a new [CatalogObject](#type-catalogobject). | [optional] 12 | **object_id** | **str** | The permanent ID for the [CatalogObject](#type-catalogobject) created by the server. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CreateOrderResponse.md: -------------------------------------------------------------------------------- 1 | # CreateOrderResponse 2 | > squareconnect.models.create_order_response 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ChargeResponse.md: -------------------------------------------------------------------------------- 1 | # ChargeResponse 2 | > squareconnect.models.charge_response 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the Charge endpoint. One of `errors` or `transaction` 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 | **transaction** | [**Transaction**](Transaction.md) | The created transaction. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CreateRefundResponse.md: -------------------------------------------------------------------------------- 1 | # CreateRefundResponse 2 | > squareconnect.models.create_refund_response 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the CreateRefund endpoint. One of `errors` or `refund` 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 | **refund** | [**Refund**](Refund.md) | The created refund. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/GetBreakTypeResponse.md: -------------------------------------------------------------------------------- 1 | # GetBreakTypeResponse 2 | > squareconnect.models.get_break_type_response 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 | **break_type** | [**BreakType**](BreakType.md) | The response object. | [optional] 12 | **errors** | [**list[Error]**](Error.md) | Any errors that occurred during the request. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1Page.md: -------------------------------------------------------------------------------- 1 | # V1Page 2 | > squareconnect.models.v1_page 3 | 4 | ### Description 5 | 6 | V1Page 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **id** | **str** | The page's unique identifier. | [optional] 12 | **name** | **str** | The page's name, if any. | [optional] 13 | **page_index** | **int** | The page's position in the merchant's list of pages. Always an integer between 0 and 6, inclusive. | [optional] 14 | **cells** | [**list[V1PageCell]**](V1PageCell.md) | The cells included on the page. | [optional] 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/SearchOrdersCustomerFilter.md: -------------------------------------------------------------------------------- 1 | # SearchOrdersCustomerFilter 2 | > squareconnect.models.search_orders_customer_filter 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 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **customer_ids** | **list[str]** | Filter by orders with any of the listed `customer_id`s. Max: 10 `customer_id`s. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CreateShiftResponse.md: -------------------------------------------------------------------------------- 1 | # CreateShiftResponse 2 | > squareconnect.models.create_shift_response 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ShiftWage.md: -------------------------------------------------------------------------------- 1 | # ShiftWage 2 | > squareconnect.models.shift_wage 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** | **str** | The name of the job performed during this shift. Square labor-reporting UIs may group shifts together by title. | [optional] 12 | **hourly_rate** | [**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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/UpdateBreakTypeResponse.md: -------------------------------------------------------------------------------- 1 | # UpdateBreakTypeResponse 2 | > squareconnect.models.update_break_type_response 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 | **break_type** | [**BreakType**](BreakType.md) | The response object. | [optional] 12 | **errors** | [**list[Error]**](Error.md) | Any errors that occurred during the request. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CatalogInfoResponse.md: -------------------------------------------------------------------------------- 1 | # CatalogInfoResponse 2 | > squareconnect.models.catalog_info_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**list[Error]**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 12 | **limits** | [**CatalogInfoResponseLimits**](CatalogInfoResponseLimits.md) | | [optional] 13 | **standard_unit_description_group** | [**StandardUnitDescriptionGroup**](StandardUnitDescriptionGroup.md) | Names and abbreviations for standard units. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/V1UpdateModifierListRequest.md: -------------------------------------------------------------------------------- 1 | # V1UpdateModifierListRequest 2 | > squareconnect.models.v1_update_modifier_list_request 3 | 4 | ### Description 5 | 6 | V1UpdateModifierListRequest 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **name** | **str** | The modifier list's name. | [optional] 12 | **selection_type** | **str** | Indicates whether multiple options from the modifier list can be applied to a single item. See [V1UpdateModifierListRequestSelectionType](#type-v1updatemodifierlistrequestselectiontype) for possible values | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CreateCustomerResponse.md: -------------------------------------------------------------------------------- 1 | # CreateCustomerResponse 2 | > squareconnect.models.create_customer_response 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/UpdateCustomerResponse.md: -------------------------------------------------------------------------------- 1 | # UpdateCustomerResponse 2 | > squareconnect.models.update_customer_response 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CreateCustomerCardResponse.md: -------------------------------------------------------------------------------- 1 | # CreateCustomerCardResponse 2 | > squareconnect.models.create_customer_card_response 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CustomerQuery.md: -------------------------------------------------------------------------------- 1 | # CustomerQuery 2 | > squareconnect.models.customer_query 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/RetrieveEmployeeResponse.md: -------------------------------------------------------------------------------- 1 | # RetrieveEmployeeResponse 2 | > squareconnect.models.retrieve_employee_response 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the RetrieveEmployee endpoint. One of `errors` or `employee` is present in a given response (never both). 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/BatchDeleteCatalogObjectsRequest.md: -------------------------------------------------------------------------------- 1 | # BatchDeleteCatalogObjectsRequest 2 | > squareconnect.models.batch_delete_catalog_objects_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **object_ids** | **list[str]** | The IDs of the [CatalogObject](#type-catalogobject)s 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](#type-catalogitem) will delete its [CatalogItemVariation](#type-catalogitemvariation)s). | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/ListLocationsResponse.md: -------------------------------------------------------------------------------- 1 | # ListLocationsResponse 2 | > squareconnect.models.list_locations_response 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's locations. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/RetrieveCustomerResponse.md: -------------------------------------------------------------------------------- 1 | # RetrieveCustomerResponse 2 | > squareconnect.models.retrieve_customer_response 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CatalogQueryItemVariationsForItemOptionValues.md: -------------------------------------------------------------------------------- 1 | # CatalogQueryItemVariationsForItemOptionValues 2 | > squareconnect.models.catalog_query_item_variations_for_item_option_values 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **item_option_value_ids** | **list[str]** | A set of [CatalogItemOptionValue](#type-catalogitemoptionvalue) IDs to be used to find associated [CatalogItemVariation](#type-catalogitemvariation)s. All ItemVariations that contain all of the given Item Option Values (in any order) will be returned. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /squareconnect/apis/__init__.py: -------------------------------------------------------------------------------- 1 | from __future__ import absolute_import 2 | 3 | from .apple_pay_api import ApplePayApi 4 | from .catalog_api import CatalogApi 5 | from .checkout_api import CheckoutApi 6 | from .customers_api import CustomersApi 7 | from .employees_api import EmployeesApi 8 | from .inventory_api import InventoryApi 9 | from .labor_api import LaborApi 10 | from .locations_api import LocationsApi 11 | from .mobile_authorization_api import MobileAuthorizationApi 12 | from .o_auth_api import OAuthApi 13 | from .orders_api import OrdersApi 14 | from .reporting_api import ReportingApi 15 | from .transactions_api import TransactionsApi 16 | from .v1_employees_api import V1EmployeesApi 17 | from .v1_items_api import V1ItemsApi 18 | from .v1_locations_api import V1LocationsApi 19 | from .v1_transactions_api import V1TransactionsApi 20 | -------------------------------------------------------------------------------- /docs/V1PaymentModifier.md: -------------------------------------------------------------------------------- 1 | # V1PaymentModifier 2 | > squareconnect.models.v1_payment_modifier 3 | 4 | ### Description 5 | 6 | V1PaymentModifier 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **name** | **str** | The modifier option's name. | [optional] 12 | **applied_money** | [**V1Money**](V1Money.md) | The amount of money that this modifier option adds to the payment. | [optional] 13 | **modifier_option_id** | **str** | 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/CreateBreakTypeResponse.md: -------------------------------------------------------------------------------- 1 | # CreateBreakTypeResponse 2 | > squareconnect.models.create_break_type_response 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 | **break_type** | [**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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/GetEmployeeWageResponse.md: -------------------------------------------------------------------------------- 1 | # GetEmployeeWageResponse 2 | > squareconnect.models.get_employee_wage_response 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 | **employee_wage** | [**EmployeeWage**](EmployeeWage.md) | The requested `EmployeeWage` object. | [optional] 12 | **errors** | [**list[Error]**](Error.md) | Any errors that occurred during the request. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/UpsertCatalogObjectResponse.md: -------------------------------------------------------------------------------- 1 | # UpsertCatalogObjectResponse 2 | > squareconnect.models.upsert_catalog_object_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**list[Error]**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 12 | **catalog_object** | [**CatalogObject**](CatalogObject.md) | The created [CatalogObject](#type-catalogobject). | [optional] 13 | **id_mappings** | [**list[CatalogIdMapping]**](CatalogIdMapping.md) | The mapping between client and server IDs for this Upsert. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/V1PaymentItemDetail.md: -------------------------------------------------------------------------------- 1 | # V1PaymentItemDetail 2 | > squareconnect.models.v1_payment_item_detail 3 | 4 | ### Description 5 | 6 | V1PaymentItemDetail 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **category_name** | **str** | The name of the item's merchant-defined category, if any. | [optional] 12 | **sku** | **str** | The item's merchant-defined SKU, if any. | [optional] 13 | **item_id** | **str** | The unique ID of the item purchased, if any. | [optional] 14 | **item_variation_id** | **str** | The unique ID of the item variation purchased, if any. | [optional] 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/RetrieveTransactionResponse.md: -------------------------------------------------------------------------------- 1 | # RetrieveTransactionResponse 2 | > squareconnect.models.retrieve_transaction_response 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the RetrieveTransaction endpoint. One of `errors` or `transaction` 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 | **transaction** | [**Transaction**](Transaction.md) | The requested transaction. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/UpdateWorkweekConfigResponse.md: -------------------------------------------------------------------------------- 1 | # UpdateWorkweekConfigResponse 2 | > squareconnect.models.update_workweek_config_response 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 | **workweek_config** | [**WorkweekConfig**](WorkweekConfig.md) | The response object. | [optional] 12 | **errors** | [**list[Error]**](Error.md) | Any errors that occurred during the request. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/SearchShiftsResponse.md: -------------------------------------------------------------------------------- 1 | # SearchShiftsResponse 2 | > squareconnect.models.search_shifts_response 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** | **str** | Opaque cursor for fetching the next page. | [optional] 13 | **errors** | [**list[Error]**](Error.md) | Any errors that occurred during the request. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/StandardUnitDescription.md: -------------------------------------------------------------------------------- 1 | # StandardUnitDescription 2 | > squareconnect.models.standard_unit_description 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** | **str** | Display name of the measurement unit. For example, 'Pound'. | [optional] 13 | **abbreviation** | **str** | Abbreviation for the measurement unit. For example, 'lb'. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/V1PaymentDiscount.md: -------------------------------------------------------------------------------- 1 | # V1PaymentDiscount 2 | > squareconnect.models.v1_payment_discount 3 | 4 | ### Description 5 | 6 | V1PaymentDiscount 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **name** | **str** | The discount's name. | [optional] 12 | **applied_money** | [**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 | **discount_id** | **str** | The ID of the applied discount, if available. Discounts applied in older versions of Square Register might not have an ID. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/V1AdjustInventoryRequest.md: -------------------------------------------------------------------------------- 1 | # V1AdjustInventoryRequest 2 | > squareconnect.models.v1_adjust_inventory_request 3 | 4 | ### Description 5 | 6 | V1AdjustInventoryRequest 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **quantity_delta** | **float** | The number to adjust the variation's quantity by. | [optional] 12 | **adjustment_type** | **str** | The reason for the inventory adjustment. See [V1AdjustInventoryRequestAdjustmentType](#type-v1adjustinventoryrequestadjustmenttype) for possible values | [optional] 13 | **memo** | **str** | A note about the inventory adjustment. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/CreateCheckoutResponse.md: -------------------------------------------------------------------------------- 1 | # CreateCheckoutResponse 2 | > squareconnect.models.create_checkout_response 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/V1ListOrdersRequest.md: -------------------------------------------------------------------------------- 1 | # V1ListOrdersRequest 2 | > squareconnect.models.v1_list_orders_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **order** | **str** | TThe order in which payments are listed in the response. See [SortOrder](#type-sortorder) for possible values | [optional] 12 | **limit** | **int** | The maximum number of payments to return in a single response. This value cannot exceed 200. | [optional] 13 | **batch_token** | **str** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/RetrieveInventoryCountRequest.md: -------------------------------------------------------------------------------- 1 | # RetrieveInventoryCountRequest 2 | > squareconnect.models.retrieve_inventory_count_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **location_ids** | **str** | The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations. | [optional] 12 | **cursor** | **str** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](/basics/api101/pagination) for more information. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ListCatalogResponse.md: -------------------------------------------------------------------------------- 1 | # ListCatalogResponse 2 | > squareconnect.models.list_catalog_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**list[Error]**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 12 | **cursor** | **str** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. | [optional] 13 | **objects** | [**list[CatalogObject]**](CatalogObject.md) | The [CatalogObject](#type-catalogobject)s returned. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/RetrieveInventoryChangesRequest.md: -------------------------------------------------------------------------------- 1 | # RetrieveInventoryChangesRequest 2 | > squareconnect.models.retrieve_inventory_changes_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **location_ids** | **str** | The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations. | [optional] 12 | **cursor** | **str** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](/basics/api101/pagination) for more information. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ListBreakTypesRequest.md: -------------------------------------------------------------------------------- 1 | # ListBreakTypesRequest 2 | > squareconnect.models.list_break_types_request 3 | 4 | ### Description 5 | 6 | A request for a filtered set of `BreakType` objects 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **location_id** | **str** | Filter Break Types returned to only those that are associated with the specified location. | [optional] 12 | **limit** | **int** | 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** | **str** | Pointer to the next page of Break Type results to fetch. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/ListEmployeeWagesRequest.md: -------------------------------------------------------------------------------- 1 | # ListEmployeeWagesRequest 2 | > squareconnect.models.list_employee_wages_request 3 | 4 | ### Description 5 | 6 | A request for a set of `EmployeeWage` objects 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **employee_id** | **str** | Filter wages returned to only those that are associated with the specified employee. | [optional] 12 | **limit** | **int** | 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** | **str** | Pointer to the next page of Employee Wage results to fetch. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/RetrieveCatalogObjectResponse.md: -------------------------------------------------------------------------------- 1 | # RetrieveCatalogObjectResponse 2 | > squareconnect.models.retrieve_catalog_object_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**list[Error]**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 12 | **object** | [**CatalogObject**](CatalogObject.md) | The [CatalogObject](#type-catalogobject)s returned. | [optional] 13 | **related_objects** | [**list[CatalogObject]**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s referenced by the object in the `object` field. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/BatchDeleteCatalogObjectsResponse.md: -------------------------------------------------------------------------------- 1 | # BatchDeleteCatalogObjectsResponse 2 | > squareconnect.models.batch_delete_catalog_objects_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**list[Error]**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 12 | **deleted_object_ids** | **list[str]** | The IDs of all [CatalogObject](#type-catalogobject)s deleted by this request. | [optional] 13 | **deleted_at** | **str** | The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/RegisterDomainResponse.md: -------------------------------------------------------------------------------- 1 | # RegisterDomainResponse 2 | > squareconnect.models.register_domain_response 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** | **str** | Status of the domain registration. See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/ListEmployeeWagesResponse.md: -------------------------------------------------------------------------------- 1 | # ListEmployeeWagesResponse 2 | > squareconnect.models.list_employee_wages_response 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 | **employee_wages** | [**list[EmployeeWage]**](EmployeeWage.md) | A page of Employee Wage results. | [optional] 12 | **cursor** | **str** | 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/CatalogObjectType.md: -------------------------------------------------------------------------------- 1 | # CatalogObjectType 2 | 3 | 4 | ### Description 5 | 6 | Possible kinds of [CatalogObject](#type-catalogobject)s returned from the Catalog, each containing type-specific properties in the `*_data` field corresponding to the object type. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **ITEM** | string 12 | **IMAGE** | string 13 | **CATEGORY** | string 14 | **ITEM_VARIATION** | string 15 | **TAX** | string 16 | **DISCOUNT** | string 17 | **MODIFIER_LIST** | string 18 | **MODIFIER** | string 19 | **PRICING_RULE** | string 20 | **PRODUCT_SET** | string 21 | **TIME_PERIOD** | string 22 | **MEASUREMENT_UNIT** | string 23 | **ITEM_OPTION** | string 24 | **ITEM_OPTION_VAL** | string 25 | 26 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/BatchRetrieveCatalogObjectsResponse.md: -------------------------------------------------------------------------------- 1 | # BatchRetrieveCatalogObjectsResponse 2 | > squareconnect.models.batch_retrieve_catalog_objects_response 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **errors** | [**list[Error]**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 12 | **objects** | [**list[CatalogObject]**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s returned. | [optional] 13 | **related_objects** | [**list[CatalogObject]**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s referenced by the object in the `objects` field. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/DateRange.md: -------------------------------------------------------------------------------- 1 | # DateRange 2 | > squareconnect.models.date_range 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 | **start_date** | **str** | 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 | **end_date** | **str** | 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/OrderMoneyAmounts.md: -------------------------------------------------------------------------------- 1 | # OrderMoneyAmounts 2 | > squareconnect.models.order_money_amounts 3 | 4 | ### Description 5 | 6 | A collection of various money amounts. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **total_money** | [**Money**](Money.md) | Total money. | [optional] 12 | **tax_money** | [**Money**](Money.md) | Money associated with taxes. | [optional] 13 | **discount_money** | [**Money**](Money.md) | Money associated with discounts. | [optional] 14 | **tip_money** | [**Money**](Money.md) | Money associated with tips. | [optional] 15 | **service_charge_money** | [**Money**](Money.md) | Money associated with service charges. | [optional] 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/CatalogImage.md: -------------------------------------------------------------------------------- 1 | # CatalogImage 2 | > squareconnect.models.catalog_image 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** | **str** | The internal name of this image. Identifies this image in calls to the Connect APIs. | [optional] 12 | **url** | **str** | The URL of this image. Generated by Square after an image is uploaded to the CreateCatalogImage endpoint. | [optional] 13 | **caption** | **str** | A caption that describes what is shown in the image. Displayed in the Square Online Store. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/TimeRange.md: -------------------------------------------------------------------------------- 1 | # TimeRange 2 | > squareconnect.models.time_range 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 | **start_at** | **str** | A datetime value in RFC-3339 format indicating when the time range starts. | [optional] 12 | **end_at** | **str** | A datetime value in RFC-3339 format indicating when the time range ends. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/RetrieveInventoryChangesResponse.md: -------------------------------------------------------------------------------- 1 | # RetrieveInventoryChangesResponse 2 | > squareconnect.models.retrieve_inventory_changes_response 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** | **str** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/RevokeTokenRequest.md: -------------------------------------------------------------------------------- 1 | # RevokeTokenRequest 2 | > squareconnect.models.revoke_token_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **client_id** | **str** | Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). | [optional] 12 | **access_token** | **str** | 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 | **merchant_id** | **str** | 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/ChargeRequestAdditionalRecipient.md: -------------------------------------------------------------------------------- 1 | # ChargeRequestAdditionalRecipient 2 | > squareconnect.models.charge_request_additional_recipient 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 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **location_id** | **str** | The location ID for a recipient (other than the merchant) receiving a portion of the tender. | 12 | **description** | **str** | The description of the additional recipient. | 13 | **amount_money** | [**Money**](Money.md) | The amount of money distributed to the recipient. | 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/Error.md: -------------------------------------------------------------------------------- 1 | # Error 2 | > squareconnect.models.error 3 | 4 | ### Description 5 | 6 | Represents an error encountered during a request to the Connect API. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **category** | **str** | The error's high-level category. See [ErrorCategory](#type-errorcategory) for possible values | 12 | **code** | **str** | The error's specific code. See [ErrorCode](#type-errorcode) for possible values | 13 | **detail** | **str** | A human-readable description of the error for debugging purposes. | [optional] 14 | **field** | **str** | The name of the field provided in the original request that the error pertains to, if any. | [optional] 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/ListEmployeesResponse.md: -------------------------------------------------------------------------------- 1 | # ListEmployeesResponse 2 | > squareconnect.models.list_employees_response 3 | 4 | ### Description 5 | 6 | Defines the fields that are included in the response body of a request to the ListEmployees endpoint. One of `errors` or `employees` is present in a given response (never both). 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** | **str** | 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/RetrieveInventoryCountResponse.md: -------------------------------------------------------------------------------- 1 | # RetrieveInventoryCountResponse 2 | > squareconnect.models.retrieve_inventory_count_response 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** | **str** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/UpdateItemTaxesRequest.md: -------------------------------------------------------------------------------- 1 | # UpdateItemTaxesRequest 2 | > squareconnect.models.update_item_taxes_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **item_ids** | **list[str]** | The [CatalogItem](#type-catalogitem)s whose enabled/disabled [CatalogTax](#type-catalogtax)es are being updated. | 12 | **taxes_to_enable** | **list[str]** | The set of [CatalogTax](#type-catalogtax)es (referenced by ID) to enable for the [CatalogItem](#type-catalogitem). | [optional] 13 | **taxes_to_disable** | **list[str]** | The set of [CatalogTax](#type-catalogtax)es (referenced by ID) to disable for the [CatalogItem](#type-catalogitem). | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/BusinessHoursPeriod.md: -------------------------------------------------------------------------------- 1 | # BusinessHoursPeriod 2 | > squareconnect.models.business_hours_period 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 | **day_of_week** | **str** | The day of week for this time period. See [DayOfWeek](#type-dayofweek) for possible values | [optional] 12 | **start_local_time** | **str** | The start time of a business hours period, specified in local time using partial-time RFC3339 format. | [optional] 13 | **end_local_time** | **str** | The end time of a business hours period, specified in local time using partial-time RFC3339 format. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/V1ListEmployeeRolesRequest.md: -------------------------------------------------------------------------------- 1 | # V1ListEmployeeRolesRequest 2 | > squareconnect.models.v1_list_employee_roles_request 3 | 4 | ### Description 5 | 6 | 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **order** | **str** | 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** | **int** | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. | [optional] 13 | **batch_token** | **str** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/CustomerCreationSource.md: -------------------------------------------------------------------------------- 1 | # CustomerCreationSource 2 | 3 | 4 | ### Description 5 | 6 | Indicates the method used to create the customer profile. 7 | 8 | ## Properties 9 | Name | Type 10 | ------------ | ------------- 11 | **OTHER** | string 12 | **APPOINTMENTS** | string 13 | **COUPON** | string 14 | **DELETION_RECOVERY** | string 15 | **DIRECTORY** | string 16 | **EGIFTING** | string 17 | **EMAIL_COLLECTION** | string 18 | **FEEDBACK** | string 19 | **IMPORT** | string 20 | **INVOICES** | string 21 | **LOYALTY** | string 22 | **MARKETING** | string 23 | **MERGE** | string 24 | **ONLINE_STORE** | string 25 | **INSTANT_PROFILE** | string 26 | **TERMINAL** | string 27 | **THIRD_PARTY** | string 28 | **THIRD_PARTY_IMPORT** | string 29 | **UNMERGE_RECOVERY** | string 30 | 31 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/EmployeeWage.md: -------------------------------------------------------------------------------- 1 | # EmployeeWage 2 | > squareconnect.models.employee_wage 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** | **str** | UUID for this object. | [optional] 12 | **employee_id** | **str** | The `Employee` that this wage is assigned to. | 13 | **title** | **str** | The job title that this wage relates to. | [optional] 14 | **hourly_rate** | [**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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/BatchRetrieveInventoryCountsResponse.md: -------------------------------------------------------------------------------- 1 | # BatchRetrieveInventoryCountsResponse 2 | > squareconnect.models.batch_retrieve_inventory_counts_response 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** | **str** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/OrderFulfillment.md: -------------------------------------------------------------------------------- 1 | # OrderFulfillment 2 | > squareconnect.models.order_fulfillment 3 | 4 | ### Description 5 | 6 | Contains details on how to fulfill this order. 7 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **type** | **str** | The type of the fulfillment. See [OrderFulfillmentType](#type-orderfulfillmenttype) for possible values | [optional] 12 | **state** | **str** | The state of the fulfillment. See [OrderFulfillmentState](#type-orderfulfillmentstate) for possible values | [optional] 13 | **pickup_details** | [**OrderFulfillmentPickupDetails**](OrderFulfillmentPickupDetails.md) | Contains pickup-specific details. Required when fulfillment type is `PICKUP`. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/BatchRetrieveInventoryChangesResponse.md: -------------------------------------------------------------------------------- 1 | # BatchRetrieveInventoryChangesResponse 2 | > squareconnect.models.batch_retrieve_inventory_changes_response 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** | **str** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/ListBreakTypesResponse.md: -------------------------------------------------------------------------------- 1 | # ListBreakTypesResponse 2 | > squareconnect.models.list_break_types_response 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 | **break_types** | [**list[BreakType]**](BreakType.md) | A page of `BreakType` results. | [optional] 12 | **cursor** | **str** | 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/OrderRoundingAdjustment.md: -------------------------------------------------------------------------------- 1 | # OrderRoundingAdjustment 2 | > squareconnect.models.order_rounding_adjustment 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 | 8 | ## Properties 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | **uid** | **str** | Unique ID that identifies the rounding adjustment only within this order. This field is read-only. | [optional] 12 | **name** | **str** | The name of the rounding adjustment from the original sale Order. | [optional] 13 | **amount_money** | [**Money**](Money.md) | Actual rounding adjustment amount. | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | --------------------------------------------------------------------------------