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
data/docs/V1Employee.md
CHANGED
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**role_ids** | **Array<String>** | The ids of the employee's associated roles. Currently, you can specify only one or zero roles per employee. | [optional]
|
|
14
14
|
**authorized_location_ids** | **Array<String>** | The IDs of the locations the employee is allowed to clock in at. | [optional]
|
|
15
15
|
**email** | **String** | The employee's email address. | [optional]
|
|
16
|
-
**status** | **String** | CWhether the employee is ACTIVE or INACTIVE. Inactive employees cannot sign in to Square Register.Merchants update this field from the Square Dashboard.
|
|
16
|
+
**status** | **String** | CWhether the employee is ACTIVE or INACTIVE. Inactive employees cannot sign in to Square Register.Merchants update this field from the Square Dashboard. See [V1EmployeeStatus](#type-v1employeestatus) for possible values | [optional]
|
|
17
17
|
**external_id** | **String** | An ID the merchant can set to associate the employee with an entity in another system. | [optional]
|
|
18
18
|
**created_at** | **String** | The time when the employee entity was created, in ISO 8601 format. | [optional]
|
|
19
19
|
**updated_at** | **String** | The time when the employee entity was most recently updated, in ISO 8601 format. | [optional]
|
data/docs/V1EmployeeRole.md
CHANGED
|
@@ -2,12 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
+
V1EmployeeRole
|
|
6
|
+
|
|
5
7
|
## Properties
|
|
6
8
|
Name | Type | Description | Notes
|
|
7
9
|
------------ | ------------- | ------------- | -------------
|
|
8
10
|
**id** | **String** | The role's unique ID, Can only be set by Square. | [optional]
|
|
9
11
|
**name** | **String** | The role's merchant-defined name. |
|
|
10
|
-
**permissions** | **Array<String>** | The role's permissions. |
|
|
12
|
+
**permissions** | **Array<String>** | The role's permissions. See [V1EmployeeRolePermissions](#type-v1employeerolepermissions) for possible values |
|
|
11
13
|
**is_owner** | **BOOLEAN** | If true, employees with this role have all permissions, regardless of the values indicated in permissions. | [optional]
|
|
12
14
|
**created_at** | **String** | The time when the employee entity was created, in ISO 8601 format. Is set by Square when the Role is created. | [optional]
|
|
13
15
|
**updated_at** | **String** | The time when the employee entity was most recently updated, in ISO 8601 format. Is set by Square when the Role updated. | [optional]
|
|
@@ -0,0 +1,18 @@
|
|
|
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
|
+
|
data/docs/V1EmployeesApi.md
CHANGED
|
@@ -4,30 +4,30 @@ All URIs are relative to *https://connect.squareup.com*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**create_employee**](V1EmployeesApi.md#create_employee) | **POST** /v1/me/employees |
|
|
8
|
-
[**create_employee_role**](V1EmployeesApi.md#create_employee_role) | **POST** /v1/me/roles |
|
|
9
|
-
[**create_timecard**](V1EmployeesApi.md#create_timecard) | **POST** /v1/me/timecards |
|
|
10
|
-
[**delete_timecard**](V1EmployeesApi.md#delete_timecard) | **DELETE** /v1/me/timecards/{timecard_id} |
|
|
11
|
-
[**list_cash_drawer_shifts**](V1EmployeesApi.md#list_cash_drawer_shifts) | **GET** /v1/{location_id}/cash-drawer-shifts |
|
|
12
|
-
[**list_employee_roles**](V1EmployeesApi.md#list_employee_roles) | **GET** /v1/me/roles |
|
|
13
|
-
[**list_employees**](V1EmployeesApi.md#list_employees) | **GET** /v1/me/employees |
|
|
14
|
-
[**list_timecard_events**](V1EmployeesApi.md#list_timecard_events) | **GET** /v1/me/timecards/{timecard_id}/events |
|
|
15
|
-
[**list_timecards**](V1EmployeesApi.md#list_timecards) | **GET** /v1/me/timecards |
|
|
16
|
-
[**retrieve_cash_drawer_shift**](V1EmployeesApi.md#retrieve_cash_drawer_shift) | **GET** /v1/{location_id}/cash-drawer-shifts/{shift_id} |
|
|
17
|
-
[**retrieve_employee**](V1EmployeesApi.md#retrieve_employee) | **GET** /v1/me/employees/{employee_id} |
|
|
18
|
-
[**retrieve_employee_role**](V1EmployeesApi.md#retrieve_employee_role) | **GET** /v1/me/roles/{role_id} |
|
|
19
|
-
[**retrieve_timecard**](V1EmployeesApi.md#retrieve_timecard) | **GET** /v1/me/timecards/{timecard_id} |
|
|
20
|
-
[**update_employee**](V1EmployeesApi.md#update_employee) | **PUT** /v1/me/employees/{employee_id} |
|
|
21
|
-
[**update_employee_role**](V1EmployeesApi.md#update_employee_role) | **PUT** /v1/me/roles/{role_id} |
|
|
22
|
-
[**update_timecard**](V1EmployeesApi.md#update_timecard) | **PUT** /v1/me/timecards/{timecard_id} |
|
|
7
|
+
[**create_employee**](V1EmployeesApi.md#create_employee) | **POST** /v1/me/employees | CreateEmployee
|
|
8
|
+
[**create_employee_role**](V1EmployeesApi.md#create_employee_role) | **POST** /v1/me/roles | CreateEmployeeRole
|
|
9
|
+
[**create_timecard**](V1EmployeesApi.md#create_timecard) | **POST** /v1/me/timecards | CreateTimecard
|
|
10
|
+
[**delete_timecard**](V1EmployeesApi.md#delete_timecard) | **DELETE** /v1/me/timecards/{timecard_id} | DeleteTimecard
|
|
11
|
+
[**list_cash_drawer_shifts**](V1EmployeesApi.md#list_cash_drawer_shifts) | **GET** /v1/{location_id}/cash-drawer-shifts | ListCashDrawerShifts
|
|
12
|
+
[**list_employee_roles**](V1EmployeesApi.md#list_employee_roles) | **GET** /v1/me/roles | ListEmployeeRoles
|
|
13
|
+
[**list_employees**](V1EmployeesApi.md#list_employees) | **GET** /v1/me/employees | ListEmployees
|
|
14
|
+
[**list_timecard_events**](V1EmployeesApi.md#list_timecard_events) | **GET** /v1/me/timecards/{timecard_id}/events | ListTimecardEvents
|
|
15
|
+
[**list_timecards**](V1EmployeesApi.md#list_timecards) | **GET** /v1/me/timecards | ListTimecards
|
|
16
|
+
[**retrieve_cash_drawer_shift**](V1EmployeesApi.md#retrieve_cash_drawer_shift) | **GET** /v1/{location_id}/cash-drawer-shifts/{shift_id} | RetrieveCashDrawerShift
|
|
17
|
+
[**retrieve_employee**](V1EmployeesApi.md#retrieve_employee) | **GET** /v1/me/employees/{employee_id} | RetrieveEmployee
|
|
18
|
+
[**retrieve_employee_role**](V1EmployeesApi.md#retrieve_employee_role) | **GET** /v1/me/roles/{role_id} | RetrieveEmployeeRole
|
|
19
|
+
[**retrieve_timecard**](V1EmployeesApi.md#retrieve_timecard) | **GET** /v1/me/timecards/{timecard_id} | RetrieveTimecard
|
|
20
|
+
[**update_employee**](V1EmployeesApi.md#update_employee) | **PUT** /v1/me/employees/{employee_id} | UpdateEmployee
|
|
21
|
+
[**update_employee_role**](V1EmployeesApi.md#update_employee_role) | **PUT** /v1/me/roles/{role_id} | UpdateEmployeeRole
|
|
22
|
+
[**update_timecard**](V1EmployeesApi.md#update_timecard) | **PUT** /v1/me/timecards/{timecard_id} | UpdateTimecard
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
# **create_employee**
|
|
26
26
|
> V1Employee create_employee(body)
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
CreateEmployee
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
Use the CreateEmployee endpoint to add an employee to a Square account. Employees created with the Connect API have an initial status of `INACTIVE`. Inactive employees cannot sign in to Square Point of Sale until they are activated from the Square Dashboard. Employee status cannot be changed with the Connect API. <aside class=\"important\"> Employee entities cannot be deleted. To disable employee profiles, set the employee's status to <code>INACTIVE</code> </aside>
|
|
31
31
|
|
|
32
32
|
### Example
|
|
33
33
|
```ruby
|
|
@@ -45,7 +45,7 @@ body = SquareConnect::V1Employee.new # V1Employee | An object containing the fie
|
|
|
45
45
|
|
|
46
46
|
|
|
47
47
|
begin
|
|
48
|
-
#
|
|
48
|
+
#CreateEmployee
|
|
49
49
|
result = api_instance.create_employee(body)
|
|
50
50
|
p result
|
|
51
51
|
rescue SquareConnect::ApiError => e
|
|
@@ -77,9 +77,9 @@ Name | Type | Description | Notes
|
|
|
77
77
|
# **create_employee_role**
|
|
78
78
|
> V1EmployeeRole create_employee_role(employee_role)
|
|
79
79
|
|
|
80
|
-
|
|
80
|
+
CreateEmployeeRole
|
|
81
81
|
|
|
82
|
-
Creates an employee role you can then assign to employees.
|
|
82
|
+
Creates an employee role you can then assign to employees. Square accounts can include any number of roles that can be assigned to employees. These roles define the actions and permissions granted to an employee with that role. For example, an employee with a \"Shift Manager\" role might be able to issue refunds in Square Point of Sale, whereas an employee with a \"Clerk\" role might not. Roles are assigned with the [V1UpdateEmployee](#endpoint-v1updateemployee) endpoint. An employee can have only one role at a time. If an employee has no role, they have none of the permissions associated with roles. All employees can accept payments with Square Point of Sale.
|
|
83
83
|
|
|
84
84
|
### Example
|
|
85
85
|
```ruby
|
|
@@ -97,7 +97,7 @@ employee_role = SquareConnect::V1EmployeeRole.new # V1EmployeeRole | An Employee
|
|
|
97
97
|
|
|
98
98
|
|
|
99
99
|
begin
|
|
100
|
-
#
|
|
100
|
+
#CreateEmployeeRole
|
|
101
101
|
result = api_instance.create_employee_role(employee_role)
|
|
102
102
|
p result
|
|
103
103
|
rescue SquareConnect::ApiError => e
|
|
@@ -129,9 +129,9 @@ Name | Type | Description | Notes
|
|
|
129
129
|
# **create_timecard**
|
|
130
130
|
> V1Timecard create_timecard(body)
|
|
131
131
|
|
|
132
|
-
|
|
132
|
+
CreateTimecard
|
|
133
133
|
|
|
134
|
-
Creates a timecard for an employee.
|
|
134
|
+
Creates a timecard for an employee and clocks them in with an `API_CREATE` event and a `clockin_time` set to the current time unless the request provides a different value. To import timecards from another system (rather than clocking someone in). Specify the `clockin_time` and* `clockout_time` in the request. Timecards correspond to exactly one shift for a given employee, bounded by the `clockin_time` and `clockout_time` fields. An employee is considered clocked in if they have a timecard that doesn't have a `clockout_time` set. An employee that is currently clocked in cannot be clocked in a second time.
|
|
135
135
|
|
|
136
136
|
### Example
|
|
137
137
|
```ruby
|
|
@@ -149,7 +149,7 @@ body = SquareConnect::V1Timecard.new # V1Timecard | An object containing the fie
|
|
|
149
149
|
|
|
150
150
|
|
|
151
151
|
begin
|
|
152
|
-
#
|
|
152
|
+
#CreateTimecard
|
|
153
153
|
result = api_instance.create_timecard(body)
|
|
154
154
|
p result
|
|
155
155
|
rescue SquareConnect::ApiError => e
|
|
@@ -181,9 +181,9 @@ Name | Type | Description | Notes
|
|
|
181
181
|
# **delete_timecard**
|
|
182
182
|
> Object delete_timecard(timecard_id)
|
|
183
183
|
|
|
184
|
-
|
|
184
|
+
DeleteTimecard
|
|
185
185
|
|
|
186
|
-
Deletes a timecard. Deleted timecards are still accessible
|
|
186
|
+
Deletes a timecard. Timecards can also be deleted through the Square Dashboard. Deleted timecards are still accessible through Connect API endpoints, but cannot be modified. The `deleted` field of the `Timecard` object indicates whether the timecard has been deleted. *Note**: By default, deleted timecards appear alongside valid timecards in results returned by the [ListTimecards](#endpoint-v1employees-listtimecards) endpoint. To filter deleted timecards, include the `deleted` query parameter in the list request. <aside> Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. </aside>
|
|
187
187
|
|
|
188
188
|
### Example
|
|
189
189
|
```ruby
|
|
@@ -201,7 +201,7 @@ timecard_id = "timecard_id_example" # String | The ID of the timecard to delete.
|
|
|
201
201
|
|
|
202
202
|
|
|
203
203
|
begin
|
|
204
|
-
#
|
|
204
|
+
#DeleteTimecard
|
|
205
205
|
result = api_instance.delete_timecard(timecard_id)
|
|
206
206
|
p result
|
|
207
207
|
rescue SquareConnect::ApiError => e
|
|
@@ -233,7 +233,7 @@ Name | Type | Description | Notes
|
|
|
233
233
|
# **list_cash_drawer_shifts**
|
|
234
234
|
> Array<V1CashDrawerShift> list_cash_drawer_shifts(location_id, opts)
|
|
235
235
|
|
|
236
|
-
|
|
236
|
+
ListCashDrawerShifts
|
|
237
237
|
|
|
238
238
|
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.
|
|
239
239
|
|
|
@@ -258,7 +258,7 @@ opts = {
|
|
|
258
258
|
}
|
|
259
259
|
|
|
260
260
|
begin
|
|
261
|
-
#
|
|
261
|
+
#ListCashDrawerShifts
|
|
262
262
|
result = api_instance.list_cash_drawer_shifts(location_id, opts)
|
|
263
263
|
p result
|
|
264
264
|
rescue SquareConnect::ApiError => e
|
|
@@ -293,7 +293,7 @@ Name | Type | Description | Notes
|
|
|
293
293
|
# **list_employee_roles**
|
|
294
294
|
> Array<V1EmployeeRole> list_employee_roles(opts)
|
|
295
295
|
|
|
296
|
-
|
|
296
|
+
ListEmployeeRoles
|
|
297
297
|
|
|
298
298
|
Provides summary information for all of a business's employee roles.
|
|
299
299
|
|
|
@@ -310,13 +310,13 @@ end
|
|
|
310
310
|
api_instance = SquareConnect::V1EmployeesApi.new
|
|
311
311
|
|
|
312
312
|
opts = {
|
|
313
|
-
order: "order_example", # String | The order in which employees are listed in the response, based on their created_at field.Default value: ASC
|
|
313
|
+
order: "order_example", # String | The order in which employees are listed in the response, based on their created_at field.Default value: ASC
|
|
314
314
|
limit: 56, # Integer | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
|
|
315
315
|
batch_token: "batch_token_example" # String | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
|
|
316
316
|
}
|
|
317
317
|
|
|
318
318
|
begin
|
|
319
|
-
#
|
|
319
|
+
#ListEmployeeRoles
|
|
320
320
|
result = api_instance.list_employee_roles(opts)
|
|
321
321
|
p result
|
|
322
322
|
rescue SquareConnect::ApiError => e
|
|
@@ -328,7 +328,7 @@ end
|
|
|
328
328
|
|
|
329
329
|
Name | Type | Description | Notes
|
|
330
330
|
------------- | ------------- | ------------- | -------------
|
|
331
|
-
**order** | **String**| The order in which employees are listed in the response, based on their created_at field.Default value: ASC
|
|
331
|
+
**order** | **String**| The order in which employees are listed in the response, based on their created_at field.Default value: ASC | [optional]
|
|
332
332
|
**limit** | **Integer**| The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. | [optional]
|
|
333
333
|
**batch_token** | **String**| A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional]
|
|
334
334
|
|
|
@@ -350,7 +350,7 @@ Name | Type | Description | Notes
|
|
|
350
350
|
# **list_employees**
|
|
351
351
|
> Array<V1Employee> list_employees(opts)
|
|
352
352
|
|
|
353
|
-
|
|
353
|
+
ListEmployees
|
|
354
354
|
|
|
355
355
|
Provides summary information for all of a business's employees.
|
|
356
356
|
|
|
@@ -367,7 +367,7 @@ end
|
|
|
367
367
|
api_instance = SquareConnect::V1EmployeesApi.new
|
|
368
368
|
|
|
369
369
|
opts = {
|
|
370
|
-
order: "order_example", # String | The order in which employees are listed in the response, based on their created_at field. Default value: ASC
|
|
370
|
+
order: "order_example", # String | The order in which employees are listed in the response, based on their created_at field. Default value: ASC
|
|
371
371
|
begin_updated_at: "begin_updated_at_example", # String | If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format
|
|
372
372
|
end_updated_at: "end_updated_at_example", # String | If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format.
|
|
373
373
|
begin_created_at: "begin_created_at_example", # String | If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format.
|
|
@@ -379,7 +379,7 @@ opts = {
|
|
|
379
379
|
}
|
|
380
380
|
|
|
381
381
|
begin
|
|
382
|
-
#
|
|
382
|
+
#ListEmployees
|
|
383
383
|
result = api_instance.list_employees(opts)
|
|
384
384
|
p result
|
|
385
385
|
rescue SquareConnect::ApiError => e
|
|
@@ -391,7 +391,7 @@ end
|
|
|
391
391
|
|
|
392
392
|
Name | Type | Description | Notes
|
|
393
393
|
------------- | ------------- | ------------- | -------------
|
|
394
|
-
**order** | **String**| The order in which employees are listed in the response, based on their created_at field. Default value: ASC
|
|
394
|
+
**order** | **String**| The order in which employees are listed in the response, based on their created_at field. Default value: ASC | [optional]
|
|
395
395
|
**begin_updated_at** | **String**| If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format | [optional]
|
|
396
396
|
**end_updated_at** | **String**| If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format. | [optional]
|
|
397
397
|
**begin_created_at** | **String**| If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format. | [optional]
|
|
@@ -419,9 +419,9 @@ Name | Type | Description | Notes
|
|
|
419
419
|
# **list_timecard_events**
|
|
420
420
|
> Array<V1TimecardEvent> list_timecard_events(timecard_id)
|
|
421
421
|
|
|
422
|
-
|
|
422
|
+
ListTimecardEvents
|
|
423
423
|
|
|
424
|
-
Provides summary information for all events associated with a particular timecard.
|
|
424
|
+
Provides summary information for all events associated with a particular timecard. <aside> Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. </aside>
|
|
425
425
|
|
|
426
426
|
### Example
|
|
427
427
|
```ruby
|
|
@@ -439,7 +439,7 @@ timecard_id = "timecard_id_example" # String | The ID of the timecard to list ev
|
|
|
439
439
|
|
|
440
440
|
|
|
441
441
|
begin
|
|
442
|
-
#
|
|
442
|
+
#ListTimecardEvents
|
|
443
443
|
result = api_instance.list_timecard_events(timecard_id)
|
|
444
444
|
p result
|
|
445
445
|
rescue SquareConnect::ApiError => e
|
|
@@ -471,7 +471,7 @@ Name | Type | Description | Notes
|
|
|
471
471
|
# **list_timecards**
|
|
472
472
|
> Array<V1Timecard> list_timecards(opts)
|
|
473
473
|
|
|
474
|
-
|
|
474
|
+
ListTimecards
|
|
475
475
|
|
|
476
476
|
Provides summary information for all of a business's employee timecards.
|
|
477
477
|
|
|
@@ -502,7 +502,7 @@ opts = {
|
|
|
502
502
|
}
|
|
503
503
|
|
|
504
504
|
begin
|
|
505
|
-
#
|
|
505
|
+
#ListTimecards
|
|
506
506
|
result = api_instance.list_timecards(opts)
|
|
507
507
|
p result
|
|
508
508
|
rescue SquareConnect::ApiError => e
|
|
@@ -544,7 +544,7 @@ Name | Type | Description | Notes
|
|
|
544
544
|
# **retrieve_cash_drawer_shift**
|
|
545
545
|
> V1CashDrawerShift retrieve_cash_drawer_shift(location_id, shift_id)
|
|
546
546
|
|
|
547
|
-
|
|
547
|
+
RetrieveCashDrawerShift
|
|
548
548
|
|
|
549
549
|
Provides the details for a single cash drawer shift, including all events that occurred during the shift.
|
|
550
550
|
|
|
@@ -566,7 +566,7 @@ shift_id = "shift_id_example" # String | The shift's ID.
|
|
|
566
566
|
|
|
567
567
|
|
|
568
568
|
begin
|
|
569
|
-
#
|
|
569
|
+
#RetrieveCashDrawerShift
|
|
570
570
|
result = api_instance.retrieve_cash_drawer_shift(location_id, shift_id)
|
|
571
571
|
p result
|
|
572
572
|
rescue SquareConnect::ApiError => e
|
|
@@ -599,7 +599,7 @@ Name | Type | Description | Notes
|
|
|
599
599
|
# **retrieve_employee**
|
|
600
600
|
> V1Employee retrieve_employee(employee_id)
|
|
601
601
|
|
|
602
|
-
|
|
602
|
+
RetrieveEmployee
|
|
603
603
|
|
|
604
604
|
Provides the details for a single employee.
|
|
605
605
|
|
|
@@ -619,7 +619,7 @@ employee_id = "employee_id_example" # String | The employee's ID.
|
|
|
619
619
|
|
|
620
620
|
|
|
621
621
|
begin
|
|
622
|
-
#
|
|
622
|
+
#RetrieveEmployee
|
|
623
623
|
result = api_instance.retrieve_employee(employee_id)
|
|
624
624
|
p result
|
|
625
625
|
rescue SquareConnect::ApiError => e
|
|
@@ -651,7 +651,7 @@ Name | Type | Description | Notes
|
|
|
651
651
|
# **retrieve_employee_role**
|
|
652
652
|
> V1EmployeeRole retrieve_employee_role(role_id)
|
|
653
653
|
|
|
654
|
-
|
|
654
|
+
RetrieveEmployeeRole
|
|
655
655
|
|
|
656
656
|
Provides the details for a single employee role.
|
|
657
657
|
|
|
@@ -671,7 +671,7 @@ role_id = "role_id_example" # String | The role's ID.
|
|
|
671
671
|
|
|
672
672
|
|
|
673
673
|
begin
|
|
674
|
-
#
|
|
674
|
+
#RetrieveEmployeeRole
|
|
675
675
|
result = api_instance.retrieve_employee_role(role_id)
|
|
676
676
|
p result
|
|
677
677
|
rescue SquareConnect::ApiError => e
|
|
@@ -703,9 +703,9 @@ Name | Type | Description | Notes
|
|
|
703
703
|
# **retrieve_timecard**
|
|
704
704
|
> V1Timecard retrieve_timecard(timecard_id)
|
|
705
705
|
|
|
706
|
-
|
|
706
|
+
RetrieveTimecard
|
|
707
707
|
|
|
708
|
-
Provides the details for a single timecard.
|
|
708
|
+
Provides the details for a single timecard. <aside> Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. </aside>
|
|
709
709
|
|
|
710
710
|
### Example
|
|
711
711
|
```ruby
|
|
@@ -723,7 +723,7 @@ timecard_id = "timecard_id_example" # String | The timecard's ID.
|
|
|
723
723
|
|
|
724
724
|
|
|
725
725
|
begin
|
|
726
|
-
#
|
|
726
|
+
#RetrieveTimecard
|
|
727
727
|
result = api_instance.retrieve_timecard(timecard_id)
|
|
728
728
|
p result
|
|
729
729
|
rescue SquareConnect::ApiError => e
|
|
@@ -755,7 +755,9 @@ Name | Type | Description | Notes
|
|
|
755
755
|
# **update_employee**
|
|
756
756
|
> V1Employee update_employee(employee_id, body)
|
|
757
757
|
|
|
758
|
-
|
|
758
|
+
UpdateEmployee
|
|
759
|
+
|
|
760
|
+
|
|
759
761
|
|
|
760
762
|
### Example
|
|
761
763
|
```ruby
|
|
@@ -775,7 +777,7 @@ body = SquareConnect::V1Employee.new # V1Employee | An object containing the fie
|
|
|
775
777
|
|
|
776
778
|
|
|
777
779
|
begin
|
|
778
|
-
#
|
|
780
|
+
#UpdateEmployee
|
|
779
781
|
result = api_instance.update_employee(employee_id, body)
|
|
780
782
|
p result
|
|
781
783
|
rescue SquareConnect::ApiError => e
|
|
@@ -808,7 +810,7 @@ Name | Type | Description | Notes
|
|
|
808
810
|
# **update_employee_role**
|
|
809
811
|
> V1EmployeeRole update_employee_role(role_id, body)
|
|
810
812
|
|
|
811
|
-
|
|
813
|
+
UpdateEmployeeRole
|
|
812
814
|
|
|
813
815
|
Modifies the details of an employee role.
|
|
814
816
|
|
|
@@ -830,7 +832,7 @@ body = SquareConnect::V1EmployeeRole.new # V1EmployeeRole | An object containing
|
|
|
830
832
|
|
|
831
833
|
|
|
832
834
|
begin
|
|
833
|
-
#
|
|
835
|
+
#UpdateEmployeeRole
|
|
834
836
|
result = api_instance.update_employee_role(role_id, body)
|
|
835
837
|
p result
|
|
836
838
|
rescue SquareConnect::ApiError => e
|
|
@@ -863,9 +865,9 @@ Name | Type | Description | Notes
|
|
|
863
865
|
# **update_timecard**
|
|
864
866
|
> V1Timecard update_timecard(timecard_id, body)
|
|
865
867
|
|
|
866
|
-
|
|
868
|
+
UpdateTimecard
|
|
867
869
|
|
|
868
|
-
Modifies a timecard
|
|
870
|
+
Modifies the details of a timecard with an `API_EDIT` event for the timecard. Updating an active timecard with a `clockout_time` clocks the employee out.
|
|
869
871
|
|
|
870
872
|
### Example
|
|
871
873
|
```ruby
|
|
@@ -881,11 +883,11 @@ api_instance = SquareConnect::V1EmployeesApi.new
|
|
|
881
883
|
|
|
882
884
|
timecard_id = "timecard_id_example" # String | TThe ID of the timecard to modify.
|
|
883
885
|
|
|
884
|
-
body = SquareConnect::V1Timecard.new # V1Timecard | An object containing the fields to POST for the request.
|
|
886
|
+
body = SquareConnect::V1Timecard.new # V1Timecard | An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
885
887
|
|
|
886
888
|
|
|
887
889
|
begin
|
|
888
|
-
#
|
|
890
|
+
#UpdateTimecard
|
|
889
891
|
result = api_instance.update_timecard(timecard_id, body)
|
|
890
892
|
p result
|
|
891
893
|
rescue SquareConnect::ApiError => e
|
|
@@ -898,7 +900,7 @@ end
|
|
|
898
900
|
Name | Type | Description | Notes
|
|
899
901
|
------------- | ------------- | ------------- | -------------
|
|
900
902
|
**timecard_id** | **String**| TThe ID of the timecard to modify. |
|
|
901
|
-
**body** | [**V1Timecard**](V1Timecard.md)| An object containing the fields to POST for the request.
|
|
903
|
+
**body** | [**V1Timecard**](V1Timecard.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. |
|
|
902
904
|
|
|
903
905
|
### Return type
|
|
904
906
|
|
data/docs/V1Fee.md
CHANGED
|
@@ -2,17 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
+
V1Fee
|
|
6
|
+
|
|
5
7
|
## Properties
|
|
6
8
|
Name | Type | Description | Notes
|
|
7
9
|
------------ | ------------- | ------------- | -------------
|
|
8
10
|
**id** | **String** | The fee's unique ID. | [optional]
|
|
9
11
|
**name** | **String** | The fee's name. | [optional]
|
|
10
12
|
**rate** | **String** | The rate of the fee, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. | [optional]
|
|
11
|
-
**calculation_phase** | **String** | Forthcoming | [optional]
|
|
12
|
-
**adjustment_type** | **String** | The type of adjustment the fee applies to a payment. Currently, this value is TAX for all fees. | [optional]
|
|
13
|
+
**calculation_phase** | **String** | Forthcoming See [V1FeeCalculationPhase](#type-v1feecalculationphase) for possible values | [optional]
|
|
14
|
+
**adjustment_type** | **String** | The type of adjustment the fee applies to a payment. Currently, this value is TAX for all fees. See [V1FeeAdjustmentType](#type-v1feeadjustmenttype) for possible values | [optional]
|
|
13
15
|
**applies_to_custom_amounts** | **BOOLEAN** | If true, the fee applies to custom amounts entered into Square Register that are not associated with a particular item. | [optional]
|
|
14
16
|
**enabled** | **BOOLEAN** | If true, the fee is applied to all appropriate items. If false, the fee is not applied at all. | [optional]
|
|
15
|
-
**inclusion_type** | **String** | Whether the fee is ADDITIVE or INCLUSIVE. | [optional]
|
|
16
|
-
**type** | **String** | In countries with multiple classifications for sales taxes, indicates which classification the fee falls under. Currently relevant only to Canadian merchants. | [optional]
|
|
17
|
+
**inclusion_type** | **String** | Whether the fee is ADDITIVE or INCLUSIVE. See [V1FeeInclusionType](#type-v1feeinclusiontype) for possible values | [optional]
|
|
18
|
+
**type** | **String** | In countries with multiple classifications for sales taxes, indicates which classification the fee falls under. Currently relevant only to Canadian merchants. See [V1FeeType](#type-v1feetype) for possible values | [optional]
|
|
17
19
|
|
|
18
20
|
|