├── .gitignore
├── .rspec
├── .swagger-codegen-ignore
├── .travis.yml
├── CHANGES.md
├── CONTRIBUTING.md
├── Gemfile
├── LICENSE.txt
├── README.md
├── Rakefile
├── docs
    ├── AdditionalRecipient.md
    ├── AdditionalRecipientReceivable.md
    ├── AdditionalRecipientReceivableRefund.md
    ├── Address.md
    ├── ApplePayApi.md
    ├── BatchChangeInventoryRequest.md
    ├── BatchChangeInventoryResponse.md
    ├── BatchDeleteCatalogObjectsRequest.md
    ├── BatchDeleteCatalogObjectsResponse.md
    ├── BatchRetrieveCatalogObjectsRequest.md
    ├── BatchRetrieveCatalogObjectsResponse.md
    ├── BatchRetrieveInventoryChangesRequest.md
    ├── BatchRetrieveInventoryChangesResponse.md
    ├── BatchRetrieveInventoryCountsRequest.md
    ├── BatchRetrieveInventoryCountsResponse.md
    ├── BatchRetrieveOrdersRequest.md
    ├── BatchRetrieveOrdersResponse.md
    ├── BatchUpsertCatalogObjectsRequest.md
    ├── BatchUpsertCatalogObjectsResponse.md
    ├── BreakType.md
    ├── BusinessHours.md
    ├── BusinessHoursPeriod.md
    ├── CaptureTransactionRequest.md
    ├── CaptureTransactionResponse.md
    ├── Card.md
    ├── CardBrand.md
    ├── CatalogApi.md
    ├── CatalogCategory.md
    ├── CatalogDiscount.md
    ├── CatalogDiscountType.md
    ├── CatalogIdMapping.md
    ├── CatalogImage.md
    ├── CatalogInfoRequest.md
    ├── CatalogInfoResponse.md
    ├── CatalogInfoResponseLimits.md
    ├── CatalogItem.md
    ├── CatalogItemModifierListInfo.md
    ├── CatalogItemOption.md
    ├── CatalogItemOptionForItem.md
    ├── CatalogItemOptionValue.md
    ├── CatalogItemOptionValueForItemVariation.md
    ├── CatalogItemProductType.md
    ├── CatalogItemVariation.md
    ├── CatalogMeasurementUnit.md
    ├── CatalogModifier.md
    ├── CatalogModifierList.md
    ├── CatalogModifierListSelectionType.md
    ├── CatalogModifierOverride.md
    ├── CatalogObject.md
    ├── CatalogObjectBatch.md
    ├── CatalogObjectType.md
    ├── CatalogPricingRule.md
    ├── CatalogPricingType.md
    ├── CatalogProductSet.md
    ├── CatalogQuery.md
    ├── CatalogQueryExact.md
    ├── CatalogQueryItemVariationsForItemOptionValues.md
    ├── CatalogQueryItemsForItemOptions.md
    ├── CatalogQueryItemsForModifierList.md
    ├── CatalogQueryItemsForTax.md
    ├── CatalogQueryPrefix.md
    ├── CatalogQueryRange.md
    ├── CatalogQuerySortedAttribute.md
    ├── CatalogQueryText.md
    ├── CatalogTax.md
    ├── CatalogTimePeriod.md
    ├── CatalogV1Id.md
    ├── ChargeRequest.md
    ├── ChargeRequestAdditionalRecipient.md
    ├── ChargeResponse.md
    ├── Checkout.md
    ├── CheckoutApi.md
    ├── Coordinates.md
    ├── Country.md
    ├── CreateBreakTypeRequest.md
    ├── CreateBreakTypeResponse.md
    ├── CreateCheckoutRequest.md
    ├── CreateCheckoutResponse.md
    ├── CreateCustomerCardRequest.md
    ├── CreateCustomerCardResponse.md
    ├── CreateCustomerRequest.md
    ├── CreateCustomerResponse.md
    ├── CreateMobileAuthorizationCodeRequest.md
    ├── CreateMobileAuthorizationCodeResponse.md
    ├── CreateOrderRequest.md
    ├── CreateOrderRequestDiscount.md
    ├── CreateOrderRequestLineItem.md
    ├── CreateOrderRequestModifier.md
    ├── CreateOrderRequestTax.md
    ├── CreateOrderResponse.md
    ├── CreateRefundRequest.md
    ├── CreateRefundResponse.md
    ├── CreateShiftRequest.md
    ├── CreateShiftResponse.md
    ├── Currency.md
    ├── Customer.md
    ├── CustomerCreationSource.md
    ├── CustomerCreationSourceFilter.md
    ├── CustomerFilter.md
    ├── CustomerGroupInfo.md
    ├── CustomerInclusionExclusion.md
    ├── CustomerPreferences.md
    ├── CustomerQuery.md
    ├── CustomerSort.md
    ├── CustomerSortField.md
    ├── CustomersApi.md
    ├── DateRange.md
    ├── DayOfWeek.md
    ├── DeleteBreakTypeRequest.md
    ├── DeleteBreakTypeResponse.md
    ├── DeleteCatalogObjectRequest.md
    ├── DeleteCatalogObjectResponse.md
    ├── DeleteCustomerCardRequest.md
    ├── DeleteCustomerCardResponse.md
    ├── DeleteCustomerRequest.md
    ├── DeleteCustomerResponse.md
    ├── DeleteShiftRequest.md
    ├── DeleteShiftResponse.md
    ├── Device.md
    ├── Employee.md
    ├── EmployeeStatus.md
    ├── EmployeeWage.md
    ├── EmployeesApi.md
    ├── Error.md
    ├── ErrorCategory.md
    ├── ErrorCode.md
    ├── GetBreakTypeRequest.md
    ├── GetBreakTypeResponse.md
    ├── GetEmployeeWageRequest.md
    ├── GetEmployeeWageResponse.md
    ├── GetShiftRequest.md
    ├── GetShiftResponse.md
    ├── InventoryAdjustment.md
    ├── InventoryAlertType.md
    ├── InventoryApi.md
    ├── InventoryChange.md
    ├── InventoryChangeType.md
    ├── InventoryCount.md
    ├── InventoryPhysicalCount.md
    ├── InventoryState.md
    ├── InventoryTransfer.md
    ├── ItemVariationLocationOverrides.md
    ├── LaborApi.md
    ├── ListAdditionalRecipientReceivableRefundsRequest.md
    ├── ListAdditionalRecipientReceivableRefundsResponse.md
    ├── ListAdditionalRecipientReceivablesRequest.md
    ├── ListAdditionalRecipientReceivablesResponse.md
    ├── ListBreakTypesRequest.md
    ├── ListBreakTypesResponse.md
    ├── ListCatalogRequest.md
    ├── ListCatalogResponse.md
    ├── ListCustomersRequest.md
    ├── ListCustomersResponse.md
    ├── ListEmployeeWagesRequest.md
    ├── ListEmployeeWagesResponse.md
    ├── ListEmployeesRequest.md
    ├── ListEmployeesResponse.md
    ├── ListLocationsRequest.md
    ├── ListLocationsResponse.md
    ├── ListRefundsRequest.md
    ├── ListRefundsResponse.md
    ├── ListTransactionsRequest.md
    ├── ListTransactionsResponse.md
    ├── ListWorkweekConfigsRequest.md
    ├── ListWorkweekConfigsResponse.md
    ├── Location.md
    ├── LocationCapability.md
    ├── LocationStatus.md
    ├── LocationType.md
    ├── LocationsApi.md
    ├── MeasurementUnit.md
    ├── MeasurementUnitArea.md
    ├── MeasurementUnitCustom.md
    ├── MeasurementUnitGeneric.md
    ├── MeasurementUnitLength.md
    ├── MeasurementUnitVolume.md
    ├── MeasurementUnitWeight.md
    ├── MobileAuthorizationApi.md
    ├── ModelBreak.md
    ├── Money.md
    ├── OAuthApi.md
    ├── ObtainTokenRequest.md
    ├── ObtainTokenResponse.md
    ├── Order.md
    ├── OrderEntry.md
    ├── OrderFulfillment.md
    ├── OrderFulfillmentPickupDetails.md
    ├── OrderFulfillmentPickupDetailsScheduleType.md
    ├── OrderFulfillmentRecipient.md
    ├── OrderFulfillmentState.md
    ├── OrderFulfillmentType.md
    ├── OrderLineItem.md
    ├── OrderLineItemDiscount.md
    ├── OrderLineItemDiscountScope.md
    ├── OrderLineItemDiscountType.md
    ├── OrderLineItemModifier.md
    ├── OrderLineItemTax.md
    ├── OrderLineItemTaxScope.md
    ├── OrderLineItemTaxType.md
    ├── OrderMoneyAmounts.md
    ├── OrderQuantityUnit.md
    ├── OrderReturn.md
    ├── OrderReturnDiscount.md
    ├── OrderReturnLineItem.md
    ├── OrderReturnLineItemModifier.md
    ├── OrderReturnServiceCharge.md
    ├── OrderReturnTax.md
    ├── OrderRoundingAdjustment.md
    ├── OrderServiceCharge.md
    ├── OrderServiceChargeCalculationPhase.md
    ├── OrderSource.md
    ├── OrderState.md
    ├── OrdersApi.md
    ├── Product.md
    ├── README.md
    ├── Refund.md
    ├── RefundStatus.md
    ├── RegisterDomainRequest.md
    ├── RegisterDomainResponse.md
    ├── RegisterDomainResponseStatus.md
    ├── RenewTokenRequest.md
    ├── RenewTokenResponse.md
    ├── ReportingApi.md
    ├── RetrieveCatalogObjectRequest.md
    ├── RetrieveCatalogObjectResponse.md
    ├── RetrieveCustomerRequest.md
    ├── RetrieveCustomerResponse.md
    ├── RetrieveEmployeeRequest.md
    ├── RetrieveEmployeeResponse.md
    ├── RetrieveInventoryAdjustmentRequest.md
    ├── RetrieveInventoryAdjustmentResponse.md
    ├── RetrieveInventoryChangesRequest.md
    ├── RetrieveInventoryChangesResponse.md
    ├── RetrieveInventoryCountRequest.md
    ├── RetrieveInventoryCountResponse.md
    ├── RetrieveInventoryPhysicalCountRequest.md
    ├── RetrieveInventoryPhysicalCountResponse.md
    ├── RetrieveTransactionRequest.md
    ├── RetrieveTransactionResponse.md
    ├── RevokeTokenRequest.md
    ├── RevokeTokenResponse.md
    ├── SearchCatalogObjectsRequest.md
    ├── SearchCatalogObjectsResponse.md
    ├── SearchCustomersRequest.md
    ├── SearchCustomersResponse.md
    ├── SearchOrdersCustomerFilter.md
    ├── SearchOrdersDateTimeFilter.md
    ├── SearchOrdersFilter.md
    ├── SearchOrdersFulfillmentFilter.md
    ├── SearchOrdersQuery.md
    ├── SearchOrdersRequest.md
    ├── SearchOrdersResponse.md
    ├── SearchOrdersSort.md
    ├── SearchOrdersSortField.md
    ├── SearchOrdersSourceFilter.md
    ├── SearchOrdersStateFilter.md
    ├── SearchShiftsRequest.md
    ├── SearchShiftsResponse.md
    ├── Shift.md
    ├── ShiftFilter.md
    ├── ShiftFilterStatus.md
    ├── ShiftQuery.md
    ├── ShiftSort.md
    ├── ShiftSortField.md
    ├── ShiftStatus.md
    ├── ShiftWage.md
    ├── ShiftWorkday.md
    ├── ShiftWorkdayMatcher.md
    ├── SortOrder.md
    ├── SourceApplication.md
    ├── StandardUnitDescription.md
    ├── StandardUnitDescriptionGroup.md
    ├── TaxCalculationPhase.md
    ├── TaxInclusionType.md
    ├── Tender.md
    ├── TenderCardDetails.md
    ├── TenderCardDetailsEntryMethod.md
    ├── TenderCardDetailsStatus.md
    ├── TenderCashDetails.md
    ├── TenderType.md
    ├── TimeRange.md
    ├── Transaction.md
    ├── TransactionProduct.md
    ├── TransactionsApi.md
    ├── UpdateBreakTypeRequest.md
    ├── UpdateBreakTypeResponse.md
    ├── UpdateCustomerRequest.md
    ├── UpdateCustomerResponse.md
    ├── UpdateItemModifierListsRequest.md
    ├── UpdateItemModifierListsResponse.md
    ├── UpdateItemTaxesRequest.md
    ├── UpdateItemTaxesResponse.md
    ├── UpdateShiftRequest.md
    ├── UpdateShiftResponse.md
    ├── UpdateWorkweekConfigRequest.md
    ├── UpdateWorkweekConfigResponse.md
    ├── UpsertCatalogObjectRequest.md
    ├── UpsertCatalogObjectResponse.md
    ├── V1AdjustInventoryRequest.md
    ├── V1AdjustInventoryRequestAdjustmentType.md
    ├── V1ApplyFeeRequest.md
    ├── V1ApplyModifierListRequest.md
    ├── V1BankAccount.md
    ├── V1BankAccountType.md
    ├── V1CashDrawerEvent.md
    ├── V1CashDrawerEventEventType.md
    ├── V1CashDrawerShift.md
    ├── V1CashDrawerShiftEventType.md
    ├── V1Category.md
    ├── V1CreateCategoryRequest.md
    ├── V1CreateDiscountRequest.md
    ├── V1CreateEmployeeRoleRequest.md
    ├── V1CreateFeeRequest.md
    ├── V1CreateItemRequest.md
    ├── V1CreateModifierListRequest.md
    ├── V1CreateModifierOptionRequest.md
    ├── V1CreatePageRequest.md
    ├── V1CreateRefundRequest.md
    ├── V1CreateRefundRequestType.md
    ├── V1CreateVariationRequest.md
    ├── V1DeleteCategoryRequest.md
    ├── V1DeleteDiscountRequest.md
    ├── V1DeleteFeeRequest.md
    ├── V1DeleteItemRequest.md
    ├── V1DeleteModifierListRequest.md
    ├── V1DeleteModifierOptionRequest.md
    ├── V1DeletePageCellRequest.md
    ├── V1DeletePageRequest.md
    ├── V1DeleteTimecardRequest.md
    ├── V1DeleteTimecardResponse.md
    ├── V1DeleteVariationRequest.md
    ├── V1Discount.md
    ├── V1DiscountColor.md
    ├── V1DiscountDiscountType.md
    ├── V1Employee.md
    ├── V1EmployeeRole.md
    ├── V1EmployeeRolePermissions.md
    ├── V1EmployeeStatus.md
    ├── V1EmployeesApi.md
    ├── V1Fee.md
    ├── V1FeeAdjustmentType.md
    ├── V1FeeCalculationPhase.md
    ├── V1FeeInclusionType.md
    ├── V1FeeType.md
    ├── V1InventoryEntry.md
    ├── V1Item.md
    ├── V1ItemColor.md
    ├── V1ItemImage.md
    ├── V1ItemType.md
    ├── V1ItemVisibility.md
    ├── V1ItemsApi.md
    ├── V1ListBankAccountsRequest.md
    ├── V1ListBankAccountsResponse.md
    ├── V1ListCashDrawerShiftsRequest.md
    ├── V1ListCashDrawerShiftsResponse.md
    ├── V1ListCategoriesRequest.md
    ├── V1ListCategoriesResponse.md
    ├── V1ListDiscountsRequest.md
    ├── V1ListDiscountsResponse.md
    ├── V1ListEmployeeRolesRequest.md
    ├── V1ListEmployeeRolesResponse.md
    ├── V1ListEmployeesRequest.md
    ├── V1ListEmployeesRequestStatus.md
    ├── V1ListEmployeesResponse.md
    ├── V1ListFeesRequest.md
    ├── V1ListFeesResponse.md
    ├── V1ListInventoryRequest.md
    ├── V1ListInventoryResponse.md
    ├── V1ListItemsRequest.md
    ├── V1ListItemsResponse.md
    ├── V1ListLocationsRequest.md
    ├── V1ListLocationsResponse.md
    ├── V1ListModifierListsRequest.md
    ├── V1ListModifierListsResponse.md
    ├── V1ListOrdersRequest.md
    ├── V1ListOrdersResponse.md
    ├── V1ListPagesRequest.md
    ├── V1ListPagesResponse.md
    ├── V1ListPaymentsRequest.md
    ├── V1ListPaymentsResponse.md
    ├── V1ListRefundsRequest.md
    ├── V1ListRefundsResponse.md
    ├── V1ListSettlementsRequest.md
    ├── V1ListSettlementsRequestStatus.md
    ├── V1ListSettlementsResponse.md
    ├── V1ListTimecardEventsRequest.md
    ├── V1ListTimecardEventsResponse.md
    ├── V1ListTimecardsRequest.md
    ├── V1ListTimecardsResponse.md
    ├── V1LocationsApi.md
    ├── V1Merchant.md
    ├── V1MerchantAccountType.md
    ├── V1MerchantBusinessType.md
    ├── V1MerchantLocationDetails.md
    ├── V1ModifierList.md
    ├── V1ModifierListSelectionType.md
    ├── V1ModifierOption.md
    ├── V1Money.md
    ├── V1Order.md
    ├── V1OrderHistoryEntry.md
    ├── V1OrderHistoryEntryAction.md
    ├── V1OrderState.md
    ├── V1Page.md
    ├── V1PageCell.md
    ├── V1PageCellObjectType.md
    ├── V1PageCellPlaceholderType.md
    ├── V1Payment.md
    ├── V1PaymentDiscount.md
    ├── V1PaymentItemDetail.md
    ├── V1PaymentItemization.md
    ├── V1PaymentItemizationItemizationType.md
    ├── V1PaymentModifier.md
    ├── V1PaymentSurcharge.md
    ├── V1PaymentSurchargeType.md
    ├── V1PaymentTax.md
    ├── V1PaymentTaxInclusionType.md
    ├── V1PhoneNumber.md
    ├── V1Refund.md
    ├── V1RefundType.md
    ├── V1RemoveFeeRequest.md
    ├── V1RemoveModifierListRequest.md
    ├── V1RetrieveBankAccountRequest.md
    ├── V1RetrieveBusinessRequest.md
    ├── V1RetrieveCashDrawerShiftRequest.md
    ├── V1RetrieveEmployeeRequest.md
    ├── V1RetrieveEmployeeRoleRequest.md
    ├── V1RetrieveItemRequest.md
    ├── V1RetrieveModifierListRequest.md
    ├── V1RetrieveOrderRequest.md
    ├── V1RetrievePaymentRequest.md
    ├── V1RetrieveSettlementRequest.md
    ├── V1RetrieveTimecardRequest.md
    ├── V1Settlement.md
    ├── V1SettlementEntry.md
    ├── V1SettlementEntryType.md
    ├── V1SettlementStatus.md
    ├── V1Tender.md
    ├── V1TenderCardBrand.md
    ├── V1TenderEntryMethod.md
    ├── V1TenderType.md
    ├── V1Timecard.md
    ├── V1TimecardEvent.md
    ├── V1TimecardEventEventType.md
    ├── V1TransactionsApi.md
    ├── V1UpdateCategoryRequest.md
    ├── V1UpdateDiscountRequest.md
    ├── V1UpdateEmployeeRequest.md
    ├── V1UpdateEmployeeRoleRequest.md
    ├── V1UpdateFeeRequest.md
    ├── V1UpdateItemRequest.md
    ├── V1UpdateModifierListRequest.md
    ├── V1UpdateModifierListRequestSelectionType.md
    ├── V1UpdateModifierOptionRequest.md
    ├── V1UpdateOrderRequest.md
    ├── V1UpdateOrderRequestAction.md
    ├── V1UpdatePageCellRequest.md
    ├── V1UpdatePageRequest.md
    ├── V1UpdateTimecardRequest.md
    ├── V1UpdateVariationRequest.md
    ├── V1Variation.md
    ├── V1VariationInventoryAlertType.md
    ├── V1VariationPricingType.md
    ├── VoidTransactionRequest.md
    ├── VoidTransactionResponse.md
    ├── WebhookEvents.md
    ├── Weekday.md
    └── WorkweekConfig.md
├── lib
    ├── square_connect.rb
    └── square_connect
    │   ├── api
    │       ├── apple_pay_api.rb
    │       ├── catalog_api.rb
    │       ├── checkout_api.rb
    │       ├── customers_api.rb
    │       ├── employees_api.rb
    │       ├── inventory_api.rb
    │       ├── labor_api.rb
    │       ├── locations_api.rb
    │       ├── mobile_authorization_api.rb
    │       ├── o_auth_api.rb
    │       ├── orders_api.rb
    │       ├── reporting_api.rb
    │       ├── transactions_api.rb
    │       ├── v1_employees_api.rb
    │       ├── v1_items_api.rb
    │       ├── v1_locations_api.rb
    │       └── v1_transactions_api.rb
    │   ├── api_client.rb
    │   ├── api_error.rb
    │   ├── configuration.rb
    │   ├── models
    │       ├── additional_recipient.rb
    │       ├── additional_recipient_receivable.rb
    │       ├── additional_recipient_receivable_refund.rb
    │       ├── address.rb
    │       ├── batch_change_inventory_request.rb
    │       ├── batch_change_inventory_response.rb
    │       ├── batch_delete_catalog_objects_request.rb
    │       ├── batch_delete_catalog_objects_response.rb
    │       ├── batch_retrieve_catalog_objects_request.rb
    │       ├── batch_retrieve_catalog_objects_response.rb
    │       ├── batch_retrieve_inventory_changes_request.rb
    │       ├── batch_retrieve_inventory_changes_response.rb
    │       ├── batch_retrieve_inventory_counts_request.rb
    │       ├── batch_retrieve_inventory_counts_response.rb
    │       ├── batch_retrieve_orders_request.rb
    │       ├── batch_retrieve_orders_response.rb
    │       ├── batch_upsert_catalog_objects_request.rb
    │       ├── batch_upsert_catalog_objects_response.rb
    │       ├── break_type.rb
    │       ├── business_hours.rb
    │       ├── business_hours_period.rb
    │       ├── capture_transaction_request.rb
    │       ├── capture_transaction_response.rb
    │       ├── card.rb
    │       ├── card_brand.rb
    │       ├── catalog_category.rb
    │       ├── catalog_discount.rb
    │       ├── catalog_discount_type.rb
    │       ├── catalog_id_mapping.rb
    │       ├── catalog_image.rb
    │       ├── catalog_info_request.rb
    │       ├── catalog_info_response.rb
    │       ├── catalog_info_response_limits.rb
    │       ├── catalog_item.rb
    │       ├── catalog_item_modifier_list_info.rb
    │       ├── catalog_item_option.rb
    │       ├── catalog_item_option_for_item.rb
    │       ├── catalog_item_option_value.rb
    │       ├── catalog_item_option_value_for_item_variation.rb
    │       ├── catalog_item_product_type.rb
    │       ├── catalog_item_variation.rb
    │       ├── catalog_measurement_unit.rb
    │       ├── catalog_modifier.rb
    │       ├── catalog_modifier_list.rb
    │       ├── catalog_modifier_list_selection_type.rb
    │       ├── catalog_modifier_override.rb
    │       ├── catalog_object.rb
    │       ├── catalog_object_batch.rb
    │       ├── catalog_object_type.rb
    │       ├── catalog_pricing_rule.rb
    │       ├── catalog_pricing_type.rb
    │       ├── catalog_product_set.rb
    │       ├── catalog_query.rb
    │       ├── catalog_query_exact.rb
    │       ├── catalog_query_item_variations_for_item_option_values.rb
    │       ├── catalog_query_items_for_item_options.rb
    │       ├── catalog_query_items_for_modifier_list.rb
    │       ├── catalog_query_items_for_tax.rb
    │       ├── catalog_query_prefix.rb
    │       ├── catalog_query_range.rb
    │       ├── catalog_query_sorted_attribute.rb
    │       ├── catalog_query_text.rb
    │       ├── catalog_tax.rb
    │       ├── catalog_time_period.rb
    │       ├── catalog_v1_id.rb
    │       ├── charge_request.rb
    │       ├── charge_request_additional_recipient.rb
    │       ├── charge_response.rb
    │       ├── checkout.rb
    │       ├── coordinates.rb
    │       ├── country.rb
    │       ├── create_break_type_request.rb
    │       ├── create_break_type_response.rb
    │       ├── create_checkout_request.rb
    │       ├── create_checkout_response.rb
    │       ├── create_customer_card_request.rb
    │       ├── create_customer_card_response.rb
    │       ├── create_customer_request.rb
    │       ├── create_customer_response.rb
    │       ├── create_mobile_authorization_code_request.rb
    │       ├── create_mobile_authorization_code_response.rb
    │       ├── create_order_request.rb
    │       ├── create_order_request_discount.rb
    │       ├── create_order_request_line_item.rb
    │       ├── create_order_request_modifier.rb
    │       ├── create_order_request_tax.rb
    │       ├── create_order_response.rb
    │       ├── create_refund_request.rb
    │       ├── create_refund_response.rb
    │       ├── create_shift_request.rb
    │       ├── create_shift_response.rb
    │       ├── currency.rb
    │       ├── customer.rb
    │       ├── customer_creation_source.rb
    │       ├── customer_creation_source_filter.rb
    │       ├── customer_filter.rb
    │       ├── customer_group_info.rb
    │       ├── customer_inclusion_exclusion.rb
    │       ├── customer_preferences.rb
    │       ├── customer_query.rb
    │       ├── customer_sort.rb
    │       ├── customer_sort_field.rb
    │       ├── date_range.rb
    │       ├── day_of_week.rb
    │       ├── delete_break_type_request.rb
    │       ├── delete_break_type_response.rb
    │       ├── delete_catalog_object_request.rb
    │       ├── delete_catalog_object_response.rb
    │       ├── delete_customer_card_request.rb
    │       ├── delete_customer_card_response.rb
    │       ├── delete_customer_request.rb
    │       ├── delete_customer_response.rb
    │       ├── delete_shift_request.rb
    │       ├── delete_shift_response.rb
    │       ├── device.rb
    │       ├── employee.rb
    │       ├── employee_status.rb
    │       ├── employee_wage.rb
    │       ├── error.rb
    │       ├── error_category.rb
    │       ├── error_code.rb
    │       ├── get_break_type_request.rb
    │       ├── get_break_type_response.rb
    │       ├── get_employee_wage_request.rb
    │       ├── get_employee_wage_response.rb
    │       ├── get_shift_request.rb
    │       ├── get_shift_response.rb
    │       ├── inventory_adjustment.rb
    │       ├── inventory_alert_type.rb
    │       ├── inventory_change.rb
    │       ├── inventory_change_type.rb
    │       ├── inventory_count.rb
    │       ├── inventory_physical_count.rb
    │       ├── inventory_state.rb
    │       ├── inventory_transfer.rb
    │       ├── item_variation_location_overrides.rb
    │       ├── list_additional_recipient_receivable_refunds_request.rb
    │       ├── list_additional_recipient_receivable_refunds_response.rb
    │       ├── list_additional_recipient_receivables_request.rb
    │       ├── list_additional_recipient_receivables_response.rb
    │       ├── list_break_types_request.rb
    │       ├── list_break_types_response.rb
    │       ├── list_catalog_request.rb
    │       ├── list_catalog_response.rb
    │       ├── list_customers_request.rb
    │       ├── list_customers_response.rb
    │       ├── list_employee_wages_request.rb
    │       ├── list_employee_wages_response.rb
    │       ├── list_employees_request.rb
    │       ├── list_employees_response.rb
    │       ├── list_locations_request.rb
    │       ├── list_locations_response.rb
    │       ├── list_refunds_request.rb
    │       ├── list_refunds_response.rb
    │       ├── list_transactions_request.rb
    │       ├── list_transactions_response.rb
    │       ├── list_workweek_configs_request.rb
    │       ├── list_workweek_configs_response.rb
    │       ├── location.rb
    │       ├── location_capability.rb
    │       ├── location_status.rb
    │       ├── location_type.rb
    │       ├── measurement_unit.rb
    │       ├── measurement_unit_area.rb
    │       ├── measurement_unit_custom.rb
    │       ├── measurement_unit_generic.rb
    │       ├── measurement_unit_length.rb
    │       ├── measurement_unit_volume.rb
    │       ├── measurement_unit_weight.rb
    │       ├── model_break.rb
    │       ├── money.rb
    │       ├── obtain_token_request.rb
    │       ├── obtain_token_response.rb
    │       ├── order.rb
    │       ├── order_entry.rb
    │       ├── order_fulfillment.rb
    │       ├── order_fulfillment_pickup_details.rb
    │       ├── order_fulfillment_pickup_details_schedule_type.rb
    │       ├── order_fulfillment_recipient.rb
    │       ├── order_fulfillment_state.rb
    │       ├── order_fulfillment_type.rb
    │       ├── order_line_item.rb
    │       ├── order_line_item_discount.rb
    │       ├── order_line_item_discount_scope.rb
    │       ├── order_line_item_discount_type.rb
    │       ├── order_line_item_modifier.rb
    │       ├── order_line_item_tax.rb
    │       ├── order_line_item_tax_scope.rb
    │       ├── order_line_item_tax_type.rb
    │       ├── order_money_amounts.rb
    │       ├── order_quantity_unit.rb
    │       ├── order_return.rb
    │       ├── order_return_discount.rb
    │       ├── order_return_line_item.rb
    │       ├── order_return_line_item_modifier.rb
    │       ├── order_return_service_charge.rb
    │       ├── order_return_tax.rb
    │       ├── order_rounding_adjustment.rb
    │       ├── order_service_charge.rb
    │       ├── order_service_charge_calculation_phase.rb
    │       ├── order_source.rb
    │       ├── order_state.rb
    │       ├── product.rb
    │       ├── refund.rb
    │       ├── refund_status.rb
    │       ├── register_domain_request.rb
    │       ├── register_domain_response.rb
    │       ├── register_domain_response_status.rb
    │       ├── renew_token_request.rb
    │       ├── renew_token_response.rb
    │       ├── retrieve_catalog_object_request.rb
    │       ├── retrieve_catalog_object_response.rb
    │       ├── retrieve_customer_request.rb
    │       ├── retrieve_customer_response.rb
    │       ├── retrieve_employee_request.rb
    │       ├── retrieve_employee_response.rb
    │       ├── retrieve_inventory_adjustment_request.rb
    │       ├── retrieve_inventory_adjustment_response.rb
    │       ├── retrieve_inventory_changes_request.rb
    │       ├── retrieve_inventory_changes_response.rb
    │       ├── retrieve_inventory_count_request.rb
    │       ├── retrieve_inventory_count_response.rb
    │       ├── retrieve_inventory_physical_count_request.rb
    │       ├── retrieve_inventory_physical_count_response.rb
    │       ├── retrieve_transaction_request.rb
    │       ├── retrieve_transaction_response.rb
    │       ├── revoke_token_request.rb
    │       ├── revoke_token_response.rb
    │       ├── search_catalog_objects_request.rb
    │       ├── search_catalog_objects_response.rb
    │       ├── search_customers_request.rb
    │       ├── search_customers_response.rb
    │       ├── search_orders_customer_filter.rb
    │       ├── search_orders_date_time_filter.rb
    │       ├── search_orders_filter.rb
    │       ├── search_orders_fulfillment_filter.rb
    │       ├── search_orders_query.rb
    │       ├── search_orders_request.rb
    │       ├── search_orders_response.rb
    │       ├── search_orders_sort.rb
    │       ├── search_orders_sort_field.rb
    │       ├── search_orders_source_filter.rb
    │       ├── search_orders_state_filter.rb
    │       ├── search_shifts_request.rb
    │       ├── search_shifts_response.rb
    │       ├── shift.rb
    │       ├── shift_filter.rb
    │       ├── shift_filter_status.rb
    │       ├── shift_query.rb
    │       ├── shift_sort.rb
    │       ├── shift_sort_field.rb
    │       ├── shift_status.rb
    │       ├── shift_wage.rb
    │       ├── shift_workday.rb
    │       ├── shift_workday_matcher.rb
    │       ├── sort_order.rb
    │       ├── source_application.rb
    │       ├── standard_unit_description.rb
    │       ├── standard_unit_description_group.rb
    │       ├── tax_calculation_phase.rb
    │       ├── tax_inclusion_type.rb
    │       ├── tender.rb
    │       ├── tender_card_details.rb
    │       ├── tender_card_details_entry_method.rb
    │       ├── tender_card_details_status.rb
    │       ├── tender_cash_details.rb
    │       ├── tender_type.rb
    │       ├── time_range.rb
    │       ├── transaction.rb
    │       ├── transaction_product.rb
    │       ├── update_break_type_request.rb
    │       ├── update_break_type_response.rb
    │       ├── update_customer_request.rb
    │       ├── update_customer_response.rb
    │       ├── update_item_modifier_lists_request.rb
    │       ├── update_item_modifier_lists_response.rb
    │       ├── update_item_taxes_request.rb
    │       ├── update_item_taxes_response.rb
    │       ├── update_shift_request.rb
    │       ├── update_shift_response.rb
    │       ├── update_workweek_config_request.rb
    │       ├── update_workweek_config_response.rb
    │       ├── upsert_catalog_object_request.rb
    │       ├── upsert_catalog_object_response.rb
    │       ├── v1_adjust_inventory_request.rb
    │       ├── v1_adjust_inventory_request_adjustment_type.rb
    │       ├── v1_apply_fee_request.rb
    │       ├── v1_apply_modifier_list_request.rb
    │       ├── v1_bank_account.rb
    │       ├── v1_bank_account_type.rb
    │       ├── v1_cash_drawer_event.rb
    │       ├── v1_cash_drawer_event_event_type.rb
    │       ├── v1_cash_drawer_shift.rb
    │       ├── v1_cash_drawer_shift_event_type.rb
    │       ├── v1_category.rb
    │       ├── v1_create_category_request.rb
    │       ├── v1_create_discount_request.rb
    │       ├── v1_create_employee_role_request.rb
    │       ├── v1_create_fee_request.rb
    │       ├── v1_create_item_request.rb
    │       ├── v1_create_modifier_list_request.rb
    │       ├── v1_create_modifier_option_request.rb
    │       ├── v1_create_page_request.rb
    │       ├── v1_create_refund_request.rb
    │       ├── v1_create_refund_request_type.rb
    │       ├── v1_create_variation_request.rb
    │       ├── v1_delete_category_request.rb
    │       ├── v1_delete_discount_request.rb
    │       ├── v1_delete_fee_request.rb
    │       ├── v1_delete_item_request.rb
    │       ├── v1_delete_modifier_list_request.rb
    │       ├── v1_delete_modifier_option_request.rb
    │       ├── v1_delete_page_cell_request.rb
    │       ├── v1_delete_page_request.rb
    │       ├── v1_delete_timecard_request.rb
    │       ├── v1_delete_timecard_response.rb
    │       ├── v1_delete_variation_request.rb
    │       ├── v1_discount.rb
    │       ├── v1_discount_color.rb
    │       ├── v1_discount_discount_type.rb
    │       ├── v1_employee.rb
    │       ├── v1_employee_role.rb
    │       ├── v1_employee_role_permissions.rb
    │       ├── v1_employee_status.rb
    │       ├── v1_fee.rb
    │       ├── v1_fee_adjustment_type.rb
    │       ├── v1_fee_calculation_phase.rb
    │       ├── v1_fee_inclusion_type.rb
    │       ├── v1_fee_type.rb
    │       ├── v1_inventory_entry.rb
    │       ├── v1_item.rb
    │       ├── v1_item_color.rb
    │       ├── v1_item_image.rb
    │       ├── v1_item_type.rb
    │       ├── v1_item_visibility.rb
    │       ├── v1_list_bank_accounts_request.rb
    │       ├── v1_list_bank_accounts_response.rb
    │       ├── v1_list_cash_drawer_shifts_request.rb
    │       ├── v1_list_cash_drawer_shifts_response.rb
    │       ├── v1_list_categories_request.rb
    │       ├── v1_list_categories_response.rb
    │       ├── v1_list_discounts_request.rb
    │       ├── v1_list_discounts_response.rb
    │       ├── v1_list_employee_roles_request.rb
    │       ├── v1_list_employee_roles_response.rb
    │       ├── v1_list_employees_request.rb
    │       ├── v1_list_employees_request_status.rb
    │       ├── v1_list_employees_response.rb
    │       ├── v1_list_fees_request.rb
    │       ├── v1_list_fees_response.rb
    │       ├── v1_list_inventory_request.rb
    │       ├── v1_list_inventory_response.rb
    │       ├── v1_list_items_request.rb
    │       ├── v1_list_items_response.rb
    │       ├── v1_list_locations_request.rb
    │       ├── v1_list_locations_response.rb
    │       ├── v1_list_modifier_lists_request.rb
    │       ├── v1_list_modifier_lists_response.rb
    │       ├── v1_list_orders_request.rb
    │       ├── v1_list_orders_response.rb
    │       ├── v1_list_pages_request.rb
    │       ├── v1_list_pages_response.rb
    │       ├── v1_list_payments_request.rb
    │       ├── v1_list_payments_response.rb
    │       ├── v1_list_refunds_request.rb
    │       ├── v1_list_refunds_response.rb
    │       ├── v1_list_settlements_request.rb
    │       ├── v1_list_settlements_request_status.rb
    │       ├── v1_list_settlements_response.rb
    │       ├── v1_list_timecard_events_request.rb
    │       ├── v1_list_timecard_events_response.rb
    │       ├── v1_list_timecards_request.rb
    │       ├── v1_list_timecards_response.rb
    │       ├── v1_merchant.rb
    │       ├── v1_merchant_account_type.rb
    │       ├── v1_merchant_business_type.rb
    │       ├── v1_merchant_location_details.rb
    │       ├── v1_modifier_list.rb
    │       ├── v1_modifier_list_selection_type.rb
    │       ├── v1_modifier_option.rb
    │       ├── v1_money.rb
    │       ├── v1_order.rb
    │       ├── v1_order_history_entry.rb
    │       ├── v1_order_history_entry_action.rb
    │       ├── v1_order_state.rb
    │       ├── v1_page.rb
    │       ├── v1_page_cell.rb
    │       ├── v1_page_cell_object_type.rb
    │       ├── v1_page_cell_placeholder_type.rb
    │       ├── v1_payment.rb
    │       ├── v1_payment_discount.rb
    │       ├── v1_payment_item_detail.rb
    │       ├── v1_payment_itemization.rb
    │       ├── v1_payment_itemization_itemization_type.rb
    │       ├── v1_payment_modifier.rb
    │       ├── v1_payment_surcharge.rb
    │       ├── v1_payment_surcharge_type.rb
    │       ├── v1_payment_tax.rb
    │       ├── v1_payment_tax_inclusion_type.rb
    │       ├── v1_phone_number.rb
    │       ├── v1_refund.rb
    │       ├── v1_refund_type.rb
    │       ├── v1_remove_fee_request.rb
    │       ├── v1_remove_modifier_list_request.rb
    │       ├── v1_retrieve_bank_account_request.rb
    │       ├── v1_retrieve_business_request.rb
    │       ├── v1_retrieve_cash_drawer_shift_request.rb
    │       ├── v1_retrieve_employee_request.rb
    │       ├── v1_retrieve_employee_role_request.rb
    │       ├── v1_retrieve_item_request.rb
    │       ├── v1_retrieve_modifier_list_request.rb
    │       ├── v1_retrieve_order_request.rb
    │       ├── v1_retrieve_payment_request.rb
    │       ├── v1_retrieve_settlement_request.rb
    │       ├── v1_retrieve_timecard_request.rb
    │       ├── v1_settlement.rb
    │       ├── v1_settlement_entry.rb
    │       ├── v1_settlement_entry_type.rb
    │       ├── v1_settlement_status.rb
    │       ├── v1_tender.rb
    │       ├── v1_tender_card_brand.rb
    │       ├── v1_tender_entry_method.rb
    │       ├── v1_tender_type.rb
    │       ├── v1_timecard.rb
    │       ├── v1_timecard_event.rb
    │       ├── v1_timecard_event_event_type.rb
    │       ├── v1_update_category_request.rb
    │       ├── v1_update_discount_request.rb
    │       ├── v1_update_employee_request.rb
    │       ├── v1_update_employee_role_request.rb
    │       ├── v1_update_fee_request.rb
    │       ├── v1_update_item_request.rb
    │       ├── v1_update_modifier_list_request.rb
    │       ├── v1_update_modifier_list_request_selection_type.rb
    │       ├── v1_update_modifier_option_request.rb
    │       ├── v1_update_order_request.rb
    │       ├── v1_update_order_request_action.rb
    │       ├── v1_update_page_cell_request.rb
    │       ├── v1_update_page_request.rb
    │       ├── v1_update_timecard_request.rb
    │       ├── v1_update_variation_request.rb
    │       ├── v1_variation.rb
    │       ├── v1_variation_inventory_alert_type.rb
    │       ├── v1_variation_pricing_type.rb
    │       ├── void_transaction_request.rb
    │       ├── void_transaction_response.rb
    │       ├── webhook_events.rb
    │       ├── weekday.rb
    │       └── workweek_config.rb
    │   └── version.rb
├── spec
    ├── api
    │   ├── apple_pay_api_spec.rb
    │   ├── catalog_api_spec.rb
    │   ├── checkout_api_spec.rb
    │   ├── customers_api_spec.rb
    │   ├── employees_api_spec.rb
    │   ├── inventory_api_spec.rb
    │   ├── labor_api_spec.rb
    │   ├── locations_api_spec.rb
    │   ├── mobile_authorization_api_spec.rb
    │   ├── o_auth_api_spec.rb
    │   ├── orders_api_spec.rb
    │   ├── reporting_api_spec.rb
    │   ├── transactions_api_spec.rb
    │   ├── v1_employees_api_spec.rb
    │   ├── v1_items_api_spec.rb
    │   ├── v1_locations_api_spec.rb
    │   └── v1_transactions_api_spec.rb
    ├── api_client_spec.rb
    ├── configuration_spec.rb
    ├── models
    │   ├── additional_recipient_receivable_refund_spec.rb
    │   ├── additional_recipient_receivable_spec.rb
    │   ├── additional_recipient_spec.rb
    │   ├── address_spec.rb
    │   ├── batch_change_inventory_request_spec.rb
    │   ├── batch_change_inventory_response_spec.rb
    │   ├── batch_delete_catalog_objects_request_spec.rb
    │   ├── batch_delete_catalog_objects_response_spec.rb
    │   ├── batch_retrieve_catalog_objects_request_spec.rb
    │   ├── batch_retrieve_catalog_objects_response_spec.rb
    │   ├── batch_retrieve_inventory_changes_request_spec.rb
    │   ├── batch_retrieve_inventory_changes_response_spec.rb
    │   ├── batch_retrieve_inventory_counts_request_spec.rb
    │   ├── batch_retrieve_inventory_counts_response_spec.rb
    │   ├── batch_retrieve_orders_request_spec.rb
    │   ├── batch_retrieve_orders_response_spec.rb
    │   ├── batch_upsert_catalog_objects_request_spec.rb
    │   ├── batch_upsert_catalog_objects_response_spec.rb
    │   ├── break_type_spec.rb
    │   ├── business_hours_period_spec.rb
    │   ├── business_hours_spec.rb
    │   ├── capture_transaction_request_spec.rb
    │   ├── capture_transaction_response_spec.rb
    │   ├── card_brand_spec.rb
    │   ├── card_spec.rb
    │   ├── catalog_category_spec.rb
    │   ├── catalog_discount_spec.rb
    │   ├── catalog_discount_type_spec.rb
    │   ├── catalog_id_mapping_spec.rb
    │   ├── catalog_image_spec.rb
    │   ├── catalog_info_request_spec.rb
    │   ├── catalog_info_response_limits_spec.rb
    │   ├── catalog_info_response_spec.rb
    │   ├── catalog_item_modifier_list_info_spec.rb
    │   ├── catalog_item_option_for_item_spec.rb
    │   ├── catalog_item_option_spec.rb
    │   ├── catalog_item_option_value_for_item_variation_spec.rb
    │   ├── catalog_item_option_value_spec.rb
    │   ├── catalog_item_product_type_spec.rb
    │   ├── catalog_item_spec.rb
    │   ├── catalog_item_variation_spec.rb
    │   ├── catalog_measurement_unit_spec.rb
    │   ├── catalog_modifier_list_selection_type_spec.rb
    │   ├── catalog_modifier_list_spec.rb
    │   ├── catalog_modifier_override_spec.rb
    │   ├── catalog_modifier_spec.rb
    │   ├── catalog_object_batch_spec.rb
    │   ├── catalog_object_spec.rb
    │   ├── catalog_object_type_spec.rb
    │   ├── catalog_pricing_rule_spec.rb
    │   ├── catalog_pricing_type_spec.rb
    │   ├── catalog_product_set_spec.rb
    │   ├── catalog_query_exact_spec.rb
    │   ├── catalog_query_item_variations_for_item_option_values_spec.rb
    │   ├── catalog_query_items_for_item_options_spec.rb
    │   ├── catalog_query_items_for_modifier_list_spec.rb
    │   ├── catalog_query_items_for_tax_spec.rb
    │   ├── catalog_query_prefix_spec.rb
    │   ├── catalog_query_range_spec.rb
    │   ├── catalog_query_sorted_attribute_spec.rb
    │   ├── catalog_query_spec.rb
    │   ├── catalog_query_text_spec.rb
    │   ├── catalog_tax_spec.rb
    │   ├── catalog_time_period_spec.rb
    │   ├── catalog_v1_id_spec.rb
    │   ├── charge_request_additional_recipient_spec.rb
    │   ├── charge_request_spec.rb
    │   ├── charge_response_spec.rb
    │   ├── checkout_spec.rb
    │   ├── coordinates_spec.rb
    │   ├── country_spec.rb
    │   ├── create_break_type_request_spec.rb
    │   ├── create_break_type_response_spec.rb
    │   ├── create_checkout_request_spec.rb
    │   ├── create_checkout_response_spec.rb
    │   ├── create_customer_card_request_spec.rb
    │   ├── create_customer_card_response_spec.rb
    │   ├── create_customer_request_spec.rb
    │   ├── create_customer_response_spec.rb
    │   ├── create_mobile_authorization_code_request_spec.rb
    │   ├── create_mobile_authorization_code_response_spec.rb
    │   ├── create_order_request_discount_spec.rb
    │   ├── create_order_request_line_item_spec.rb
    │   ├── create_order_request_modifier_spec.rb
    │   ├── create_order_request_spec.rb
    │   ├── create_order_request_tax_spec.rb
    │   ├── create_order_response_spec.rb
    │   ├── create_refund_request_spec.rb
    │   ├── create_refund_response_spec.rb
    │   ├── create_shift_request_spec.rb
    │   ├── create_shift_response_spec.rb
    │   ├── currency_spec.rb
    │   ├── customer_creation_source_filter_spec.rb
    │   ├── customer_creation_source_spec.rb
    │   ├── customer_filter_spec.rb
    │   ├── customer_group_info_spec.rb
    │   ├── customer_inclusion_exclusion_spec.rb
    │   ├── customer_preferences_spec.rb
    │   ├── customer_query_spec.rb
    │   ├── customer_sort_field_spec.rb
    │   ├── customer_sort_spec.rb
    │   ├── customer_spec.rb
    │   ├── date_range_spec.rb
    │   ├── day_of_week_spec.rb
    │   ├── delete_break_type_request_spec.rb
    │   ├── delete_break_type_response_spec.rb
    │   ├── delete_catalog_object_request_spec.rb
    │   ├── delete_catalog_object_response_spec.rb
    │   ├── delete_customer_card_request_spec.rb
    │   ├── delete_customer_card_response_spec.rb
    │   ├── delete_customer_request_spec.rb
    │   ├── delete_customer_response_spec.rb
    │   ├── delete_shift_request_spec.rb
    │   ├── delete_shift_response_spec.rb
    │   ├── device_spec.rb
    │   ├── employee_spec.rb
    │   ├── employee_status_spec.rb
    │   ├── employee_wage_spec.rb
    │   ├── error_category_spec.rb
    │   ├── error_code_spec.rb
    │   ├── error_spec.rb
    │   ├── get_break_type_request_spec.rb
    │   ├── get_break_type_response_spec.rb
    │   ├── get_employee_wage_request_spec.rb
    │   ├── get_employee_wage_response_spec.rb
    │   ├── get_shift_request_spec.rb
    │   ├── get_shift_response_spec.rb
    │   ├── inventory_adjustment_spec.rb
    │   ├── inventory_alert_type_spec.rb
    │   ├── inventory_change_spec.rb
    │   ├── inventory_change_type_spec.rb
    │   ├── inventory_count_spec.rb
    │   ├── inventory_physical_count_spec.rb
    │   ├── inventory_state_spec.rb
    │   ├── inventory_transfer_spec.rb
    │   ├── item_variation_location_overrides_spec.rb
    │   ├── list_additional_recipient_receivable_refunds_request_spec.rb
    │   ├── list_additional_recipient_receivable_refunds_response_spec.rb
    │   ├── list_additional_recipient_receivables_request_spec.rb
    │   ├── list_additional_recipient_receivables_response_spec.rb
    │   ├── list_break_types_request_spec.rb
    │   ├── list_break_types_response_spec.rb
    │   ├── list_catalog_request_spec.rb
    │   ├── list_catalog_response_spec.rb
    │   ├── list_customers_request_spec.rb
    │   ├── list_customers_response_spec.rb
    │   ├── list_employee_wages_request_spec.rb
    │   ├── list_employee_wages_response_spec.rb
    │   ├── list_employees_request_spec.rb
    │   ├── list_employees_response_spec.rb
    │   ├── list_locations_request_spec.rb
    │   ├── list_locations_response_spec.rb
    │   ├── list_refunds_request_spec.rb
    │   ├── list_refunds_response_spec.rb
    │   ├── list_transactions_request_spec.rb
    │   ├── list_transactions_response_spec.rb
    │   ├── list_workweek_configs_request_spec.rb
    │   ├── list_workweek_configs_response_spec.rb
    │   ├── location_capability_spec.rb
    │   ├── location_spec.rb
    │   ├── location_status_spec.rb
    │   ├── location_type_spec.rb
    │   ├── measurement_unit_area_spec.rb
    │   ├── measurement_unit_custom_spec.rb
    │   ├── measurement_unit_generic_spec.rb
    │   ├── measurement_unit_length_spec.rb
    │   ├── measurement_unit_spec.rb
    │   ├── measurement_unit_volume_spec.rb
    │   ├── measurement_unit_weight_spec.rb
    │   ├── model_break_spec.rb
    │   ├── money_spec.rb
    │   ├── obtain_token_request_spec.rb
    │   ├── obtain_token_response_spec.rb
    │   ├── order_entry_spec.rb
    │   ├── order_fulfillment_pickup_details_schedule_type_spec.rb
    │   ├── order_fulfillment_pickup_details_spec.rb
    │   ├── order_fulfillment_recipient_spec.rb
    │   ├── order_fulfillment_spec.rb
    │   ├── order_fulfillment_state_spec.rb
    │   ├── order_fulfillment_type_spec.rb
    │   ├── order_line_item_discount_scope_spec.rb
    │   ├── order_line_item_discount_spec.rb
    │   ├── order_line_item_discount_type_spec.rb
    │   ├── order_line_item_modifier_spec.rb
    │   ├── order_line_item_spec.rb
    │   ├── order_line_item_tax_scope_spec.rb
    │   ├── order_line_item_tax_spec.rb
    │   ├── order_line_item_tax_type_spec.rb
    │   ├── order_money_amounts_spec.rb
    │   ├── order_quantity_unit_spec.rb
    │   ├── order_return_discount_spec.rb
    │   ├── order_return_line_item_modifier_spec.rb
    │   ├── order_return_line_item_spec.rb
    │   ├── order_return_service_charge_spec.rb
    │   ├── order_return_spec.rb
    │   ├── order_return_tax_spec.rb
    │   ├── order_rounding_adjustment_spec.rb
    │   ├── order_service_charge_calculation_phase_spec.rb
    │   ├── order_service_charge_spec.rb
    │   ├── order_source_spec.rb
    │   ├── order_spec.rb
    │   ├── order_state_spec.rb
    │   ├── product_spec.rb
    │   ├── refund_spec.rb
    │   ├── refund_status_spec.rb
    │   ├── register_domain_request_spec.rb
    │   ├── register_domain_response_spec.rb
    │   ├── register_domain_response_status_spec.rb
    │   ├── renew_token_request_spec.rb
    │   ├── renew_token_response_spec.rb
    │   ├── retrieve_catalog_object_request_spec.rb
    │   ├── retrieve_catalog_object_response_spec.rb
    │   ├── retrieve_customer_request_spec.rb
    │   ├── retrieve_customer_response_spec.rb
    │   ├── retrieve_employee_request_spec.rb
    │   ├── retrieve_employee_response_spec.rb
    │   ├── retrieve_inventory_adjustment_request_spec.rb
    │   ├── retrieve_inventory_adjustment_response_spec.rb
    │   ├── retrieve_inventory_changes_request_spec.rb
    │   ├── retrieve_inventory_changes_response_spec.rb
    │   ├── retrieve_inventory_count_request_spec.rb
    │   ├── retrieve_inventory_count_response_spec.rb
    │   ├── retrieve_inventory_physical_count_request_spec.rb
    │   ├── retrieve_inventory_physical_count_response_spec.rb
    │   ├── retrieve_transaction_request_spec.rb
    │   ├── retrieve_transaction_response_spec.rb
    │   ├── revoke_token_request_spec.rb
    │   ├── revoke_token_response_spec.rb
    │   ├── search_catalog_objects_request_spec.rb
    │   ├── search_catalog_objects_response_spec.rb
    │   ├── search_customers_request_spec.rb
    │   ├── search_customers_response_spec.rb
    │   ├── search_orders_customer_filter_spec.rb
    │   ├── search_orders_date_time_filter_spec.rb
    │   ├── search_orders_filter_spec.rb
    │   ├── search_orders_fulfillment_filter_spec.rb
    │   ├── search_orders_query_spec.rb
    │   ├── search_orders_request_spec.rb
    │   ├── search_orders_response_spec.rb
    │   ├── search_orders_sort_field_spec.rb
    │   ├── search_orders_sort_spec.rb
    │   ├── search_orders_source_filter_spec.rb
    │   ├── search_orders_state_filter_spec.rb
    │   ├── search_shifts_request_spec.rb
    │   ├── search_shifts_response_spec.rb
    │   ├── shift_filter_spec.rb
    │   ├── shift_filter_status_spec.rb
    │   ├── shift_query_spec.rb
    │   ├── shift_sort_field_spec.rb
    │   ├── shift_sort_spec.rb
    │   ├── shift_spec.rb
    │   ├── shift_status_spec.rb
    │   ├── shift_wage_spec.rb
    │   ├── shift_workday_matcher_spec.rb
    │   ├── shift_workday_spec.rb
    │   ├── sort_order_spec.rb
    │   ├── source_application_spec.rb
    │   ├── standard_unit_description_group_spec.rb
    │   ├── standard_unit_description_spec.rb
    │   ├── tax_calculation_phase_spec.rb
    │   ├── tax_inclusion_type_spec.rb
    │   ├── tender_card_details_entry_method_spec.rb
    │   ├── tender_card_details_spec.rb
    │   ├── tender_card_details_status_spec.rb
    │   ├── tender_cash_details_spec.rb
    │   ├── tender_spec.rb
    │   ├── tender_type_spec.rb
    │   ├── time_range_spec.rb
    │   ├── transaction_product_spec.rb
    │   ├── transaction_spec.rb
    │   ├── update_break_type_request_spec.rb
    │   ├── update_break_type_response_spec.rb
    │   ├── update_customer_request_spec.rb
    │   ├── update_customer_response_spec.rb
    │   ├── update_item_modifier_lists_request_spec.rb
    │   ├── update_item_modifier_lists_response_spec.rb
    │   ├── update_item_taxes_request_spec.rb
    │   ├── update_item_taxes_response_spec.rb
    │   ├── update_shift_request_spec.rb
    │   ├── update_shift_response_spec.rb
    │   ├── update_workweek_config_request_spec.rb
    │   ├── update_workweek_config_response_spec.rb
    │   ├── upsert_catalog_object_request_spec.rb
    │   ├── upsert_catalog_object_response_spec.rb
    │   ├── v1_adjust_inventory_request_adjustment_type_spec.rb
    │   ├── v1_adjust_inventory_request_spec.rb
    │   ├── v1_apply_fee_request_spec.rb
    │   ├── v1_apply_modifier_list_request_spec.rb
    │   ├── v1_bank_account_spec.rb
    │   ├── v1_bank_account_type_spec.rb
    │   ├── v1_cash_drawer_event_event_type_spec.rb
    │   ├── v1_cash_drawer_event_spec.rb
    │   ├── v1_cash_drawer_shift_event_type_spec.rb
    │   ├── v1_cash_drawer_shift_spec.rb
    │   ├── v1_category_spec.rb
    │   ├── v1_create_category_request_spec.rb
    │   ├── v1_create_discount_request_spec.rb
    │   ├── v1_create_employee_role_request_spec.rb
    │   ├── v1_create_fee_request_spec.rb
    │   ├── v1_create_item_request_spec.rb
    │   ├── v1_create_modifier_list_request_spec.rb
    │   ├── v1_create_modifier_option_request_spec.rb
    │   ├── v1_create_page_request_spec.rb
    │   ├── v1_create_refund_request_spec.rb
    │   ├── v1_create_refund_request_type_spec.rb
    │   ├── v1_create_variation_request_spec.rb
    │   ├── v1_delete_category_request_spec.rb
    │   ├── v1_delete_discount_request_spec.rb
    │   ├── v1_delete_fee_request_spec.rb
    │   ├── v1_delete_item_request_spec.rb
    │   ├── v1_delete_modifier_list_request_spec.rb
    │   ├── v1_delete_modifier_option_request_spec.rb
    │   ├── v1_delete_page_cell_request_spec.rb
    │   ├── v1_delete_page_request_spec.rb
    │   ├── v1_delete_timecard_request_spec.rb
    │   ├── v1_delete_timecard_response_spec.rb
    │   ├── v1_delete_variation_request_spec.rb
    │   ├── v1_discount_color_spec.rb
    │   ├── v1_discount_discount_type_spec.rb
    │   ├── v1_discount_spec.rb
    │   ├── v1_employee_role_permissions_spec.rb
    │   ├── v1_employee_role_spec.rb
    │   ├── v1_employee_spec.rb
    │   ├── v1_employee_status_spec.rb
    │   ├── v1_fee_adjustment_type_spec.rb
    │   ├── v1_fee_calculation_phase_spec.rb
    │   ├── v1_fee_inclusion_type_spec.rb
    │   ├── v1_fee_spec.rb
    │   ├── v1_fee_type_spec.rb
    │   ├── v1_inventory_entry_spec.rb
    │   ├── v1_item_color_spec.rb
    │   ├── v1_item_image_spec.rb
    │   ├── v1_item_spec.rb
    │   ├── v1_item_type_spec.rb
    │   ├── v1_item_visibility_spec.rb
    │   ├── v1_list_bank_accounts_request_spec.rb
    │   ├── v1_list_bank_accounts_response_spec.rb
    │   ├── v1_list_cash_drawer_shifts_request_spec.rb
    │   ├── v1_list_cash_drawer_shifts_response_spec.rb
    │   ├── v1_list_categories_request_spec.rb
    │   ├── v1_list_categories_response_spec.rb
    │   ├── v1_list_discounts_request_spec.rb
    │   ├── v1_list_discounts_response_spec.rb
    │   ├── v1_list_employee_roles_request_spec.rb
    │   ├── v1_list_employee_roles_response_spec.rb
    │   ├── v1_list_employees_request_spec.rb
    │   ├── v1_list_employees_request_status_spec.rb
    │   ├── v1_list_employees_response_spec.rb
    │   ├── v1_list_fees_request_spec.rb
    │   ├── v1_list_fees_response_spec.rb
    │   ├── v1_list_inventory_request_spec.rb
    │   ├── v1_list_inventory_response_spec.rb
    │   ├── v1_list_items_request_spec.rb
    │   ├── v1_list_items_response_spec.rb
    │   ├── v1_list_locations_request_spec.rb
    │   ├── v1_list_locations_response_spec.rb
    │   ├── v1_list_modifier_lists_request_spec.rb
    │   ├── v1_list_modifier_lists_response_spec.rb
    │   ├── v1_list_orders_request_spec.rb
    │   ├── v1_list_orders_response_spec.rb
    │   ├── v1_list_pages_request_spec.rb
    │   ├── v1_list_pages_response_spec.rb
    │   ├── v1_list_payments_request_spec.rb
    │   ├── v1_list_payments_response_spec.rb
    │   ├── v1_list_refunds_request_spec.rb
    │   ├── v1_list_refunds_response_spec.rb
    │   ├── v1_list_settlements_request_spec.rb
    │   ├── v1_list_settlements_request_status_spec.rb
    │   ├── v1_list_settlements_response_spec.rb
    │   ├── v1_list_timecard_events_request_spec.rb
    │   ├── v1_list_timecard_events_response_spec.rb
    │   ├── v1_list_timecards_request_spec.rb
    │   ├── v1_list_timecards_response_spec.rb
    │   ├── v1_merchant_account_type_spec.rb
    │   ├── v1_merchant_business_type_spec.rb
    │   ├── v1_merchant_location_details_spec.rb
    │   ├── v1_merchant_spec.rb
    │   ├── v1_modifier_list_selection_type_spec.rb
    │   ├── v1_modifier_list_spec.rb
    │   ├── v1_modifier_option_spec.rb
    │   ├── v1_money_spec.rb
    │   ├── v1_order_history_entry_action_spec.rb
    │   ├── v1_order_history_entry_spec.rb
    │   ├── v1_order_spec.rb
    │   ├── v1_order_state_spec.rb
    │   ├── v1_page_cell_object_type_spec.rb
    │   ├── v1_page_cell_placeholder_type_spec.rb
    │   ├── v1_page_cell_spec.rb
    │   ├── v1_page_spec.rb
    │   ├── v1_payment_discount_spec.rb
    │   ├── v1_payment_item_detail_spec.rb
    │   ├── v1_payment_itemization_itemization_type_spec.rb
    │   ├── v1_payment_itemization_spec.rb
    │   ├── v1_payment_modifier_spec.rb
    │   ├── v1_payment_spec.rb
    │   ├── v1_payment_surcharge_spec.rb
    │   ├── v1_payment_surcharge_type_spec.rb
    │   ├── v1_payment_tax_inclusion_type_spec.rb
    │   ├── v1_payment_tax_spec.rb
    │   ├── v1_phone_number_spec.rb
    │   ├── v1_refund_spec.rb
    │   ├── v1_refund_type_spec.rb
    │   ├── v1_remove_fee_request_spec.rb
    │   ├── v1_remove_modifier_list_request_spec.rb
    │   ├── v1_retrieve_bank_account_request_spec.rb
    │   ├── v1_retrieve_business_request_spec.rb
    │   ├── v1_retrieve_cash_drawer_shift_request_spec.rb
    │   ├── v1_retrieve_employee_request_spec.rb
    │   ├── v1_retrieve_employee_role_request_spec.rb
    │   ├── v1_retrieve_item_request_spec.rb
    │   ├── v1_retrieve_modifier_list_request_spec.rb
    │   ├── v1_retrieve_order_request_spec.rb
    │   ├── v1_retrieve_payment_request_spec.rb
    │   ├── v1_retrieve_settlement_request_spec.rb
    │   ├── v1_retrieve_timecard_request_spec.rb
    │   ├── v1_settlement_entry_spec.rb
    │   ├── v1_settlement_entry_type_spec.rb
    │   ├── v1_settlement_spec.rb
    │   ├── v1_settlement_status_spec.rb
    │   ├── v1_tender_card_brand_spec.rb
    │   ├── v1_tender_entry_method_spec.rb
    │   ├── v1_tender_spec.rb
    │   ├── v1_tender_type_spec.rb
    │   ├── v1_timecard_event_event_type_spec.rb
    │   ├── v1_timecard_event_spec.rb
    │   ├── v1_timecard_spec.rb
    │   ├── v1_update_category_request_spec.rb
    │   ├── v1_update_discount_request_spec.rb
    │   ├── v1_update_employee_request_spec.rb
    │   ├── v1_update_employee_role_request_spec.rb
    │   ├── v1_update_fee_request_spec.rb
    │   ├── v1_update_item_request_spec.rb
    │   ├── v1_update_modifier_list_request_selection_type_spec.rb
    │   ├── v1_update_modifier_list_request_spec.rb
    │   ├── v1_update_modifier_option_request_spec.rb
    │   ├── v1_update_order_request_action_spec.rb
    │   ├── v1_update_order_request_spec.rb
    │   ├── v1_update_page_cell_request_spec.rb
    │   ├── v1_update_page_request_spec.rb
    │   ├── v1_update_timecard_request_spec.rb
    │   ├── v1_update_variation_request_spec.rb
    │   ├── v1_variation_inventory_alert_type_spec.rb
    │   ├── v1_variation_pricing_type_spec.rb
    │   ├── v1_variation_spec.rb
    │   ├── void_transaction_request_spec.rb
    │   ├── void_transaction_response_spec.rb
    │   ├── webhook_events_spec.rb
    │   ├── weekday_spec.rb
    │   └── workweek_config_spec.rb
    └── spec_helper.rb
├── square_connect.gemspec
└── travis-ci
    └── accounts.enc


/.rspec:
--------------------------------------------------------------------------------
1 | --color
2 | --require spec_helper
3 | 


--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | Contributing
2 | ============
3 | 
4 | We are not be accepting bug reports, feature requests, or code contributions to
5 | this repository.
6 | 


--------------------------------------------------------------------------------
/Gemfile:
--------------------------------------------------------------------------------
1 | source 'https://rubygems.org'
2 | 
3 | gemspec
4 | 
5 | group :development, :test do
6 |   gem 'rake', '~> 12.0.0'
7 | end
8 | 


--------------------------------------------------------------------------------
/Rakefile:
--------------------------------------------------------------------------------
1 | begin
2 |   require 'rspec/core/rake_task'
3 | 
4 |   RSpec::Core::RakeTask.new(:spec)
5 |   task default: :spec
6 | rescue LoadError
7 |   # no rspec available
8 | end
9 | 


--------------------------------------------------------------------------------
/docs/BatchChangeInventoryResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::BatchChangeInventoryResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | **counts** | [**Array<InventoryCount>**](InventoryCount.md) | The current counts for all objects referenced in the request. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/BatchDeleteCatalogObjectsRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::BatchDeleteCatalogObjectsRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **object_ids** | **Array<String>** | 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] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/BatchDeleteCatalogObjectsResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::BatchDeleteCatalogObjectsResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 
11 | **deleted_object_ids** | **Array<String>** | The IDs of all [CatalogObject](#type-catalogobject)s deleted by this request. | [optional] 
12 | **deleted_at** | **String** | The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/BatchRetrieveCatalogObjectsResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::BatchRetrieveCatalogObjectsResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 
11 | **objects** | [**Array<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s returned. | [optional] 
12 | **related_objects** | [**Array<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s referenced by the object in the `objects` field. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/BatchRetrieveInventoryChangesResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::BatchRetrieveInventoryChangesResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | **changes** | [**Array<InventoryChange>**](InventoryChange.md) | The current calculated inventory changes for the requested objects and locations. | [optional] 
12 | **cursor** | **String** | 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 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/BatchRetrieveInventoryCountsResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::BatchRetrieveInventoryCountsResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | **counts** | [**Array<InventoryCount>**](InventoryCount.md) | The current calculated inventory counts for the requested objects and locations. | [optional] 
12 | **cursor** | **String** | 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 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/BatchRetrieveOrdersRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::BatchRetrieveOrdersRequest
 2 | 
 3 | ### Description
 4 | 
 5 | Defines the fields that are included in requests to the BatchRetrieveOrders endpoint.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **order_ids** | **Array<String>** | The IDs of the orders to retrieve. A maximum of 100 orders can be retrieved per request. | 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/BusinessHours.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::BusinessHours
 2 | 
 3 | ### Description
 4 | 
 5 |  Represents the hours of operation for a business location.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **periods** | [**Array<BusinessHoursPeriod>**](BusinessHoursPeriod.md) | The list of time periods during which the business is open. There may be at most 10 periods per day. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/BusinessHoursPeriod.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::BusinessHoursPeriod
 2 | 
 3 | ### Description
 4 | 
 5 |  Represents a period of time during which a business location is open.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **day_of_week** | **String** | The day of week for this time period. See [DayOfWeek](#type-dayofweek) for possible values | [optional] 
11 | **start_local_time** | **String** | The start time of a business hours period, specified in local time using partial-time RFC3339 format. | [optional] 
12 | **end_local_time** | **String** | The end time of a business hours period, specified in local time using partial-time RFC3339 format. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/CaptureTransactionRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CaptureTransactionRequest
 2 | 
 3 | ### Description
 4 | 
 5 | Defines the query parameters for calls to the CaptureTransaction endpoint.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/CaptureTransactionResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CaptureTransactionResponse
 2 | 
 3 | ### Description
 4 | 
 5 | Defines the fields that are included in the response body of a request to the CaptureTransaction endpoint.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/CardBrand.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CardBrand
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates a card's brand, such as `VISA` or `MASTERCARD`.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **OTHER_BRAND** | string
11 | **VISA** | string
12 | **MASTERCARD** | string
13 | **AMERICAN_EXPRESS** | string
14 | **DISCOVER** | string
15 | **DISCOVER_DINERS** | string
16 | **JCB** | string
17 | **CHINA_UNIONPAY** | string
18 | **SQUARE_GIFT_CARD** | string
19 | 
20 | 
21 | 


--------------------------------------------------------------------------------
/docs/CatalogCategory.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogCategory
 2 | 
 3 | ### Description
 4 | 
 5 | A category to which an [CatalogItem](#type-catalogitem) belongs in the Catalog object model.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **name** | **String** | The category's name. Searchable. This field has max length of 255 Unicode code points. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/CatalogDiscountType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogDiscountType
 2 | 
 3 | ### Description
 4 | 
 5 | How to apply a [CatalogDiscount](#type-catalogdiscount) to a [CatalogItem](#type-catalogitem).
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **FIXED_PERCENTAGE** | string
11 | **FIXED_AMOUNT** | string
12 | **VARIABLE_PERCENTAGE** | string
13 | **VARIABLE_AMOUNT** | string
14 | 
15 | 
16 | 


--------------------------------------------------------------------------------
/docs/CatalogIdMapping.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogIdMapping
 2 | 
 3 | ### Description
 4 | 
 5 | A mapping between a client-supplied temporary ID and a permanent server ID.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **client_object_id** | **String** | The client-supplied, temporary `#`-prefixed ID for a new [CatalogObject](#type-catalogobject). | [optional] 
11 | **object_id** | **String** | The permanent ID for the [CatalogObject](#type-catalogobject) created by the server. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CatalogImage.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogImage
 2 | 
 3 | ### Description
 4 | 
 5 | An image file to use in Square catalogs. Can be associated with catalog items, item variations, and categories.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **name** | **String** | The internal name of this image. Identifies this image in calls to the Connect APIs. | [optional] 
11 | **url** | **String** | The URL of this image. Generated by Square after an image is uploaded to the CreateCatalogImage endpoint. | [optional] 
12 | **caption** | **String** | A caption that describes what is shown in the image. Displayed in the Square Online Store. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/CatalogInfoRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogInfoRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/CatalogInfoResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogInfoResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 
11 | **limits** | [**CatalogInfoResponseLimits**](CatalogInfoResponseLimits.md) |  | [optional] 
12 | **standard_unit_description_group** | [**StandardUnitDescriptionGroup**](StandardUnitDescriptionGroup.md) | Names and abbreviations for standard units. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/CatalogItemOptionForItem.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogItemOptionForItem
 2 | 
 3 | ### Description
 4 | 
 5 |  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.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **item_option_id** | **String** | The unique id of the item option, used to form the dimensions of the item option matrix in a specified order. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/CatalogItemOptionValueForItemVariation.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogItemOptionValueForItemVariation
 2 | 
 3 | ### Description
 4 | 
 5 | A [CatalogItemOptionValue](#type-catalogitemoptionvalue) links an item variation to an item option as an item option value. For example, a t-shirt item may offer a color option and a size option. An item option value would represent each variation of t-shirt: For example, “Color:Red, Size:Small” or “Color:Blue, Size:Medium”.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **item_option_id** | **String** | The unique id of an item option. | [optional] 
11 | **item_option_value_id** | **String** | The unique id of the selected value for the item option. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CatalogItemProductType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogItemProductType
 2 | 
 3 | ### Description
 4 | 
 5 |  The type of a [CatalogItem](#type-catalogitem). Connect V2 only allows the creation of `REGULAR` or `APPOINTMENTS_SERVICE` items.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **REGULAR** | string
11 | **GIFT_CARD** | string
12 | **APPOINTMENTS_SERVICE** | string
13 | **RETAIL_ITEM** | string
14 | **RESTAURANT_ITEM** | string
15 | 
16 | 
17 | 


--------------------------------------------------------------------------------
/docs/CatalogModifier.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogModifier
 2 | 
 3 | ### Description
 4 | 
 5 | A modifier in the Catalog object model.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **name** | **String** | The modifier's name. Searchable. This field has max length of 255 Unicode code points. | [optional] 
11 | **price_money** | [**Money**](Money.md) | The modifier's price. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CatalogModifierListSelectionType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogModifierListSelectionType
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates whether a [CatalogModifierList](#type-catalogmodifierlist) supports multiple selections.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **SINGLE** | string
11 | **MULTIPLE** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CatalogModifierOverride.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogModifierOverride
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **modifier_id** | **String** | The ID of the [CatalogModifier](#type-catalogmodifier) whose default behavior is being overridden. | 
11 | **on_by_default** | **BOOLEAN** | If `true`, this [CatalogModifier](#type-catalogmodifier) should be selected by default for this [CatalogItem](#type-catalogitem). | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CatalogObjectBatch.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogObjectBatch
 2 | 
 3 | ### Description
 4 | 
 5 | A batch of [CatalogObject](#type-catalogobject)s.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **objects** | [**Array<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s belonging to this batch. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/CatalogObjectType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogObjectType
 2 | 
 3 | ### Description
 4 | 
 5 | 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.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **ITEM** | string
11 | **IMAGE** | string
12 | **CATEGORY** | string
13 | **ITEM_VARIATION** | string
14 | **TAX** | string
15 | **DISCOUNT** | string
16 | **MODIFIER_LIST** | string
17 | **MODIFIER** | string
18 | **PRICING_RULE** | string
19 | **PRODUCT_SET** | string
20 | **TIME_PERIOD** | string
21 | **MEASUREMENT_UNIT** | string
22 | **ITEM_OPTION** | string
23 | **ITEM_OPTION_VAL** | string
24 | 
25 | 
26 | 


--------------------------------------------------------------------------------
/docs/CatalogPricingType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogPricingType
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates whether the price of a [CatalogItemVariation](#type-catalogitemvariation) should be entered manually at the time of sale.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **FIXED_PRICING** | string
11 | **VARIABLE_PRICING** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CatalogQueryExact.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogQueryExact
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **attribute_name** | **String** | The name of the attribute to be searched. | 
11 | **attribute_value** | **String** | The desired value of the search attribute. | 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CatalogQueryItemVariationsForItemOptionValues.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogQueryItemVariationsForItemOptionValues
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **item_option_value_ids** | **Array<String>** | 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] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/CatalogQueryItemsForItemOptions.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogQueryItemsForItemOptions
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **item_option_ids** | **Array<String>** | 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] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/CatalogQueryItemsForModifierList.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogQueryItemsForModifierList
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **modifier_list_ids** | **Array<String>** | A set of [CatalogModifierList](#type-catalogmodifierlist) IDs to be used to find associated [CatalogItem](#type-catalogitem)s. | 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/CatalogQueryItemsForTax.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogQueryItemsForTax
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **tax_ids** | **Array<String>** | A set of [CatalogTax](#type-catalogtax) IDs to be used to find associated [CatalogItem](#type-catalogitem)s. | 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/CatalogQueryPrefix.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogQueryPrefix
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **attribute_name** | **String** | The name of the attribute to be searched. | 
11 | **attribute_prefix** | **String** | The desired prefix of the search attribute value. | 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CatalogQueryRange.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogQueryRange
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **attribute_name** | **String** | The name of the attribute to be searched. | 
11 | **attribute_min_value** | **Integer** | The desired minimum value for the search attribute (inclusive). | [optional] 
12 | **attribute_max_value** | **Integer** | The desired maximum value for the search attribute (inclusive). | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/CatalogQueryText.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogQueryText
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **keywords** | **Array<String>** | A list of one, two, or three search keywords. Keywords with fewer than three characters are ignored. | 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/CatalogV1Id.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CatalogV1Id
 2 | 
 3 | ### Description
 4 | 
 5 | An Items Connect V1 object ID along with its associated [location](#type-location) ID.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **catalog_v1_id** | **String** | The ID for an object in Connect V1, if different from its Connect V2 ID. | [optional] 
11 | **location_id** | **String** | The ID of the [location](#type-location) this Connect V1 ID is associated with. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ChargeRequestAdditionalRecipient.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::ChargeRequestAdditionalRecipient
 2 | 
 3 | ### Description
 4 | 
 5 | 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
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **location_id** | **String** | The location ID for a recipient (other than the merchant) receiving a portion of the tender. | 
11 | **description** | **String** | The description of the additional recipient. | 
12 | **amount_money** | [**Money**](Money.md) | The amount of money distributed to the recipient. | 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ChargeResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::ChargeResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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).
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | **transaction** | [**Transaction**](Transaction.md) | The created transaction. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/Coordinates.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::Coordinates
 2 | 
 3 | ### Description
 4 | 
 5 | Latitude and longitude coordinates.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **latitude** | **Float** | The coordinate's latitude expressed in degrees. | [optional] 
11 | **longitude** | **Float** | The coordinate's longitude expressed in degrees. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CreateBreakTypeRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CreateBreakTypeRequest
 2 | 
 3 | ### Description
 4 | 
 5 | A request to create a new `BreakType`
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **idempotency_key** | **String** | Unique string value to insure idempotency of the operation | [optional] 
11 | **break_type** | [**BreakType**](BreakType.md) | The `BreakType` to be created. | 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CreateBreakTypeResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CreateBreakTypeResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **break_type** | [**BreakType**](BreakType.md) | The `BreakType` that was created by the request. | [optional] 
11 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CreateCheckoutResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CreateCheckoutResponse
 2 | 
 3 | ### Description
 4 | 
 5 | Defines the fields that are included in the response body of a request to the CreateCheckout endpoint.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **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] 
11 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CreateCustomerCardResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CreateCustomerCardResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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).
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | **card** | [**Card**](Card.md) | The created card on file. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CreateCustomerResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CreateCustomerResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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).
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | **customer** | [**Customer**](Customer.md) | The created customer. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CreateMobileAuthorizationCodeRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CreateMobileAuthorizationCodeRequest
 2 | 
 3 | ### Description
 4 | 
 5 | Defines the body parameters that can be provided in a request to the CreateMobileAuthorizationCode endpoint.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **location_id** | **String** | The Square location ID the authorization code should be tied to. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/CreateOrderResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CreateOrderResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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).
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **order** | [**Order**](Order.md) | The newly created order. | [optional] 
11 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CreateRefundResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CreateRefundResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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).
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | **refund** | [**Refund**](Refund.md) | The created refund. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CreateShiftRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CreateShiftRequest
 2 | 
 3 | ### Description
 4 | 
 5 | Represents a request to create a `Shift`
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **idempotency_key** | **String** | Unique string value to insure the idempotency of the operation. | [optional] 
11 | **shift** | [**Shift**](Shift.md) | The `Shift` to be created | 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CreateShiftResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CreateShiftResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **shift** | [**Shift**](Shift.md) | The `Shift` that was created on the request. | [optional] 
11 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CustomerCreationSource.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CustomerCreationSource
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates the method used to create the customer profile.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **OTHER** | string
11 | **APPOINTMENTS** | string
12 | **COUPON** | string
13 | **DELETION_RECOVERY** | string
14 | **DIRECTORY** | string
15 | **EGIFTING** | string
16 | **EMAIL_COLLECTION** | string
17 | **FEEDBACK** | string
18 | **IMPORT** | string
19 | **INVOICES** | string
20 | **LOYALTY** | string
21 | **MARKETING** | string
22 | **MERGE** | string
23 | **ONLINE_STORE** | string
24 | **INSTANT_PROFILE** | string
25 | **TERMINAL** | string
26 | **THIRD_PARTY** | string
27 | **THIRD_PARTY_IMPORT** | string
28 | **UNMERGE_RECOVERY** | string
29 | 
30 | 
31 | 


--------------------------------------------------------------------------------
/docs/CustomerGroupInfo.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CustomerGroupInfo
 2 | 
 3 | ### Description
 4 | 
 5 | Contains some brief information about a customer group with its identifier included.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **id** | **String** | The ID of the customer group. | 
11 | **name** | **String** | The name of the customer group. | 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CustomerInclusionExclusion.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CustomerInclusionExclusion
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates whether customers should be included in, or excluded from, the result set when they match the filtering criteria.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **INCLUDE** | string
11 | **EXCLUDE** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CustomerPreferences.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CustomerPreferences
 2 | 
 3 | ### Description
 4 | 
 5 | Represents a particular customer's preferences.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **email_unsubscribed** | **BOOLEAN** | The customer has unsubscribed from receiving marketing campaign emails. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/CustomerQuery.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CustomerQuery
 2 | 
 3 | ### Description
 4 | 
 5 | Represents a query (filtering and sorting criteria) used to search for customer profiles.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **filter** | [**CustomerFilter**](CustomerFilter.md) | A list of filter criteria. | [optional] 
11 | **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] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/CustomerSortField.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::CustomerSortField
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates the sort criteria for a list of Customers.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **DEFAULT** | string
11 | **CREATED_AT** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/DateRange.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::DateRange
 2 | 
 3 | ### Description
 4 | 
 5 | A range defined by two dates. Used for filtering a query for Connect v2  objects that have date properties.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **start_date** | **String** | String in `YYYY-MM-DD` format, e.g. `2017-10-31` per the ISO 8601 extended format for calendar dates. The beginning of a date range (inclusive) | [optional] 
11 | **end_date** | **String** | String in `YYYY-MM-DD` format, e.g. `2017-10-31` per the ISO 8601 extended format for calendar dates. The end of a date range (inclusive) | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/DayOfWeek.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::DayOfWeek
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates the specific day  of the week.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **SUN** | string
11 | **MON** | string
12 | **TUE** | string
13 | **WED** | string
14 | **THU** | string
15 | **FRI** | string
16 | **SAT** | string
17 | 
18 | 
19 | 


--------------------------------------------------------------------------------
/docs/DeleteBreakTypeRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::DeleteBreakTypeRequest
 2 | 
 3 | ### Description
 4 | 
 5 | A request to delete a `BreakType`
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/DeleteBreakTypeResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::DeleteBreakTypeResponse
 2 | 
 3 | ### Description
 4 | 
 5 | The response to a request to delete a `BreakType`. May contain a set  of `Error` objects if the request resulted in errors.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/DeleteCatalogObjectRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::DeleteCatalogObjectRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/DeleteCustomerCardRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::DeleteCustomerCardRequest
 2 | 
 3 | ### Description
 4 | 
 5 | Defines the fields that are included in requests to the DeleteCustomerCard endpoint.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/DeleteCustomerCardResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::DeleteCustomerCardResponse
 2 | 
 3 | ### Description
 4 | 
 5 | Defines the fields that are included in the response body of a request to the DeleteCustomerCard endpoint.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/DeleteCustomerRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::DeleteCustomerRequest
 2 | 
 3 | ### Description
 4 | 
 5 | Defines the fields that are included in a request to the DeleteCustomer endpoint.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/DeleteCustomerResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::DeleteCustomerResponse
 2 | 
 3 | ### Description
 4 | 
 5 | Defines the fields that are included in the response body of a request to the DeleteCustomer endpoint.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/DeleteShiftRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::DeleteShiftRequest
 2 | 
 3 | ### Description
 4 | 
 5 | A request to delete a `Shift`
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/DeleteShiftResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::DeleteShiftResponse
 2 | 
 3 | ### Description
 4 | 
 5 | The response to a request to delete a `Shift`. May contain a set of  `Error` objects if the request resulted in errors.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/Device.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::Device
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **id** | **String** | The device's Square-issued ID. | [optional] 
11 | **name** | **String** | The device's merchant-specified name. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/EmployeeStatus.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::EmployeeStatus
 2 | 
 3 | ### Description
 4 | 
 5 | The status of the Employee being retrieved.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **ACTIVE** | string
11 | **INACTIVE** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/EmployeeWage.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::EmployeeWage
 2 | 
 3 | ### Description
 4 | 
 5 | The hourly wage rate that an employee will earn on a `Shift` for doing the job specified by the `title` property of this object.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **id** | **String** | UUID for this object. | [optional] 
11 | **employee_id** | **String** | The `Employee` that this wage is assigned to. | 
12 | **title** | **String** | The job title that this wage relates to. | [optional] 
13 | **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] 
14 | 
15 | 
16 | 


--------------------------------------------------------------------------------
/docs/Error.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::Error
 2 | 
 3 | ### Description
 4 | 
 5 | Represents an error encountered during a request to the Connect API.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **category** | **String** | The error's high-level category. See [ErrorCategory](#type-errorcategory) for possible values | 
11 | **code** | **String** | The error's specific code. See [ErrorCode](#type-errorcode) for possible values | 
12 | **detail** | **String** | A human-readable description of the error for debugging purposes. | [optional] 
13 | **field** | **String** | The name of the field provided in the original request that the error pertains to, if any. | [optional] 
14 | 
15 | 
16 | 


--------------------------------------------------------------------------------
/docs/ErrorCategory.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::ErrorCategory
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates which high-level category of error has occurred during a request to the Connect API.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **API_ERROR** | string
11 | **AUTHENTICATION_ERROR** | string
12 | **INVALID_REQUEST_ERROR** | string
13 | **RATE_LIMIT_ERROR** | string
14 | **PAYMENT_METHOD_ERROR** | string
15 | **REFUND_ERROR** | string
16 | 
17 | 
18 | 


--------------------------------------------------------------------------------
/docs/GetBreakTypeRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::GetBreakTypeRequest
 2 | 
 3 | ### Description
 4 | 
 5 | A request to GET a `BreakType` by ID
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/GetBreakTypeResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::GetBreakTypeResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **break_type** | [**BreakType**](BreakType.md) | The response object. | [optional] 
11 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/GetEmployeeWageRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::GetEmployeeWageRequest
 2 | 
 3 | ### Description
 4 | 
 5 | A request to get an `EmployeeWage`
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/GetEmployeeWageResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::GetEmployeeWageResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **employee_wage** | [**EmployeeWage**](EmployeeWage.md) | The requested `EmployeeWage` object. | [optional] 
11 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/GetShiftRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::GetShiftRequest
 2 | 
 3 | ### Description
 4 | 
 5 | A request to get a `Shift` by ID
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/GetShiftResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::GetShiftResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **shift** | [**Shift**](Shift.md) | The requested `Shift`. | [optional] 
11 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/InventoryAlertType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::InventoryAlertType
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates whether Square should alert the merchant when the inventory quantity of a [CatalogItemVariation](#type-catalogitemvariation) is low.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **NONE** | string
11 | **LOW_QUANTITY** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/InventoryChangeType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::InventoryChangeType
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates how the inventory change was applied to a tracked quantity of items.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **PHYSICAL_COUNT** | string
11 | **ADJUSTMENT** | string
12 | **TRANSFER** | string
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/InventoryState.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::InventoryState
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates the state of a tracked item quantity in the lifecycle of goods.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **CUSTOM** | string
11 | **IN_STOCK** | string
12 | **SOLD** | string
13 | **RETURNED_BY_CUSTOMER** | string
14 | **RESERVED_FOR_SALE** | string
15 | **SOLD_ONLINE** | string
16 | **ORDERED_FROM_VENDOR** | string
17 | **RECEIVED_FROM_VENDOR** | string
18 | **IN_TRANSIT_TO** | string
19 | **NONE** | string
20 | **WASTE** | string
21 | **UNLINKED_RETURN** | string
22 | 
23 | 
24 | 


--------------------------------------------------------------------------------
/docs/ListBreakTypesRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::ListBreakTypesRequest
 2 | 
 3 | ### Description
 4 | 
 5 | A request for a filtered set of `BreakType` objects
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **location_id** | **String** | Filter Break Types returned to only those that are associated with the specified location. | [optional] 
11 | **limit** | **Integer** | Maximum number of Break Types to return per page. Can range between 1 and 200. The default is the maximum at 200. | [optional] 
12 | **cursor** | **String** | Pointer to the next page of Break Type results to fetch. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ListBreakTypesResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::ListBreakTypesResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **break_types** | [**Array<BreakType>**](BreakType.md) |  A page of `BreakType` results. | [optional] 
11 | **cursor** | **String** | Value supplied in the subsequent request to fetch the next next page of Break Type results. | [optional] 
12 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ListCatalogResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::ListCatalogResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 
11 | **cursor** | **String** | 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] 
12 | **objects** | [**Array<CatalogObject>**](CatalogObject.md) | The [CatalogObject](#type-catalogobject)s returned. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ListEmployeeWagesRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::ListEmployeeWagesRequest
 2 | 
 3 | ### Description
 4 | 
 5 | A request for a set of `EmployeeWage` objects
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **employee_id** | **String** | Filter wages returned to only those that are associated with the specified employee. | [optional] 
11 | **limit** | **Integer** | Maximum number of Employee Wages to return per page. Can range between 1 and 200. The default is the maximum at 200. | [optional] 
12 | **cursor** | **String** | Pointer to the next page of Employee Wage results to fetch. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ListEmployeeWagesResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::ListEmployeeWagesResponse
 2 | 
 3 | ### Description
 4 | 
 5 | The response to a request for a set of `EmployeeWage` objects. Contains  a set of `EmployeeWage`.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **employee_wages** | [**Array<EmployeeWage>**](EmployeeWage.md) | A page of Employee Wage results. | [optional] 
11 | **cursor** | **String** | Value supplied in the subsequent request to fetch the next next page of Employee Wage results. | [optional] 
12 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ListEmployeesRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::ListEmployeesRequest
 2 | 
 3 | ### Description
 4 | 
 5 | Retrieve a paged-list of employees for a Square account
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **location_id** | **String** | Filter employees returned to only those that are associated with the specified location. | [optional] 
11 | **status** | **String** | Specifies the EmployeeStatus to filter the employee by. See [EmployeeStatus](#type-employeestatus) for possible values | [optional] 
12 | **limit** | **Integer** | The number of employees to be returned on each page. | [optional] 
13 | **cursor** | **String** | The token required to retrieve the specified page of results. | [optional] 
14 | 
15 | 
16 | 


--------------------------------------------------------------------------------
/docs/ListEmployeesResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::ListEmployeesResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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).
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **employees** | [**Array<Employee>**](Employee.md) | List of employees returned from the request. | [optional] 
11 | **cursor** | **String** | The token to be used to retrieve the next page of results. | [optional] 
12 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ListLocationsRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::ListLocationsRequest
 2 | 
 3 | ### Description
 4 | 
 5 | Defines the fields that are included in requests to the ListLocations endpoint.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/ListLocationsResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::ListLocationsResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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).
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | **locations** | [**Array<Location>**](Location.md) | The business's locations. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ListWorkweekConfigsRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::ListWorkweekConfigsRequest
 2 | 
 3 | ### Description
 4 | 
 5 | A request for a set of `WorkweekConfig` objects
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **limit** | **Integer** | Maximum number of Workweek Configs to return per page. | [optional] 
11 | **cursor** | **String** | Pointer to the next page of Workweek Config results to fetch. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LocationCapability.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::LocationCapability
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates payment capabilities that a business's location might or might not have enabled.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **CREDIT_CARD_PROCESSING** | string
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/LocationStatus.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::LocationStatus
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates the location's status.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **ACTIVE** | string
11 | **INACTIVE** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/LocationType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::LocationType
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates the location's type.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **PHYSICAL** | string
11 | **MOBILE** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/MeasurementUnitArea.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::MeasurementUnitArea
 2 | 
 3 | ### Description
 4 | 
 5 | Unit of area used to measure a quantity.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **IMPERIAL_ACRE** | string
11 | **IMPERIAL_SQUARE_INCH** | string
12 | **IMPERIAL_SQUARE_FOOT** | string
13 | **IMPERIAL_SQUARE_YARD** | string
14 | **IMPERIAL_SQUARE_MILE** | string
15 | **METRIC_SQUARE_CENTIMETER** | string
16 | **METRIC_SQUARE_METER** | string
17 | **METRIC_SQUARE_KILOMETER** | string
18 | 
19 | 
20 | 


--------------------------------------------------------------------------------
/docs/MeasurementUnitCustom.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::MeasurementUnitCustom
 2 | 
 3 | ### Description
 4 | 
 5 | The information needed to define a custom unit, provided by the seller.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **name** | **String** | The name of the custom unit, for example \"bushel\". | 
11 | **abbreviation** | **String** | The abbreviation of the custom unit, such as \"bsh\" (bushel). This appears in the cart for the Point of Sale app, and in reports. | 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/MeasurementUnitGeneric.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::MeasurementUnitGeneric
 2 | 
 3 | ### Description
 4 | 
 5 | A custom unit of measurement defined by the user.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **INVALID_GENERIC_UNIT** | string
11 | **UNIT** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/MeasurementUnitLength.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::MeasurementUnitLength
 2 | 
 3 | ### Description
 4 | 
 5 | The unit of length used to measure a quantity.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **IMPERIAL_INCH** | string
11 | **IMPERIAL_FOOT** | string
12 | **IMPERIAL_YARD** | string
13 | **IMPERIAL_MILE** | string
14 | **METRIC_MILLIMETER** | string
15 | **METRIC_CENTIMETER** | string
16 | **METRIC_METER** | string
17 | **METRIC_KILOMETER** | string
18 | 
19 | 
20 | 


--------------------------------------------------------------------------------
/docs/MeasurementUnitVolume.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::MeasurementUnitVolume
 2 | 
 3 | ### Description
 4 | 
 5 | The unit of volume used to measure a quantity.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **GENERIC_FLUID_OUNCE** | string
11 | **GENERIC_SHOT** | string
12 | **GENERIC_CUP** | string
13 | **GENERIC_PINT** | string
14 | **GENERIC_QUART** | string
15 | **GENERIC_GALLON** | string
16 | **IMPERIAL_CUBIC_INCH** | string
17 | **IMPERIAL_CUBIC_FOOT** | string
18 | **IMPERIAL_CUBIC_YARD** | string
19 | **METRIC_MILLILITER** | string
20 | **METRIC_LITER** | string
21 | 
22 | 
23 | 


--------------------------------------------------------------------------------
/docs/MeasurementUnitWeight.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::MeasurementUnitWeight
 2 | 
 3 | ### Description
 4 | 
 5 | Unit of weight used to measure a quantity.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **IMPERIAL_WEIGHT_OUNCE** | string
11 | **IMPERIAL_POUND** | string
12 | **IMPERIAL_STONE** | string
13 | **METRIC_MILLIGRAM** | string
14 | **METRIC_GRAM** | string
15 | **METRIC_KILOGRAM** | string
16 | 
17 | 
18 | 


--------------------------------------------------------------------------------
/docs/OrderEntry.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::OrderEntry
 2 | 
 3 | ### Description
 4 | 
 5 | A lightweight description of an [Order](#type-order) that is returned when `returned_entries` is true on a [SearchOrderRequest](#type-searchorderrequest)
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **order_id** | **String** | The id of the Order | [optional] 
11 | **location_id** | **String** | The location id the Order belongs to. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/OrderFulfillment.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::OrderFulfillment
 2 | 
 3 | ### Description
 4 | 
 5 | Contains details on how to fulfill this order.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **type** | **String** | The type of the fulfillment. See [OrderFulfillmentType](#type-orderfulfillmenttype) for possible values | [optional] 
11 | **state** | **String** | The state of the fulfillment. See [OrderFulfillmentState](#type-orderfulfillmentstate) for possible values | [optional] 
12 | **pickup_details** | [**OrderFulfillmentPickupDetails**](OrderFulfillmentPickupDetails.md) | Contains pickup-specific details. Required when fulfillment type is `PICKUP`. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/OrderFulfillmentPickupDetailsScheduleType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::OrderFulfillmentPickupDetailsScheduleType
 2 | 
 3 | ### Description
 4 | 
 5 | The schedule type of the pickup fulfillment.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **SCHEDULED** | string
11 | **ASAP** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/OrderFulfillmentState.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::OrderFulfillmentState
 2 | 
 3 | ### Description
 4 | 
 5 | The state of the fulfillment.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **PROPOSED** | string
11 | **RESERVED** | string
12 | **PREPARED** | string
13 | **COMPLETED** | string
14 | **CANCELED** | string
15 | **FAILED** | string
16 | 
17 | 
18 | 


--------------------------------------------------------------------------------
/docs/OrderFulfillmentType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::OrderFulfillmentType
 2 | 
 3 | ### Description
 4 | 
 5 | The type of fulfillment.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **PICKUP** | string
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/OrderLineItemDiscountScope.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::OrderLineItemDiscountScope
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates whether this is a line item or order level discount.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **OTHER_DISCOUNT_SCOPE** | string
11 | **LINE_ITEM** | string
12 | **ORDER** | string
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/OrderLineItemDiscountType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::OrderLineItemDiscountType
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates how the discount is applied to the associated line item or order.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **UNKNOWN_DISCOUNT** | string
11 | **FIXED_PERCENTAGE** | string
12 | **FIXED_AMOUNT** | string
13 | **VARIABLE_PERCENTAGE** | string
14 | **VARIABLE_AMOUNT** | string
15 | 
16 | 
17 | 


--------------------------------------------------------------------------------
/docs/OrderLineItemTaxScope.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::OrderLineItemTaxScope
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates whether this is a line item or order level tax.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **OTHER_TAX_SCOPE** | string
11 | **LINE_ITEM** | string
12 | **ORDER** | string
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/OrderLineItemTaxType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::OrderLineItemTaxType
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates how the tax is applied to the associated line item or order.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **UNKNOWN_TAX** | string
11 | **ADDITIVE** | string
12 | **INCLUSIVE** | string
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/OrderMoneyAmounts.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::OrderMoneyAmounts
 2 | 
 3 | ### Description
 4 | 
 5 | A collection of various money amounts.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **total_money** | [**Money**](Money.md) | Total money. | [optional] 
11 | **tax_money** | [**Money**](Money.md) | Money associated with taxes. | [optional] 
12 | **discount_money** | [**Money**](Money.md) | Money associated with discounts. | [optional] 
13 | **tip_money** | [**Money**](Money.md) | Money associated with tips. | [optional] 
14 | **service_charge_money** | [**Money**](Money.md) | Money associated with service charges. | [optional] 
15 | 
16 | 
17 | 


--------------------------------------------------------------------------------
/docs/OrderRoundingAdjustment.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::OrderRoundingAdjustment
 2 | 
 3 | ### Description
 4 | 
 5 | 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.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **uid** | **String** | Unique ID that identifies the rounding adjustment only within this order.  This field is read-only. | [optional] 
11 | **name** | **String** | The name of the rounding adjustment from the original sale Order. | [optional] 
12 | **amount_money** | [**Money**](Money.md) | Actual rounding adjustment amount. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/OrderServiceChargeCalculationPhase.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::OrderServiceChargeCalculationPhase
 2 | 
 3 | ### Description
 4 | 
 5 | 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)
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **SUBTOTAL_PHASE** | string
11 | **TOTAL_PHASE** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/OrderSource.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::OrderSource
 2 | 
 3 | ### Description
 4 | 
 5 | Represents the origination details of an order.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **name** | **String** | The name used to identify the place (physical or digital) that an order originates. If unset, the name defaults to the name of the application that created the order. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/OrderState.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::OrderState
 2 | 
 3 | ### Description
 4 | 
 5 | The state of the order.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **OPEN** | string
11 | **COMPLETED** | string
12 | **CANCELED** | string
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/Product.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::Product
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates the Square product used to generate an inventory change.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **SQUARE_POS** | string
11 | **EXTERNAL_API** | string
12 | **BILLING** | string
13 | **APPOINTMENTS** | string
14 | **INVOICES** | string
15 | **ONLINE_STORE** | string
16 | **PAYROLL** | string
17 | **DASHBOARD** | string
18 | **ITEM_LIBRARY_IMPORT** | string
19 | **OTHER** | string
20 | 
21 | 
22 | 


--------------------------------------------------------------------------------
/docs/RefundStatus.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RefundStatus
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates a refund's current status.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **PENDING** | string
11 | **APPROVED** | string
12 | **REJECTED** | string
13 | **FAILED** | string
14 | 
15 | 
16 | 


--------------------------------------------------------------------------------
/docs/RegisterDomainRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RegisterDomainRequest
 2 | 
 3 | ### Description
 4 | 
 5 | Defines the parameters that can be included in the body of a request to the RegisterDomain endpoint.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **domain_name** | **String** | A domain name as described in RFC-1034 that will be registered with ApplePay | 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/RegisterDomainResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RegisterDomainResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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).
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | **status** | **String** | Status of the domain registration. See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RegisterDomainResponseStatus.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RegisterDomainResponseStatus
 2 | 
 3 | ### Description
 4 | 
 5 | The status of domain registration.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **PENDING** | string
11 | **VERIFIED** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RenewTokenRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RenewTokenRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **access_token** | **String** | The token you want to renew. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/RetrieveCatalogObjectResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RetrieveCatalogObjectResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 
11 | **object** | [**CatalogObject**](CatalogObject.md) | The [CatalogObject](#type-catalogobject)s returned. | [optional] 
12 | **related_objects** | [**Array<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s referenced by the object in the `object` field. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/RetrieveCustomerRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RetrieveCustomerRequest
 2 | 
 3 | ### Description
 4 | 
 5 | Defines the fields that are included in requests to the RetrieveCustomer endpoint.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/RetrieveCustomerResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RetrieveCustomerResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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).
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | **customer** | [**Customer**](Customer.md) | The requested customer. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RetrieveEmployeeRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RetrieveEmployeeRequest
 2 | 
 3 | ### Description
 4 | 
 5 | Retrieve an employee by `Employee.id`
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/RetrieveEmployeeResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RetrieveEmployeeResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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).
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **employee** | [**Employee**](Employee.md) | The response object. | [optional] 
11 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RetrieveInventoryAdjustmentRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RetrieveInventoryAdjustmentRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/RetrieveInventoryAdjustmentResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RetrieveInventoryAdjustmentResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | **adjustment** | [**InventoryAdjustment**](InventoryAdjustment.md) | The requested [InventoryAdjustment](#type-inventoryadjustment). | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RetrieveInventoryChangesRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RetrieveInventoryChangesRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **location_ids** | **String** | The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations. | [optional] 
11 | **cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.  See [Pagination](/basics/api101/pagination) for more information. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RetrieveInventoryChangesResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RetrieveInventoryChangesResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | **changes** | [**Array<InventoryChange>**](InventoryChange.md) | The set of inventory changes for the requested object and locations. | [optional] 
12 | **cursor** | **String** | 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 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/RetrieveInventoryCountRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RetrieveInventoryCountRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **location_ids** | **String** | The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations. | [optional] 
11 | **cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.  See [Pagination](/basics/api101/pagination) for more information. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RetrieveInventoryCountResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RetrieveInventoryCountResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | **counts** | [**Array<InventoryCount>**](InventoryCount.md) | The current calculated inventory counts for the requested object and locations. | [optional] 
12 | **cursor** | **String** | 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 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/RetrieveInventoryPhysicalCountRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RetrieveInventoryPhysicalCountRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/RetrieveInventoryPhysicalCountResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RetrieveInventoryPhysicalCountResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | **count** | [**InventoryPhysicalCount**](InventoryPhysicalCount.md) | The requested [InventoryPhysicalCount](#type-inventoryphysicalcount). | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RetrieveTransactionRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RetrieveTransactionRequest
 2 | 
 3 | ### Description
 4 | 
 5 | Defines the request body fields for calls to the RetrieveTransaction endpoint.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/RetrieveTransactionResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RetrieveTransactionResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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).
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | **transaction** | [**Transaction**](Transaction.md) | The requested transaction. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/RevokeTokenRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RevokeTokenRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **client_id** | **String** | Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). | [optional] 
11 | **access_token** | **String** | The access token of the merchant whose token you want to revoke. Do not provide a value for merchant_id if you provide this parameter. | [optional] 
12 | **merchant_id** | **String** | The ID of the merchant whose token you want to revoke. Do not provide a value for access_token if you provide this parameter. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/RevokeTokenResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::RevokeTokenResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **success** | **BOOLEAN** | If the request is successful, this is true. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/SearchOrdersCustomerFilter.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::SearchOrdersCustomerFilter
 2 | 
 3 | ### Description
 4 | 
 5 | 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`.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **customer_ids** | **Array<String>** | Filter by orders with any of the listed `customer_id`s.  Max: 10 `customer_id`s. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/SearchOrdersQuery.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::SearchOrdersQuery
 2 | 
 3 | ### Description
 4 | 
 5 | Contains query criteria for the search.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **filter** | [**SearchOrdersFilter**](SearchOrdersFilter.md) | Criteria to filter results by. | [optional] 
11 | **sort** | [**SearchOrdersSort**](SearchOrdersSort.md) | Criteria to sort results by. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/SearchOrdersSortField.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::SearchOrdersSortField
 2 | 
 3 | ### Description
 4 | 
 5 | Specifies which timestamp to use to sort SearchOrder results.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **CREATED_AT** | string
11 | **UPDATED_AT** | string
12 | **CLOSED_AT** | string
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/SearchOrdersSourceFilter.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::SearchOrdersSourceFilter
 2 | 
 3 | ### Description
 4 | 
 5 | Filter based on Order `source` information.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **source_names** | **Array<String>** | 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] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/SearchOrdersStateFilter.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::SearchOrdersStateFilter
 2 | 
 3 | ### Description
 4 | 
 5 | Filter by current Order `state`.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **states** | **Array<String>** | States to filter for. See [OrderState](#type-orderstate) for possible values | 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/SearchShiftsRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::SearchShiftsRequest
 2 | 
 3 | ### Description
 4 | 
 5 | A request for a filtered and sorted set of `Shift` objects.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **query** | [**ShiftQuery**](ShiftQuery.md) | Query filters. | [optional] 
11 | **limit** | **Integer** | number of resources in a page (200 by default). | [optional] 
12 | **cursor** | **String** | opaque cursor for fetching the next page. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/SearchShiftsResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::SearchShiftsResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **shifts** | [**Array<Shift>**](Shift.md) | Shifts | [optional] 
11 | **cursor** | **String** | Opaque cursor for fetching the next page. | [optional] 
12 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/ShiftFilterStatus.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::ShiftFilterStatus
 2 | 
 3 | ### Description
 4 | 
 5 | Specifies the `status` of `Shift` records to be returned.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **OPEN** | string
11 | **CLOSED** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ShiftQuery.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::ShiftQuery
 2 | 
 3 | ### Description
 4 | 
 5 | The parameters of a `Shift` search query. Includes filter and sort options.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **filter** | [**ShiftFilter**](ShiftFilter.md) | Query filter options | [optional] 
11 | **sort** | [**ShiftSort**](ShiftSort.md) | Sort order details | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ShiftSort.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::ShiftSort
 2 | 
 3 | ### Description
 4 | 
 5 | Sets the sort order of search results.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **field** | **String** | The field to sort on. See [ShiftSortField](#type-shiftsortfield) for possible values | [optional] 
11 | **order** | **String** | The order in which results are returned. Defaults to DESC. See [SortOrder](#type-sortorder) for possible values | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ShiftSortField.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::ShiftSortField
 2 | 
 3 | ### Description
 4 | 
 5 | Enumerates the `Shift` fields to sort on.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **START_AT** | string
11 | **END_AT** | string
12 | **CREATED_AT** | string
13 | **UPDATED_AT** | string
14 | 
15 | 
16 | 


--------------------------------------------------------------------------------
/docs/ShiftStatus.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::ShiftStatus
 2 | 
 3 | ### Description
 4 | 
 5 | Enumerates the possible status of a `Shift`
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **OPEN** | string
11 | **CLOSED** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ShiftWage.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::ShiftWage
 2 | 
 3 | ### Description
 4 | 
 5 | The hourly wage rate used to compensate an employee for this shift.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **title** | **String** | The name of the job performed during this shift. Square labor-reporting UIs may group shifts together by title. | [optional] 
11 | **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] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/ShiftWorkdayMatcher.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::ShiftWorkdayMatcher
 2 | 
 3 | ### Description
 4 | 
 5 | Defines the logic used to apply a workday filter.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **START_AT** | string
11 | **END_AT** | string
12 | **INTERSECTION** | string
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/SortOrder.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::SortOrder
 2 | 
 3 | ### Description
 4 | 
 5 | The order (e.g., chronological or alphabetical) in which results from a request are returned.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **DESC** | string
11 | **ASC** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/StandardUnitDescription.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::StandardUnitDescription
 2 | 
 3 | ### Description
 4 | 
 5 | Contains the name and abbreviation for standard measurement unit.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **unit** | [**MeasurementUnit**](MeasurementUnit.md) | Identifies the measurement unit being described. | [optional] 
11 | **name** | **String** | Display name of the measurement unit. For example, 'Pound'. | [optional] 
12 | **abbreviation** | **String** | Abbreviation for the measurement unit. For example, 'lb'. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/StandardUnitDescriptionGroup.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::StandardUnitDescriptionGroup
 2 | 
 3 | ### Description
 4 | 
 5 | Group of standard measurement units.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **standard_unit_descriptions** | [**Array<StandardUnitDescription>**](StandardUnitDescription.md) | List of measurement units in this description group. | [optional] 
11 | **language_code** | **String** | IETF language tag. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/TaxCalculationPhase.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::TaxCalculationPhase
 2 | 
 3 | ### Description
 4 | 
 5 | When to calculate the taxes due on a cart.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **TAX_SUBTOTAL_PHASE** | string
11 | **TAX_TOTAL_PHASE** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/TaxInclusionType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::TaxInclusionType
 2 | 
 3 | ### Description
 4 | 
 5 | Whether to the tax amount should be additional to or included in to the [CatalogItem](#type-catalogitem) price.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **ADDITIVE** | string
11 | **INCLUSIVE** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/TenderCardDetailsEntryMethod.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::TenderCardDetailsEntryMethod
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates the method used to enter the card's details.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **SWIPED** | string
11 | **KEYED** | string
12 | **EMV** | string
13 | **ON_FILE** | string
14 | **CONTACTLESS** | string
15 | 
16 | 
17 | 


--------------------------------------------------------------------------------
/docs/TenderCardDetailsStatus.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::TenderCardDetailsStatus
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates the card transaction's current status.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **AUTHORIZED** | string
11 | **CAPTURED** | string
12 | **VOIDED** | string
13 | **FAILED** | string
14 | 
15 | 
16 | 


--------------------------------------------------------------------------------
/docs/TenderCashDetails.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::TenderCashDetails
 2 | 
 3 | ### Description
 4 | 
 5 | Represents the details of a tender with `type` `CASH`.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **buyer_tendered_money** | [**Money**](Money.md) | The total amount of cash provided by the buyer, before change is given. | [optional] 
11 | **change_back_money** | [**Money**](Money.md) | The amount of change returned to the buyer. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/TenderType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::TenderType
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates a tender's type.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **CARD** | string
11 | **CASH** | string
12 | **THIRD_PARTY_CARD** | string
13 | **SQUARE_GIFT_CARD** | string
14 | **NO_SALE** | string
15 | **OTHER** | string
16 | 
17 | 
18 | 


--------------------------------------------------------------------------------
/docs/TimeRange.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::TimeRange
 2 | 
 3 | ### Description
 4 | 
 5 | 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.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **start_at** | **String** | A datetime value in RFC-3339 format indicating when the time range starts. | [optional] 
11 | **end_at** | **String** | A datetime value in RFC-3339 format indicating when the time range ends. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/TransactionProduct.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::TransactionProduct
 2 | 
 3 | ### Description
 4 | 
 5 | Indicates the Square product used to process a transaction.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **REGISTER** | string
11 | **EXTERNAL_API** | string
12 | **BILLING** | string
13 | **APPOINTMENTS** | string
14 | **INVOICES** | string
15 | **ONLINE_STORE** | string
16 | **PAYROLL** | string
17 | **OTHER** | string
18 | 
19 | 
20 | 


--------------------------------------------------------------------------------
/docs/UpdateBreakTypeRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::UpdateBreakTypeRequest
 2 | 
 3 | ### Description
 4 | 
 5 | A request to update a `BreakType`
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **break_type** | [**BreakType**](BreakType.md) | The updated `BreakType`. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/UpdateBreakTypeResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::UpdateBreakTypeResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **break_type** | [**BreakType**](BreakType.md) | The response object. | [optional] 
11 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/UpdateCustomerResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::UpdateCustomerResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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).
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | **customer** | [**Customer**](Customer.md) | The updated customer. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/UpdateItemModifierListsResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::UpdateItemModifierListsResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 
11 | **updated_at** | **String** | The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/UpdateItemTaxesRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::UpdateItemTaxesRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **item_ids** | **Array<String>** | The [CatalogItem](#type-catalogitem)s whose enabled/disabled [CatalogTax](#type-catalogtax)es are being updated. | 
11 | **taxes_to_enable** | **Array<String>** | The set of [CatalogTax](#type-catalogtax)es (referenced by ID) to enable for the [CatalogItem](#type-catalogitem). | [optional] 
12 | **taxes_to_disable** | **Array<String>** | The set of [CatalogTax](#type-catalogtax)es (referenced by ID) to disable for the [CatalogItem](#type-catalogitem). | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/UpdateItemTaxesResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::UpdateItemTaxesResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 
11 | **updated_at** | **String** | The database [timestamp](#workingwithdates) of this update in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/UpdateShiftRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::UpdateShiftRequest
 2 | 
 3 | ### Description
 4 | 
 5 | A request to update a `Shift` object.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **shift** | [**Shift**](Shift.md) | The updated `Shift` object. | 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/UpdateShiftResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::UpdateShiftResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **shift** | [**Shift**](Shift.md) | The updated `Shift`. | [optional] 
11 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/UpdateWorkweekConfigRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::UpdateWorkweekConfigRequest
 2 | 
 3 | ### Description
 4 | 
 5 | A request to update a `WorkweekConfig` object
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **workweek_config** | [**WorkweekConfig**](WorkweekConfig.md) | The updated `WorkweekConfig` object. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/UpdateWorkweekConfigResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::UpdateWorkweekConfigResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 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.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **workweek_config** | [**WorkweekConfig**](WorkweekConfig.md) | The response object. | [optional] 
11 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/UpsertCatalogObjectResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::UpsertCatalogObjectResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 
11 | **catalog_object** | [**CatalogObject**](CatalogObject.md) | The created [CatalogObject](#type-catalogobject). | [optional] 
12 | **id_mappings** | [**Array<CatalogIdMapping>**](CatalogIdMapping.md) | The mapping between client and server IDs for this Upsert. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/V1AdjustInventoryRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1AdjustInventoryRequest
 2 | 
 3 | ### Description
 4 | 
 5 | V1AdjustInventoryRequest
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **quantity_delta** | **Float** | The number to adjust the variation's quantity by. | [optional] 
11 | **adjustment_type** | **String** | The reason for the inventory adjustment. See [V1AdjustInventoryRequestAdjustmentType](#type-v1adjustinventoryrequestadjustmenttype) for possible values | [optional] 
12 | **memo** | **String** | A note about the inventory adjustment. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/V1AdjustInventoryRequestAdjustmentType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1AdjustInventoryRequestAdjustmentType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **SALE** | string
11 | **RECEIVE_STOCK** | string
12 | **MANUAL_ADJUST** | string
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/V1ApplyFeeRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ApplyFeeRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1ApplyModifierListRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ApplyModifierListRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1BankAccountType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1BankAccountType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **BUSINESS_CHECKING** | string
11 | **CHECKING** | string
12 | **INVESTMENT** | string
13 | **LOAN** | string
14 | **SAVINGS** | string
15 | **OTHER** | string
16 | 
17 | 
18 | 


--------------------------------------------------------------------------------
/docs/V1CashDrawerEventEventType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1CashDrawerEventEventType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **NO_SALE** | string
11 | **CASH_TENDER_PAYMENT** | string
12 | **OTHER_TENDER_PAYMENT** | string
13 | **CASH_TENDER_CANCELED_PAYMENT** | string
14 | **OTHER_TENDER_CANCELED_PAYMENT** | string
15 | **CASH_TENDER_REFUND** | string
16 | **OTHER_TENDER_REFUND** | string
17 | **PAID_IN** | string
18 | **PAID_OUT** | string
19 | 
20 | 
21 | 


--------------------------------------------------------------------------------
/docs/V1CashDrawerShiftEventType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1CashDrawerShiftEventType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **OPEN** | string
11 | **ENDED** | string
12 | **CLOSED** | string
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/V1Category.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1Category
 2 | 
 3 | ### Description
 4 | 
 5 | V1Category
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **id** | **String** | The category's unique ID. | [optional] 
11 | **name** | **String** | The category's name. | [optional] 
12 | **v2_id** | **String** | The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/V1CreateCategoryRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1CreateCategoryRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **body** | [**V1Category**](V1Category.md) | An object containing the fields to POST for the request.  See the corresponding object definition for field details. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1CreateDiscountRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1CreateDiscountRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **body** | [**V1Discount**](V1Discount.md) | An object containing the fields to POST for the request.  See the corresponding object definition for field details. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1CreateEmployeeRoleRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1CreateEmployeeRoleRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **employee_role** | [**V1EmployeeRole**](V1EmployeeRole.md) | An EmployeeRole object with a name and permissions, and an optional owner flag. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1CreateFeeRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1CreateFeeRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **body** | [**V1Fee**](V1Fee.md) | An object containing the fields to POST for the request.  See the corresponding object definition for field details. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1CreateItemRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1CreateItemRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **body** | [**V1Item**](V1Item.md) | An object containing the fields to POST for the request.  See the corresponding object definition for field details. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1CreateModifierListRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1CreateModifierListRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **body** | [**V1ModifierList**](V1ModifierList.md) | An object containing the fields to POST for the request.  See the corresponding object definition for field details. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1CreateModifierOptionRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1CreateModifierOptionRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **body** | [**V1ModifierOption**](V1ModifierOption.md) | An object containing the fields to POST for the request.  See the corresponding object definition for field details. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1CreatePageRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1CreatePageRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **body** | [**V1Page**](V1Page.md) | An object containing the fields to POST for the request.  See the corresponding object definition for field details. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1CreateRefundRequestType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1CreateRefundRequestType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **FULL** | string
11 | **PARTIAL** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/V1CreateVariationRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1CreateVariationRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **body** | [**V1Variation**](V1Variation.md) | An object containing the fields to POST for the request.  See the corresponding object definition for field details. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1DeleteCategoryRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1DeleteCategoryRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1DeleteDiscountRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1DeleteDiscountRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1DeleteFeeRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1DeleteFeeRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1DeleteItemRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1DeleteItemRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1DeleteModifierListRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1DeleteModifierListRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1DeleteModifierOptionRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1DeleteModifierOptionRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1DeletePageCellRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1DeletePageCellRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **row** | **String** | The row of the cell to clear. Always an integer between 0 and 4, inclusive. Row 0 is the top row. | [optional] 
11 | **column** | **String** | The column of the cell to clear. Always an integer between 0 and 4, inclusive. Column 0 is the leftmost column. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/V1DeletePageRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1DeletePageRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1DeleteTimecardRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1DeleteTimecardRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1DeleteTimecardResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1DeleteTimecardResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1DeleteVariationRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1DeleteVariationRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1DiscountColor.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1DiscountColor
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **9da2a6** | string
11 | **4ab200** | string
12 | **0b8000** | string
13 | **2952cc** | string
14 | **a82ee5** | string
15 | **e5457a** | string
16 | **b21212** | string
17 | **593c00** | string
18 | **e5BF00** | string
19 | 
20 | 
21 | 


--------------------------------------------------------------------------------
/docs/V1DiscountDiscountType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1DiscountDiscountType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **FIXED** | string
11 | **VARIABLE_PERCENTAGE** | string
12 | **VARIABLE_AMOUNT** | string
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/V1EmployeeRolePermissions.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1EmployeeRolePermissions
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **REGISTER_ACCESS_SALES_HISTORY** | string
11 | **REGISTER_APPLY_RESTRICTED_DISCOUNTS** | string
12 | **REGISTER_CHANGE_SETTINGS** | string
13 | **REGISTER_EDIT_ITEM** | string
14 | **REGISTER_ISSUE_REFUNDS** | string
15 | **REGISTER_OPEN_CASH_DRAWER_OUTSIDE_SALE** | string
16 | **REGISTER_VIEW_SUMMARY_REPORTS** | string
17 | 
18 | 
19 | 


--------------------------------------------------------------------------------
/docs/V1EmployeeStatus.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1EmployeeStatus
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **ACTIVE** | string
11 | **INACTIVE** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/V1FeeAdjustmentType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1FeeAdjustmentType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **TAX** | string
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1FeeCalculationPhase.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1FeeCalculationPhase
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **FEE_SUBTOTAL_PHASE** | string
11 | **OTHER** | string
12 | **FEE_TOTAL_PHASE** | string
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/V1FeeInclusionType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1FeeInclusionType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **ADDITIVE** | string
11 | **INCLUSIVE** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/V1FeeType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1FeeType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **CA_GST** | string
11 | **CA_HST** | string
12 | **CA_PST** | string
13 | **CA_QST** | string
14 | **JP_CONSUMPTION_TAX** | string
15 | **CA_PEI_PST** | string
16 | **US_SALES_TAX** | string
17 | **OTHER** | string
18 | 
19 | 
20 | 


--------------------------------------------------------------------------------
/docs/V1InventoryEntry.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1InventoryEntry
 2 | 
 3 | ### Description
 4 | 
 5 | V1InventoryEntry
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **variation_id** | **String** | The variation that the entry corresponds to. | [optional] 
11 | **quantity_on_hand** | **Float** | The current available quantity of the item variation. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/V1ItemColor.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ItemColor
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **9da2a6** | string
11 | **4ab200** | string
12 | **0b8000** | string
13 | **2952cc** | string
14 | **a82ee5** | string
15 | **e5457a** | string
16 | **b21212** | string
17 | **593c00** | string
18 | **e5BF00** | string
19 | 
20 | 
21 | 


--------------------------------------------------------------------------------
/docs/V1ItemImage.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ItemImage
 2 | 
 3 | ### Description
 4 | 
 5 | V1ItemImage
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **id** | **String** | The image's unique ID. | [optional] 
11 | **url** | **String** | The image's publicly accessible URL. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/V1ItemType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ItemType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **NORMAL** | string
11 | **GIFT_CARD** | string
12 | **OTHER** | string
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/V1ItemVisibility.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ItemVisibility
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **PUBLIC** | string
11 | **PRIVATE** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/V1ListBankAccountsRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListBankAccountsRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1ListBankAccountsResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListBankAccountsResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **items** | [**Array<V1BankAccount>**](V1BankAccount.md) |  | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1ListCashDrawerShiftsRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListCashDrawerShiftsRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **order** | **String** | The order in which cash drawer shifts are listed in the response, based on their created_at field. Default value: ASC See [SortOrder](#type-sortorder) for possible values | [optional] 
11 | **begin_time** | **String** | The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time minus 90 days. | [optional] 
12 | **end_time** | **String** | The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/V1ListCashDrawerShiftsResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListCashDrawerShiftsResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **items** | [**Array<V1CashDrawerShift>**](V1CashDrawerShift.md) |  | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1ListCategoriesRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListCategoriesRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1ListCategoriesResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListCategoriesResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **items** | [**Array<V1Category>**](V1Category.md) |  | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1ListDiscountsRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListDiscountsRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1ListDiscountsResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListDiscountsResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **items** | [**Array<V1Discount>**](V1Discount.md) |  | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1ListEmployeeRolesRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListEmployeeRolesRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **order** | **String** | The order in which employees are listed in the response, based on their created_at field.Default value: ASC See [SortOrder](#type-sortorder) for possible values | [optional] 
11 | **limit** | **Integer** | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. | [optional] 
12 | **batch_token** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/V1ListEmployeeRolesResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListEmployeeRolesResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **items** | [**Array<V1EmployeeRole>**](V1EmployeeRole.md) |  | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1ListEmployeesRequestStatus.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListEmployeesRequestStatus
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **ACTIVE** | string
11 | **INACTIVE** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/V1ListEmployeesResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListEmployeesResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **items** | [**Array<V1Employee>**](V1Employee.md) |  | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1ListFeesRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListFeesRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1ListFeesResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListFeesResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **items** | [**Array<V1Fee>**](V1Fee.md) |  | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1ListInventoryRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListInventoryRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **limit** | **Integer** | The maximum number of inventory entries to return in a single response. This value cannot exceed 1000. | [optional] 
11 | **batch_token** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/V1ListInventoryResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListInventoryResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **items** | [**Array<V1InventoryEntry>**](V1InventoryEntry.md) |  | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1ListItemsRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListItemsRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **batch_token** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1ListItemsResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListItemsResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **items** | [**Array<V1Item>**](V1Item.md) |  | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1ListLocationsRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListLocationsRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1ListLocationsResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListLocationsResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **items** | [**Array<V1Merchant>**](V1Merchant.md) |  | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1ListModifierListsRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListModifierListsRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1ListModifierListsResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListModifierListsResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **items** | [**Array<V1ModifierList>**](V1ModifierList.md) |  | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1ListOrdersRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListOrdersRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **order** | **String** | TThe order in which payments are listed in the response. See [SortOrder](#type-sortorder) for possible values | [optional] 
11 | **limit** | **Integer** | The maximum number of payments to return in a single response. This value cannot exceed 200. | [optional] 
12 | **batch_token** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/V1ListOrdersResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListOrdersResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **items** | [**Array<V1Order>**](V1Order.md) |  | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1ListPagesRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListPagesRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1ListPagesResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListPagesResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **items** | [**Array<V1Page>**](V1Page.md) |  | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1ListPaymentsResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListPaymentsResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **items** | [**Array<V1Payment>**](V1Payment.md) |  | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1ListRefundsResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListRefundsResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **items** | [**Array<V1Refund>**](V1Refund.md) |  | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1ListSettlementsRequestStatus.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListSettlementsRequestStatus
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **SENT** | string
11 | **FAILED** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/V1ListSettlementsResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListSettlementsResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **items** | [**Array<V1Settlement>**](V1Settlement.md) |  | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1ListTimecardEventsRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListTimecardEventsRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1ListTimecardEventsResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListTimecardEventsResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **items** | [**Array<V1TimecardEvent>**](V1TimecardEvent.md) |  | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1ListTimecardsResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ListTimecardsResponse
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **items** | [**Array<V1Timecard>**](V1Timecard.md) |  | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1MerchantAccountType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1MerchantAccountType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **LOCATION** | string
11 | **BUSINESS** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/V1MerchantLocationDetails.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1MerchantLocationDetails
 2 | 
 3 | ### Description
 4 | 
 5 | Additional information for a single-location account specified by its associated business account, if it has one.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **nickname** | **String** | The nickname assigned to the single-location account by the parent business. This value appears in the parent business's multi-location dashboard. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1ModifierListSelectionType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1ModifierListSelectionType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **SINGLE** | string
11 | **MULTIPLE** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/V1Money.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1Money
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **amount** | **Integer** | Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). | [optional] 
11 | **currency_code** | **String** |  See [Currency](#type-currency) for possible values | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/V1OrderHistoryEntry.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1OrderHistoryEntry
 2 | 
 3 | ### Description
 4 | 
 5 | V1OrderHistoryEntry
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **action** | **String** | The type of action performed on the order. See [V1OrderHistoryEntryAction](#type-v1orderhistoryentryaction) for possible values | [optional] 
11 | **created_at** | **String** | The time when the action was performed, in ISO 8601 format. | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/V1OrderHistoryEntryAction.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1OrderHistoryEntryAction
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **ORDER_PLACED** | string
11 | **DECLINED** | string
12 | **PAYMENT_RECEIVED** | string
13 | **CANCELED** | string
14 | **COMPLETED** | string
15 | **REFUNDED** | string
16 | **EXPIRED** | string
17 | 
18 | 
19 | 


--------------------------------------------------------------------------------
/docs/V1OrderState.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1OrderState
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **PENDING** | string
11 | **OPEN** | string
12 | **COMPLETED** | string
13 | **CANCELED** | string
14 | **REFUNDED** | string
15 | **REJECTED** | string
16 | 
17 | 
18 | 


--------------------------------------------------------------------------------
/docs/V1Page.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1Page
 2 | 
 3 | ### Description
 4 | 
 5 | V1Page
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **id** | **String** | The page's unique identifier. | [optional] 
11 | **name** | **String** | The page's name, if any. | [optional] 
12 | **page_index** | **Integer** | The page's position in the merchant's list of pages. Always an integer between 0 and 6, inclusive. | [optional] 
13 | **cells** | [**Array<V1PageCell>**](V1PageCell.md) | The cells included on the page. | [optional] 
14 | 
15 | 
16 | 


--------------------------------------------------------------------------------
/docs/V1PageCellObjectType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1PageCellObjectType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **ITEM** | string
11 | **DISCOUNT** | string
12 | **CATEGORY** | string
13 | **PLACEHOLDER** | string
14 | 
15 | 
16 | 


--------------------------------------------------------------------------------
/docs/V1PageCellPlaceholderType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1PageCellPlaceholderType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **ALL_ITEMS** | string
11 | **DISCOUNTS_CATEGORY** | string
12 | **REWARDS_FINDER** | string
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/V1PaymentDiscount.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1PaymentDiscount
 2 | 
 3 | ### Description
 4 | 
 5 | V1PaymentDiscount
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **name** | **String** | The discount's name. | [optional] 
11 | **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] 
12 | **discount_id** | **String** | The ID of the applied discount, if available. Discounts applied in older versions of Square Register might not have an ID. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/V1PaymentItemDetail.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1PaymentItemDetail
 2 | 
 3 | ### Description
 4 | 
 5 | V1PaymentItemDetail
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **category_name** | **String** | The name of the item's merchant-defined category, if any. | [optional] 
11 | **sku** | **String** |  The item's merchant-defined SKU, if any. | [optional] 
12 | **item_id** | **String** | The unique ID of the item purchased, if any. | [optional] 
13 | **item_variation_id** | **String** | The unique ID of the item variation purchased, if any. | [optional] 
14 | 
15 | 
16 | 


--------------------------------------------------------------------------------
/docs/V1PaymentItemizationItemizationType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1PaymentItemizationItemizationType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **ITEM** | string
11 | **CUSTOM_AMOUNT** | string
12 | **GIFT_CARD_ACTIVATION** | string
13 | **GIFT_CARD_RELOAD** | string
14 | **GIFT_CARD_UNKNOWN** | string
15 | **OTHER** | string
16 | 
17 | 
18 | 


--------------------------------------------------------------------------------
/docs/V1PaymentModifier.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1PaymentModifier
 2 | 
 3 | ### Description
 4 | 
 5 | V1PaymentModifier
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **name** | **String** | The modifier option's name. | [optional] 
11 | **applied_money** | [**V1Money**](V1Money.md) | The amount of money that this modifier option adds to the payment. | [optional] 
12 | **modifier_option_id** | **String** | TThe ID of the applied modifier option, if available. Modifier options applied in older versions of Square Register might not have an ID. | [optional] 
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/V1PaymentSurchargeType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1PaymentSurchargeType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **UNKNOWN** | string
11 | **AUTO_GRATUITY** | string
12 | **CUSTOM** | string
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/V1PaymentTaxInclusionType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1PaymentTaxInclusionType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **ADDITIVE** | string
11 | **INCLUSIVE** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/V1PhoneNumber.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1PhoneNumber
 2 | 
 3 | ### Description
 4 | 
 5 | Represents a phone number.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **calling_code** | **String** | The phone number's international calling code. For US phone numbers, this value is +1. | 
11 | **number** | **String** | The phone number. | 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/V1RefundType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1RefundType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **FULL** | string
11 | **PARTIAL** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/V1RemoveFeeRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1RemoveFeeRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1RemoveModifierListRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1RemoveModifierListRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1RetrieveBankAccountRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1RetrieveBankAccountRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1RetrieveBusinessRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1RetrieveBusinessRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1RetrieveCashDrawerShiftRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1RetrieveCashDrawerShiftRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1RetrieveEmployeeRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1RetrieveEmployeeRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1RetrieveEmployeeRoleRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1RetrieveEmployeeRoleRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1RetrieveItemRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1RetrieveItemRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1RetrieveModifierListRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1RetrieveModifierListRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1RetrieveOrderRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1RetrieveOrderRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1RetrievePaymentRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1RetrievePaymentRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1RetrieveSettlementRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1RetrieveSettlementRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1RetrieveTimecardRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1RetrieveTimecardRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/V1SettlementStatus.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1SettlementStatus
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **FAILED** | string
11 | **SENT** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/V1TenderCardBrand.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1TenderCardBrand
 2 | 
 3 | ### Description
 4 | 
 5 | The brand of a credit card.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **OTHER_BRAND** | string
11 | **VISA** | string
12 | **MASTER_CARD** | string
13 | **AMERICAN_EXPRESS** | string
14 | **DISCOVER** | string
15 | **DISCOVER_DINERS** | string
16 | **JCB** | string
17 | **CHINA_UNIONPAY** | string
18 | **SQUARE_GIFT_CARD** | string
19 | 
20 | 
21 | 


--------------------------------------------------------------------------------
/docs/V1TenderEntryMethod.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1TenderEntryMethod
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **MANUAL** | string
11 | **SCANNED** | string
12 | **SQUARE_CASH** | string
13 | **SQUARE_WALLET** | string
14 | **SWIPED** | string
15 | **WEB_FORM** | string
16 | **OTHER** | string
17 | 
18 | 
19 | 


--------------------------------------------------------------------------------
/docs/V1TenderType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1TenderType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **CREDIT_CARD** | string
11 | **CASH** | string
12 | **THIRD_PARTY_CARD** | string
13 | **NO_SALE** | string
14 | **SQUARE_WALLET** | string
15 | **SQUARE_GIFT_CARD** | string
16 | **UNKNOWN** | string
17 | **OTHER** | string
18 | 
19 | 
20 | 


--------------------------------------------------------------------------------
/docs/V1TimecardEvent.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1TimecardEvent
 2 | 
 3 | ### Description
 4 | 
 5 | V1TimecardEvent
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **id** | **String** | The event's unique ID. | [optional] 
11 | **event_type** | **String** | The ID of the timecard to list events for. See [V1TimecardEventEventType](#type-v1timecardeventeventtype) for possible values | [optional] 
12 | **clockin_time** | **String** | The time the employee clocked in, in ISO 8601 format. | [optional] 
13 | **clockout_time** | **String** | The time the employee clocked out, in ISO 8601 format. | [optional] 
14 | **created_at** | **String** | The time when the event was created, in ISO 8601 format. | [optional] 
15 | 
16 | 
17 | 


--------------------------------------------------------------------------------
/docs/V1TimecardEventEventType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1TimecardEventEventType
 2 | 
 3 | ### Description
 4 | 
 5 | 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`.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **API_CREATE** | string
11 | **API_EDIT** | string
12 | **API_DELETE** | string
13 | **REGISTER_CLOCKIN** | string
14 | **REGISTER_CLOCKOUT** | string
15 | **DASHBOARD_SUPERVISOR_CLOSE** | string
16 | **DASHBOARD_EDIT** | string
17 | **DASHBOARD_DELETE** | string
18 | 
19 | 
20 | 


--------------------------------------------------------------------------------
/docs/V1UpdateCategoryRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1UpdateCategoryRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **body** | [**V1Category**](V1Category.md) | An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1UpdateDiscountRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1UpdateDiscountRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **body** | [**V1Discount**](V1Discount.md) | An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1UpdateEmployeeRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1UpdateEmployeeRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **body** | [**V1Employee**](V1Employee.md) | An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1UpdateEmployeeRoleRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1UpdateEmployeeRoleRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **body** | [**V1EmployeeRole**](V1EmployeeRole.md) | An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1UpdateFeeRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1UpdateFeeRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **body** | [**V1Fee**](V1Fee.md) | An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1UpdateItemRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1UpdateItemRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **body** | [**V1Item**](V1Item.md) | An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1UpdateModifierListRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1UpdateModifierListRequest
 2 | 
 3 | ### Description
 4 | 
 5 | V1UpdateModifierListRequest
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **name** | **String** | The modifier list's name. | [optional] 
11 | **selection_type** | **String** | Indicates whether multiple options from the modifier list can be applied to a single item. See [V1UpdateModifierListRequestSelectionType](#type-v1updatemodifierlistrequestselectiontype) for possible values | [optional] 
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/V1UpdateModifierListRequestSelectionType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1UpdateModifierListRequestSelectionType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **SINGLE** | string
11 | **MULTIPLE** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/V1UpdateModifierOptionRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1UpdateModifierOptionRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **body** | [**V1ModifierOption**](V1ModifierOption.md) | An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1UpdateOrderRequestAction.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1UpdateOrderRequestAction
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **COMPLETE** | string
11 | **CANCEL** | string
12 | **REFUND** | string
13 | 
14 | 
15 | 


--------------------------------------------------------------------------------
/docs/V1UpdatePageCellRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1UpdatePageCellRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **body** | [**V1PageCell**](V1PageCell.md) | An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1UpdatePageRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1UpdatePageRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **body** | [**V1Page**](V1Page.md) | An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1UpdateTimecardRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1UpdateTimecardRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **body** | [**V1Timecard**](V1Timecard.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1UpdateVariationRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1UpdateVariationRequest
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **body** | [**V1Variation**](V1Variation.md) | An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/V1VariationInventoryAlertType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1VariationInventoryAlertType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **LOW_QUANTITY** | string
11 | **NONE** | string
12 | **INVESTMENT** | string
13 | **LOAN** | string
14 | **SAVINGS** | string
15 | **OTHER** | string
16 | 
17 | 
18 | 


--------------------------------------------------------------------------------
/docs/V1VariationPricingType.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::V1VariationPricingType
 2 | 
 3 | ### Description
 4 | 
 5 | 
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **FIXED_PRICING** | string
11 | **VARIABLE_PRICING** | string
12 | 
13 | 
14 | 


--------------------------------------------------------------------------------
/docs/VoidTransactionRequest.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::VoidTransactionRequest
 2 | 
 3 | ### Description
 4 | 
 5 | Defines the request body for calls to the VoidTransaction endpoint.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | 
11 | 
12 | 


--------------------------------------------------------------------------------
/docs/VoidTransactionResponse.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::VoidTransactionResponse
 2 | 
 3 | ### Description
 4 | 
 5 | Defines the fields that are included in the response body of a request to the VoidTransaction endpoint.
 6 | 
 7 | ## Properties
 8 | Name | Type | Description | Notes
 9 | ------------ | ------------- | ------------- | -------------
10 | **errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/WebhookEvents.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::WebhookEvents
 2 | 
 3 | ### Description
 4 | 
 5 | The type of an event that triggers a webhook notification to an application.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **inventory.count.updated** | string
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/docs/Weekday.md:
--------------------------------------------------------------------------------
 1 | # SquareConnect::Weekday
 2 | 
 3 | ### Description
 4 | 
 5 | The days of the week.
 6 | 
 7 | ## Properties
 8 | Name | Type
 9 | ------------ | -------------
10 | **MON** | string
11 | **TUE** | string
12 | **WED** | string
13 | **THU** | string
14 | **FRI** | string
15 | **SAT** | string
16 | **SUN** | string
17 | 
18 | 
19 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/card_brand.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class CardBrand
14 |     
15 |     OTHER_BRAND = "OTHER_BRAND".freeze
16 |     VISA = "VISA".freeze
17 |     MASTERCARD = "MASTERCARD".freeze
18 |     AMERICAN_EXPRESS = "AMERICAN_EXPRESS".freeze
19 |     DISCOVER = "DISCOVER".freeze
20 |     DISCOVER_DINERS = "DISCOVER_DINERS".freeze
21 |     JCB = "JCB".freeze
22 |     CHINA_UNIONPAY = "CHINA_UNIONPAY".freeze
23 |     SQUARE_GIFT_CARD = "SQUARE_GIFT_CARD".freeze
24 |   end
25 | 
26 | end
27 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/catalog_discount_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class CatalogDiscountType
14 |     
15 |     FIXED_PERCENTAGE = "FIXED_PERCENTAGE".freeze
16 |     FIXED_AMOUNT = "FIXED_AMOUNT".freeze
17 |     VARIABLE_PERCENTAGE = "VARIABLE_PERCENTAGE".freeze
18 |     VARIABLE_AMOUNT = "VARIABLE_AMOUNT".freeze
19 |   end
20 | 
21 | end
22 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/catalog_item_product_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class CatalogItemProductType
14 |     
15 |     REGULAR = "REGULAR".freeze
16 |     GIFT_CARD = "GIFT_CARD".freeze
17 |     APPOINTMENTS_SERVICE = "APPOINTMENTS_SERVICE".freeze
18 |     RETAIL_ITEM = "RETAIL_ITEM".freeze
19 |     RESTAURANT_ITEM = "RESTAURANT_ITEM".freeze
20 |   end
21 | 
22 | end
23 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/catalog_modifier_list_selection_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class CatalogModifierListSelectionType
14 |     
15 |     SINGLE = "SINGLE".freeze
16 |     MULTIPLE = "MULTIPLE".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/catalog_pricing_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class CatalogPricingType
14 |     
15 |     FIXED_PRICING = "FIXED_PRICING".freeze
16 |     VARIABLE_PRICING = "VARIABLE_PRICING".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/customer_inclusion_exclusion.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class CustomerInclusionExclusion
14 |     
15 |     INCLUDE = "INCLUDE".freeze
16 |     EXCLUDE = "EXCLUDE".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/customer_sort_field.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class CustomerSortField
14 |     
15 |     DEFAULT = "DEFAULT".freeze
16 |     CREATED_AT = "CREATED_AT".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/day_of_week.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class DayOfWeek
14 |     
15 |     SUN = "SUN".freeze
16 |     MON = "MON".freeze
17 |     TUE = "TUE".freeze
18 |     WED = "WED".freeze
19 |     THU = "THU".freeze
20 |     FRI = "FRI".freeze
21 |     SAT = "SAT".freeze
22 |   end
23 | 
24 | end
25 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/employee_status.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class EmployeeStatus
14 |     
15 |     ACTIVE = "ACTIVE".freeze
16 |     INACTIVE = "INACTIVE".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/error_category.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class ErrorCategory
14 |     
15 |     API_ERROR = "API_ERROR".freeze
16 |     AUTHENTICATION_ERROR = "AUTHENTICATION_ERROR".freeze
17 |     INVALID_REQUEST_ERROR = "INVALID_REQUEST_ERROR".freeze
18 |     RATE_LIMIT_ERROR = "RATE_LIMIT_ERROR".freeze
19 |     PAYMENT_METHOD_ERROR = "PAYMENT_METHOD_ERROR".freeze
20 |     REFUND_ERROR = "REFUND_ERROR".freeze
21 |   end
22 | 
23 | end
24 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/inventory_alert_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class InventoryAlertType
14 |     
15 |     NONE = "NONE".freeze
16 |     LOW_QUANTITY = "LOW_QUANTITY".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/inventory_change_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class InventoryChangeType
14 |     
15 |     PHYSICAL_COUNT = "PHYSICAL_COUNT".freeze
16 |     ADJUSTMENT = "ADJUSTMENT".freeze
17 |     TRANSFER = "TRANSFER".freeze
18 |   end
19 | 
20 | end
21 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/location_capability.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class LocationCapability
14 |     
15 |     PROCESSING = "CREDIT_CARD_PROCESSING".freeze
16 |   end
17 | 
18 | end
19 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/location_status.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class LocationStatus
14 |     
15 |     ACTIVE = "ACTIVE".freeze
16 |     INACTIVE = "INACTIVE".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/location_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class LocationType
14 |     
15 |     PHYSICAL = "PHYSICAL".freeze
16 |     MOBILE = "MOBILE".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/measurement_unit_generic.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class MeasurementUnitGeneric
14 |     
15 |     INVALID_GENERIC_UNIT = "INVALID_GENERIC_UNIT".freeze
16 |     UNIT = "UNIT".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/measurement_unit_length.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class MeasurementUnitLength
14 |     
15 |     IMPERIAL_INCH = "IMPERIAL_INCH".freeze
16 |     IMPERIAL_FOOT = "IMPERIAL_FOOT".freeze
17 |     IMPERIAL_YARD = "IMPERIAL_YARD".freeze
18 |     IMPERIAL_MILE = "IMPERIAL_MILE".freeze
19 |     METRIC_MILLIMETER = "METRIC_MILLIMETER".freeze
20 |     METRIC_CENTIMETER = "METRIC_CENTIMETER".freeze
21 |     METRIC_METER = "METRIC_METER".freeze
22 |     METRIC_KILOMETER = "METRIC_KILOMETER".freeze
23 |   end
24 | 
25 | end
26 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/measurement_unit_weight.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class MeasurementUnitWeight
14 |     
15 |     IMPERIAL_WEIGHT_OUNCE = "IMPERIAL_WEIGHT_OUNCE".freeze
16 |     IMPERIAL_POUND = "IMPERIAL_POUND".freeze
17 |     IMPERIAL_STONE = "IMPERIAL_STONE".freeze
18 |     METRIC_MILLIGRAM = "METRIC_MILLIGRAM".freeze
19 |     METRIC_GRAM = "METRIC_GRAM".freeze
20 |     METRIC_KILOGRAM = "METRIC_KILOGRAM".freeze
21 |   end
22 | 
23 | end
24 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/order_fulfillment_pickup_details_schedule_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class OrderFulfillmentPickupDetailsScheduleType
14 |     
15 |     SCHEDULED = "SCHEDULED".freeze
16 |     ASAP = "ASAP".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/order_fulfillment_state.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class OrderFulfillmentState
14 |     
15 |     PROPOSED = "PROPOSED".freeze
16 |     RESERVED = "RESERVED".freeze
17 |     PREPARED = "PREPARED".freeze
18 |     COMPLETED = "COMPLETED".freeze
19 |     CANCELED = "CANCELED".freeze
20 |     FAILED = "FAILED".freeze
21 |   end
22 | 
23 | end
24 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/order_fulfillment_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class OrderFulfillmentType
14 |     
15 |     PICKUP = "PICKUP".freeze
16 |   end
17 | 
18 | end
19 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/order_line_item_discount_scope.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class OrderLineItemDiscountScope
14 |     
15 |     OTHER_DISCOUNT_SCOPE = "OTHER_DISCOUNT_SCOPE".freeze
16 |     LINE_ITEM = "LINE_ITEM".freeze
17 |     ORDER = "ORDER".freeze
18 |   end
19 | 
20 | end
21 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/order_line_item_discount_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class OrderLineItemDiscountType
14 |     
15 |     UNKNOWN_DISCOUNT = "UNKNOWN_DISCOUNT".freeze
16 |     FIXED_PERCENTAGE = "FIXED_PERCENTAGE".freeze
17 |     FIXED_AMOUNT = "FIXED_AMOUNT".freeze
18 |     VARIABLE_PERCENTAGE = "VARIABLE_PERCENTAGE".freeze
19 |     VARIABLE_AMOUNT = "VARIABLE_AMOUNT".freeze
20 |   end
21 | 
22 | end
23 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/order_line_item_tax_scope.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class OrderLineItemTaxScope
14 |     
15 |     OTHER_TAX_SCOPE = "OTHER_TAX_SCOPE".freeze
16 |     LINE_ITEM = "LINE_ITEM".freeze
17 |     ORDER = "ORDER".freeze
18 |   end
19 | 
20 | end
21 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/order_line_item_tax_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class OrderLineItemTaxType
14 |     
15 |     UNKNOWN_TAX = "UNKNOWN_TAX".freeze
16 |     ADDITIVE = "ADDITIVE".freeze
17 |     INCLUSIVE = "INCLUSIVE".freeze
18 |   end
19 | 
20 | end
21 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/order_service_charge_calculation_phase.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class OrderServiceChargeCalculationPhase
14 |     
15 |     SUBTOTAL_PHASE = "SUBTOTAL_PHASE".freeze
16 |     TOTAL_PHASE = "TOTAL_PHASE".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/order_state.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class OrderState
14 |     
15 |     OPEN = "OPEN".freeze
16 |     COMPLETED = "COMPLETED".freeze
17 |     CANCELED = "CANCELED".freeze
18 |   end
19 | 
20 | end
21 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/product.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class Product
14 |     
15 |     SQUARE_POS = "SQUARE_POS".freeze
16 |     EXTERNAL_API = "EXTERNAL_API".freeze
17 |     BILLING = "BILLING".freeze
18 |     APPOINTMENTS = "APPOINTMENTS".freeze
19 |     INVOICES = "INVOICES".freeze
20 |     ONLINE_STORE = "ONLINE_STORE".freeze
21 |     PAYROLL = "PAYROLL".freeze
22 |     DASHBOARD = "DASHBOARD".freeze
23 |     ITEM_LIBRARY_IMPORT = "ITEM_LIBRARY_IMPORT".freeze
24 |     OTHER = "OTHER".freeze
25 |   end
26 | 
27 | end
28 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/refund_status.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class RefundStatus
14 |     
15 |     PENDING = "PENDING".freeze
16 |     APPROVED = "APPROVED".freeze
17 |     REJECTED = "REJECTED".freeze
18 |     FAILED = "FAILED".freeze
19 |   end
20 | 
21 | end
22 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/register_domain_response_status.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class RegisterDomainResponseStatus
14 |     
15 |     PENDING = "PENDING".freeze
16 |     VERIFIED = "VERIFIED".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/search_orders_sort_field.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class SearchOrdersSortField
14 |     
15 |     CREATED_AT = "CREATED_AT".freeze
16 |     UPDATED_AT = "UPDATED_AT".freeze
17 |     CLOSED_AT = "CLOSED_AT".freeze
18 |   end
19 | 
20 | end
21 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/shift_filter_status.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class ShiftFilterStatus
14 |     
15 |     OPEN = "OPEN".freeze
16 |     CLOSED = "CLOSED".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/shift_sort_field.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class ShiftSortField
14 |     
15 |     START_AT = "START_AT".freeze
16 |     END_AT = "END_AT".freeze
17 |     CREATED_AT = "CREATED_AT".freeze
18 |     UPDATED_AT = "UPDATED_AT".freeze
19 |   end
20 | 
21 | end
22 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/shift_status.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class ShiftStatus
14 |     
15 |     OPEN = "OPEN".freeze
16 |     CLOSED = "CLOSED".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/shift_workday_matcher.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class ShiftWorkdayMatcher
14 |     
15 |     START_AT = "START_AT".freeze
16 |     END_AT = "END_AT".freeze
17 |     INTERSECTION = "INTERSECTION".freeze
18 |   end
19 | 
20 | end
21 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/sort_order.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class SortOrder
14 |     
15 |     DESC = "DESC".freeze
16 |     ASC = "ASC".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/tax_calculation_phase.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class TaxCalculationPhase
14 |     
15 |     SUBTOTAL_PHASE = "TAX_SUBTOTAL_PHASE".freeze
16 |     TOTAL_PHASE = "TAX_TOTAL_PHASE".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/tax_inclusion_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class TaxInclusionType
14 |     
15 |     ADDITIVE = "ADDITIVE".freeze
16 |     INCLUSIVE = "INCLUSIVE".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/tender_card_details_entry_method.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class TenderCardDetailsEntryMethod
14 |     
15 |     SWIPED = "SWIPED".freeze
16 |     KEYED = "KEYED".freeze
17 |     EMV = "EMV".freeze
18 |     ON_FILE = "ON_FILE".freeze
19 |     CONTACTLESS = "CONTACTLESS".freeze
20 |   end
21 | 
22 | end
23 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/tender_card_details_status.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class TenderCardDetailsStatus
14 |     
15 |     AUTHORIZED = "AUTHORIZED".freeze
16 |     CAPTURED = "CAPTURED".freeze
17 |     VOIDED = "VOIDED".freeze
18 |     FAILED = "FAILED".freeze
19 |   end
20 | 
21 | end
22 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/tender_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class TenderType
14 |     
15 |     CARD = "CARD".freeze
16 |     CASH = "CASH".freeze
17 |     THIRD_PARTY_CARD = "THIRD_PARTY_CARD".freeze
18 |     SQUARE_GIFT_CARD = "SQUARE_GIFT_CARD".freeze
19 |     NO_SALE = "NO_SALE".freeze
20 |     OTHER = "OTHER".freeze
21 |   end
22 | 
23 | end
24 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/transaction_product.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class TransactionProduct
14 |     
15 |     REGISTER = "REGISTER".freeze
16 |     EXTERNAL_API = "EXTERNAL_API".freeze
17 |     BILLING = "BILLING".freeze
18 |     APPOINTMENTS = "APPOINTMENTS".freeze
19 |     INVOICES = "INVOICES".freeze
20 |     ONLINE_STORE = "ONLINE_STORE".freeze
21 |     PAYROLL = "PAYROLL".freeze
22 |     OTHER = "OTHER".freeze
23 |   end
24 | 
25 | end
26 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_adjust_inventory_request_adjustment_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1AdjustInventoryRequestAdjustmentType
14 |     
15 |     SALE = "SALE".freeze
16 |     RECEIVE_STOCK = "RECEIVE_STOCK".freeze
17 |     MANUAL_ADJUST = "MANUAL_ADJUST".freeze
18 |   end
19 | 
20 | end
21 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_bank_account_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1BankAccountType
14 |     
15 |     BUSINESS_CHECKING = "BUSINESS_CHECKING".freeze
16 |     CHECKING = "CHECKING".freeze
17 |     INVESTMENT = "INVESTMENT".freeze
18 |     LOAN = "LOAN".freeze
19 |     SAVINGS = "SAVINGS".freeze
20 |     OTHER = "OTHER".freeze
21 |   end
22 | 
23 | end
24 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_cash_drawer_shift_event_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1CashDrawerShiftEventType
14 |     
15 |     OPEN = "OPEN".freeze
16 |     ENDED = "ENDED".freeze
17 |     CLOSED = "CLOSED".freeze
18 |   end
19 | 
20 | end
21 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_create_refund_request_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1CreateRefundRequestType
14 |     
15 |     FULL = "FULL".freeze
16 |     PARTIAL = "PARTIAL".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_discount_color.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1DiscountColor
14 |     
15 |     N9DA2A6 = "9da2a6".freeze
16 |     N4AB200 = "4ab200".freeze
17 |     N0B8000 = "0b8000".freeze
18 |     N2952CC = "2952cc".freeze
19 |     A82EE5 = "a82ee5".freeze
20 |     E5457A = "e5457a".freeze
21 |     B21212 = "b21212".freeze
22 |     N593C00 = "593c00".freeze
23 |     E5_BF00 = "e5BF00".freeze
24 |   end
25 | 
26 | end
27 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_discount_discount_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1DiscountDiscountType
14 |     
15 |     FIXED = "FIXED".freeze
16 |     VARIABLE_PERCENTAGE = "VARIABLE_PERCENTAGE".freeze
17 |     VARIABLE_AMOUNT = "VARIABLE_AMOUNT".freeze
18 |   end
19 | 
20 | end
21 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_employee_status.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1EmployeeStatus
14 |     
15 |     ACTIVE = "ACTIVE".freeze
16 |     INACTIVE = "INACTIVE".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_fee_adjustment_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1FeeAdjustmentType
14 |     
15 |     TAX = "TAX".freeze
16 |   end
17 | 
18 | end
19 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_fee_calculation_phase.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1FeeCalculationPhase
14 |     
15 |     FEE_SUBTOTAL_PHASE = "FEE_SUBTOTAL_PHASE".freeze
16 |     OTHER = "OTHER".freeze
17 |     FEE_TOTAL_PHASE = "FEE_TOTAL_PHASE".freeze
18 |   end
19 | 
20 | end
21 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_fee_inclusion_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1FeeInclusionType
14 |     
15 |     ADDITIVE = "ADDITIVE".freeze
16 |     INCLUSIVE = "INCLUSIVE".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_fee_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1FeeType
14 |     
15 |     CA_GST = "CA_GST".freeze
16 |     CA_HST = "CA_HST".freeze
17 |     CA_PST = "CA_PST".freeze
18 |     CA_QST = "CA_QST".freeze
19 |     JP_CONSUMPTION_TAX = "JP_CONSUMPTION_TAX".freeze
20 |     CA_PEI_PST = "CA_PEI_PST".freeze
21 |     US_SALES_TAX = "US_SALES_TAX".freeze
22 |     OTHER = "OTHER".freeze
23 |   end
24 | 
25 | end
26 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_item_color.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1ItemColor
14 |     
15 |     N9DA2A6 = "9da2a6".freeze
16 |     N4AB200 = "4ab200".freeze
17 |     N0B8000 = "0b8000".freeze
18 |     N2952CC = "2952cc".freeze
19 |     A82EE5 = "a82ee5".freeze
20 |     E5457A = "e5457a".freeze
21 |     B21212 = "b21212".freeze
22 |     N593C00 = "593c00".freeze
23 |     E5_BF00 = "e5BF00".freeze
24 |   end
25 | 
26 | end
27 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_item_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1ItemType
14 |     
15 |     NORMAL = "NORMAL".freeze
16 |     GIFT_CARD = "GIFT_CARD".freeze
17 |     OTHER = "OTHER".freeze
18 |   end
19 | 
20 | end
21 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_item_visibility.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1ItemVisibility
14 |     
15 |     PUBLIC = "PUBLIC".freeze
16 |     PRIVATE = "PRIVATE".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_list_employees_request_status.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1ListEmployeesRequestStatus
14 |     
15 |     ACTIVE = "ACTIVE".freeze
16 |     INACTIVE = "INACTIVE".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_list_settlements_request_status.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1ListSettlementsRequestStatus
14 |     
15 |     SENT = "SENT".freeze
16 |     FAILED = "FAILED".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_merchant_account_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1MerchantAccountType
14 |     
15 |     LOCATION = "LOCATION".freeze
16 |     BUSINESS = "BUSINESS".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_modifier_list_selection_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1ModifierListSelectionType
14 |     
15 |     SINGLE = "SINGLE".freeze
16 |     MULTIPLE = "MULTIPLE".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_order_history_entry_action.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1OrderHistoryEntryAction
14 |     
15 |     ORDER_PLACED = "ORDER_PLACED".freeze
16 |     DECLINED = "DECLINED".freeze
17 |     PAYMENT_RECEIVED = "PAYMENT_RECEIVED".freeze
18 |     CANCELED = "CANCELED".freeze
19 |     COMPLETED = "COMPLETED".freeze
20 |     REFUNDED = "REFUNDED".freeze
21 |     EXPIRED = "EXPIRED".freeze
22 |   end
23 | 
24 | end
25 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_order_state.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1OrderState
14 |     
15 |     PENDING = "PENDING".freeze
16 |     OPEN = "OPEN".freeze
17 |     COMPLETED = "COMPLETED".freeze
18 |     CANCELED = "CANCELED".freeze
19 |     REFUNDED = "REFUNDED".freeze
20 |     REJECTED = "REJECTED".freeze
21 |   end
22 | 
23 | end
24 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_page_cell_object_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1PageCellObjectType
14 |     
15 |     ITEM = "ITEM".freeze
16 |     DISCOUNT = "DISCOUNT".freeze
17 |     CATEGORY = "CATEGORY".freeze
18 |     PLACEHOLDER = "PLACEHOLDER".freeze
19 |   end
20 | 
21 | end
22 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_page_cell_placeholder_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1PageCellPlaceholderType
14 |     
15 |     ALL_ITEMS = "ALL_ITEMS".freeze
16 |     DISCOUNTS_CATEGORY = "DISCOUNTS_CATEGORY".freeze
17 |     REWARDS_FINDER = "REWARDS_FINDER".freeze
18 |   end
19 | 
20 | end
21 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_payment_itemization_itemization_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1PaymentItemizationItemizationType
14 |     
15 |     ITEM = "ITEM".freeze
16 |     CUSTOM_AMOUNT = "CUSTOM_AMOUNT".freeze
17 |     GIFT_CARD_ACTIVATION = "GIFT_CARD_ACTIVATION".freeze
18 |     GIFT_CARD_RELOAD = "GIFT_CARD_RELOAD".freeze
19 |     GIFT_CARD_UNKNOWN = "GIFT_CARD_UNKNOWN".freeze
20 |     OTHER = "OTHER".freeze
21 |   end
22 | 
23 | end
24 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_payment_surcharge_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1PaymentSurchargeType
14 |     
15 |     UNKNOWN = "UNKNOWN".freeze
16 |     AUTO_GRATUITY = "AUTO_GRATUITY".freeze
17 |     CUSTOM = "CUSTOM".freeze
18 |   end
19 | 
20 | end
21 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_payment_tax_inclusion_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1PaymentTaxInclusionType
14 |     
15 |     ADDITIVE = "ADDITIVE".freeze
16 |     INCLUSIVE = "INCLUSIVE".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_refund_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1RefundType
14 |     
15 |     FULL = "FULL".freeze
16 |     PARTIAL = "PARTIAL".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_settlement_status.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1SettlementStatus
14 |     
15 |     FAILED = "FAILED".freeze
16 |     SENT = "SENT".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_tender_card_brand.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1TenderCardBrand
14 |     
15 |     OTHER_BRAND = "OTHER_BRAND".freeze
16 |     VISA = "VISA".freeze
17 |     MASTER_CARD = "MASTER_CARD".freeze
18 |     AMERICAN_EXPRESS = "AMERICAN_EXPRESS".freeze
19 |     DISCOVER = "DISCOVER".freeze
20 |     DISCOVER_DINERS = "DISCOVER_DINERS".freeze
21 |     JCB = "JCB".freeze
22 |     CHINA_UNIONPAY = "CHINA_UNIONPAY".freeze
23 |     SQUARE_GIFT_CARD = "SQUARE_GIFT_CARD".freeze
24 |   end
25 | 
26 | end
27 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_tender_entry_method.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1TenderEntryMethod
14 |     
15 |     MANUAL = "MANUAL".freeze
16 |     SCANNED = "SCANNED".freeze
17 |     SQUARE_CASH = "SQUARE_CASH".freeze
18 |     SQUARE_WALLET = "SQUARE_WALLET".freeze
19 |     SWIPED = "SWIPED".freeze
20 |     WEB_FORM = "WEB_FORM".freeze
21 |     OTHER = "OTHER".freeze
22 |   end
23 | 
24 | end
25 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_tender_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1TenderType
14 |     
15 |     CREDIT_CARD = "CREDIT_CARD".freeze
16 |     CASH = "CASH".freeze
17 |     THIRD_PARTY_CARD = "THIRD_PARTY_CARD".freeze
18 |     NO_SALE = "NO_SALE".freeze
19 |     SQUARE_WALLET = "SQUARE_WALLET".freeze
20 |     SQUARE_GIFT_CARD = "SQUARE_GIFT_CARD".freeze
21 |     UNKNOWN = "UNKNOWN".freeze
22 |     OTHER = "OTHER".freeze
23 |   end
24 | 
25 | end
26 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_timecard_event_event_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1TimecardEventEventType
14 |     
15 |     API_CREATE = "API_CREATE".freeze
16 |     API_EDIT = "API_EDIT".freeze
17 |     API_DELETE = "API_DELETE".freeze
18 |     REGISTER_CLOCKIN = "REGISTER_CLOCKIN".freeze
19 |     REGISTER_CLOCKOUT = "REGISTER_CLOCKOUT".freeze
20 |     DASHBOARD_SUPERVISOR_CLOSE = "DASHBOARD_SUPERVISOR_CLOSE".freeze
21 |     DASHBOARD_EDIT = "DASHBOARD_EDIT".freeze
22 |     DASHBOARD_DELETE = "DASHBOARD_DELETE".freeze
23 |   end
24 | 
25 | end
26 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_update_modifier_list_request_selection_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1UpdateModifierListRequestSelectionType
14 |     
15 |     SINGLE = "SINGLE".freeze
16 |     MULTIPLE = "MULTIPLE".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_update_order_request_action.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1UpdateOrderRequestAction
14 |     
15 |     COMPLETE = "COMPLETE".freeze
16 |     CANCEL = "CANCEL".freeze
17 |     REFUND = "REFUND".freeze
18 |   end
19 | 
20 | end
21 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_variation_inventory_alert_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1VariationInventoryAlertType
14 |     
15 |     LOW_QUANTITY = "LOW_QUANTITY".freeze
16 |     NONE = "NONE".freeze
17 |     INVESTMENT = "INVESTMENT".freeze
18 |     LOAN = "LOAN".freeze
19 |     SAVINGS = "SAVINGS".freeze
20 |     OTHER = "OTHER".freeze
21 |   end
22 | 
23 | end
24 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/v1_variation_pricing_type.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class V1VariationPricingType
14 |     
15 |     FIXED_PRICING = "FIXED_PRICING".freeze
16 |     VARIABLE_PRICING = "VARIABLE_PRICING".freeze
17 |   end
18 | 
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/webhook_events.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class WebhookEvents
14 |     
15 |     UPDATED = "inventory.count.updated".freeze
16 |   end
17 | 
18 | end
19 | 


--------------------------------------------------------------------------------
/lib/square_connect/models/weekday.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | require 'date'
11 | 
12 | module SquareConnect
13 |   class Weekday
14 |     
15 |     MON = "MON".freeze
16 |     TUE = "TUE".freeze
17 |     WED = "WED".freeze
18 |     THU = "THU".freeze
19 |     FRI = "FRI".freeze
20 |     SAT = "SAT".freeze
21 |     SUN = "SUN".freeze
22 |   end
23 | 
24 | end
25 | 


--------------------------------------------------------------------------------
/lib/square_connect/version.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | #Square Connect API
 3 | 
 4 | OpenAPI spec version: 2.0
 5 | Contact: developers@squareup.com
 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git
 7 | 
 8 | =end
 9 | 
10 | module SquareConnect
11 |   VERSION = "2.20190724.1"
12 | end
13 | 


--------------------------------------------------------------------------------
/travis-ci/accounts.enc:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/square/connect-ruby-sdk/edb6067e761c766d3da067c0d01c7365f1b7d39b/travis-ci/accounts.enc


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