square_connect 2.20190213.0.274 → 2.20190313.0.278
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGES.md +24 -0
- data/README.md +256 -70
- data/docs/BatchRetrieveInventoryChangesRequest.md +1 -1
- data/docs/BatchRetrieveInventoryChangesResponse.md +1 -1
- data/docs/BatchRetrieveInventoryCountsRequest.md +1 -1
- data/docs/BatchRetrieveInventoryCountsResponse.md +1 -1
- data/docs/BatchUpsertCatalogObjectsRequest.md +1 -1
- data/docs/BreakType.md +19 -0
- data/docs/Card.md +1 -1
- data/docs/CatalogApi.md +2 -2
- data/docs/CatalogItem.md +1 -1
- data/docs/CatalogItemVariation.md +1 -1
- data/docs/CatalogObject.md +1 -1
- data/docs/CatalogQuery.md +1 -1
- data/docs/ChargeRequest.md +1 -1
- data/docs/CreateBreakTypeRequest.md +13 -0
- data/docs/CreateBreakTypeResponse.md +13 -0
- data/docs/CreateCheckoutRequest.md +1 -1
- data/docs/CreateOrderRequest.md +1 -1
- data/docs/CreateRefundRequest.md +1 -1
- data/docs/CreateShiftRequest.md +13 -0
- data/docs/CreateShiftResponse.md +13 -0
- data/docs/CustomersApi.md +2 -2
- data/docs/DateRange.md +13 -0
- data/docs/DeleteBreakTypeRequest.md +11 -0
- data/docs/DeleteBreakTypeResponse.md +12 -0
- data/docs/DeleteShiftRequest.md +11 -0
- data/docs/DeleteShiftResponse.md +12 -0
- data/docs/Device.md +2 -0
- data/docs/Employee.md +18 -0
- data/docs/EmployeeStatus.md +13 -0
- data/docs/EmployeeWage.md +15 -0
- data/docs/EmployeesApi.md +121 -0
- data/docs/Error.md +1 -1
- data/docs/GetBreakTypeRequest.md +11 -0
- data/docs/GetBreakTypeResponse.md +13 -0
- data/docs/GetEmployeeWageRequest.md +11 -0
- data/docs/GetEmployeeWageResponse.md +13 -0
- data/docs/GetShiftRequest.md +11 -0
- data/docs/GetShiftResponse.md +13 -0
- data/docs/InventoryApi.md +4 -4
- data/docs/LaborApi.md +772 -0
- data/docs/ListAdditionalRecipientReceivableRefundsRequest.md +1 -1
- data/docs/ListAdditionalRecipientReceivableRefundsResponse.md +1 -1
- data/docs/ListAdditionalRecipientReceivablesRequest.md +1 -1
- data/docs/ListAdditionalRecipientReceivablesResponse.md +1 -1
- data/docs/ListBreakTypesRequest.md +14 -0
- data/docs/ListBreakTypesResponse.md +14 -0
- data/docs/ListCatalogRequest.md +1 -1
- data/docs/ListCatalogResponse.md +1 -1
- data/docs/ListCustomersRequest.md +1 -1
- data/docs/ListCustomersResponse.md +1 -1
- data/docs/ListEmployeeWagesRequest.md +14 -0
- data/docs/ListEmployeeWagesResponse.md +14 -0
- data/docs/ListEmployeesRequest.md +15 -0
- data/docs/ListEmployeesResponse.md +14 -0
- data/docs/ListRefundsRequest.md +1 -1
- data/docs/ListRefundsResponse.md +1 -1
- data/docs/ListTransactionsRequest.md +1 -1
- data/docs/ListTransactionsResponse.md +1 -1
- data/docs/ListWorkweekConfigsRequest.md +13 -0
- data/docs/ListWorkweekConfigsResponse.md +14 -0
- data/docs/ModelBreak.md +18 -0
- data/docs/OAuthApi.md +5 -5
- data/docs/ObtainTokenRequest.md +6 -3
- data/docs/ObtainTokenResponse.md +3 -2
- data/docs/ReportingApi.md +4 -4
- data/docs/RetrieveEmployeeRequest.md +11 -0
- data/docs/RetrieveEmployeeResponse.md +13 -0
- data/docs/RetrieveInventoryChangesRequest.md +1 -1
- data/docs/RetrieveInventoryChangesResponse.md +1 -1
- data/docs/RetrieveInventoryCountRequest.md +1 -1
- data/docs/RetrieveInventoryCountResponse.md +1 -1
- data/docs/SearchCatalogObjectsRequest.md +1 -1
- data/docs/SearchCatalogObjectsResponse.md +1 -1
- data/docs/SearchCustomersRequest.md +1 -1
- data/docs/SearchCustomersResponse.md +1 -1
- data/docs/SearchShiftsRequest.md +14 -0
- data/docs/SearchShiftsResponse.md +14 -0
- data/docs/Shift.md +23 -0
- data/docs/ShiftFilter.md +17 -0
- data/docs/ShiftFilterStatus.md +13 -0
- data/docs/ShiftQuery.md +13 -0
- data/docs/ShiftSort.md +13 -0
- data/docs/ShiftSortField.md +15 -0
- data/docs/ShiftStatus.md +13 -0
- data/docs/ShiftWage.md +13 -0
- data/docs/ShiftWorkday.md +14 -0
- data/docs/ShiftWorkdayMatcher.md +14 -0
- data/docs/TransactionsApi.md +4 -4
- data/docs/UpdateBreakTypeRequest.md +12 -0
- data/docs/UpdateBreakTypeResponse.md +13 -0
- data/docs/UpdateShiftRequest.md +12 -0
- data/docs/UpdateShiftResponse.md +13 -0
- data/docs/UpdateWorkweekConfigRequest.md +12 -0
- data/docs/UpdateWorkweekConfigResponse.md +13 -0
- data/docs/UpsertCatalogObjectRequest.md +1 -1
- data/docs/V1AdjustInventoryRequest.md +3 -1
- data/docs/V1AdjustInventoryRequestAdjustmentType.md +14 -0
- data/docs/V1ApplyFeeRequest.md +11 -0
- data/docs/V1ApplyModifierListRequest.md +11 -0
- data/docs/V1BankAccount.md +3 -1
- data/docs/V1BankAccountType.md +17 -0
- data/docs/V1CashDrawerEvent.md +3 -1
- data/docs/V1CashDrawerEventEventType.md +20 -0
- data/docs/V1CashDrawerShift.md +3 -1
- data/docs/V1CashDrawerShiftEventType.md +14 -0
- data/docs/V1Category.md +2 -0
- data/docs/V1CreateCategoryRequest.md +12 -0
- data/docs/V1CreateDiscountRequest.md +12 -0
- data/docs/V1CreateEmployeeRoleRequest.md +12 -0
- data/docs/V1CreateFeeRequest.md +12 -0
- data/docs/V1CreateItemRequest.md +12 -0
- data/docs/V1CreateModifierListRequest.md +12 -0
- data/docs/V1CreateModifierOptionRequest.md +12 -0
- data/docs/V1CreatePageRequest.md +12 -0
- data/docs/V1CreateRefundRequest.md +4 -2
- data/docs/V1CreateRefundRequestType.md +13 -0
- data/docs/V1CreateVariationRequest.md +12 -0
- data/docs/V1DeleteCategoryRequest.md +11 -0
- data/docs/V1DeleteDiscountRequest.md +11 -0
- data/docs/V1DeleteFeeRequest.md +11 -0
- data/docs/V1DeleteItemRequest.md +11 -0
- data/docs/V1DeleteModifierListRequest.md +11 -0
- data/docs/V1DeleteModifierOptionRequest.md +11 -0
- data/docs/V1DeletePageCellRequest.md +13 -0
- data/docs/V1DeletePageRequest.md +11 -0
- data/docs/V1DeleteTimecardRequest.md +11 -0
- data/docs/V1DeleteTimecardResponse.md +11 -0
- data/docs/V1DeleteVariationRequest.md +11 -0
- data/docs/V1Discount.md +4 -2
- data/docs/V1DiscountColor.md +20 -0
- data/docs/V1DiscountDiscountType.md +14 -0
- data/docs/V1Employee.md +1 -1
- data/docs/V1EmployeeRole.md +3 -1
- data/docs/V1EmployeeRolePermissions.md +18 -0
- data/docs/V1EmployeeStatus.md +13 -0
- data/docs/V1EmployeesApi.md +63 -61
- data/docs/V1Fee.md +6 -4
- data/docs/V1FeeAdjustmentType.md +12 -0
- data/docs/V1FeeCalculationPhase.md +14 -0
- data/docs/V1FeeInclusionType.md +13 -0
- data/docs/V1FeeType.md +19 -0
- data/docs/V1InventoryEntry.md +2 -0
- data/docs/V1Item.md +5 -3
- data/docs/V1ItemColor.md +20 -0
- data/docs/V1ItemImage.md +2 -0
- data/docs/V1ItemType.md +14 -0
- data/docs/V1ItemVisibility.md +13 -0
- data/docs/V1ItemsApi.md +130 -130
- data/docs/V1ListBankAccountsRequest.md +11 -0
- data/docs/V1ListBankAccountsResponse.md +12 -0
- data/docs/V1ListCashDrawerShiftsRequest.md +14 -0
- data/docs/V1ListCashDrawerShiftsResponse.md +12 -0
- data/docs/V1ListCategoriesRequest.md +11 -0
- data/docs/V1ListCategoriesResponse.md +12 -0
- data/docs/V1ListDiscountsRequest.md +11 -0
- data/docs/V1ListDiscountsResponse.md +12 -0
- data/docs/V1ListEmployeeRolesRequest.md +14 -0
- data/docs/V1ListEmployeeRolesResponse.md +12 -0
- data/docs/V1ListEmployeesRequest.md +20 -0
- data/docs/V1ListEmployeesRequestStatus.md +13 -0
- data/docs/V1ListEmployeesResponse.md +12 -0
- data/docs/V1ListFeesRequest.md +11 -0
- data/docs/V1ListFeesResponse.md +12 -0
- data/docs/V1ListInventoryRequest.md +13 -0
- data/docs/V1ListInventoryResponse.md +12 -0
- data/docs/V1ListItemsRequest.md +12 -0
- data/docs/V1ListItemsResponse.md +12 -0
- data/docs/V1ListLocationsRequest.md +11 -0
- data/docs/V1ListLocationsResponse.md +12 -0
- data/docs/V1ListModifierListsRequest.md +11 -0
- data/docs/V1ListModifierListsResponse.md +12 -0
- data/docs/V1ListOrdersRequest.md +14 -0
- data/docs/V1ListOrdersResponse.md +12 -0
- data/docs/V1ListPagesRequest.md +11 -0
- data/docs/V1ListPagesResponse.md +12 -0
- data/docs/V1ListPaymentsRequest.md +17 -0
- data/docs/V1ListPaymentsResponse.md +12 -0
- data/docs/V1ListRefundsRequest.md +16 -0
- data/docs/V1ListRefundsResponse.md +12 -0
- data/docs/V1ListSettlementsRequest.md +17 -0
- data/docs/V1ListSettlementsRequestStatus.md +13 -0
- data/docs/V1ListSettlementsResponse.md +12 -0
- data/docs/V1ListTimecardEventsRequest.md +12 -0
- data/docs/V1ListTimecardEventsResponse.md +12 -0
- data/docs/V1ListTimecardsRequest.md +22 -0
- data/docs/V1ListTimecardsResponse.md +12 -0
- data/docs/V1LocationsApi.md +6 -6
- data/docs/V1Merchant.md +4 -4
- data/docs/V1MerchantAccountType.md +13 -0
- data/docs/V1MerchantBusinessType.md +61 -0
- data/docs/V1ModifierList.md +3 -1
- data/docs/V1ModifierListSelectionType.md +13 -0
- data/docs/V1ModifierOption.md +2 -0
- data/docs/V1Money.md +1 -1
- data/docs/V1Order.md +3 -1
- data/docs/V1OrderHistoryEntry.md +3 -1
- data/docs/V1OrderHistoryEntryAction.md +18 -0
- data/docs/V1OrderState.md +17 -0
- data/docs/V1Page.md +2 -0
- data/docs/V1PageCell.md +4 -2
- data/docs/V1PageCellObjectType.md +15 -0
- data/docs/V1PageCellPlaceholderType.md +14 -0
- data/docs/V1Payment.md +2 -0
- data/docs/V1PaymentDiscount.md +2 -0
- data/docs/V1PaymentItemDetail.md +2 -0
- data/docs/V1PaymentItemization.md +3 -1
- data/docs/V1PaymentItemizationItemizationType.md +17 -0
- data/docs/V1PaymentModifier.md +2 -0
- data/docs/V1PaymentSurcharge.md +3 -1
- data/docs/V1PaymentSurchargeType.md +14 -0
- data/docs/V1PaymentTax.md +3 -1
- data/docs/V1PaymentTaxInclusionType.md +13 -0
- data/docs/V1Refund.md +3 -1
- data/docs/V1RefundType.md +13 -0
- data/docs/V1RemoveFeeRequest.md +11 -0
- data/docs/V1RemoveModifierListRequest.md +11 -0
- data/docs/V1RetrieveBankAccountRequest.md +11 -0
- data/docs/V1RetrieveBusinessRequest.md +11 -0
- data/docs/V1RetrieveCashDrawerShiftRequest.md +11 -0
- data/docs/V1RetrieveEmployeeRequest.md +11 -0
- data/docs/V1RetrieveEmployeeRoleRequest.md +11 -0
- data/docs/V1RetrieveItemRequest.md +11 -0
- data/docs/V1RetrieveModifierListRequest.md +11 -0
- data/docs/V1RetrieveOrderRequest.md +11 -0
- data/docs/V1RetrievePaymentRequest.md +11 -0
- data/docs/V1RetrieveSettlementRequest.md +11 -0
- data/docs/V1RetrieveTimecardRequest.md +11 -0
- data/docs/V1Settlement.md +3 -1
- data/docs/V1SettlementEntry.md +3 -1
- data/docs/V1SettlementEntryType.md +32 -0
- data/docs/V1SettlementStatus.md +13 -0
- data/docs/V1Tender.md +5 -3
- data/docs/V1TenderEntryMethod.md +18 -0
- data/docs/V1TenderType.md +19 -0
- data/docs/V1Timecard.md +1 -1
- data/docs/V1TimecardEvent.md +3 -1
- data/docs/V1TimecardEventEventType.md +19 -0
- data/docs/V1TransactionsApi.md +37 -37
- data/docs/V1UpdateCategoryRequest.md +12 -0
- data/docs/V1UpdateDiscountRequest.md +12 -0
- data/docs/V1UpdateEmployeeRequest.md +12 -0
- data/docs/V1UpdateEmployeeRoleRequest.md +12 -0
- data/docs/V1UpdateFeeRequest.md +12 -0
- data/docs/V1UpdateItemRequest.md +12 -0
- data/docs/V1UpdateModifierListRequest.md +3 -1
- data/docs/V1UpdateModifierListRequestSelectionType.md +13 -0
- data/docs/V1UpdateModifierOptionRequest.md +12 -0
- data/docs/V1UpdateOrderRequest.md +3 -1
- data/docs/V1UpdateOrderRequestAction.md +14 -0
- data/docs/V1UpdatePageCellRequest.md +12 -0
- data/docs/V1UpdatePageRequest.md +12 -0
- data/docs/V1UpdateTimecardRequest.md +12 -0
- data/docs/V1UpdateVariationRequest.md +12 -0
- data/docs/V1Variation.md +4 -2
- data/docs/V1VariationInventoryAlertType.md +17 -0
- data/docs/V1VariationPricingType.md +13 -0
- data/docs/Weekday.md +18 -0
- data/docs/WorkweekConfig.md +17 -0
- data/lib/square_connect.rb +172 -0
- data/lib/square_connect/api/apple_pay_api.rb +1 -1
- data/lib/square_connect/api/catalog_api.rb +13 -13
- data/lib/square_connect/api/checkout_api.rb +1 -1
- data/lib/square_connect/api/customers_api.rb +10 -10
- data/lib/square_connect/api/employees_api.rb +141 -0
- data/lib/square_connect/api/inventory_api.rb +11 -11
- data/lib/square_connect/api/labor_api.rb +814 -0
- data/lib/square_connect/api/locations_api.rb +1 -1
- data/lib/square_connect/api/mobile_authorization_api.rb +1 -1
- data/lib/square_connect/api/o_auth_api.rb +9 -9
- data/lib/square_connect/api/orders_api.rb +2 -2
- data/lib/square_connect/api/reporting_api.rb +6 -6
- data/lib/square_connect/api/transactions_api.rb +11 -11
- data/lib/square_connect/api/v1_employees_api.rb +78 -73
- data/lib/square_connect/api/v1_items_api.rb +140 -104
- data/lib/square_connect/api/v1_locations_api.rb +6 -4
- data/lib/square_connect/api/v1_transactions_api.rb +49 -54
- data/lib/square_connect/api_client.rb +1 -1
- data/lib/square_connect/models/batch_retrieve_inventory_changes_request.rb +1 -1
- data/lib/square_connect/models/batch_retrieve_inventory_changes_response.rb +1 -1
- data/lib/square_connect/models/batch_retrieve_inventory_counts_request.rb +1 -1
- data/lib/square_connect/models/batch_retrieve_inventory_counts_response.rb +1 -1
- data/lib/square_connect/models/batch_upsert_catalog_objects_request.rb +1 -1
- data/lib/square_connect/models/break_type.rb +349 -0
- data/lib/square_connect/models/card.rb +1 -1
- data/lib/square_connect/models/catalog_item.rb +1 -1
- data/lib/square_connect/models/catalog_item_variation.rb +1 -1
- data/lib/square_connect/models/catalog_object.rb +1 -1
- data/lib/square_connect/models/catalog_query.rb +1 -1
- data/lib/square_connect/models/charge_request.rb +1 -1
- data/lib/square_connect/models/create_break_type_request.rb +217 -0
- data/lib/square_connect/models/create_break_type_response.rb +198 -0
- data/lib/square_connect/models/create_checkout_request.rb +1 -1
- data/lib/square_connect/models/create_order_request.rb +1 -1
- data/lib/square_connect/models/create_refund_request.rb +1 -1
- data/lib/square_connect/models/create_shift_request.rb +217 -0
- data/lib/square_connect/models/create_shift_response.rb +198 -0
- data/lib/square_connect/models/date_range.rb +196 -0
- data/lib/square_connect/models/delete_break_type_request.rb +176 -0
- data/lib/square_connect/models/delete_break_type_response.rb +188 -0
- data/lib/square_connect/models/delete_shift_request.rb +176 -0
- data/lib/square_connect/models/delete_shift_response.rb +188 -0
- data/lib/square_connect/models/device.rb +1 -1
- data/lib/square_connect/models/employee.rb +281 -0
- data/lib/square_connect/models/employee_status.rb +19 -0
- data/lib/square_connect/models/employee_wage.rb +240 -0
- data/lib/square_connect/models/error.rb +1 -1
- data/lib/square_connect/models/get_break_type_request.rb +176 -0
- data/lib/square_connect/models/get_break_type_response.rb +198 -0
- data/lib/square_connect/models/get_employee_wage_request.rb +176 -0
- data/lib/square_connect/models/get_employee_wage_response.rb +198 -0
- data/lib/square_connect/models/get_shift_request.rb +176 -0
- data/lib/square_connect/models/get_shift_response.rb +198 -0
- data/lib/square_connect/models/list_additional_recipient_receivable_refunds_request.rb +1 -1
- data/lib/square_connect/models/list_additional_recipient_receivable_refunds_response.rb +1 -1
- data/lib/square_connect/models/list_additional_recipient_receivables_request.rb +1 -1
- data/lib/square_connect/models/list_additional_recipient_receivables_response.rb +1 -1
- data/lib/square_connect/models/list_break_types_request.rb +231 -0
- data/lib/square_connect/models/list_break_types_response.rb +210 -0
- data/lib/square_connect/models/list_catalog_request.rb +1 -1
- data/lib/square_connect/models/list_catalog_response.rb +1 -1
- data/lib/square_connect/models/list_customers_request.rb +1 -1
- data/lib/square_connect/models/list_customers_response.rb +1 -1
- data/lib/square_connect/models/list_employee_wages_request.rb +231 -0
- data/lib/square_connect/models/list_employee_wages_response.rb +210 -0
- data/lib/square_connect/models/list_employees_request.rb +249 -0
- data/lib/square_connect/models/list_employees_response.rb +210 -0
- data/lib/square_connect/models/list_refunds_request.rb +1 -1
- data/lib/square_connect/models/list_refunds_response.rb +1 -1
- data/lib/square_connect/models/list_transactions_request.rb +1 -1
- data/lib/square_connect/models/list_transactions_response.rb +1 -1
- data/lib/square_connect/models/list_workweek_configs_request.rb +196 -0
- data/lib/square_connect/models/list_workweek_configs_response.rb +210 -0
- data/lib/square_connect/models/model_break.rb +347 -0
- data/lib/square_connect/models/obtain_token_request.rb +37 -7
- data/lib/square_connect/models/obtain_token_response.rb +16 -6
- data/lib/square_connect/models/retrieve_employee_request.rb +176 -0
- data/lib/square_connect/models/retrieve_employee_response.rb +198 -0
- data/lib/square_connect/models/retrieve_inventory_changes_request.rb +1 -1
- data/lib/square_connect/models/retrieve_inventory_changes_response.rb +1 -1
- data/lib/square_connect/models/retrieve_inventory_count_request.rb +1 -1
- data/lib/square_connect/models/retrieve_inventory_count_response.rb +1 -1
- data/lib/square_connect/models/search_catalog_objects_request.rb +1 -1
- data/lib/square_connect/models/search_catalog_objects_response.rb +1 -1
- data/lib/square_connect/models/search_customers_request.rb +1 -1
- data/lib/square_connect/models/search_customers_response.rb +1 -1
- data/lib/square_connect/models/search_shifts_request.rb +231 -0
- data/lib/square_connect/models/search_shifts_response.rb +210 -0
- data/lib/square_connect/models/shift.rb +395 -0
- data/lib/square_connect/models/shift_filter.rb +273 -0
- data/lib/square_connect/models/shift_filter_status.rb +19 -0
- data/lib/square_connect/models/shift_query.rb +196 -0
- data/lib/square_connect/models/shift_sort.rb +241 -0
- data/lib/square_connect/models/shift_sort_field.rb +21 -0
- data/lib/square_connect/models/shift_status.rb +19 -0
- data/lib/square_connect/models/shift_wage.rb +196 -0
- data/lib/square_connect/models/shift_workday.rb +239 -0
- data/lib/square_connect/models/shift_workday_matcher.rb +20 -0
- data/lib/square_connect/models/update_break_type_request.rb +186 -0
- data/lib/square_connect/models/update_break_type_response.rb +198 -0
- data/lib/square_connect/models/update_shift_request.rb +191 -0
- data/lib/square_connect/models/update_shift_response.rb +198 -0
- data/lib/square_connect/models/update_workweek_config_request.rb +186 -0
- data/lib/square_connect/models/update_workweek_config_response.rb +198 -0
- data/lib/square_connect/models/upsert_catalog_object_request.rb +1 -1
- data/lib/square_connect/models/v1_adjust_inventory_request.rb +2 -2
- data/lib/square_connect/models/v1_adjust_inventory_request_adjustment_type.rb +20 -0
- data/lib/square_connect/models/v1_apply_fee_request.rb +176 -0
- data/lib/square_connect/models/v1_apply_modifier_list_request.rb +176 -0
- data/lib/square_connect/models/v1_bank_account.rb +2 -2
- data/lib/square_connect/models/v1_bank_account_type.rb +23 -0
- data/lib/square_connect/models/v1_cash_drawer_event.rb +2 -2
- data/lib/square_connect/models/v1_cash_drawer_event_event_type.rb +26 -0
- data/lib/square_connect/models/v1_cash_drawer_shift.rb +2 -2
- data/lib/square_connect/models/v1_cash_drawer_shift_event_type.rb +20 -0
- data/lib/square_connect/models/v1_category.rb +1 -1
- data/lib/square_connect/models/v1_create_category_request.rb +186 -0
- data/lib/square_connect/models/v1_create_discount_request.rb +186 -0
- data/lib/square_connect/models/v1_create_employee_role_request.rb +186 -0
- data/lib/square_connect/models/v1_create_fee_request.rb +186 -0
- data/lib/square_connect/models/v1_create_item_request.rb +186 -0
- data/lib/square_connect/models/v1_create_modifier_list_request.rb +186 -0
- data/lib/square_connect/models/v1_create_modifier_option_request.rb +186 -0
- data/lib/square_connect/models/v1_create_page_request.rb +186 -0
- data/lib/square_connect/models/v1_create_refund_request.rb +3 -3
- data/lib/square_connect/models/v1_create_refund_request_type.rb +19 -0
- data/lib/square_connect/models/v1_create_variation_request.rb +186 -0
- data/lib/square_connect/models/v1_delete_category_request.rb +176 -0
- data/lib/square_connect/models/v1_delete_discount_request.rb +176 -0
- data/lib/square_connect/models/v1_delete_fee_request.rb +176 -0
- data/lib/square_connect/models/v1_delete_item_request.rb +176 -0
- data/lib/square_connect/models/v1_delete_modifier_list_request.rb +176 -0
- data/lib/square_connect/models/v1_delete_modifier_option_request.rb +176 -0
- data/lib/square_connect/models/v1_delete_page_cell_request.rb +196 -0
- data/lib/square_connect/models/v1_delete_page_request.rb +176 -0
- data/lib/square_connect/models/v1_delete_timecard_request.rb +176 -0
- data/lib/square_connect/models/v1_delete_timecard_response.rb +176 -0
- data/lib/square_connect/models/v1_delete_variation_request.rb +176 -0
- data/lib/square_connect/models/v1_discount.rb +3 -3
- data/lib/square_connect/models/v1_discount_color.rb +26 -0
- data/lib/square_connect/models/v1_discount_discount_type.rb +20 -0
- data/lib/square_connect/models/v1_employee.rb +1 -1
- data/lib/square_connect/models/v1_employee_role.rb +2 -2
- data/lib/square_connect/models/v1_employee_role_permissions.rb +24 -0
- data/lib/square_connect/models/v1_employee_status.rb +19 -0
- data/lib/square_connect/models/v1_fee.rb +5 -5
- data/lib/square_connect/models/v1_fee_adjustment_type.rb +18 -0
- data/lib/square_connect/models/v1_fee_calculation_phase.rb +20 -0
- data/lib/square_connect/models/v1_fee_inclusion_type.rb +19 -0
- data/lib/square_connect/models/v1_fee_type.rb +25 -0
- data/lib/square_connect/models/v1_inventory_entry.rb +1 -1
- data/lib/square_connect/models/v1_item.rb +4 -4
- data/lib/square_connect/models/v1_item_color.rb +26 -0
- data/lib/square_connect/models/v1_item_image.rb +1 -1
- data/lib/square_connect/models/v1_item_type.rb +20 -0
- data/lib/square_connect/models/v1_item_visibility.rb +19 -0
- data/lib/square_connect/models/v1_list_bank_accounts_request.rb +176 -0
- data/lib/square_connect/models/v1_list_bank_accounts_response.rb +188 -0
- data/lib/square_connect/models/v1_list_cash_drawer_shifts_request.rb +239 -0
- data/lib/square_connect/models/v1_list_cash_drawer_shifts_response.rb +188 -0
- data/lib/square_connect/models/v1_list_categories_request.rb +176 -0
- data/lib/square_connect/models/v1_list_categories_response.rb +188 -0
- data/lib/square_connect/models/v1_list_discounts_request.rb +176 -0
- data/lib/square_connect/models/v1_list_discounts_response.rb +188 -0
- data/lib/square_connect/models/v1_list_employee_roles_request.rb +239 -0
- data/lib/square_connect/models/v1_list_employee_roles_response.rb +188 -0
- data/lib/square_connect/models/v1_list_employees_request.rb +311 -0
- data/lib/square_connect/models/v1_list_employees_request_status.rb +19 -0
- data/lib/square_connect/models/v1_list_employees_response.rb +188 -0
- data/lib/square_connect/models/v1_list_fees_request.rb +176 -0
- data/lib/square_connect/models/v1_list_fees_response.rb +188 -0
- data/lib/square_connect/models/v1_list_inventory_request.rb +196 -0
- data/lib/square_connect/models/v1_list_inventory_response.rb +188 -0
- data/lib/square_connect/models/v1_list_items_request.rb +186 -0
- data/lib/square_connect/models/v1_list_items_response.rb +188 -0
- data/lib/square_connect/models/v1_list_locations_request.rb +176 -0
- data/lib/square_connect/models/v1_list_locations_response.rb +188 -0
- data/lib/square_connect/models/v1_list_modifier_lists_request.rb +176 -0
- data/lib/square_connect/models/v1_list_modifier_lists_response.rb +188 -0
- data/lib/square_connect/models/v1_list_orders_request.rb +239 -0
- data/lib/square_connect/models/v1_list_orders_response.rb +188 -0
- data/lib/square_connect/models/v1_list_pages_request.rb +176 -0
- data/lib/square_connect/models/v1_list_pages_response.rb +188 -0
- data/lib/square_connect/models/v1_list_payments_request.rb +269 -0
- data/lib/square_connect/models/v1_list_payments_response.rb +188 -0
- data/lib/square_connect/models/v1_list_refunds_request.rb +259 -0
- data/lib/square_connect/models/v1_list_refunds_response.rb +188 -0
- data/lib/square_connect/models/v1_list_settlements_request.rb +281 -0
- data/lib/square_connect/models/v1_list_settlements_request_status.rb +19 -0
- data/lib/square_connect/models/v1_list_settlements_response.rb +188 -0
- data/lib/square_connect/models/v1_list_timecard_events_request.rb +191 -0
- data/lib/square_connect/models/v1_list_timecard_events_response.rb +188 -0
- data/lib/square_connect/models/v1_list_timecards_request.rb +319 -0
- data/lib/square_connect/models/v1_list_timecards_response.rb +188 -0
- data/lib/square_connect/models/v1_merchant.rb +10 -9
- data/lib/square_connect/models/v1_merchant_account_type.rb +19 -0
- data/lib/square_connect/models/v1_merchant_business_type.rb +67 -0
- data/lib/square_connect/models/v1_modifier_list.rb +2 -2
- data/lib/square_connect/models/v1_modifier_list_selection_type.rb +19 -0
- data/lib/square_connect/models/v1_modifier_option.rb +1 -1
- data/lib/square_connect/models/v1_money.rb +3 -3
- data/lib/square_connect/models/v1_order.rb +2 -2
- data/lib/square_connect/models/v1_order_history_entry.rb +2 -2
- data/lib/square_connect/models/v1_order_history_entry_action.rb +24 -0
- data/lib/square_connect/models/v1_order_state.rb +23 -0
- data/lib/square_connect/models/v1_page.rb +1 -1
- data/lib/square_connect/models/v1_page_cell.rb +3 -3
- data/lib/square_connect/models/v1_page_cell_object_type.rb +21 -0
- data/lib/square_connect/models/v1_page_cell_placeholder_type.rb +20 -0
- data/lib/square_connect/models/v1_payment.rb +1 -1
- data/lib/square_connect/models/v1_payment_discount.rb +1 -1
- data/lib/square_connect/models/v1_payment_item_detail.rb +1 -1
- data/lib/square_connect/models/v1_payment_itemization.rb +2 -2
- data/lib/square_connect/models/v1_payment_itemization_itemization_type.rb +23 -0
- data/lib/square_connect/models/v1_payment_modifier.rb +1 -1
- data/lib/square_connect/models/v1_payment_surcharge.rb +2 -2
- data/lib/square_connect/models/v1_payment_surcharge_type.rb +20 -0
- data/lib/square_connect/models/v1_payment_tax.rb +2 -2
- data/lib/square_connect/models/v1_payment_tax_inclusion_type.rb +19 -0
- data/lib/square_connect/models/v1_refund.rb +2 -2
- data/lib/square_connect/models/v1_refund_type.rb +19 -0
- data/lib/square_connect/models/v1_remove_fee_request.rb +176 -0
- data/lib/square_connect/models/v1_remove_modifier_list_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_bank_account_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_business_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_cash_drawer_shift_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_employee_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_employee_role_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_item_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_modifier_list_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_order_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_payment_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_settlement_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_timecard_request.rb +176 -0
- data/lib/square_connect/models/v1_settlement.rb +2 -2
- data/lib/square_connect/models/v1_settlement_entry.rb +4 -4
- data/lib/square_connect/models/v1_settlement_entry_type.rb +38 -0
- data/lib/square_connect/models/v1_settlement_status.rb +19 -0
- data/lib/square_connect/models/v1_tender.rb +6 -6
- data/lib/square_connect/models/v1_tender_entry_method.rb +24 -0
- data/lib/square_connect/models/v1_tender_type.rb +25 -0
- data/lib/square_connect/models/v1_timecard.rb +1 -1
- data/lib/square_connect/models/v1_timecard_event.rb +2 -2
- data/lib/square_connect/models/v1_timecard_event_event_type.rb +25 -0
- data/lib/square_connect/models/v1_update_category_request.rb +191 -0
- data/lib/square_connect/models/v1_update_discount_request.rb +191 -0
- data/lib/square_connect/models/v1_update_employee_request.rb +191 -0
- data/lib/square_connect/models/v1_update_employee_role_request.rb +191 -0
- data/lib/square_connect/models/v1_update_fee_request.rb +191 -0
- data/lib/square_connect/models/v1_update_item_request.rb +191 -0
- data/lib/square_connect/models/v1_update_modifier_list_request.rb +2 -2
- data/lib/square_connect/models/v1_update_modifier_list_request_selection_type.rb +19 -0
- data/lib/square_connect/models/v1_update_modifier_option_request.rb +191 -0
- data/lib/square_connect/models/v1_update_order_request.rb +2 -2
- data/lib/square_connect/models/v1_update_order_request_action.rb +20 -0
- data/lib/square_connect/models/v1_update_page_cell_request.rb +191 -0
- data/lib/square_connect/models/v1_update_page_request.rb +191 -0
- data/lib/square_connect/models/v1_update_timecard_request.rb +191 -0
- data/lib/square_connect/models/v1_update_variation_request.rb +191 -0
- data/lib/square_connect/models/v1_variation.rb +3 -3
- data/lib/square_connect/models/v1_variation_inventory_alert_type.rb +23 -0
- data/lib/square_connect/models/v1_variation_pricing_type.rb +19 -0
- data/lib/square_connect/models/weekday.rb +24 -0
- data/lib/square_connect/models/workweek_config.rb +298 -0
- data/lib/square_connect/version.rb +1 -1
- data/spec/api/employees_api_spec.rb +59 -0
- data/spec/api/labor_api_spec.rb +208 -0
- data/spec/models/break_type_spec.rb +81 -0
- data/spec/models/create_break_type_request_spec.rb +45 -0
- data/spec/models/create_break_type_response_spec.rb +45 -0
- data/spec/models/create_shift_request_spec.rb +45 -0
- data/spec/models/create_shift_response_spec.rb +45 -0
- data/spec/models/date_range_spec.rb +45 -0
- data/spec/models/delete_break_type_request_spec.rb +33 -0
- data/spec/models/delete_break_type_response_spec.rb +39 -0
- data/spec/models/delete_shift_request_spec.rb +33 -0
- data/spec/models/delete_shift_response_spec.rb +39 -0
- data/spec/models/employee_spec.rb +79 -0
- data/spec/models/employee_status_spec.rb +33 -0
- data/spec/models/employee_wage_spec.rb +57 -0
- data/spec/models/get_break_type_request_spec.rb +33 -0
- data/spec/models/get_break_type_response_spec.rb +45 -0
- data/spec/models/get_employee_wage_request_spec.rb +33 -0
- data/spec/models/get_employee_wage_response_spec.rb +45 -0
- data/spec/models/get_shift_request_spec.rb +33 -0
- data/spec/models/get_shift_response_spec.rb +45 -0
- data/spec/models/list_break_types_request_spec.rb +51 -0
- data/spec/models/list_break_types_response_spec.rb +51 -0
- data/spec/models/list_employee_wages_request_spec.rb +51 -0
- data/spec/models/list_employee_wages_response_spec.rb +51 -0
- data/spec/models/list_employees_request_spec.rb +61 -0
- data/spec/models/list_employees_response_spec.rb +51 -0
- data/spec/models/list_workweek_configs_request_spec.rb +45 -0
- data/spec/models/list_workweek_configs_response_spec.rb +51 -0
- data/spec/models/model_break_spec.rb +75 -0
- data/spec/models/retrieve_employee_request_spec.rb +33 -0
- data/spec/models/retrieve_employee_response_spec.rb +45 -0
- data/spec/models/search_shifts_request_spec.rb +51 -0
- data/spec/models/search_shifts_response_spec.rb +51 -0
- data/spec/models/shift_filter_spec.rb +73 -0
- data/spec/models/shift_filter_status_spec.rb +33 -0
- data/spec/models/shift_query_spec.rb +45 -0
- data/spec/models/shift_sort_field_spec.rb +33 -0
- data/spec/models/shift_sort_spec.rb +53 -0
- data/spec/models/shift_spec.rb +109 -0
- data/spec/models/shift_status_spec.rb +33 -0
- data/spec/models/shift_wage_spec.rb +45 -0
- data/spec/models/shift_workday_matcher_spec.rb +33 -0
- data/spec/models/shift_workday_spec.rb +55 -0
- data/spec/models/update_break_type_request_spec.rb +39 -0
- data/spec/models/update_break_type_response_spec.rb +45 -0
- data/spec/models/update_shift_request_spec.rb +39 -0
- data/spec/models/update_shift_response_spec.rb +45 -0
- data/spec/models/update_workweek_config_request_spec.rb +39 -0
- data/spec/models/update_workweek_config_response_spec.rb +45 -0
- data/spec/models/v1_adjust_inventory_request_adjustment_type_spec.rb +33 -0
- data/spec/models/v1_apply_fee_request_spec.rb +33 -0
- data/spec/models/v1_apply_modifier_list_request_spec.rb +33 -0
- data/spec/models/v1_bank_account_type_spec.rb +33 -0
- data/spec/models/v1_cash_drawer_event_event_type_spec.rb +33 -0
- data/spec/models/v1_cash_drawer_shift_event_type_spec.rb +33 -0
- data/spec/models/v1_create_category_request_spec.rb +39 -0
- data/spec/models/v1_create_discount_request_spec.rb +39 -0
- data/spec/models/v1_create_employee_role_request_spec.rb +39 -0
- data/spec/models/v1_create_fee_request_spec.rb +39 -0
- data/spec/models/v1_create_item_request_spec.rb +39 -0
- data/spec/models/v1_create_modifier_list_request_spec.rb +39 -0
- data/spec/models/v1_create_modifier_option_request_spec.rb +39 -0
- data/spec/models/v1_create_page_request_spec.rb +39 -0
- data/spec/models/v1_create_refund_request_type_spec.rb +33 -0
- data/spec/models/v1_create_variation_request_spec.rb +39 -0
- data/spec/models/v1_delete_category_request_spec.rb +33 -0
- data/spec/models/v1_delete_discount_request_spec.rb +33 -0
- data/spec/models/v1_delete_fee_request_spec.rb +33 -0
- data/spec/models/v1_delete_item_request_spec.rb +33 -0
- data/spec/models/v1_delete_modifier_list_request_spec.rb +33 -0
- data/spec/models/v1_delete_modifier_option_request_spec.rb +33 -0
- data/spec/models/v1_delete_page_cell_request_spec.rb +45 -0
- data/spec/models/v1_delete_page_request_spec.rb +33 -0
- data/spec/models/v1_delete_timecard_request_spec.rb +33 -0
- data/spec/models/v1_delete_timecard_response_spec.rb +33 -0
- data/spec/models/v1_delete_variation_request_spec.rb +33 -0
- data/spec/models/v1_discount_color_spec.rb +33 -0
- data/spec/models/v1_discount_discount_type_spec.rb +33 -0
- data/spec/models/v1_employee_role_permissions_spec.rb +33 -0
- data/spec/models/v1_employee_status_spec.rb +33 -0
- data/spec/models/v1_fee_adjustment_type_spec.rb +33 -0
- data/spec/models/v1_fee_calculation_phase_spec.rb +33 -0
- data/spec/models/v1_fee_inclusion_type_spec.rb +33 -0
- data/spec/models/v1_fee_type_spec.rb +33 -0
- data/spec/models/v1_item_color_spec.rb +33 -0
- data/spec/models/v1_item_type_spec.rb +33 -0
- data/spec/models/v1_item_visibility_spec.rb +33 -0
- data/spec/models/v1_list_bank_accounts_request_spec.rb +33 -0
- data/spec/models/v1_list_bank_accounts_response_spec.rb +39 -0
- data/spec/models/v1_list_cash_drawer_shifts_request_spec.rb +55 -0
- data/spec/models/v1_list_cash_drawer_shifts_response_spec.rb +39 -0
- data/spec/models/v1_list_categories_request_spec.rb +33 -0
- data/spec/models/v1_list_categories_response_spec.rb +39 -0
- data/spec/models/v1_list_discounts_request_spec.rb +33 -0
- data/spec/models/v1_list_discounts_response_spec.rb +39 -0
- data/spec/models/v1_list_employee_roles_request_spec.rb +55 -0
- data/spec/models/v1_list_employee_roles_response_spec.rb +39 -0
- data/spec/models/v1_list_employees_request_spec.rb +95 -0
- data/spec/models/v1_list_employees_request_status_spec.rb +33 -0
- data/spec/models/v1_list_employees_response_spec.rb +39 -0
- data/spec/models/v1_list_fees_request_spec.rb +33 -0
- data/spec/models/v1_list_fees_response_spec.rb +39 -0
- data/spec/models/v1_list_inventory_request_spec.rb +45 -0
- data/spec/models/v1_list_inventory_response_spec.rb +39 -0
- data/spec/models/v1_list_items_request_spec.rb +39 -0
- data/spec/models/v1_list_items_response_spec.rb +39 -0
- data/spec/models/v1_list_locations_request_spec.rb +33 -0
- data/spec/models/v1_list_locations_response_spec.rb +39 -0
- data/spec/models/v1_list_modifier_lists_request_spec.rb +33 -0
- data/spec/models/v1_list_modifier_lists_response_spec.rb +39 -0
- data/spec/models/v1_list_orders_request_spec.rb +55 -0
- data/spec/models/v1_list_orders_response_spec.rb +39 -0
- data/spec/models/v1_list_pages_request_spec.rb +33 -0
- data/spec/models/v1_list_pages_response_spec.rb +39 -0
- data/spec/models/v1_list_payments_request_spec.rb +73 -0
- data/spec/models/v1_list_payments_response_spec.rb +39 -0
- data/spec/models/v1_list_refunds_request_spec.rb +67 -0
- data/spec/models/v1_list_refunds_response_spec.rb +39 -0
- data/spec/models/v1_list_settlements_request_spec.rb +77 -0
- data/spec/models/v1_list_settlements_request_status_spec.rb +33 -0
- data/spec/models/v1_list_settlements_response_spec.rb +39 -0
- data/spec/models/v1_list_timecard_events_request_spec.rb +39 -0
- data/spec/models/v1_list_timecard_events_response_spec.rb +39 -0
- data/spec/models/v1_list_timecards_request_spec.rb +103 -0
- data/spec/models/v1_list_timecards_response_spec.rb +39 -0
- data/spec/models/v1_merchant_account_type_spec.rb +33 -0
- data/spec/models/v1_merchant_business_type_spec.rb +33 -0
- data/spec/models/v1_modifier_list_selection_type_spec.rb +33 -0
- data/spec/models/v1_order_history_entry_action_spec.rb +33 -0
- data/spec/models/v1_order_state_spec.rb +33 -0
- data/spec/models/v1_page_cell_object_type_spec.rb +33 -0
- data/spec/models/v1_page_cell_placeholder_type_spec.rb +33 -0
- data/spec/models/v1_payment_itemization_itemization_type_spec.rb +33 -0
- data/spec/models/v1_payment_surcharge_type_spec.rb +33 -0
- data/spec/models/v1_payment_tax_inclusion_type_spec.rb +33 -0
- data/spec/models/v1_refund_type_spec.rb +33 -0
- data/spec/models/v1_remove_fee_request_spec.rb +33 -0
- data/spec/models/v1_remove_modifier_list_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_bank_account_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_business_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_cash_drawer_shift_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_employee_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_employee_role_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_item_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_modifier_list_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_order_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_payment_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_settlement_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_timecard_request_spec.rb +33 -0
- data/spec/models/v1_settlement_entry_type_spec.rb +33 -0
- data/spec/models/v1_settlement_status_spec.rb +33 -0
- data/spec/models/v1_tender_entry_method_spec.rb +33 -0
- data/spec/models/v1_tender_type_spec.rb +33 -0
- data/spec/models/v1_timecard_event_event_type_spec.rb +33 -0
- data/spec/models/v1_update_category_request_spec.rb +39 -0
- data/spec/models/v1_update_discount_request_spec.rb +39 -0
- data/spec/models/v1_update_employee_request_spec.rb +39 -0
- data/spec/models/v1_update_employee_role_request_spec.rb +39 -0
- data/spec/models/v1_update_fee_request_spec.rb +39 -0
- data/spec/models/v1_update_item_request_spec.rb +39 -0
- data/spec/models/v1_update_modifier_list_request_selection_type_spec.rb +33 -0
- data/spec/models/v1_update_modifier_option_request_spec.rb +39 -0
- data/spec/models/v1_update_order_request_action_spec.rb +33 -0
- data/spec/models/v1_update_page_cell_request_spec.rb +39 -0
- data/spec/models/v1_update_page_request_spec.rb +39 -0
- data/spec/models/v1_update_timecard_request_spec.rb +39 -0
- data/spec/models/v1_update_variation_request_spec.rb +39 -0
- data/spec/models/v1_variation_inventory_alert_type_spec.rb +33 -0
- data/spec/models/v1_variation_pricing_type_spec.rb +33 -0
- data/spec/models/weekday_spec.rb +33 -0
- data/spec/models/workweek_config_spec.rb +73 -0
- metadata +691 -3
@@ -8,7 +8,7 @@
|
|
8
8
|
Name | Type | Description | Notes
|
9
9
|
------------ | ------------- | ------------- | -------------
|
10
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 [
|
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
12
|
**objects** | [**Array<CatalogObject>**](CatalogObject.md) | The [CatalogObject](#type-catalogobject)s returned. | [optional]
|
13
13
|
**related_objects** | [**Array<CatalogObject>**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s referenced by the objects in the `objects` field. | [optional]
|
14
14
|
|
@@ -7,7 +7,7 @@ Defines the fields included in the request body for the [SearchCustomers](#endpo
|
|
7
7
|
## Properties
|
8
8
|
Name | Type | Description | Notes
|
9
9
|
------------ | ------------- | ------------- | -------------
|
10
|
-
**cursor** | **String** | Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See [
|
10
|
+
**cursor** | **String** | Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See [Pagination](/basics/api101/pagination) for more information. | [optional]
|
11
11
|
**limit** | **Integer** | A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored. | [optional]
|
12
12
|
**query** | [**CustomerQuery**](CustomerQuery.md) | Query customers based on the given conditions and sort order. Calling SearchCustomers without an explicit query parameter will return all customers ordered alphabetically based on `given_name` and `family_name`. | [optional]
|
13
13
|
|
@@ -9,6 +9,6 @@ Name | Type | Description | Notes
|
|
9
9
|
------------ | ------------- | ------------- | -------------
|
10
10
|
**errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional]
|
11
11
|
**customers** | [**Array<Customer>**](Customer.md) | An array of `Customer` objects that match a query. | [optional]
|
12
|
-
**cursor** | **String** | A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See [
|
12
|
+
**cursor** | **String** | A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See [Pagination](/basics/api101/pagination) for more information. | [optional]
|
13
13
|
|
14
14
|
|
@@ -0,0 +1,14 @@
|
|
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
|
+
|
@@ -0,0 +1,14 @@
|
|
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
|
+
|
data/docs/Shift.md
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
# SquareConnect::Shift
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
A record of the hourly rate, start, and end times for a single work shift for an employee. May include a record of the start and end times for breaks taken during the shift.
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type | Description | Notes
|
9
|
+
------------ | ------------- | ------------- | -------------
|
10
|
+
**id** | **String** | UUID for this object | [optional]
|
11
|
+
**employee_id** | **String** | The ID of the employee this shift belongs to. |
|
12
|
+
**location_id** | **String** | The ID of the location this shift occurred at. Should be based on where the employee clocked in. | [optional]
|
13
|
+
**timezone** | **String** | Read-only convenience value that is calculated from the location based on `location_id`. Format: the IANA Timezone Database identifier for the location timezone. | [optional]
|
14
|
+
**start_at** | **String** | RFC 3339; shifted to location timezone + offset. Precision up to the minute is respected; seconds are truncated. |
|
15
|
+
**end_at** | **String** | RFC 3339; shifted to timezone + offset. Precision up to the minute is respected; seconds are truncated. The `end_at` minute is not counted when the shift length is calculated. For example, a shift from `00:00` to `08:01` is considered an 8 hour shift (midnight to 8am). | [optional]
|
16
|
+
**wage** | [**ShiftWage**](ShiftWage.md) | Job and pay related information. | [optional]
|
17
|
+
**breaks** | [**Array<ModelBreak>**](ModelBreak.md) | A list of any paid or unpaid breaks that were taken during this shift. | [optional]
|
18
|
+
**status** | **String** | Describes working state of the current `Shift`. | [optional]
|
19
|
+
**version** | **Integer** | Used for resolving concurrency issues; request will fail if version provided does not match server version at time of request. If not provided, Square executes a blind write; potentially overwriting data from another write. | [optional]
|
20
|
+
**created_at** | **String** | A read-only timestamp in RFC 3339 format; presented in UTC. | [optional]
|
21
|
+
**updated_at** | **String** | A read-only timestamp in RFC 3339 format; presented in UTC. | [optional]
|
22
|
+
|
23
|
+
|
data/docs/ShiftFilter.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# SquareConnect::ShiftFilter
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
Defines a filter used in a search for `Shift` records. `AND` logic is used by Square's servers to apply each filter property specified.
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type | Description | Notes
|
9
|
+
------------ | ------------- | ------------- | -------------
|
10
|
+
**location_id** | **Array<String>** | Fetch shifts for the specified location. | [optional]
|
11
|
+
**employee_id** | **Array<String>** | Fetch shifts for the specified employee. | [optional]
|
12
|
+
**status** | **String** | Fetch a `Shift` instance by `Shift.status`. | [optional]
|
13
|
+
**start** | [**TimeRange**](TimeRange.md) | Fetch `Shift`s that start in the time range - Inclusive. | [optional]
|
14
|
+
**_end** | [**TimeRange**](TimeRange.md) | Fetch the `Shift`s that end in the time range - Inclusive. | [optional]
|
15
|
+
**workday** | [**ShiftWorkday**](ShiftWorkday.md) | Fetch the `Shift`s based on workday date range. | [optional]
|
16
|
+
|
17
|
+
|
data/docs/ShiftQuery.md
ADDED
@@ -0,0 +1,13 @@
|
|
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
|
+
|
data/docs/ShiftSort.md
ADDED
@@ -0,0 +1,13 @@
|
|
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. | [optional]
|
11
|
+
**order** | **String** | The order in which results are returned. Defaults to DESC. | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,15 @@
|
|
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
|
+
|
data/docs/ShiftStatus.md
ADDED
data/docs/ShiftWage.md
ADDED
@@ -0,0 +1,13 @@
|
|
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
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# SquareConnect::ShiftWorkday
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
A `Shift` search query filter parameter that sets a range of days that a `Shift` must start or end in before passing the filter condition.
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type | Description | Notes
|
9
|
+
------------ | ------------- | ------------- | -------------
|
10
|
+
**date_range** | [**DateRange**](DateRange.md) | Dates for fetching the shifts | [optional]
|
11
|
+
**match_shifts_by** | **String** | The strategy on which the dates are applied. | [optional]
|
12
|
+
**default_timezone** | **String** | Location-specific timezones convert workdays to datetime filters. Every location included in the query must have a timezone, or this field must be provided as a fallback. Format: the IANA timezone database identifier for the relevant timezone. | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,14 @@
|
|
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
|
+
|
data/docs/TransactionsApi.md
CHANGED
@@ -206,7 +206,7 @@ opts = {
|
|
206
206
|
begin_time: "begin_time_example", # String | The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year.
|
207
207
|
end_time: "end_time_example", # String | The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time.
|
208
208
|
sort_order: "sort_order_example", # String | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`
|
209
|
-
cursor: "cursor_example" # String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [
|
209
|
+
cursor: "cursor_example" # String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](/basics/api101/pagination) for more information.
|
210
210
|
}
|
211
211
|
|
212
212
|
begin
|
@@ -226,7 +226,7 @@ Name | Type | Description | Notes
|
|
226
226
|
**begin_time** | **String**| The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. | [optional]
|
227
227
|
**end_time** | **String**| The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. | [optional]
|
228
228
|
**sort_order** | **String**| The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` | [optional]
|
229
|
-
**cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [
|
229
|
+
**cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](/basics/api101/pagination) for more information. | [optional]
|
230
230
|
|
231
231
|
### Return type
|
232
232
|
|
@@ -268,7 +268,7 @@ opts = {
|
|
268
268
|
begin_time: "begin_time_example", # String | The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year.
|
269
269
|
end_time: "end_time_example", # String | The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time.
|
270
270
|
sort_order: "sort_order_example", # String | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`
|
271
|
-
cursor: "cursor_example" # String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [
|
271
|
+
cursor: "cursor_example" # String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](/basics/api101/pagination) for more information.
|
272
272
|
}
|
273
273
|
|
274
274
|
begin
|
@@ -288,7 +288,7 @@ Name | Type | Description | Notes
|
|
288
288
|
**begin_time** | **String**| The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. | [optional]
|
289
289
|
**end_time** | **String**| The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time. | [optional]
|
290
290
|
**sort_order** | **String**| The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` | [optional]
|
291
|
-
**cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [
|
291
|
+
**cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](/basics/api101/pagination) for more information. | [optional]
|
292
292
|
|
293
293
|
### Return type
|
294
294
|
|
@@ -0,0 +1,12 @@
|
|
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
|
+
|
@@ -0,0 +1,13 @@
|
|
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
|
+
|
@@ -0,0 +1,12 @@
|
|
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
|
+
|
@@ -0,0 +1,13 @@
|
|
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
|
+
|
@@ -0,0 +1,12 @@
|
|
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
|
+
|
@@ -0,0 +1,13 @@
|
|
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
|
+
|
@@ -7,7 +7,7 @@
|
|
7
7
|
## Properties
|
8
8
|
Name | Type | Description | Notes
|
9
9
|
------------ | ------------- | ------------- | -------------
|
10
|
-
**idempotency_key** | **String** | A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID). If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects. See [Idempotency
|
10
|
+
**idempotency_key** | **String** | A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID). If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects. See [Idempotency](/basics/api101/idempotency) for more information. |
|
11
11
|
**object** | [**CatalogObject**](CatalogObject.md) | A [CatalogObject](#type-catalogobject) to be created or updated. The object's `is_deleted` field must not be set to `true`. When creating a new object, the object's ID must either start with a `#` character or be left blank. In either case it will be replaced with a server-generated ID. |
|
12
12
|
|
13
13
|
|
@@ -2,11 +2,13 @@
|
|
2
2
|
|
3
3
|
### Description
|
4
4
|
|
5
|
+
V1AdjustInventoryRequest
|
6
|
+
|
5
7
|
## Properties
|
6
8
|
Name | Type | Description | Notes
|
7
9
|
------------ | ------------- | ------------- | -------------
|
8
10
|
**quantity_delta** | **Float** | The number to adjust the variation's quantity by. | [optional]
|
9
|
-
**adjustment_type** | **String** | The reason for the inventory adjustment. | [optional]
|
11
|
+
**adjustment_type** | **String** | The reason for the inventory adjustment. See [V1AdjustInventoryRequestAdjustmentType](#type-v1adjustinventoryrequestadjustmenttype) for possible values | [optional]
|
10
12
|
**memo** | **String** | A note about the inventory adjustment. | [optional]
|
11
13
|
|
12
14
|
|
data/docs/V1BankAccount.md
CHANGED
@@ -2,6 +2,8 @@
|
|
2
2
|
|
3
3
|
### Description
|
4
4
|
|
5
|
+
V1BankAccount
|
6
|
+
|
5
7
|
## Properties
|
6
8
|
Name | Type | Description | Notes
|
7
9
|
------------ | ------------- | ------------- | -------------
|
@@ -12,6 +14,6 @@ Name | Type | Description | Notes
|
|
12
14
|
**routing_number** | **String** | The bank account's routing number. | [optional]
|
13
15
|
**account_number_suffix** | **String** | The last few digits of the bank account number. | [optional]
|
14
16
|
**currency_code** | **String** | The currency code of the currency associated with the bank account, in ISO 4217 format. For example, the currency code for US dollars is USD. | [optional]
|
15
|
-
**type** | **String** | The bank account's type (for example, savings or checking). | [optional]
|
17
|
+
**type** | **String** | The bank account's type (for example, savings or checking). See [V1BankAccountType](#type-v1bankaccounttype) for possible values | [optional]
|
16
18
|
|
17
19
|
|
@@ -0,0 +1,17 @@
|
|
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
|
+
|