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
|
@@ -47,7 +47,7 @@ module SquareConnect
|
|
|
47
47
|
# HTTP header 'Content-Type'
|
|
48
48
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
49
49
|
|
|
50
|
-
header_params['Square-Version'] = "2019-
|
|
50
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
51
51
|
|
|
52
52
|
# form parameters
|
|
53
53
|
form_params = {}
|
|
@@ -51,7 +51,7 @@ module SquareConnect
|
|
|
51
51
|
# HTTP header 'Content-Type'
|
|
52
52
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
53
53
|
|
|
54
|
-
header_params['Square-Version'] = "2019-
|
|
54
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
55
55
|
|
|
56
56
|
# form parameters
|
|
57
57
|
form_params = {}
|
|
@@ -18,7 +18,7 @@ module SquareConnect
|
|
|
18
18
|
end
|
|
19
19
|
|
|
20
20
|
# ObtainToken
|
|
21
|
-
#
|
|
21
|
+
# Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. By default, the OAuth API lets up to 500 Square accounts authorize your application. Please [contact support](https://squareup.com/help/us/en/contact?prefill=developer_api) if you are developing an application for a larger audience. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__.
|
|
22
22
|
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
23
23
|
# @param [Hash] opts the optional parameters
|
|
24
24
|
# @return [ObtainTokenResponse]
|
|
@@ -28,7 +28,7 @@ module SquareConnect
|
|
|
28
28
|
end
|
|
29
29
|
|
|
30
30
|
# ObtainToken
|
|
31
|
-
#
|
|
31
|
+
# Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. By default, the OAuth API lets up to 500 Square accounts authorize your application. Please [contact support](https://squareup.com/help/us/en/contact?prefill=developer_api) if you are developing an application for a larger audience. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__.
|
|
32
32
|
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
33
33
|
# @param [Hash] opts the optional parameters
|
|
34
34
|
# @return [Array<(ObtainTokenResponse, Fixnum, Hash)>] ObtainTokenResponse data, response status code and response headers
|
|
@@ -51,7 +51,7 @@ module SquareConnect
|
|
|
51
51
|
# HTTP header 'Content-Type'
|
|
52
52
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
53
53
|
|
|
54
|
-
header_params['Square-Version'] = "2019-
|
|
54
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
55
55
|
|
|
56
56
|
# form parameters
|
|
57
57
|
form_params = {}
|
|
@@ -73,7 +73,7 @@ module SquareConnect
|
|
|
73
73
|
end
|
|
74
74
|
|
|
75
75
|
# RenewToken
|
|
76
|
-
# Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated
|
|
76
|
+
# `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](/authz/oauth/cookbook/oauth-renew). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps).
|
|
77
77
|
# @param client_id Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps).
|
|
78
78
|
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
79
79
|
# @param [Hash] opts the optional parameters
|
|
@@ -84,7 +84,7 @@ module SquareConnect
|
|
|
84
84
|
end
|
|
85
85
|
|
|
86
86
|
# RenewToken
|
|
87
|
-
# Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated
|
|
87
|
+
# `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](/authz/oauth/cookbook/oauth-renew). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps).
|
|
88
88
|
# @param client_id Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps).
|
|
89
89
|
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
90
90
|
# @param [Hash] opts the optional parameters
|
|
@@ -110,7 +110,7 @@ module SquareConnect
|
|
|
110
110
|
# HTTP header 'Content-Type'
|
|
111
111
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
112
112
|
|
|
113
|
-
header_params['Square-Version'] = "2019-
|
|
113
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
114
114
|
|
|
115
115
|
# form parameters
|
|
116
116
|
form_params = {}
|
|
@@ -132,7 +132,7 @@ module SquareConnect
|
|
|
132
132
|
end
|
|
133
133
|
|
|
134
134
|
# RevokeToken
|
|
135
|
-
# Revokes an access token generated with the OAuth flow. If
|
|
135
|
+
# Revokes an access token generated with the OAuth flow. If an account has more than one OAuth access token for your application, this endpoint revokes all of them, regardless of which token you specify. When an OAuth access token is revoked, all of the active subscriptions associated with that OAuth token are canceled immediately. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps).
|
|
136
136
|
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
137
137
|
# @param [Hash] opts the optional parameters
|
|
138
138
|
# @return [RevokeTokenResponse]
|
|
@@ -142,7 +142,7 @@ module SquareConnect
|
|
|
142
142
|
end
|
|
143
143
|
|
|
144
144
|
# RevokeToken
|
|
145
|
-
# Revokes an access token generated with the OAuth flow. If
|
|
145
|
+
# Revokes an access token generated with the OAuth flow. If an account has more than one OAuth access token for your application, this endpoint revokes all of them, regardless of which token you specify. When an OAuth access token is revoked, all of the active subscriptions associated with that OAuth token are canceled immediately. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps).
|
|
146
146
|
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
147
147
|
# @param [Hash] opts the optional parameters
|
|
148
148
|
# @return [Array<(RevokeTokenResponse, Fixnum, Hash)>] RevokeTokenResponse data, response status code and response headers
|
|
@@ -165,7 +165,7 @@ module SquareConnect
|
|
|
165
165
|
# HTTP header 'Content-Type'
|
|
166
166
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
167
167
|
|
|
168
|
-
header_params['Square-Version'] = "2019-
|
|
168
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
169
169
|
|
|
170
170
|
# form parameters
|
|
171
171
|
form_params = {}
|
|
@@ -55,7 +55,7 @@ module SquareConnect
|
|
|
55
55
|
# HTTP header 'Content-Type'
|
|
56
56
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
57
57
|
|
|
58
|
-
header_params['Square-Version'] = "2019-
|
|
58
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
59
59
|
|
|
60
60
|
# form parameters
|
|
61
61
|
form_params = {}
|
|
@@ -114,7 +114,7 @@ module SquareConnect
|
|
|
114
114
|
# HTTP header 'Content-Type'
|
|
115
115
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
116
116
|
|
|
117
|
-
header_params['Square-Version'] = "2019-
|
|
117
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
118
118
|
|
|
119
119
|
# form parameters
|
|
120
120
|
form_params = {}
|
|
@@ -24,7 +24,7 @@ module SquareConnect
|
|
|
24
24
|
# @option opts [String] :begin_time The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year.
|
|
25
25
|
# @option opts [String] :end_time The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time.
|
|
26
26
|
# @option opts [String] :sort_order The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`
|
|
27
|
-
# @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [
|
|
27
|
+
# @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](/basics/api101/pagination) for more information.
|
|
28
28
|
# @return [ListAdditionalRecipientReceivableRefundsResponse]
|
|
29
29
|
def list_additional_recipient_receivable_refunds(location_id, opts = {})
|
|
30
30
|
data, _status_code, _headers = list_additional_recipient_receivable_refunds_with_http_info(location_id, opts)
|
|
@@ -38,7 +38,7 @@ module SquareConnect
|
|
|
38
38
|
# @option opts [String] :begin_time The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year.
|
|
39
39
|
# @option opts [String] :end_time The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time.
|
|
40
40
|
# @option opts [String] :sort_order The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`
|
|
41
|
-
# @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [
|
|
41
|
+
# @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](/basics/api101/pagination) for more information.
|
|
42
42
|
# @return [Array<(ListAdditionalRecipientReceivableRefundsResponse, Fixnum, Hash)>] ListAdditionalRecipientReceivableRefundsResponse data, response status code and response headers
|
|
43
43
|
def list_additional_recipient_receivable_refunds_with_http_info(location_id, opts = {})
|
|
44
44
|
if @api_client.config.debugging
|
|
@@ -66,7 +66,7 @@ module SquareConnect
|
|
|
66
66
|
# HTTP header 'Content-Type'
|
|
67
67
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
68
68
|
|
|
69
|
-
header_params['Square-Version'] = "2019-
|
|
69
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
70
70
|
|
|
71
71
|
# form parameters
|
|
72
72
|
form_params = {}
|
|
@@ -94,7 +94,7 @@ module SquareConnect
|
|
|
94
94
|
# @option opts [String] :begin_time The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year.
|
|
95
95
|
# @option opts [String] :end_time The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time.
|
|
96
96
|
# @option opts [String] :sort_order The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`
|
|
97
|
-
# @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [
|
|
97
|
+
# @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](/basics/api101/pagination) for more information.
|
|
98
98
|
# @return [ListAdditionalRecipientReceivablesResponse]
|
|
99
99
|
def list_additional_recipient_receivables(location_id, opts = {})
|
|
100
100
|
data, _status_code, _headers = list_additional_recipient_receivables_with_http_info(location_id, opts)
|
|
@@ -108,7 +108,7 @@ module SquareConnect
|
|
|
108
108
|
# @option opts [String] :begin_time The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year.
|
|
109
109
|
# @option opts [String] :end_time The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time.
|
|
110
110
|
# @option opts [String] :sort_order The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`
|
|
111
|
-
# @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [
|
|
111
|
+
# @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](/basics/api101/pagination) for more information.
|
|
112
112
|
# @return [Array<(ListAdditionalRecipientReceivablesResponse, Fixnum, Hash)>] ListAdditionalRecipientReceivablesResponse data, response status code and response headers
|
|
113
113
|
def list_additional_recipient_receivables_with_http_info(location_id, opts = {})
|
|
114
114
|
if @api_client.config.debugging
|
|
@@ -136,7 +136,7 @@ module SquareConnect
|
|
|
136
136
|
# HTTP header 'Content-Type'
|
|
137
137
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
138
138
|
|
|
139
|
-
header_params['Square-Version'] = "2019-
|
|
139
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
140
140
|
|
|
141
141
|
# form parameters
|
|
142
142
|
form_params = {}
|
|
@@ -55,7 +55,7 @@ module SquareConnect
|
|
|
55
55
|
# HTTP header 'Content-Type'
|
|
56
56
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
57
57
|
|
|
58
|
-
header_params['Square-Version'] = "2019-
|
|
58
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
59
59
|
|
|
60
60
|
# form parameters
|
|
61
61
|
form_params = {}
|
|
@@ -114,7 +114,7 @@ module SquareConnect
|
|
|
114
114
|
# HTTP header 'Content-Type'
|
|
115
115
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
116
116
|
|
|
117
|
-
header_params['Square-Version'] = "2019-
|
|
117
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
118
118
|
|
|
119
119
|
# form parameters
|
|
120
120
|
form_params = {}
|
|
@@ -177,7 +177,7 @@ module SquareConnect
|
|
|
177
177
|
# HTTP header 'Content-Type'
|
|
178
178
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
179
179
|
|
|
180
|
-
header_params['Square-Version'] = "2019-
|
|
180
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
181
181
|
|
|
182
182
|
# form parameters
|
|
183
183
|
form_params = {}
|
|
@@ -205,7 +205,7 @@ module SquareConnect
|
|
|
205
205
|
# @option opts [String] :begin_time The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year.
|
|
206
206
|
# @option opts [String] :end_time The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time.
|
|
207
207
|
# @option opts [String] :sort_order The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`
|
|
208
|
-
# @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [
|
|
208
|
+
# @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](/basics/api101/pagination) for more information.
|
|
209
209
|
# @return [ListRefundsResponse]
|
|
210
210
|
def list_refunds(location_id, opts = {})
|
|
211
211
|
data, _status_code, _headers = list_refunds_with_http_info(location_id, opts)
|
|
@@ -219,7 +219,7 @@ module SquareConnect
|
|
|
219
219
|
# @option opts [String] :begin_time The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year.
|
|
220
220
|
# @option opts [String] :end_time The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time.
|
|
221
221
|
# @option opts [String] :sort_order The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`
|
|
222
|
-
# @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [
|
|
222
|
+
# @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](/basics/api101/pagination) for more information.
|
|
223
223
|
# @return [Array<(ListRefundsResponse, Fixnum, Hash)>] ListRefundsResponse data, response status code and response headers
|
|
224
224
|
def list_refunds_with_http_info(location_id, opts = {})
|
|
225
225
|
if @api_client.config.debugging
|
|
@@ -247,7 +247,7 @@ module SquareConnect
|
|
|
247
247
|
# HTTP header 'Content-Type'
|
|
248
248
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
249
249
|
|
|
250
|
-
header_params['Square-Version'] = "2019-
|
|
250
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
251
251
|
|
|
252
252
|
# form parameters
|
|
253
253
|
form_params = {}
|
|
@@ -275,7 +275,7 @@ module SquareConnect
|
|
|
275
275
|
# @option opts [String] :begin_time The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year.
|
|
276
276
|
# @option opts [String] :end_time The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time.
|
|
277
277
|
# @option opts [String] :sort_order The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`
|
|
278
|
-
# @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [
|
|
278
|
+
# @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](/basics/api101/pagination) for more information.
|
|
279
279
|
# @return [ListTransactionsResponse]
|
|
280
280
|
def list_transactions(location_id, opts = {})
|
|
281
281
|
data, _status_code, _headers = list_transactions_with_http_info(location_id, opts)
|
|
@@ -289,7 +289,7 @@ module SquareConnect
|
|
|
289
289
|
# @option opts [String] :begin_time The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year.
|
|
290
290
|
# @option opts [String] :end_time The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time.
|
|
291
291
|
# @option opts [String] :sort_order The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`
|
|
292
|
-
# @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [
|
|
292
|
+
# @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](/basics/api101/pagination) for more information.
|
|
293
293
|
# @return [Array<(ListTransactionsResponse, Fixnum, Hash)>] ListTransactionsResponse data, response status code and response headers
|
|
294
294
|
def list_transactions_with_http_info(location_id, opts = {})
|
|
295
295
|
if @api_client.config.debugging
|
|
@@ -317,7 +317,7 @@ module SquareConnect
|
|
|
317
317
|
# HTTP header 'Content-Type'
|
|
318
318
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
319
319
|
|
|
320
|
-
header_params['Square-Version'] = "2019-
|
|
320
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
321
321
|
|
|
322
322
|
# form parameters
|
|
323
323
|
form_params = {}
|
|
@@ -376,7 +376,7 @@ module SquareConnect
|
|
|
376
376
|
# HTTP header 'Content-Type'
|
|
377
377
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
378
378
|
|
|
379
|
-
header_params['Square-Version'] = "2019-
|
|
379
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
380
380
|
|
|
381
381
|
# form parameters
|
|
382
382
|
form_params = {}
|
|
@@ -435,7 +435,7 @@ module SquareConnect
|
|
|
435
435
|
# HTTP header 'Content-Type'
|
|
436
436
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
437
437
|
|
|
438
|
-
header_params['Square-Version'] = "2019-
|
|
438
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
439
439
|
|
|
440
440
|
# form parameters
|
|
441
441
|
form_params = {}
|
|
@@ -17,8 +17,8 @@ module SquareConnect
|
|
|
17
17
|
@api_client = api_client
|
|
18
18
|
end
|
|
19
19
|
|
|
20
|
-
#
|
|
21
|
-
#
|
|
20
|
+
# CreateEmployee
|
|
21
|
+
# 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>
|
|
22
22
|
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
23
23
|
# @param [Hash] opts the optional parameters
|
|
24
24
|
# @return [V1Employee]
|
|
@@ -27,8 +27,8 @@ module SquareConnect
|
|
|
27
27
|
return data
|
|
28
28
|
end
|
|
29
29
|
|
|
30
|
-
#
|
|
31
|
-
#
|
|
30
|
+
# CreateEmployee
|
|
31
|
+
# 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>
|
|
32
32
|
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
33
33
|
# @param [Hash] opts the optional parameters
|
|
34
34
|
# @return [Array<(V1Employee, Fixnum, Hash)>] V1Employee data, response status code and response headers
|
|
@@ -51,6 +51,7 @@ module SquareConnect
|
|
|
51
51
|
# HTTP header 'Content-Type'
|
|
52
52
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
53
53
|
|
|
54
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
54
55
|
|
|
55
56
|
# form parameters
|
|
56
57
|
form_params = {}
|
|
@@ -71,8 +72,8 @@ module SquareConnect
|
|
|
71
72
|
return data, status_code, headers
|
|
72
73
|
end
|
|
73
74
|
|
|
74
|
-
#
|
|
75
|
-
# Creates an employee role you can then assign to employees.
|
|
75
|
+
# CreateEmployeeRole
|
|
76
|
+
# 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.
|
|
76
77
|
# @param employee_role An EmployeeRole object with a name and permissions, and an optional owner flag.
|
|
77
78
|
# @param [Hash] opts the optional parameters
|
|
78
79
|
# @return [V1EmployeeRole]
|
|
@@ -81,8 +82,8 @@ module SquareConnect
|
|
|
81
82
|
return data
|
|
82
83
|
end
|
|
83
84
|
|
|
84
|
-
#
|
|
85
|
-
# Creates an employee role you can then assign to employees.
|
|
85
|
+
# CreateEmployeeRole
|
|
86
|
+
# 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.
|
|
86
87
|
# @param employee_role An EmployeeRole object with a name and permissions, and an optional owner flag.
|
|
87
88
|
# @param [Hash] opts the optional parameters
|
|
88
89
|
# @return [Array<(V1EmployeeRole, Fixnum, Hash)>] V1EmployeeRole data, response status code and response headers
|
|
@@ -105,6 +106,7 @@ module SquareConnect
|
|
|
105
106
|
# HTTP header 'Content-Type'
|
|
106
107
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
107
108
|
|
|
109
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
108
110
|
|
|
109
111
|
# form parameters
|
|
110
112
|
form_params = {}
|
|
@@ -125,8 +127,8 @@ module SquareConnect
|
|
|
125
127
|
return data, status_code, headers
|
|
126
128
|
end
|
|
127
129
|
|
|
128
|
-
#
|
|
129
|
-
# Creates a timecard for an employee.
|
|
130
|
+
# CreateTimecard
|
|
131
|
+
# 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.
|
|
130
132
|
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
131
133
|
# @param [Hash] opts the optional parameters
|
|
132
134
|
# @return [V1Timecard]
|
|
@@ -135,8 +137,8 @@ module SquareConnect
|
|
|
135
137
|
return data
|
|
136
138
|
end
|
|
137
139
|
|
|
138
|
-
#
|
|
139
|
-
# Creates a timecard for an employee.
|
|
140
|
+
# CreateTimecard
|
|
141
|
+
# 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.
|
|
140
142
|
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
141
143
|
# @param [Hash] opts the optional parameters
|
|
142
144
|
# @return [Array<(V1Timecard, Fixnum, Hash)>] V1Timecard data, response status code and response headers
|
|
@@ -159,6 +161,7 @@ module SquareConnect
|
|
|
159
161
|
# HTTP header 'Content-Type'
|
|
160
162
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
161
163
|
|
|
164
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
162
165
|
|
|
163
166
|
# form parameters
|
|
164
167
|
form_params = {}
|
|
@@ -179,8 +182,8 @@ module SquareConnect
|
|
|
179
182
|
return data, status_code, headers
|
|
180
183
|
end
|
|
181
184
|
|
|
182
|
-
#
|
|
183
|
-
# Deletes a timecard. Deleted timecards are still accessible
|
|
185
|
+
# DeleteTimecard
|
|
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>
|
|
184
187
|
# @param timecard_id The ID of the timecard to delete.
|
|
185
188
|
# @param [Hash] opts the optional parameters
|
|
186
189
|
# @return [Object]
|
|
@@ -189,8 +192,8 @@ module SquareConnect
|
|
|
189
192
|
return data
|
|
190
193
|
end
|
|
191
194
|
|
|
192
|
-
#
|
|
193
|
-
# Deletes a timecard. Deleted timecards are still accessible
|
|
195
|
+
# DeleteTimecard
|
|
196
|
+
# 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>
|
|
194
197
|
# @param timecard_id The ID of the timecard to delete.
|
|
195
198
|
# @param [Hash] opts the optional parameters
|
|
196
199
|
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
|
@@ -213,6 +216,7 @@ module SquareConnect
|
|
|
213
216
|
# HTTP header 'Content-Type'
|
|
214
217
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
215
218
|
|
|
219
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
216
220
|
|
|
217
221
|
# form parameters
|
|
218
222
|
form_params = {}
|
|
@@ -233,7 +237,7 @@ module SquareConnect
|
|
|
233
237
|
return data, status_code, headers
|
|
234
238
|
end
|
|
235
239
|
|
|
236
|
-
#
|
|
240
|
+
# ListCashDrawerShifts
|
|
237
241
|
# 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.
|
|
238
242
|
# @param location_id The ID of the location to list cash drawer shifts for.
|
|
239
243
|
# @param [Hash] opts the optional parameters
|
|
@@ -246,7 +250,7 @@ module SquareConnect
|
|
|
246
250
|
return data
|
|
247
251
|
end
|
|
248
252
|
|
|
249
|
-
#
|
|
253
|
+
# ListCashDrawerShifts
|
|
250
254
|
# 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.
|
|
251
255
|
# @param location_id The ID of the location to list cash drawer shifts for.
|
|
252
256
|
# @param [Hash] opts the optional parameters
|
|
@@ -260,8 +264,8 @@ module SquareConnect
|
|
|
260
264
|
end
|
|
261
265
|
# verify the required parameter 'location_id' is set
|
|
262
266
|
fail ArgumentError, "Missing the required parameter 'location_id' when calling V1EmployeesApi.list_cash_drawer_shifts" if location_id.nil?
|
|
263
|
-
if opts[:'order'] && !['
|
|
264
|
-
fail ArgumentError, 'invalid value for "order", must be one of
|
|
267
|
+
if opts[:'order'] && !['DESC', 'ASC'].include?(opts[:'order'])
|
|
268
|
+
fail ArgumentError, 'invalid value for "order", must be one of DESC, ASC'
|
|
265
269
|
end
|
|
266
270
|
# resource path
|
|
267
271
|
local_var_path = "/v1/{location_id}/cash-drawer-shifts".sub('{format}','json').sub('{' + 'location_id' + '}', location_id.to_s)
|
|
@@ -279,6 +283,7 @@ module SquareConnect
|
|
|
279
283
|
# HTTP header 'Content-Type'
|
|
280
284
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
281
285
|
|
|
286
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
282
287
|
|
|
283
288
|
# form parameters
|
|
284
289
|
form_params = {}
|
|
@@ -299,10 +304,10 @@ module SquareConnect
|
|
|
299
304
|
return data, status_code, headers
|
|
300
305
|
end
|
|
301
306
|
|
|
302
|
-
#
|
|
307
|
+
# ListEmployeeRoles
|
|
303
308
|
# Provides summary information for all of a business's employee roles.
|
|
304
309
|
# @param [Hash] opts the optional parameters
|
|
305
|
-
# @option opts [String] :order The order in which employees are listed in the response, based on their created_at field.Default value: ASC
|
|
310
|
+
# @option opts [String] :order The order in which employees are listed in the response, based on their created_at field.Default value: ASC
|
|
306
311
|
# @option opts [Integer] :limit The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
|
|
307
312
|
# @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
|
|
308
313
|
# @return [Array<V1EmployeeRole>]
|
|
@@ -311,10 +316,10 @@ module SquareConnect
|
|
|
311
316
|
return data
|
|
312
317
|
end
|
|
313
318
|
|
|
314
|
-
#
|
|
319
|
+
# ListEmployeeRoles
|
|
315
320
|
# Provides summary information for all of a business's employee roles.
|
|
316
321
|
# @param [Hash] opts the optional parameters
|
|
317
|
-
# @option opts [String] :order The order in which employees are listed in the response, based on their created_at field.Default value: ASC
|
|
322
|
+
# @option opts [String] :order The order in which employees are listed in the response, based on their created_at field.Default value: ASC
|
|
318
323
|
# @option opts [Integer] :limit The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
|
|
319
324
|
# @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
|
|
320
325
|
# @return [Array<(Array<V1EmployeeRole>, Fixnum, Hash)>] Array<V1EmployeeRole> data, response status code and response headers
|
|
@@ -322,13 +327,9 @@ module SquareConnect
|
|
|
322
327
|
if @api_client.config.debugging
|
|
323
328
|
@api_client.config.logger.debug "Calling API: V1EmployeesApi.list_employee_roles ..."
|
|
324
329
|
end
|
|
325
|
-
if opts[:'order'] && !['
|
|
326
|
-
fail ArgumentError, 'invalid value for "order", must be one of
|
|
327
|
-
end
|
|
328
|
-
if !opts[:'limit'].nil? && opts[:'limit'] > 200
|
|
329
|
-
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling V1EmployeesApi.list_employee_roles, must be smaller than or equal to 200.'
|
|
330
|
+
if opts[:'order'] && !['DESC', 'ASC'].include?(opts[:'order'])
|
|
331
|
+
fail ArgumentError, 'invalid value for "order", must be one of DESC, ASC'
|
|
330
332
|
end
|
|
331
|
-
|
|
332
333
|
# resource path
|
|
333
334
|
local_var_path = "/v1/me/roles".sub('{format}','json')
|
|
334
335
|
|
|
@@ -345,6 +346,7 @@ module SquareConnect
|
|
|
345
346
|
# HTTP header 'Content-Type'
|
|
346
347
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
347
348
|
|
|
349
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
348
350
|
|
|
349
351
|
# form parameters
|
|
350
352
|
form_params = {}
|
|
@@ -365,10 +367,10 @@ module SquareConnect
|
|
|
365
367
|
return data, status_code, headers
|
|
366
368
|
end
|
|
367
369
|
|
|
368
|
-
#
|
|
370
|
+
# ListEmployees
|
|
369
371
|
# Provides summary information for all of a business's employees.
|
|
370
372
|
# @param [Hash] opts the optional parameters
|
|
371
|
-
# @option opts [String] :order The order in which employees are listed in the response, based on their created_at field. Default value: ASC
|
|
373
|
+
# @option opts [String] :order The order in which employees are listed in the response, based on their created_at field. Default value: ASC
|
|
372
374
|
# @option opts [String] :begin_updated_at If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format
|
|
373
375
|
# @option opts [String] :end_updated_at If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format.
|
|
374
376
|
# @option opts [String] :begin_created_at If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format.
|
|
@@ -383,10 +385,10 @@ module SquareConnect
|
|
|
383
385
|
return data
|
|
384
386
|
end
|
|
385
387
|
|
|
386
|
-
#
|
|
388
|
+
# ListEmployees
|
|
387
389
|
# Provides summary information for all of a business's employees.
|
|
388
390
|
# @param [Hash] opts the optional parameters
|
|
389
|
-
# @option opts [String] :order The order in which employees are listed in the response, based on their created_at field. Default value: ASC
|
|
391
|
+
# @option opts [String] :order The order in which employees are listed in the response, based on their created_at field. Default value: ASC
|
|
390
392
|
# @option opts [String] :begin_updated_at If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format
|
|
391
393
|
# @option opts [String] :end_updated_at If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format.
|
|
392
394
|
# @option opts [String] :begin_created_at If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format.
|
|
@@ -400,16 +402,12 @@ module SquareConnect
|
|
|
400
402
|
if @api_client.config.debugging
|
|
401
403
|
@api_client.config.logger.debug "Calling API: V1EmployeesApi.list_employees ..."
|
|
402
404
|
end
|
|
403
|
-
if opts[:'order'] && !['
|
|
404
|
-
fail ArgumentError, 'invalid value for "order", must be one of
|
|
405
|
+
if opts[:'order'] && !['DESC', 'ASC'].include?(opts[:'order'])
|
|
406
|
+
fail ArgumentError, 'invalid value for "order", must be one of DESC, ASC'
|
|
405
407
|
end
|
|
406
408
|
if opts[:'status'] && !['ACTIVE', 'INACTIVE'].include?(opts[:'status'])
|
|
407
409
|
fail ArgumentError, 'invalid value for "status", must be one of ACTIVE, INACTIVE'
|
|
408
410
|
end
|
|
409
|
-
if !opts[:'limit'].nil? && opts[:'limit'] > 200
|
|
410
|
-
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling V1EmployeesApi.list_employees, must be smaller than or equal to 200.'
|
|
411
|
-
end
|
|
412
|
-
|
|
413
411
|
# resource path
|
|
414
412
|
local_var_path = "/v1/me/employees".sub('{format}','json')
|
|
415
413
|
|
|
@@ -432,6 +430,7 @@ module SquareConnect
|
|
|
432
430
|
# HTTP header 'Content-Type'
|
|
433
431
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
434
432
|
|
|
433
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
435
434
|
|
|
436
435
|
# form parameters
|
|
437
436
|
form_params = {}
|
|
@@ -452,8 +451,8 @@ module SquareConnect
|
|
|
452
451
|
return data, status_code, headers
|
|
453
452
|
end
|
|
454
453
|
|
|
455
|
-
#
|
|
456
|
-
# Provides summary information for all events associated with a particular timecard.
|
|
454
|
+
# ListTimecardEvents
|
|
455
|
+
# 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>
|
|
457
456
|
# @param timecard_id The ID of the timecard to list events for.
|
|
458
457
|
# @param [Hash] opts the optional parameters
|
|
459
458
|
# @return [Array<V1TimecardEvent>]
|
|
@@ -462,8 +461,8 @@ module SquareConnect
|
|
|
462
461
|
return data
|
|
463
462
|
end
|
|
464
463
|
|
|
465
|
-
#
|
|
466
|
-
# Provides summary information for all events associated with a particular timecard.
|
|
464
|
+
# ListTimecardEvents
|
|
465
|
+
# 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>
|
|
467
466
|
# @param timecard_id The ID of the timecard to list events for.
|
|
468
467
|
# @param [Hash] opts the optional parameters
|
|
469
468
|
# @return [Array<(Array<V1TimecardEvent>, Fixnum, Hash)>] Array<V1TimecardEvent> data, response status code and response headers
|
|
@@ -474,10 +473,11 @@ module SquareConnect
|
|
|
474
473
|
# verify the required parameter 'timecard_id' is set
|
|
475
474
|
fail ArgumentError, "Missing the required parameter 'timecard_id' when calling V1EmployeesApi.list_timecard_events" if timecard_id.nil?
|
|
476
475
|
# resource path
|
|
477
|
-
local_var_path = "/v1/me/timecards/{timecard_id}/events".sub('{format}','json')
|
|
476
|
+
local_var_path = "/v1/me/timecards/{timecard_id}/events".sub('{format}','json')
|
|
478
477
|
|
|
479
478
|
# query parameters
|
|
480
479
|
query_params = {}
|
|
480
|
+
query_params[:'timecard_id'] = timecard_id
|
|
481
481
|
|
|
482
482
|
# header parameters
|
|
483
483
|
header_params = {}
|
|
@@ -486,6 +486,7 @@ module SquareConnect
|
|
|
486
486
|
# HTTP header 'Content-Type'
|
|
487
487
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
488
488
|
|
|
489
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
489
490
|
|
|
490
491
|
# form parameters
|
|
491
492
|
form_params = {}
|
|
@@ -506,7 +507,7 @@ module SquareConnect
|
|
|
506
507
|
return data, status_code, headers
|
|
507
508
|
end
|
|
508
509
|
|
|
509
|
-
#
|
|
510
|
+
# ListTimecards
|
|
510
511
|
# Provides summary information for all of a business's employee timecards.
|
|
511
512
|
# @param [Hash] opts the optional parameters
|
|
512
513
|
# @option opts [String] :order The order in which timecards are listed in the response, based on their created_at field.
|
|
@@ -526,7 +527,7 @@ module SquareConnect
|
|
|
526
527
|
return data
|
|
527
528
|
end
|
|
528
529
|
|
|
529
|
-
#
|
|
530
|
+
# ListTimecards
|
|
530
531
|
# Provides summary information for all of a business's employee timecards.
|
|
531
532
|
# @param [Hash] opts the optional parameters
|
|
532
533
|
# @option opts [String] :order The order in which timecards are listed in the response, based on their created_at field.
|
|
@@ -545,13 +546,9 @@ module SquareConnect
|
|
|
545
546
|
if @api_client.config.debugging
|
|
546
547
|
@api_client.config.logger.debug "Calling API: V1EmployeesApi.list_timecards ..."
|
|
547
548
|
end
|
|
548
|
-
if opts[:'order'] && !['
|
|
549
|
-
fail ArgumentError, 'invalid value for "order", must be one of
|
|
549
|
+
if opts[:'order'] && !['DESC', 'ASC'].include?(opts[:'order'])
|
|
550
|
+
fail ArgumentError, 'invalid value for "order", must be one of DESC, ASC'
|
|
550
551
|
end
|
|
551
|
-
if !opts[:'limit'].nil? && opts[:'limit'] > 200
|
|
552
|
-
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling V1EmployeesApi.list_timecards, must be smaller than or equal to 200.'
|
|
553
|
-
end
|
|
554
|
-
|
|
555
552
|
# resource path
|
|
556
553
|
local_var_path = "/v1/me/timecards".sub('{format}','json')
|
|
557
554
|
|
|
@@ -576,6 +573,7 @@ module SquareConnect
|
|
|
576
573
|
# HTTP header 'Content-Type'
|
|
577
574
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
578
575
|
|
|
576
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
579
577
|
|
|
580
578
|
# form parameters
|
|
581
579
|
form_params = {}
|
|
@@ -596,7 +594,7 @@ module SquareConnect
|
|
|
596
594
|
return data, status_code, headers
|
|
597
595
|
end
|
|
598
596
|
|
|
599
|
-
#
|
|
597
|
+
# RetrieveCashDrawerShift
|
|
600
598
|
# Provides the details for a single cash drawer shift, including all events that occurred during the shift.
|
|
601
599
|
# @param location_id The ID of the location to list cash drawer shifts for.
|
|
602
600
|
# @param shift_id The shift's ID.
|
|
@@ -607,7 +605,7 @@ module SquareConnect
|
|
|
607
605
|
return data
|
|
608
606
|
end
|
|
609
607
|
|
|
610
|
-
#
|
|
608
|
+
# RetrieveCashDrawerShift
|
|
611
609
|
# Provides the details for a single cash drawer shift, including all events that occurred during the shift.
|
|
612
610
|
# @param location_id The ID of the location to list cash drawer shifts for.
|
|
613
611
|
# @param shift_id The shift's ID.
|
|
@@ -634,6 +632,7 @@ module SquareConnect
|
|
|
634
632
|
# HTTP header 'Content-Type'
|
|
635
633
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
636
634
|
|
|
635
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
637
636
|
|
|
638
637
|
# form parameters
|
|
639
638
|
form_params = {}
|
|
@@ -654,7 +653,7 @@ module SquareConnect
|
|
|
654
653
|
return data, status_code, headers
|
|
655
654
|
end
|
|
656
655
|
|
|
657
|
-
#
|
|
656
|
+
# RetrieveEmployee
|
|
658
657
|
# Provides the details for a single employee.
|
|
659
658
|
# @param employee_id The employee's ID.
|
|
660
659
|
# @param [Hash] opts the optional parameters
|
|
@@ -664,7 +663,7 @@ module SquareConnect
|
|
|
664
663
|
return data
|
|
665
664
|
end
|
|
666
665
|
|
|
667
|
-
#
|
|
666
|
+
# RetrieveEmployee
|
|
668
667
|
# Provides the details for a single employee.
|
|
669
668
|
# @param employee_id The employee's ID.
|
|
670
669
|
# @param [Hash] opts the optional parameters
|
|
@@ -688,6 +687,7 @@ module SquareConnect
|
|
|
688
687
|
# HTTP header 'Content-Type'
|
|
689
688
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
690
689
|
|
|
690
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
691
691
|
|
|
692
692
|
# form parameters
|
|
693
693
|
form_params = {}
|
|
@@ -708,7 +708,7 @@ module SquareConnect
|
|
|
708
708
|
return data, status_code, headers
|
|
709
709
|
end
|
|
710
710
|
|
|
711
|
-
#
|
|
711
|
+
# RetrieveEmployeeRole
|
|
712
712
|
# Provides the details for a single employee role.
|
|
713
713
|
# @param role_id The role's ID.
|
|
714
714
|
# @param [Hash] opts the optional parameters
|
|
@@ -718,7 +718,7 @@ module SquareConnect
|
|
|
718
718
|
return data
|
|
719
719
|
end
|
|
720
720
|
|
|
721
|
-
#
|
|
721
|
+
# RetrieveEmployeeRole
|
|
722
722
|
# Provides the details for a single employee role.
|
|
723
723
|
# @param role_id The role's ID.
|
|
724
724
|
# @param [Hash] opts the optional parameters
|
|
@@ -742,6 +742,7 @@ module SquareConnect
|
|
|
742
742
|
# HTTP header 'Content-Type'
|
|
743
743
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
744
744
|
|
|
745
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
745
746
|
|
|
746
747
|
# form parameters
|
|
747
748
|
form_params = {}
|
|
@@ -762,8 +763,8 @@ module SquareConnect
|
|
|
762
763
|
return data, status_code, headers
|
|
763
764
|
end
|
|
764
765
|
|
|
765
|
-
#
|
|
766
|
-
# Provides the details for a single timecard.
|
|
766
|
+
# RetrieveTimecard
|
|
767
|
+
# 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>
|
|
767
768
|
# @param timecard_id The timecard's ID.
|
|
768
769
|
# @param [Hash] opts the optional parameters
|
|
769
770
|
# @return [V1Timecard]
|
|
@@ -772,8 +773,8 @@ module SquareConnect
|
|
|
772
773
|
return data
|
|
773
774
|
end
|
|
774
775
|
|
|
775
|
-
#
|
|
776
|
-
# Provides the details for a single timecard.
|
|
776
|
+
# RetrieveTimecard
|
|
777
|
+
# 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>
|
|
777
778
|
# @param timecard_id The timecard's ID.
|
|
778
779
|
# @param [Hash] opts the optional parameters
|
|
779
780
|
# @return [Array<(V1Timecard, Fixnum, Hash)>] V1Timecard data, response status code and response headers
|
|
@@ -796,6 +797,7 @@ module SquareConnect
|
|
|
796
797
|
# HTTP header 'Content-Type'
|
|
797
798
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
798
799
|
|
|
800
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
799
801
|
|
|
800
802
|
# form parameters
|
|
801
803
|
form_params = {}
|
|
@@ -816,7 +818,7 @@ module SquareConnect
|
|
|
816
818
|
return data, status_code, headers
|
|
817
819
|
end
|
|
818
820
|
|
|
819
|
-
#
|
|
821
|
+
# UpdateEmployee
|
|
820
822
|
#
|
|
821
823
|
# @param employee_id The ID of the role to modify.
|
|
822
824
|
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
@@ -827,7 +829,7 @@ module SquareConnect
|
|
|
827
829
|
return data
|
|
828
830
|
end
|
|
829
831
|
|
|
830
|
-
#
|
|
832
|
+
# UpdateEmployee
|
|
831
833
|
#
|
|
832
834
|
# @param employee_id The ID of the role to modify.
|
|
833
835
|
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
@@ -854,6 +856,7 @@ module SquareConnect
|
|
|
854
856
|
# HTTP header 'Content-Type'
|
|
855
857
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
856
858
|
|
|
859
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
857
860
|
|
|
858
861
|
# form parameters
|
|
859
862
|
form_params = {}
|
|
@@ -874,7 +877,7 @@ module SquareConnect
|
|
|
874
877
|
return data, status_code, headers
|
|
875
878
|
end
|
|
876
879
|
|
|
877
|
-
#
|
|
880
|
+
# UpdateEmployeeRole
|
|
878
881
|
# Modifies the details of an employee role.
|
|
879
882
|
# @param role_id The ID of the role to modify.
|
|
880
883
|
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
@@ -885,7 +888,7 @@ module SquareConnect
|
|
|
885
888
|
return data
|
|
886
889
|
end
|
|
887
890
|
|
|
888
|
-
#
|
|
891
|
+
# UpdateEmployeeRole
|
|
889
892
|
# Modifies the details of an employee role.
|
|
890
893
|
# @param role_id The ID of the role to modify.
|
|
891
894
|
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
@@ -912,6 +915,7 @@ module SquareConnect
|
|
|
912
915
|
# HTTP header 'Content-Type'
|
|
913
916
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
914
917
|
|
|
918
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
915
919
|
|
|
916
920
|
# form parameters
|
|
917
921
|
form_params = {}
|
|
@@ -932,10 +936,10 @@ module SquareConnect
|
|
|
932
936
|
return data, status_code, headers
|
|
933
937
|
end
|
|
934
938
|
|
|
935
|
-
#
|
|
936
|
-
# Modifies a timecard
|
|
939
|
+
# UpdateTimecard
|
|
940
|
+
# 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.
|
|
937
941
|
# @param timecard_id TThe ID of the timecard to modify.
|
|
938
|
-
# @param body An object containing the fields to POST for the request.
|
|
942
|
+
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
939
943
|
# @param [Hash] opts the optional parameters
|
|
940
944
|
# @return [V1Timecard]
|
|
941
945
|
def update_timecard(timecard_id, body, opts = {})
|
|
@@ -943,10 +947,10 @@ module SquareConnect
|
|
|
943
947
|
return data
|
|
944
948
|
end
|
|
945
949
|
|
|
946
|
-
#
|
|
947
|
-
# Modifies a timecard
|
|
950
|
+
# UpdateTimecard
|
|
951
|
+
# 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.
|
|
948
952
|
# @param timecard_id TThe ID of the timecard to modify.
|
|
949
|
-
# @param body An object containing the fields to POST for the request.
|
|
953
|
+
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
950
954
|
# @param [Hash] opts the optional parameters
|
|
951
955
|
# @return [Array<(V1Timecard, Fixnum, Hash)>] V1Timecard data, response status code and response headers
|
|
952
956
|
def update_timecard_with_http_info(timecard_id, body, opts = {})
|
|
@@ -970,6 +974,7 @@ module SquareConnect
|
|
|
970
974
|
# HTTP header 'Content-Type'
|
|
971
975
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
972
976
|
|
|
977
|
+
header_params['Square-Version'] = "2019-03-13"
|
|
973
978
|
|
|
974
979
|
# form parameters
|
|
975
980
|
form_params = {}
|