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/Error.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
-
Represents an error encountered during a request to the Connect API.
|
|
5
|
+
Represents an error encountered during a request to the Connect API.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
Name | Type | Description | Notes
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# SquareConnect::GetBreakTypeResponse
|
|
2
|
+
|
|
3
|
+
### Description
|
|
4
|
+
|
|
5
|
+
The response to a request to get a `BreakType`. Contains the requested `BreakType` objects. May contain a set of `Error` objects if the request resulted in errors.
|
|
6
|
+
|
|
7
|
+
## Properties
|
|
8
|
+
Name | Type | Description | Notes
|
|
9
|
+
------------ | ------------- | ------------- | -------------
|
|
10
|
+
**break_type** | [**BreakType**](BreakType.md) | The response object. | [optional]
|
|
11
|
+
**errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional]
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# SquareConnect::GetEmployeeWageResponse
|
|
2
|
+
|
|
3
|
+
### Description
|
|
4
|
+
|
|
5
|
+
A response to a request to get an `EmployeeWage`. Contains the requested `EmployeeWage` objects. May contain a set of `Error` objects if the request resulted in errors.
|
|
6
|
+
|
|
7
|
+
## Properties
|
|
8
|
+
Name | Type | Description | Notes
|
|
9
|
+
------------ | ------------- | ------------- | -------------
|
|
10
|
+
**employee_wage** | [**EmployeeWage**](EmployeeWage.md) | The requested `EmployeeWage` object. | [optional]
|
|
11
|
+
**errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional]
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# SquareConnect::GetShiftResponse
|
|
2
|
+
|
|
3
|
+
### Description
|
|
4
|
+
|
|
5
|
+
A response to request to get a `Shift`. Contains the requested `Shift` object. May contain a set of `Error` objects if the request resulted in errors.
|
|
6
|
+
|
|
7
|
+
## Properties
|
|
8
|
+
Name | Type | Description | Notes
|
|
9
|
+
------------ | ------------- | ------------- | -------------
|
|
10
|
+
**shift** | [**Shift**](Shift.md) | The requested `Shift`. | [optional]
|
|
11
|
+
**errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional]
|
|
12
|
+
|
|
13
|
+
|
data/docs/InventoryApi.md
CHANGED
|
@@ -244,7 +244,7 @@ catalog_object_id = "catalog_object_id_example" # String | ID of the [CatalogObj
|
|
|
244
244
|
|
|
245
245
|
opts = {
|
|
246
246
|
location_ids: "location_ids_example", # String | The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations.
|
|
247
|
-
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 the original query. See [
|
|
247
|
+
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 the original query. See [Pagination](/basics/api101/pagination) for more information.
|
|
248
248
|
}
|
|
249
249
|
|
|
250
250
|
begin
|
|
@@ -262,7 +262,7 @@ Name | Type | Description | Notes
|
|
|
262
262
|
------------- | ------------- | ------------- | -------------
|
|
263
263
|
**catalog_object_id** | **String**| ID of the [CatalogObject](#type-catalogobject) to retrieve. |
|
|
264
264
|
**location_ids** | **String**| The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations. | [optional]
|
|
265
|
-
**cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [
|
|
265
|
+
**cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](/basics/api101/pagination) for more information. | [optional]
|
|
266
266
|
|
|
267
267
|
### Return type
|
|
268
268
|
|
|
@@ -302,7 +302,7 @@ catalog_object_id = "catalog_object_id_example" # String | ID of the [CatalogObj
|
|
|
302
302
|
|
|
303
303
|
opts = {
|
|
304
304
|
location_ids: "location_ids_example", # String | The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations.
|
|
305
|
-
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 the original query. See [
|
|
305
|
+
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 the original query. See [Pagination](/basics/api101/pagination) for more information.
|
|
306
306
|
}
|
|
307
307
|
|
|
308
308
|
begin
|
|
@@ -320,7 +320,7 @@ Name | Type | Description | Notes
|
|
|
320
320
|
------------- | ------------- | ------------- | -------------
|
|
321
321
|
**catalog_object_id** | **String**| ID of the [CatalogObject](#type-catalogobject) to retrieve. |
|
|
322
322
|
**location_ids** | **String**| The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations. | [optional]
|
|
323
|
-
**cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [
|
|
323
|
+
**cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](/basics/api101/pagination) for more information. | [optional]
|
|
324
324
|
|
|
325
325
|
### Return type
|
|
326
326
|
|
data/docs/LaborApi.md
ADDED
|
@@ -0,0 +1,772 @@
|
|
|
1
|
+
# SquareConnect::LaborApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://connect.squareup.com*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create_break_type**](LaborApi.md#create_break_type) | **POST** /v2/labor/break-types | CreateBreakType
|
|
8
|
+
[**create_shift**](LaborApi.md#create_shift) | **POST** /v2/labor/shifts | CreateShift
|
|
9
|
+
[**delete_break_type**](LaborApi.md#delete_break_type) | **DELETE** /v2/labor/break-types/{id} | DeleteBreakType
|
|
10
|
+
[**delete_shift**](LaborApi.md#delete_shift) | **DELETE** /v2/labor/shifts/{id} | DeleteShift
|
|
11
|
+
[**get_break_type**](LaborApi.md#get_break_type) | **GET** /v2/labor/break-types/{id} | GetBreakType
|
|
12
|
+
[**get_employee_wage**](LaborApi.md#get_employee_wage) | **GET** /v2/labor/employee-wages/{id} | GetEmployeeWage
|
|
13
|
+
[**get_shift**](LaborApi.md#get_shift) | **GET** /v2/labor/shifts/{id} | GetShift
|
|
14
|
+
[**list_break_types**](LaborApi.md#list_break_types) | **GET** /v2/labor/break-types | ListBreakTypes
|
|
15
|
+
[**list_employee_wages**](LaborApi.md#list_employee_wages) | **GET** /v2/labor/employee-wages | ListEmployeeWages
|
|
16
|
+
[**list_workweek_configs**](LaborApi.md#list_workweek_configs) | **GET** /v2/labor/workweek-configs | ListWorkweekConfigs
|
|
17
|
+
[**search_shifts**](LaborApi.md#search_shifts) | **POST** /v2/labor/shifts/search | SearchShifts
|
|
18
|
+
[**update_break_type**](LaborApi.md#update_break_type) | **PUT** /v2/labor/break-types/{id} | UpdateBreakType
|
|
19
|
+
[**update_shift**](LaborApi.md#update_shift) | **PUT** /v2/labor/shifts/{id} | UpdateShift
|
|
20
|
+
[**update_workweek_config**](LaborApi.md#update_workweek_config) | **PUT** /v2/labor/workweek-configs/{id} | UpdateWorkweekConfig
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
# **create_break_type**
|
|
24
|
+
> CreateBreakTypeResponse create_break_type(body)
|
|
25
|
+
|
|
26
|
+
CreateBreakType
|
|
27
|
+
|
|
28
|
+
Creates a new `BreakType`. A `BreakType` is a template for creating `Break` objects. You must provide the following values in your request to this endpoint: - `location_id` - `break_name` - `expected_duration` - `is_paid` You can only have 3 `BreakType` instances per location. If you attempt to add a 4th `BreakType` for a location, an `INVALID_REQUEST_ERROR` \"Exceeded limit of 3 breaks per location.\" is returned.
|
|
29
|
+
|
|
30
|
+
### Example
|
|
31
|
+
```ruby
|
|
32
|
+
# load the gem
|
|
33
|
+
require 'square_connect'
|
|
34
|
+
# setup authorization
|
|
35
|
+
SquareConnect.configure do |config|
|
|
36
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
37
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
api_instance = SquareConnect::LaborApi.new
|
|
41
|
+
|
|
42
|
+
body = SquareConnect::CreateBreakTypeRequest.new # CreateBreakTypeRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
begin
|
|
46
|
+
#CreateBreakType
|
|
47
|
+
result = api_instance.create_break_type(body)
|
|
48
|
+
p result
|
|
49
|
+
rescue SquareConnect::ApiError => e
|
|
50
|
+
puts "Exception when calling LaborApi->create_break_type: #{e}"
|
|
51
|
+
end
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Parameters
|
|
55
|
+
|
|
56
|
+
Name | Type | Description | Notes
|
|
57
|
+
------------- | ------------- | ------------- | -------------
|
|
58
|
+
**body** | [**CreateBreakTypeRequest**](CreateBreakTypeRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. |
|
|
59
|
+
|
|
60
|
+
### Return type
|
|
61
|
+
|
|
62
|
+
[**CreateBreakTypeResponse**](CreateBreakTypeResponse.md)
|
|
63
|
+
|
|
64
|
+
### Authorization
|
|
65
|
+
|
|
66
|
+
[oauth2](../README.md#oauth2)
|
|
67
|
+
|
|
68
|
+
### HTTP request headers
|
|
69
|
+
|
|
70
|
+
- **Content-Type**: application/json
|
|
71
|
+
- **Accept**: application/json
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
# **create_shift**
|
|
76
|
+
> CreateShiftResponse create_shift(body)
|
|
77
|
+
|
|
78
|
+
CreateShift
|
|
79
|
+
|
|
80
|
+
Creates a new `Shift`. A `Shift` represents a complete work day for a single employee. You must provide the following values in your request to this endpoint: - `location_id` - `employee_id` - `start_at` An attempt to create a new `Shift` can result in a `BAD_REQUEST` error when: - The `status` of the new `Shift` is `OPEN` and the employee has another shift with an `OPEN` status. - The `start_at` date is in the future - the `start_at` or `end_at` overlaps another shift for the same employee - If `Break`s are set in the request, a break `start_at` must not be before the `Shift.start_at`. A break `end_at` must not be after the `Shift.end_at`
|
|
81
|
+
|
|
82
|
+
### Example
|
|
83
|
+
```ruby
|
|
84
|
+
# load the gem
|
|
85
|
+
require 'square_connect'
|
|
86
|
+
# setup authorization
|
|
87
|
+
SquareConnect.configure do |config|
|
|
88
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
89
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
api_instance = SquareConnect::LaborApi.new
|
|
93
|
+
|
|
94
|
+
body = SquareConnect::CreateShiftRequest.new # CreateShiftRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
begin
|
|
98
|
+
#CreateShift
|
|
99
|
+
result = api_instance.create_shift(body)
|
|
100
|
+
p result
|
|
101
|
+
rescue SquareConnect::ApiError => e
|
|
102
|
+
puts "Exception when calling LaborApi->create_shift: #{e}"
|
|
103
|
+
end
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Parameters
|
|
107
|
+
|
|
108
|
+
Name | Type | Description | Notes
|
|
109
|
+
------------- | ------------- | ------------- | -------------
|
|
110
|
+
**body** | [**CreateShiftRequest**](CreateShiftRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. |
|
|
111
|
+
|
|
112
|
+
### Return type
|
|
113
|
+
|
|
114
|
+
[**CreateShiftResponse**](CreateShiftResponse.md)
|
|
115
|
+
|
|
116
|
+
### Authorization
|
|
117
|
+
|
|
118
|
+
[oauth2](../README.md#oauth2)
|
|
119
|
+
|
|
120
|
+
### HTTP request headers
|
|
121
|
+
|
|
122
|
+
- **Content-Type**: application/json
|
|
123
|
+
- **Accept**: application/json
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
# **delete_break_type**
|
|
128
|
+
> DeleteBreakTypeResponse delete_break_type(id)
|
|
129
|
+
|
|
130
|
+
DeleteBreakType
|
|
131
|
+
|
|
132
|
+
Deletes an existing `BreakType`. A `BreakType` can be deleted even if it is referenced from a `Shift`.
|
|
133
|
+
|
|
134
|
+
### Example
|
|
135
|
+
```ruby
|
|
136
|
+
# load the gem
|
|
137
|
+
require 'square_connect'
|
|
138
|
+
# setup authorization
|
|
139
|
+
SquareConnect.configure do |config|
|
|
140
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
141
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
api_instance = SquareConnect::LaborApi.new
|
|
145
|
+
|
|
146
|
+
id = "id_example" # String | UUID for the `BreakType` being deleted.
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
begin
|
|
150
|
+
#DeleteBreakType
|
|
151
|
+
result = api_instance.delete_break_type(id)
|
|
152
|
+
p result
|
|
153
|
+
rescue SquareConnect::ApiError => e
|
|
154
|
+
puts "Exception when calling LaborApi->delete_break_type: #{e}"
|
|
155
|
+
end
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### Parameters
|
|
159
|
+
|
|
160
|
+
Name | Type | Description | Notes
|
|
161
|
+
------------- | ------------- | ------------- | -------------
|
|
162
|
+
**id** | **String**| UUID for the `BreakType` being deleted. |
|
|
163
|
+
|
|
164
|
+
### Return type
|
|
165
|
+
|
|
166
|
+
[**DeleteBreakTypeResponse**](DeleteBreakTypeResponse.md)
|
|
167
|
+
|
|
168
|
+
### Authorization
|
|
169
|
+
|
|
170
|
+
[oauth2](../README.md#oauth2)
|
|
171
|
+
|
|
172
|
+
### HTTP request headers
|
|
173
|
+
|
|
174
|
+
- **Content-Type**: application/json
|
|
175
|
+
- **Accept**: application/json
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
# **delete_shift**
|
|
180
|
+
> DeleteShiftResponse delete_shift(id)
|
|
181
|
+
|
|
182
|
+
DeleteShift
|
|
183
|
+
|
|
184
|
+
Deletes a `Shift`.
|
|
185
|
+
|
|
186
|
+
### Example
|
|
187
|
+
```ruby
|
|
188
|
+
# load the gem
|
|
189
|
+
require 'square_connect'
|
|
190
|
+
# setup authorization
|
|
191
|
+
SquareConnect.configure do |config|
|
|
192
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
193
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
194
|
+
end
|
|
195
|
+
|
|
196
|
+
api_instance = SquareConnect::LaborApi.new
|
|
197
|
+
|
|
198
|
+
id = "id_example" # String | UUID for the `Shift` being deleted.
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
begin
|
|
202
|
+
#DeleteShift
|
|
203
|
+
result = api_instance.delete_shift(id)
|
|
204
|
+
p result
|
|
205
|
+
rescue SquareConnect::ApiError => e
|
|
206
|
+
puts "Exception when calling LaborApi->delete_shift: #{e}"
|
|
207
|
+
end
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### Parameters
|
|
211
|
+
|
|
212
|
+
Name | Type | Description | Notes
|
|
213
|
+
------------- | ------------- | ------------- | -------------
|
|
214
|
+
**id** | **String**| UUID for the `Shift` being deleted. |
|
|
215
|
+
|
|
216
|
+
### Return type
|
|
217
|
+
|
|
218
|
+
[**DeleteShiftResponse**](DeleteShiftResponse.md)
|
|
219
|
+
|
|
220
|
+
### Authorization
|
|
221
|
+
|
|
222
|
+
[oauth2](../README.md#oauth2)
|
|
223
|
+
|
|
224
|
+
### HTTP request headers
|
|
225
|
+
|
|
226
|
+
- **Content-Type**: application/json
|
|
227
|
+
- **Accept**: application/json
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
# **get_break_type**
|
|
232
|
+
> GetBreakTypeResponse get_break_type(id)
|
|
233
|
+
|
|
234
|
+
GetBreakType
|
|
235
|
+
|
|
236
|
+
Returns a single `BreakType` specified by id.
|
|
237
|
+
|
|
238
|
+
### Example
|
|
239
|
+
```ruby
|
|
240
|
+
# load the gem
|
|
241
|
+
require 'square_connect'
|
|
242
|
+
# setup authorization
|
|
243
|
+
SquareConnect.configure do |config|
|
|
244
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
245
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
246
|
+
end
|
|
247
|
+
|
|
248
|
+
api_instance = SquareConnect::LaborApi.new
|
|
249
|
+
|
|
250
|
+
id = "id_example" # String | UUID for the `BreakType` being retrieved.
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
begin
|
|
254
|
+
#GetBreakType
|
|
255
|
+
result = api_instance.get_break_type(id)
|
|
256
|
+
p result
|
|
257
|
+
rescue SquareConnect::ApiError => e
|
|
258
|
+
puts "Exception when calling LaborApi->get_break_type: #{e}"
|
|
259
|
+
end
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
### Parameters
|
|
263
|
+
|
|
264
|
+
Name | Type | Description | Notes
|
|
265
|
+
------------- | ------------- | ------------- | -------------
|
|
266
|
+
**id** | **String**| UUID for the `BreakType` being retrieved. |
|
|
267
|
+
|
|
268
|
+
### Return type
|
|
269
|
+
|
|
270
|
+
[**GetBreakTypeResponse**](GetBreakTypeResponse.md)
|
|
271
|
+
|
|
272
|
+
### Authorization
|
|
273
|
+
|
|
274
|
+
[oauth2](../README.md#oauth2)
|
|
275
|
+
|
|
276
|
+
### HTTP request headers
|
|
277
|
+
|
|
278
|
+
- **Content-Type**: application/json
|
|
279
|
+
- **Accept**: application/json
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
# **get_employee_wage**
|
|
284
|
+
> GetEmployeeWageResponse get_employee_wage(id)
|
|
285
|
+
|
|
286
|
+
GetEmployeeWage
|
|
287
|
+
|
|
288
|
+
Returns a single `EmployeeWage` specified by id.
|
|
289
|
+
|
|
290
|
+
### Example
|
|
291
|
+
```ruby
|
|
292
|
+
# load the gem
|
|
293
|
+
require 'square_connect'
|
|
294
|
+
# setup authorization
|
|
295
|
+
SquareConnect.configure do |config|
|
|
296
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
297
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
298
|
+
end
|
|
299
|
+
|
|
300
|
+
api_instance = SquareConnect::LaborApi.new
|
|
301
|
+
|
|
302
|
+
id = "id_example" # String | UUID for the `EmployeeWage` being retrieved.
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
begin
|
|
306
|
+
#GetEmployeeWage
|
|
307
|
+
result = api_instance.get_employee_wage(id)
|
|
308
|
+
p result
|
|
309
|
+
rescue SquareConnect::ApiError => e
|
|
310
|
+
puts "Exception when calling LaborApi->get_employee_wage: #{e}"
|
|
311
|
+
end
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
### Parameters
|
|
315
|
+
|
|
316
|
+
Name | Type | Description | Notes
|
|
317
|
+
------------- | ------------- | ------------- | -------------
|
|
318
|
+
**id** | **String**| UUID for the `EmployeeWage` being retrieved. |
|
|
319
|
+
|
|
320
|
+
### Return type
|
|
321
|
+
|
|
322
|
+
[**GetEmployeeWageResponse**](GetEmployeeWageResponse.md)
|
|
323
|
+
|
|
324
|
+
### Authorization
|
|
325
|
+
|
|
326
|
+
[oauth2](../README.md#oauth2)
|
|
327
|
+
|
|
328
|
+
### HTTP request headers
|
|
329
|
+
|
|
330
|
+
- **Content-Type**: application/json
|
|
331
|
+
- **Accept**: application/json
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
# **get_shift**
|
|
336
|
+
> GetShiftResponse get_shift(id)
|
|
337
|
+
|
|
338
|
+
GetShift
|
|
339
|
+
|
|
340
|
+
Returns a single `Shift` specified by id.
|
|
341
|
+
|
|
342
|
+
### Example
|
|
343
|
+
```ruby
|
|
344
|
+
# load the gem
|
|
345
|
+
require 'square_connect'
|
|
346
|
+
# setup authorization
|
|
347
|
+
SquareConnect.configure do |config|
|
|
348
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
349
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
350
|
+
end
|
|
351
|
+
|
|
352
|
+
api_instance = SquareConnect::LaborApi.new
|
|
353
|
+
|
|
354
|
+
id = "id_example" # String | UUID for the `Shift` being retrieved.
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
begin
|
|
358
|
+
#GetShift
|
|
359
|
+
result = api_instance.get_shift(id)
|
|
360
|
+
p result
|
|
361
|
+
rescue SquareConnect::ApiError => e
|
|
362
|
+
puts "Exception when calling LaborApi->get_shift: #{e}"
|
|
363
|
+
end
|
|
364
|
+
```
|
|
365
|
+
|
|
366
|
+
### Parameters
|
|
367
|
+
|
|
368
|
+
Name | Type | Description | Notes
|
|
369
|
+
------------- | ------------- | ------------- | -------------
|
|
370
|
+
**id** | **String**| UUID for the `Shift` being retrieved. |
|
|
371
|
+
|
|
372
|
+
### Return type
|
|
373
|
+
|
|
374
|
+
[**GetShiftResponse**](GetShiftResponse.md)
|
|
375
|
+
|
|
376
|
+
### Authorization
|
|
377
|
+
|
|
378
|
+
[oauth2](../README.md#oauth2)
|
|
379
|
+
|
|
380
|
+
### HTTP request headers
|
|
381
|
+
|
|
382
|
+
- **Content-Type**: application/json
|
|
383
|
+
- **Accept**: application/json
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
# **list_break_types**
|
|
388
|
+
> ListBreakTypesResponse list_break_types(opts)
|
|
389
|
+
|
|
390
|
+
ListBreakTypes
|
|
391
|
+
|
|
392
|
+
Returns a paginated list of `BreakType` instances for a business.
|
|
393
|
+
|
|
394
|
+
### Example
|
|
395
|
+
```ruby
|
|
396
|
+
# load the gem
|
|
397
|
+
require 'square_connect'
|
|
398
|
+
# setup authorization
|
|
399
|
+
SquareConnect.configure do |config|
|
|
400
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
401
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
402
|
+
end
|
|
403
|
+
|
|
404
|
+
api_instance = SquareConnect::LaborApi.new
|
|
405
|
+
|
|
406
|
+
opts = {
|
|
407
|
+
location_id: "location_id_example", # String | Filter Break Types returned to only those that are associated with the specified location.
|
|
408
|
+
limit: 56, # Integer | Maximum number of Break Types to return per page. Can range between 1 and 200. The default is the maximum at 200.
|
|
409
|
+
cursor: "cursor_example" # String | Pointer to the next page of Break Type results to fetch.
|
|
410
|
+
}
|
|
411
|
+
|
|
412
|
+
begin
|
|
413
|
+
#ListBreakTypes
|
|
414
|
+
result = api_instance.list_break_types(opts)
|
|
415
|
+
p result
|
|
416
|
+
rescue SquareConnect::ApiError => e
|
|
417
|
+
puts "Exception when calling LaborApi->list_break_types: #{e}"
|
|
418
|
+
end
|
|
419
|
+
```
|
|
420
|
+
|
|
421
|
+
### Parameters
|
|
422
|
+
|
|
423
|
+
Name | Type | Description | Notes
|
|
424
|
+
------------- | ------------- | ------------- | -------------
|
|
425
|
+
**location_id** | **String**| Filter Break Types returned to only those that are associated with the specified location. | [optional]
|
|
426
|
+
**limit** | **Integer**| Maximum number of Break Types to return per page. Can range between 1 and 200. The default is the maximum at 200. | [optional]
|
|
427
|
+
**cursor** | **String**| Pointer to the next page of Break Type results to fetch. | [optional]
|
|
428
|
+
|
|
429
|
+
### Return type
|
|
430
|
+
|
|
431
|
+
[**ListBreakTypesResponse**](ListBreakTypesResponse.md)
|
|
432
|
+
|
|
433
|
+
### Authorization
|
|
434
|
+
|
|
435
|
+
[oauth2](../README.md#oauth2)
|
|
436
|
+
|
|
437
|
+
### HTTP request headers
|
|
438
|
+
|
|
439
|
+
- **Content-Type**: application/json
|
|
440
|
+
- **Accept**: application/json
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
# **list_employee_wages**
|
|
445
|
+
> ListEmployeeWagesResponse list_employee_wages(opts)
|
|
446
|
+
|
|
447
|
+
ListEmployeeWages
|
|
448
|
+
|
|
449
|
+
Returns a paginated list of `EmployeeWage` instances for a business.
|
|
450
|
+
|
|
451
|
+
### Example
|
|
452
|
+
```ruby
|
|
453
|
+
# load the gem
|
|
454
|
+
require 'square_connect'
|
|
455
|
+
# setup authorization
|
|
456
|
+
SquareConnect.configure do |config|
|
|
457
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
458
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
459
|
+
end
|
|
460
|
+
|
|
461
|
+
api_instance = SquareConnect::LaborApi.new
|
|
462
|
+
|
|
463
|
+
opts = {
|
|
464
|
+
employee_id: "employee_id_example", # String | Filter wages returned to only those that are associated with the specified employee.
|
|
465
|
+
limit: 56, # Integer | Maximum number of Employee Wages to return per page. Can range between 1 and 200. The default is the maximum at 200.
|
|
466
|
+
cursor: "cursor_example" # String | Pointer to the next page of Employee Wage results to fetch.
|
|
467
|
+
}
|
|
468
|
+
|
|
469
|
+
begin
|
|
470
|
+
#ListEmployeeWages
|
|
471
|
+
result = api_instance.list_employee_wages(opts)
|
|
472
|
+
p result
|
|
473
|
+
rescue SquareConnect::ApiError => e
|
|
474
|
+
puts "Exception when calling LaborApi->list_employee_wages: #{e}"
|
|
475
|
+
end
|
|
476
|
+
```
|
|
477
|
+
|
|
478
|
+
### Parameters
|
|
479
|
+
|
|
480
|
+
Name | Type | Description | Notes
|
|
481
|
+
------------- | ------------- | ------------- | -------------
|
|
482
|
+
**employee_id** | **String**| Filter wages returned to only those that are associated with the specified employee. | [optional]
|
|
483
|
+
**limit** | **Integer**| Maximum number of Employee Wages to return per page. Can range between 1 and 200. The default is the maximum at 200. | [optional]
|
|
484
|
+
**cursor** | **String**| Pointer to the next page of Employee Wage results to fetch. | [optional]
|
|
485
|
+
|
|
486
|
+
### Return type
|
|
487
|
+
|
|
488
|
+
[**ListEmployeeWagesResponse**](ListEmployeeWagesResponse.md)
|
|
489
|
+
|
|
490
|
+
### Authorization
|
|
491
|
+
|
|
492
|
+
[oauth2](../README.md#oauth2)
|
|
493
|
+
|
|
494
|
+
### HTTP request headers
|
|
495
|
+
|
|
496
|
+
- **Content-Type**: application/json
|
|
497
|
+
- **Accept**: application/json
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
# **list_workweek_configs**
|
|
502
|
+
> ListWorkweekConfigsResponse list_workweek_configs(opts)
|
|
503
|
+
|
|
504
|
+
ListWorkweekConfigs
|
|
505
|
+
|
|
506
|
+
Returns a list of `WorkweekConfig` instances for a business.
|
|
507
|
+
|
|
508
|
+
### Example
|
|
509
|
+
```ruby
|
|
510
|
+
# load the gem
|
|
511
|
+
require 'square_connect'
|
|
512
|
+
# setup authorization
|
|
513
|
+
SquareConnect.configure do |config|
|
|
514
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
515
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
516
|
+
end
|
|
517
|
+
|
|
518
|
+
api_instance = SquareConnect::LaborApi.new
|
|
519
|
+
|
|
520
|
+
opts = {
|
|
521
|
+
limit: 56, # Integer | Maximum number of Workweek Configs to return per page.
|
|
522
|
+
cursor: "cursor_example" # String | Pointer to the next page of Workweek Config results to fetch.
|
|
523
|
+
}
|
|
524
|
+
|
|
525
|
+
begin
|
|
526
|
+
#ListWorkweekConfigs
|
|
527
|
+
result = api_instance.list_workweek_configs(opts)
|
|
528
|
+
p result
|
|
529
|
+
rescue SquareConnect::ApiError => e
|
|
530
|
+
puts "Exception when calling LaborApi->list_workweek_configs: #{e}"
|
|
531
|
+
end
|
|
532
|
+
```
|
|
533
|
+
|
|
534
|
+
### Parameters
|
|
535
|
+
|
|
536
|
+
Name | Type | Description | Notes
|
|
537
|
+
------------- | ------------- | ------------- | -------------
|
|
538
|
+
**limit** | **Integer**| Maximum number of Workweek Configs to return per page. | [optional]
|
|
539
|
+
**cursor** | **String**| Pointer to the next page of Workweek Config results to fetch. | [optional]
|
|
540
|
+
|
|
541
|
+
### Return type
|
|
542
|
+
|
|
543
|
+
[**ListWorkweekConfigsResponse**](ListWorkweekConfigsResponse.md)
|
|
544
|
+
|
|
545
|
+
### Authorization
|
|
546
|
+
|
|
547
|
+
[oauth2](../README.md#oauth2)
|
|
548
|
+
|
|
549
|
+
### HTTP request headers
|
|
550
|
+
|
|
551
|
+
- **Content-Type**: application/json
|
|
552
|
+
- **Accept**: application/json
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
# **search_shifts**
|
|
557
|
+
> SearchShiftsResponse search_shifts(body)
|
|
558
|
+
|
|
559
|
+
SearchShifts
|
|
560
|
+
|
|
561
|
+
Returns a paginated list of `Shift` records for a business. The list to be returned can be filtered by: - Location IDs **and** - employee IDs **and** - shift status (`OPEN`, `CLOSED`) **and** - shift start **and** - shift end **and** - work day details The list can be sorted by: - `start_at` - `end_at` - `created_at` - `updated_at`
|
|
562
|
+
|
|
563
|
+
### Example
|
|
564
|
+
```ruby
|
|
565
|
+
# load the gem
|
|
566
|
+
require 'square_connect'
|
|
567
|
+
# setup authorization
|
|
568
|
+
SquareConnect.configure do |config|
|
|
569
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
570
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
571
|
+
end
|
|
572
|
+
|
|
573
|
+
api_instance = SquareConnect::LaborApi.new
|
|
574
|
+
|
|
575
|
+
body = SquareConnect::SearchShiftsRequest.new # SearchShiftsRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
begin
|
|
579
|
+
#SearchShifts
|
|
580
|
+
result = api_instance.search_shifts(body)
|
|
581
|
+
p result
|
|
582
|
+
rescue SquareConnect::ApiError => e
|
|
583
|
+
puts "Exception when calling LaborApi->search_shifts: #{e}"
|
|
584
|
+
end
|
|
585
|
+
```
|
|
586
|
+
|
|
587
|
+
### Parameters
|
|
588
|
+
|
|
589
|
+
Name | Type | Description | Notes
|
|
590
|
+
------------- | ------------- | ------------- | -------------
|
|
591
|
+
**body** | [**SearchShiftsRequest**](SearchShiftsRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. |
|
|
592
|
+
|
|
593
|
+
### Return type
|
|
594
|
+
|
|
595
|
+
[**SearchShiftsResponse**](SearchShiftsResponse.md)
|
|
596
|
+
|
|
597
|
+
### Authorization
|
|
598
|
+
|
|
599
|
+
[oauth2](../README.md#oauth2)
|
|
600
|
+
|
|
601
|
+
### HTTP request headers
|
|
602
|
+
|
|
603
|
+
- **Content-Type**: application/json
|
|
604
|
+
- **Accept**: application/json
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
# **update_break_type**
|
|
609
|
+
> UpdateBreakTypeResponse update_break_type(id, body)
|
|
610
|
+
|
|
611
|
+
UpdateBreakType
|
|
612
|
+
|
|
613
|
+
Updates an existing `BreakType`.
|
|
614
|
+
|
|
615
|
+
### Example
|
|
616
|
+
```ruby
|
|
617
|
+
# load the gem
|
|
618
|
+
require 'square_connect'
|
|
619
|
+
# setup authorization
|
|
620
|
+
SquareConnect.configure do |config|
|
|
621
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
622
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
623
|
+
end
|
|
624
|
+
|
|
625
|
+
api_instance = SquareConnect::LaborApi.new
|
|
626
|
+
|
|
627
|
+
id = "id_example" # String | UUID for the `BreakType` being updated.
|
|
628
|
+
|
|
629
|
+
body = SquareConnect::UpdateBreakTypeRequest.new # UpdateBreakTypeRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
begin
|
|
633
|
+
#UpdateBreakType
|
|
634
|
+
result = api_instance.update_break_type(id, body)
|
|
635
|
+
p result
|
|
636
|
+
rescue SquareConnect::ApiError => e
|
|
637
|
+
puts "Exception when calling LaborApi->update_break_type: #{e}"
|
|
638
|
+
end
|
|
639
|
+
```
|
|
640
|
+
|
|
641
|
+
### Parameters
|
|
642
|
+
|
|
643
|
+
Name | Type | Description | Notes
|
|
644
|
+
------------- | ------------- | ------------- | -------------
|
|
645
|
+
**id** | **String**| UUID for the `BreakType` being updated. |
|
|
646
|
+
**body** | [**UpdateBreakTypeRequest**](UpdateBreakTypeRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. |
|
|
647
|
+
|
|
648
|
+
### Return type
|
|
649
|
+
|
|
650
|
+
[**UpdateBreakTypeResponse**](UpdateBreakTypeResponse.md)
|
|
651
|
+
|
|
652
|
+
### Authorization
|
|
653
|
+
|
|
654
|
+
[oauth2](../README.md#oauth2)
|
|
655
|
+
|
|
656
|
+
### HTTP request headers
|
|
657
|
+
|
|
658
|
+
- **Content-Type**: application/json
|
|
659
|
+
- **Accept**: application/json
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
# **update_shift**
|
|
664
|
+
> UpdateShiftResponse update_shift(id, body)
|
|
665
|
+
|
|
666
|
+
UpdateShift
|
|
667
|
+
|
|
668
|
+
Updates an existing `Shift`. When adding a `Break` to a `Shift`, any earlier `Breaks` in the `Shift` have the `end_at` property set to a valid RFC-3339 datetime string. When closing a `Shift`, all `Break` instances in the shift must be complete with `end_at` set on each `Break`.
|
|
669
|
+
|
|
670
|
+
### Example
|
|
671
|
+
```ruby
|
|
672
|
+
# load the gem
|
|
673
|
+
require 'square_connect'
|
|
674
|
+
# setup authorization
|
|
675
|
+
SquareConnect.configure do |config|
|
|
676
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
677
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
678
|
+
end
|
|
679
|
+
|
|
680
|
+
api_instance = SquareConnect::LaborApi.new
|
|
681
|
+
|
|
682
|
+
id = "id_example" # String | ID of the object being updated.
|
|
683
|
+
|
|
684
|
+
body = SquareConnect::UpdateShiftRequest.new # UpdateShiftRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
begin
|
|
688
|
+
#UpdateShift
|
|
689
|
+
result = api_instance.update_shift(id, body)
|
|
690
|
+
p result
|
|
691
|
+
rescue SquareConnect::ApiError => e
|
|
692
|
+
puts "Exception when calling LaborApi->update_shift: #{e}"
|
|
693
|
+
end
|
|
694
|
+
```
|
|
695
|
+
|
|
696
|
+
### Parameters
|
|
697
|
+
|
|
698
|
+
Name | Type | Description | Notes
|
|
699
|
+
------------- | ------------- | ------------- | -------------
|
|
700
|
+
**id** | **String**| ID of the object being updated. |
|
|
701
|
+
**body** | [**UpdateShiftRequest**](UpdateShiftRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. |
|
|
702
|
+
|
|
703
|
+
### Return type
|
|
704
|
+
|
|
705
|
+
[**UpdateShiftResponse**](UpdateShiftResponse.md)
|
|
706
|
+
|
|
707
|
+
### Authorization
|
|
708
|
+
|
|
709
|
+
[oauth2](../README.md#oauth2)
|
|
710
|
+
|
|
711
|
+
### HTTP request headers
|
|
712
|
+
|
|
713
|
+
- **Content-Type**: application/json
|
|
714
|
+
- **Accept**: application/json
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
|
|
718
|
+
# **update_workweek_config**
|
|
719
|
+
> UpdateWorkweekConfigResponse update_workweek_config(id, body)
|
|
720
|
+
|
|
721
|
+
UpdateWorkweekConfig
|
|
722
|
+
|
|
723
|
+
Updates a `WorkweekConfig`.
|
|
724
|
+
|
|
725
|
+
### Example
|
|
726
|
+
```ruby
|
|
727
|
+
# load the gem
|
|
728
|
+
require 'square_connect'
|
|
729
|
+
# setup authorization
|
|
730
|
+
SquareConnect.configure do |config|
|
|
731
|
+
# Configure OAuth2 access token for authorization: oauth2
|
|
732
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
733
|
+
end
|
|
734
|
+
|
|
735
|
+
api_instance = SquareConnect::LaborApi.new
|
|
736
|
+
|
|
737
|
+
id = "id_example" # String | UUID for the `WorkweekConfig` object being updated.
|
|
738
|
+
|
|
739
|
+
body = SquareConnect::UpdateWorkweekConfigRequest.new # UpdateWorkweekConfigRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
begin
|
|
743
|
+
#UpdateWorkweekConfig
|
|
744
|
+
result = api_instance.update_workweek_config(id, body)
|
|
745
|
+
p result
|
|
746
|
+
rescue SquareConnect::ApiError => e
|
|
747
|
+
puts "Exception when calling LaborApi->update_workweek_config: #{e}"
|
|
748
|
+
end
|
|
749
|
+
```
|
|
750
|
+
|
|
751
|
+
### Parameters
|
|
752
|
+
|
|
753
|
+
Name | Type | Description | Notes
|
|
754
|
+
------------- | ------------- | ------------- | -------------
|
|
755
|
+
**id** | **String**| UUID for the `WorkweekConfig` object being updated. |
|
|
756
|
+
**body** | [**UpdateWorkweekConfigRequest**](UpdateWorkweekConfigRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. |
|
|
757
|
+
|
|
758
|
+
### Return type
|
|
759
|
+
|
|
760
|
+
[**UpdateWorkweekConfigResponse**](UpdateWorkweekConfigResponse.md)
|
|
761
|
+
|
|
762
|
+
### Authorization
|
|
763
|
+
|
|
764
|
+
[oauth2](../README.md#oauth2)
|
|
765
|
+
|
|
766
|
+
### HTTP request headers
|
|
767
|
+
|
|
768
|
+
- **Content-Type**: application/json
|
|
769
|
+
- **Accept**: application/json
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
|