square_connect 2.20190213.0.274 → 2.20190313.0.278
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGES.md +24 -0
- data/README.md +256 -70
- data/docs/BatchRetrieveInventoryChangesRequest.md +1 -1
- data/docs/BatchRetrieveInventoryChangesResponse.md +1 -1
- data/docs/BatchRetrieveInventoryCountsRequest.md +1 -1
- data/docs/BatchRetrieveInventoryCountsResponse.md +1 -1
- data/docs/BatchUpsertCatalogObjectsRequest.md +1 -1
- data/docs/BreakType.md +19 -0
- data/docs/Card.md +1 -1
- data/docs/CatalogApi.md +2 -2
- data/docs/CatalogItem.md +1 -1
- data/docs/CatalogItemVariation.md +1 -1
- data/docs/CatalogObject.md +1 -1
- data/docs/CatalogQuery.md +1 -1
- data/docs/ChargeRequest.md +1 -1
- data/docs/CreateBreakTypeRequest.md +13 -0
- data/docs/CreateBreakTypeResponse.md +13 -0
- data/docs/CreateCheckoutRequest.md +1 -1
- data/docs/CreateOrderRequest.md +1 -1
- data/docs/CreateRefundRequest.md +1 -1
- data/docs/CreateShiftRequest.md +13 -0
- data/docs/CreateShiftResponse.md +13 -0
- data/docs/CustomersApi.md +2 -2
- data/docs/DateRange.md +13 -0
- data/docs/DeleteBreakTypeRequest.md +11 -0
- data/docs/DeleteBreakTypeResponse.md +12 -0
- data/docs/DeleteShiftRequest.md +11 -0
- data/docs/DeleteShiftResponse.md +12 -0
- data/docs/Device.md +2 -0
- data/docs/Employee.md +18 -0
- data/docs/EmployeeStatus.md +13 -0
- data/docs/EmployeeWage.md +15 -0
- data/docs/EmployeesApi.md +121 -0
- data/docs/Error.md +1 -1
- data/docs/GetBreakTypeRequest.md +11 -0
- data/docs/GetBreakTypeResponse.md +13 -0
- data/docs/GetEmployeeWageRequest.md +11 -0
- data/docs/GetEmployeeWageResponse.md +13 -0
- data/docs/GetShiftRequest.md +11 -0
- data/docs/GetShiftResponse.md +13 -0
- data/docs/InventoryApi.md +4 -4
- data/docs/LaborApi.md +772 -0
- data/docs/ListAdditionalRecipientReceivableRefundsRequest.md +1 -1
- data/docs/ListAdditionalRecipientReceivableRefundsResponse.md +1 -1
- data/docs/ListAdditionalRecipientReceivablesRequest.md +1 -1
- data/docs/ListAdditionalRecipientReceivablesResponse.md +1 -1
- data/docs/ListBreakTypesRequest.md +14 -0
- data/docs/ListBreakTypesResponse.md +14 -0
- data/docs/ListCatalogRequest.md +1 -1
- data/docs/ListCatalogResponse.md +1 -1
- data/docs/ListCustomersRequest.md +1 -1
- data/docs/ListCustomersResponse.md +1 -1
- data/docs/ListEmployeeWagesRequest.md +14 -0
- data/docs/ListEmployeeWagesResponse.md +14 -0
- data/docs/ListEmployeesRequest.md +15 -0
- data/docs/ListEmployeesResponse.md +14 -0
- data/docs/ListRefundsRequest.md +1 -1
- data/docs/ListRefundsResponse.md +1 -1
- data/docs/ListTransactionsRequest.md +1 -1
- data/docs/ListTransactionsResponse.md +1 -1
- data/docs/ListWorkweekConfigsRequest.md +13 -0
- data/docs/ListWorkweekConfigsResponse.md +14 -0
- data/docs/ModelBreak.md +18 -0
- data/docs/OAuthApi.md +5 -5
- data/docs/ObtainTokenRequest.md +6 -3
- data/docs/ObtainTokenResponse.md +3 -2
- data/docs/ReportingApi.md +4 -4
- data/docs/RetrieveEmployeeRequest.md +11 -0
- data/docs/RetrieveEmployeeResponse.md +13 -0
- data/docs/RetrieveInventoryChangesRequest.md +1 -1
- data/docs/RetrieveInventoryChangesResponse.md +1 -1
- data/docs/RetrieveInventoryCountRequest.md +1 -1
- data/docs/RetrieveInventoryCountResponse.md +1 -1
- data/docs/SearchCatalogObjectsRequest.md +1 -1
- data/docs/SearchCatalogObjectsResponse.md +1 -1
- data/docs/SearchCustomersRequest.md +1 -1
- data/docs/SearchCustomersResponse.md +1 -1
- data/docs/SearchShiftsRequest.md +14 -0
- data/docs/SearchShiftsResponse.md +14 -0
- data/docs/Shift.md +23 -0
- data/docs/ShiftFilter.md +17 -0
- data/docs/ShiftFilterStatus.md +13 -0
- data/docs/ShiftQuery.md +13 -0
- data/docs/ShiftSort.md +13 -0
- data/docs/ShiftSortField.md +15 -0
- data/docs/ShiftStatus.md +13 -0
- data/docs/ShiftWage.md +13 -0
- data/docs/ShiftWorkday.md +14 -0
- data/docs/ShiftWorkdayMatcher.md +14 -0
- data/docs/TransactionsApi.md +4 -4
- data/docs/UpdateBreakTypeRequest.md +12 -0
- data/docs/UpdateBreakTypeResponse.md +13 -0
- data/docs/UpdateShiftRequest.md +12 -0
- data/docs/UpdateShiftResponse.md +13 -0
- data/docs/UpdateWorkweekConfigRequest.md +12 -0
- data/docs/UpdateWorkweekConfigResponse.md +13 -0
- data/docs/UpsertCatalogObjectRequest.md +1 -1
- data/docs/V1AdjustInventoryRequest.md +3 -1
- data/docs/V1AdjustInventoryRequestAdjustmentType.md +14 -0
- data/docs/V1ApplyFeeRequest.md +11 -0
- data/docs/V1ApplyModifierListRequest.md +11 -0
- data/docs/V1BankAccount.md +3 -1
- data/docs/V1BankAccountType.md +17 -0
- data/docs/V1CashDrawerEvent.md +3 -1
- data/docs/V1CashDrawerEventEventType.md +20 -0
- data/docs/V1CashDrawerShift.md +3 -1
- data/docs/V1CashDrawerShiftEventType.md +14 -0
- data/docs/V1Category.md +2 -0
- data/docs/V1CreateCategoryRequest.md +12 -0
- data/docs/V1CreateDiscountRequest.md +12 -0
- data/docs/V1CreateEmployeeRoleRequest.md +12 -0
- data/docs/V1CreateFeeRequest.md +12 -0
- data/docs/V1CreateItemRequest.md +12 -0
- data/docs/V1CreateModifierListRequest.md +12 -0
- data/docs/V1CreateModifierOptionRequest.md +12 -0
- data/docs/V1CreatePageRequest.md +12 -0
- data/docs/V1CreateRefundRequest.md +4 -2
- data/docs/V1CreateRefundRequestType.md +13 -0
- data/docs/V1CreateVariationRequest.md +12 -0
- data/docs/V1DeleteCategoryRequest.md +11 -0
- data/docs/V1DeleteDiscountRequest.md +11 -0
- data/docs/V1DeleteFeeRequest.md +11 -0
- data/docs/V1DeleteItemRequest.md +11 -0
- data/docs/V1DeleteModifierListRequest.md +11 -0
- data/docs/V1DeleteModifierOptionRequest.md +11 -0
- data/docs/V1DeletePageCellRequest.md +13 -0
- data/docs/V1DeletePageRequest.md +11 -0
- data/docs/V1DeleteTimecardRequest.md +11 -0
- data/docs/V1DeleteTimecardResponse.md +11 -0
- data/docs/V1DeleteVariationRequest.md +11 -0
- data/docs/V1Discount.md +4 -2
- data/docs/V1DiscountColor.md +20 -0
- data/docs/V1DiscountDiscountType.md +14 -0
- data/docs/V1Employee.md +1 -1
- data/docs/V1EmployeeRole.md +3 -1
- data/docs/V1EmployeeRolePermissions.md +18 -0
- data/docs/V1EmployeeStatus.md +13 -0
- data/docs/V1EmployeesApi.md +63 -61
- data/docs/V1Fee.md +6 -4
- data/docs/V1FeeAdjustmentType.md +12 -0
- data/docs/V1FeeCalculationPhase.md +14 -0
- data/docs/V1FeeInclusionType.md +13 -0
- data/docs/V1FeeType.md +19 -0
- data/docs/V1InventoryEntry.md +2 -0
- data/docs/V1Item.md +5 -3
- data/docs/V1ItemColor.md +20 -0
- data/docs/V1ItemImage.md +2 -0
- data/docs/V1ItemType.md +14 -0
- data/docs/V1ItemVisibility.md +13 -0
- data/docs/V1ItemsApi.md +130 -130
- data/docs/V1ListBankAccountsRequest.md +11 -0
- data/docs/V1ListBankAccountsResponse.md +12 -0
- data/docs/V1ListCashDrawerShiftsRequest.md +14 -0
- data/docs/V1ListCashDrawerShiftsResponse.md +12 -0
- data/docs/V1ListCategoriesRequest.md +11 -0
- data/docs/V1ListCategoriesResponse.md +12 -0
- data/docs/V1ListDiscountsRequest.md +11 -0
- data/docs/V1ListDiscountsResponse.md +12 -0
- data/docs/V1ListEmployeeRolesRequest.md +14 -0
- data/docs/V1ListEmployeeRolesResponse.md +12 -0
- data/docs/V1ListEmployeesRequest.md +20 -0
- data/docs/V1ListEmployeesRequestStatus.md +13 -0
- data/docs/V1ListEmployeesResponse.md +12 -0
- data/docs/V1ListFeesRequest.md +11 -0
- data/docs/V1ListFeesResponse.md +12 -0
- data/docs/V1ListInventoryRequest.md +13 -0
- data/docs/V1ListInventoryResponse.md +12 -0
- data/docs/V1ListItemsRequest.md +12 -0
- data/docs/V1ListItemsResponse.md +12 -0
- data/docs/V1ListLocationsRequest.md +11 -0
- data/docs/V1ListLocationsResponse.md +12 -0
- data/docs/V1ListModifierListsRequest.md +11 -0
- data/docs/V1ListModifierListsResponse.md +12 -0
- data/docs/V1ListOrdersRequest.md +14 -0
- data/docs/V1ListOrdersResponse.md +12 -0
- data/docs/V1ListPagesRequest.md +11 -0
- data/docs/V1ListPagesResponse.md +12 -0
- data/docs/V1ListPaymentsRequest.md +17 -0
- data/docs/V1ListPaymentsResponse.md +12 -0
- data/docs/V1ListRefundsRequest.md +16 -0
- data/docs/V1ListRefundsResponse.md +12 -0
- data/docs/V1ListSettlementsRequest.md +17 -0
- data/docs/V1ListSettlementsRequestStatus.md +13 -0
- data/docs/V1ListSettlementsResponse.md +12 -0
- data/docs/V1ListTimecardEventsRequest.md +12 -0
- data/docs/V1ListTimecardEventsResponse.md +12 -0
- data/docs/V1ListTimecardsRequest.md +22 -0
- data/docs/V1ListTimecardsResponse.md +12 -0
- data/docs/V1LocationsApi.md +6 -6
- data/docs/V1Merchant.md +4 -4
- data/docs/V1MerchantAccountType.md +13 -0
- data/docs/V1MerchantBusinessType.md +61 -0
- data/docs/V1ModifierList.md +3 -1
- data/docs/V1ModifierListSelectionType.md +13 -0
- data/docs/V1ModifierOption.md +2 -0
- data/docs/V1Money.md +1 -1
- data/docs/V1Order.md +3 -1
- data/docs/V1OrderHistoryEntry.md +3 -1
- data/docs/V1OrderHistoryEntryAction.md +18 -0
- data/docs/V1OrderState.md +17 -0
- data/docs/V1Page.md +2 -0
- data/docs/V1PageCell.md +4 -2
- data/docs/V1PageCellObjectType.md +15 -0
- data/docs/V1PageCellPlaceholderType.md +14 -0
- data/docs/V1Payment.md +2 -0
- data/docs/V1PaymentDiscount.md +2 -0
- data/docs/V1PaymentItemDetail.md +2 -0
- data/docs/V1PaymentItemization.md +3 -1
- data/docs/V1PaymentItemizationItemizationType.md +17 -0
- data/docs/V1PaymentModifier.md +2 -0
- data/docs/V1PaymentSurcharge.md +3 -1
- data/docs/V1PaymentSurchargeType.md +14 -0
- data/docs/V1PaymentTax.md +3 -1
- data/docs/V1PaymentTaxInclusionType.md +13 -0
- data/docs/V1Refund.md +3 -1
- data/docs/V1RefundType.md +13 -0
- data/docs/V1RemoveFeeRequest.md +11 -0
- data/docs/V1RemoveModifierListRequest.md +11 -0
- data/docs/V1RetrieveBankAccountRequest.md +11 -0
- data/docs/V1RetrieveBusinessRequest.md +11 -0
- data/docs/V1RetrieveCashDrawerShiftRequest.md +11 -0
- data/docs/V1RetrieveEmployeeRequest.md +11 -0
- data/docs/V1RetrieveEmployeeRoleRequest.md +11 -0
- data/docs/V1RetrieveItemRequest.md +11 -0
- data/docs/V1RetrieveModifierListRequest.md +11 -0
- data/docs/V1RetrieveOrderRequest.md +11 -0
- data/docs/V1RetrievePaymentRequest.md +11 -0
- data/docs/V1RetrieveSettlementRequest.md +11 -0
- data/docs/V1RetrieveTimecardRequest.md +11 -0
- data/docs/V1Settlement.md +3 -1
- data/docs/V1SettlementEntry.md +3 -1
- data/docs/V1SettlementEntryType.md +32 -0
- data/docs/V1SettlementStatus.md +13 -0
- data/docs/V1Tender.md +5 -3
- data/docs/V1TenderEntryMethod.md +18 -0
- data/docs/V1TenderType.md +19 -0
- data/docs/V1Timecard.md +1 -1
- data/docs/V1TimecardEvent.md +3 -1
- data/docs/V1TimecardEventEventType.md +19 -0
- data/docs/V1TransactionsApi.md +37 -37
- data/docs/V1UpdateCategoryRequest.md +12 -0
- data/docs/V1UpdateDiscountRequest.md +12 -0
- data/docs/V1UpdateEmployeeRequest.md +12 -0
- data/docs/V1UpdateEmployeeRoleRequest.md +12 -0
- data/docs/V1UpdateFeeRequest.md +12 -0
- data/docs/V1UpdateItemRequest.md +12 -0
- data/docs/V1UpdateModifierListRequest.md +3 -1
- data/docs/V1UpdateModifierListRequestSelectionType.md +13 -0
- data/docs/V1UpdateModifierOptionRequest.md +12 -0
- data/docs/V1UpdateOrderRequest.md +3 -1
- data/docs/V1UpdateOrderRequestAction.md +14 -0
- data/docs/V1UpdatePageCellRequest.md +12 -0
- data/docs/V1UpdatePageRequest.md +12 -0
- data/docs/V1UpdateTimecardRequest.md +12 -0
- data/docs/V1UpdateVariationRequest.md +12 -0
- data/docs/V1Variation.md +4 -2
- data/docs/V1VariationInventoryAlertType.md +17 -0
- data/docs/V1VariationPricingType.md +13 -0
- data/docs/Weekday.md +18 -0
- data/docs/WorkweekConfig.md +17 -0
- data/lib/square_connect.rb +172 -0
- data/lib/square_connect/api/apple_pay_api.rb +1 -1
- data/lib/square_connect/api/catalog_api.rb +13 -13
- data/lib/square_connect/api/checkout_api.rb +1 -1
- data/lib/square_connect/api/customers_api.rb +10 -10
- data/lib/square_connect/api/employees_api.rb +141 -0
- data/lib/square_connect/api/inventory_api.rb +11 -11
- data/lib/square_connect/api/labor_api.rb +814 -0
- data/lib/square_connect/api/locations_api.rb +1 -1
- data/lib/square_connect/api/mobile_authorization_api.rb +1 -1
- data/lib/square_connect/api/o_auth_api.rb +9 -9
- data/lib/square_connect/api/orders_api.rb +2 -2
- data/lib/square_connect/api/reporting_api.rb +6 -6
- data/lib/square_connect/api/transactions_api.rb +11 -11
- data/lib/square_connect/api/v1_employees_api.rb +78 -73
- data/lib/square_connect/api/v1_items_api.rb +140 -104
- data/lib/square_connect/api/v1_locations_api.rb +6 -4
- data/lib/square_connect/api/v1_transactions_api.rb +49 -54
- data/lib/square_connect/api_client.rb +1 -1
- data/lib/square_connect/models/batch_retrieve_inventory_changes_request.rb +1 -1
- data/lib/square_connect/models/batch_retrieve_inventory_changes_response.rb +1 -1
- data/lib/square_connect/models/batch_retrieve_inventory_counts_request.rb +1 -1
- data/lib/square_connect/models/batch_retrieve_inventory_counts_response.rb +1 -1
- data/lib/square_connect/models/batch_upsert_catalog_objects_request.rb +1 -1
- data/lib/square_connect/models/break_type.rb +349 -0
- data/lib/square_connect/models/card.rb +1 -1
- data/lib/square_connect/models/catalog_item.rb +1 -1
- data/lib/square_connect/models/catalog_item_variation.rb +1 -1
- data/lib/square_connect/models/catalog_object.rb +1 -1
- data/lib/square_connect/models/catalog_query.rb +1 -1
- data/lib/square_connect/models/charge_request.rb +1 -1
- data/lib/square_connect/models/create_break_type_request.rb +217 -0
- data/lib/square_connect/models/create_break_type_response.rb +198 -0
- data/lib/square_connect/models/create_checkout_request.rb +1 -1
- data/lib/square_connect/models/create_order_request.rb +1 -1
- data/lib/square_connect/models/create_refund_request.rb +1 -1
- data/lib/square_connect/models/create_shift_request.rb +217 -0
- data/lib/square_connect/models/create_shift_response.rb +198 -0
- data/lib/square_connect/models/date_range.rb +196 -0
- data/lib/square_connect/models/delete_break_type_request.rb +176 -0
- data/lib/square_connect/models/delete_break_type_response.rb +188 -0
- data/lib/square_connect/models/delete_shift_request.rb +176 -0
- data/lib/square_connect/models/delete_shift_response.rb +188 -0
- data/lib/square_connect/models/device.rb +1 -1
- data/lib/square_connect/models/employee.rb +281 -0
- data/lib/square_connect/models/employee_status.rb +19 -0
- data/lib/square_connect/models/employee_wage.rb +240 -0
- data/lib/square_connect/models/error.rb +1 -1
- data/lib/square_connect/models/get_break_type_request.rb +176 -0
- data/lib/square_connect/models/get_break_type_response.rb +198 -0
- data/lib/square_connect/models/get_employee_wage_request.rb +176 -0
- data/lib/square_connect/models/get_employee_wage_response.rb +198 -0
- data/lib/square_connect/models/get_shift_request.rb +176 -0
- data/lib/square_connect/models/get_shift_response.rb +198 -0
- data/lib/square_connect/models/list_additional_recipient_receivable_refunds_request.rb +1 -1
- data/lib/square_connect/models/list_additional_recipient_receivable_refunds_response.rb +1 -1
- data/lib/square_connect/models/list_additional_recipient_receivables_request.rb +1 -1
- data/lib/square_connect/models/list_additional_recipient_receivables_response.rb +1 -1
- data/lib/square_connect/models/list_break_types_request.rb +231 -0
- data/lib/square_connect/models/list_break_types_response.rb +210 -0
- data/lib/square_connect/models/list_catalog_request.rb +1 -1
- data/lib/square_connect/models/list_catalog_response.rb +1 -1
- data/lib/square_connect/models/list_customers_request.rb +1 -1
- data/lib/square_connect/models/list_customers_response.rb +1 -1
- data/lib/square_connect/models/list_employee_wages_request.rb +231 -0
- data/lib/square_connect/models/list_employee_wages_response.rb +210 -0
- data/lib/square_connect/models/list_employees_request.rb +249 -0
- data/lib/square_connect/models/list_employees_response.rb +210 -0
- data/lib/square_connect/models/list_refunds_request.rb +1 -1
- data/lib/square_connect/models/list_refunds_response.rb +1 -1
- data/lib/square_connect/models/list_transactions_request.rb +1 -1
- data/lib/square_connect/models/list_transactions_response.rb +1 -1
- data/lib/square_connect/models/list_workweek_configs_request.rb +196 -0
- data/lib/square_connect/models/list_workweek_configs_response.rb +210 -0
- data/lib/square_connect/models/model_break.rb +347 -0
- data/lib/square_connect/models/obtain_token_request.rb +37 -7
- data/lib/square_connect/models/obtain_token_response.rb +16 -6
- data/lib/square_connect/models/retrieve_employee_request.rb +176 -0
- data/lib/square_connect/models/retrieve_employee_response.rb +198 -0
- data/lib/square_connect/models/retrieve_inventory_changes_request.rb +1 -1
- data/lib/square_connect/models/retrieve_inventory_changes_response.rb +1 -1
- data/lib/square_connect/models/retrieve_inventory_count_request.rb +1 -1
- data/lib/square_connect/models/retrieve_inventory_count_response.rb +1 -1
- data/lib/square_connect/models/search_catalog_objects_request.rb +1 -1
- data/lib/square_connect/models/search_catalog_objects_response.rb +1 -1
- data/lib/square_connect/models/search_customers_request.rb +1 -1
- data/lib/square_connect/models/search_customers_response.rb +1 -1
- data/lib/square_connect/models/search_shifts_request.rb +231 -0
- data/lib/square_connect/models/search_shifts_response.rb +210 -0
- data/lib/square_connect/models/shift.rb +395 -0
- data/lib/square_connect/models/shift_filter.rb +273 -0
- data/lib/square_connect/models/shift_filter_status.rb +19 -0
- data/lib/square_connect/models/shift_query.rb +196 -0
- data/lib/square_connect/models/shift_sort.rb +241 -0
- data/lib/square_connect/models/shift_sort_field.rb +21 -0
- data/lib/square_connect/models/shift_status.rb +19 -0
- data/lib/square_connect/models/shift_wage.rb +196 -0
- data/lib/square_connect/models/shift_workday.rb +239 -0
- data/lib/square_connect/models/shift_workday_matcher.rb +20 -0
- data/lib/square_connect/models/update_break_type_request.rb +186 -0
- data/lib/square_connect/models/update_break_type_response.rb +198 -0
- data/lib/square_connect/models/update_shift_request.rb +191 -0
- data/lib/square_connect/models/update_shift_response.rb +198 -0
- data/lib/square_connect/models/update_workweek_config_request.rb +186 -0
- data/lib/square_connect/models/update_workweek_config_response.rb +198 -0
- data/lib/square_connect/models/upsert_catalog_object_request.rb +1 -1
- data/lib/square_connect/models/v1_adjust_inventory_request.rb +2 -2
- data/lib/square_connect/models/v1_adjust_inventory_request_adjustment_type.rb +20 -0
- data/lib/square_connect/models/v1_apply_fee_request.rb +176 -0
- data/lib/square_connect/models/v1_apply_modifier_list_request.rb +176 -0
- data/lib/square_connect/models/v1_bank_account.rb +2 -2
- data/lib/square_connect/models/v1_bank_account_type.rb +23 -0
- data/lib/square_connect/models/v1_cash_drawer_event.rb +2 -2
- data/lib/square_connect/models/v1_cash_drawer_event_event_type.rb +26 -0
- data/lib/square_connect/models/v1_cash_drawer_shift.rb +2 -2
- data/lib/square_connect/models/v1_cash_drawer_shift_event_type.rb +20 -0
- data/lib/square_connect/models/v1_category.rb +1 -1
- data/lib/square_connect/models/v1_create_category_request.rb +186 -0
- data/lib/square_connect/models/v1_create_discount_request.rb +186 -0
- data/lib/square_connect/models/v1_create_employee_role_request.rb +186 -0
- data/lib/square_connect/models/v1_create_fee_request.rb +186 -0
- data/lib/square_connect/models/v1_create_item_request.rb +186 -0
- data/lib/square_connect/models/v1_create_modifier_list_request.rb +186 -0
- data/lib/square_connect/models/v1_create_modifier_option_request.rb +186 -0
- data/lib/square_connect/models/v1_create_page_request.rb +186 -0
- data/lib/square_connect/models/v1_create_refund_request.rb +3 -3
- data/lib/square_connect/models/v1_create_refund_request_type.rb +19 -0
- data/lib/square_connect/models/v1_create_variation_request.rb +186 -0
- data/lib/square_connect/models/v1_delete_category_request.rb +176 -0
- data/lib/square_connect/models/v1_delete_discount_request.rb +176 -0
- data/lib/square_connect/models/v1_delete_fee_request.rb +176 -0
- data/lib/square_connect/models/v1_delete_item_request.rb +176 -0
- data/lib/square_connect/models/v1_delete_modifier_list_request.rb +176 -0
- data/lib/square_connect/models/v1_delete_modifier_option_request.rb +176 -0
- data/lib/square_connect/models/v1_delete_page_cell_request.rb +196 -0
- data/lib/square_connect/models/v1_delete_page_request.rb +176 -0
- data/lib/square_connect/models/v1_delete_timecard_request.rb +176 -0
- data/lib/square_connect/models/v1_delete_timecard_response.rb +176 -0
- data/lib/square_connect/models/v1_delete_variation_request.rb +176 -0
- data/lib/square_connect/models/v1_discount.rb +3 -3
- data/lib/square_connect/models/v1_discount_color.rb +26 -0
- data/lib/square_connect/models/v1_discount_discount_type.rb +20 -0
- data/lib/square_connect/models/v1_employee.rb +1 -1
- data/lib/square_connect/models/v1_employee_role.rb +2 -2
- data/lib/square_connect/models/v1_employee_role_permissions.rb +24 -0
- data/lib/square_connect/models/v1_employee_status.rb +19 -0
- data/lib/square_connect/models/v1_fee.rb +5 -5
- data/lib/square_connect/models/v1_fee_adjustment_type.rb +18 -0
- data/lib/square_connect/models/v1_fee_calculation_phase.rb +20 -0
- data/lib/square_connect/models/v1_fee_inclusion_type.rb +19 -0
- data/lib/square_connect/models/v1_fee_type.rb +25 -0
- data/lib/square_connect/models/v1_inventory_entry.rb +1 -1
- data/lib/square_connect/models/v1_item.rb +4 -4
- data/lib/square_connect/models/v1_item_color.rb +26 -0
- data/lib/square_connect/models/v1_item_image.rb +1 -1
- data/lib/square_connect/models/v1_item_type.rb +20 -0
- data/lib/square_connect/models/v1_item_visibility.rb +19 -0
- data/lib/square_connect/models/v1_list_bank_accounts_request.rb +176 -0
- data/lib/square_connect/models/v1_list_bank_accounts_response.rb +188 -0
- data/lib/square_connect/models/v1_list_cash_drawer_shifts_request.rb +239 -0
- data/lib/square_connect/models/v1_list_cash_drawer_shifts_response.rb +188 -0
- data/lib/square_connect/models/v1_list_categories_request.rb +176 -0
- data/lib/square_connect/models/v1_list_categories_response.rb +188 -0
- data/lib/square_connect/models/v1_list_discounts_request.rb +176 -0
- data/lib/square_connect/models/v1_list_discounts_response.rb +188 -0
- data/lib/square_connect/models/v1_list_employee_roles_request.rb +239 -0
- data/lib/square_connect/models/v1_list_employee_roles_response.rb +188 -0
- data/lib/square_connect/models/v1_list_employees_request.rb +311 -0
- data/lib/square_connect/models/v1_list_employees_request_status.rb +19 -0
- data/lib/square_connect/models/v1_list_employees_response.rb +188 -0
- data/lib/square_connect/models/v1_list_fees_request.rb +176 -0
- data/lib/square_connect/models/v1_list_fees_response.rb +188 -0
- data/lib/square_connect/models/v1_list_inventory_request.rb +196 -0
- data/lib/square_connect/models/v1_list_inventory_response.rb +188 -0
- data/lib/square_connect/models/v1_list_items_request.rb +186 -0
- data/lib/square_connect/models/v1_list_items_response.rb +188 -0
- data/lib/square_connect/models/v1_list_locations_request.rb +176 -0
- data/lib/square_connect/models/v1_list_locations_response.rb +188 -0
- data/lib/square_connect/models/v1_list_modifier_lists_request.rb +176 -0
- data/lib/square_connect/models/v1_list_modifier_lists_response.rb +188 -0
- data/lib/square_connect/models/v1_list_orders_request.rb +239 -0
- data/lib/square_connect/models/v1_list_orders_response.rb +188 -0
- data/lib/square_connect/models/v1_list_pages_request.rb +176 -0
- data/lib/square_connect/models/v1_list_pages_response.rb +188 -0
- data/lib/square_connect/models/v1_list_payments_request.rb +269 -0
- data/lib/square_connect/models/v1_list_payments_response.rb +188 -0
- data/lib/square_connect/models/v1_list_refunds_request.rb +259 -0
- data/lib/square_connect/models/v1_list_refunds_response.rb +188 -0
- data/lib/square_connect/models/v1_list_settlements_request.rb +281 -0
- data/lib/square_connect/models/v1_list_settlements_request_status.rb +19 -0
- data/lib/square_connect/models/v1_list_settlements_response.rb +188 -0
- data/lib/square_connect/models/v1_list_timecard_events_request.rb +191 -0
- data/lib/square_connect/models/v1_list_timecard_events_response.rb +188 -0
- data/lib/square_connect/models/v1_list_timecards_request.rb +319 -0
- data/lib/square_connect/models/v1_list_timecards_response.rb +188 -0
- data/lib/square_connect/models/v1_merchant.rb +10 -9
- data/lib/square_connect/models/v1_merchant_account_type.rb +19 -0
- data/lib/square_connect/models/v1_merchant_business_type.rb +67 -0
- data/lib/square_connect/models/v1_modifier_list.rb +2 -2
- data/lib/square_connect/models/v1_modifier_list_selection_type.rb +19 -0
- data/lib/square_connect/models/v1_modifier_option.rb +1 -1
- data/lib/square_connect/models/v1_money.rb +3 -3
- data/lib/square_connect/models/v1_order.rb +2 -2
- data/lib/square_connect/models/v1_order_history_entry.rb +2 -2
- data/lib/square_connect/models/v1_order_history_entry_action.rb +24 -0
- data/lib/square_connect/models/v1_order_state.rb +23 -0
- data/lib/square_connect/models/v1_page.rb +1 -1
- data/lib/square_connect/models/v1_page_cell.rb +3 -3
- data/lib/square_connect/models/v1_page_cell_object_type.rb +21 -0
- data/lib/square_connect/models/v1_page_cell_placeholder_type.rb +20 -0
- data/lib/square_connect/models/v1_payment.rb +1 -1
- data/lib/square_connect/models/v1_payment_discount.rb +1 -1
- data/lib/square_connect/models/v1_payment_item_detail.rb +1 -1
- data/lib/square_connect/models/v1_payment_itemization.rb +2 -2
- data/lib/square_connect/models/v1_payment_itemization_itemization_type.rb +23 -0
- data/lib/square_connect/models/v1_payment_modifier.rb +1 -1
- data/lib/square_connect/models/v1_payment_surcharge.rb +2 -2
- data/lib/square_connect/models/v1_payment_surcharge_type.rb +20 -0
- data/lib/square_connect/models/v1_payment_tax.rb +2 -2
- data/lib/square_connect/models/v1_payment_tax_inclusion_type.rb +19 -0
- data/lib/square_connect/models/v1_refund.rb +2 -2
- data/lib/square_connect/models/v1_refund_type.rb +19 -0
- data/lib/square_connect/models/v1_remove_fee_request.rb +176 -0
- data/lib/square_connect/models/v1_remove_modifier_list_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_bank_account_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_business_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_cash_drawer_shift_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_employee_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_employee_role_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_item_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_modifier_list_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_order_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_payment_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_settlement_request.rb +176 -0
- data/lib/square_connect/models/v1_retrieve_timecard_request.rb +176 -0
- data/lib/square_connect/models/v1_settlement.rb +2 -2
- data/lib/square_connect/models/v1_settlement_entry.rb +4 -4
- data/lib/square_connect/models/v1_settlement_entry_type.rb +38 -0
- data/lib/square_connect/models/v1_settlement_status.rb +19 -0
- data/lib/square_connect/models/v1_tender.rb +6 -6
- data/lib/square_connect/models/v1_tender_entry_method.rb +24 -0
- data/lib/square_connect/models/v1_tender_type.rb +25 -0
- data/lib/square_connect/models/v1_timecard.rb +1 -1
- data/lib/square_connect/models/v1_timecard_event.rb +2 -2
- data/lib/square_connect/models/v1_timecard_event_event_type.rb +25 -0
- data/lib/square_connect/models/v1_update_category_request.rb +191 -0
- data/lib/square_connect/models/v1_update_discount_request.rb +191 -0
- data/lib/square_connect/models/v1_update_employee_request.rb +191 -0
- data/lib/square_connect/models/v1_update_employee_role_request.rb +191 -0
- data/lib/square_connect/models/v1_update_fee_request.rb +191 -0
- data/lib/square_connect/models/v1_update_item_request.rb +191 -0
- data/lib/square_connect/models/v1_update_modifier_list_request.rb +2 -2
- data/lib/square_connect/models/v1_update_modifier_list_request_selection_type.rb +19 -0
- data/lib/square_connect/models/v1_update_modifier_option_request.rb +191 -0
- data/lib/square_connect/models/v1_update_order_request.rb +2 -2
- data/lib/square_connect/models/v1_update_order_request_action.rb +20 -0
- data/lib/square_connect/models/v1_update_page_cell_request.rb +191 -0
- data/lib/square_connect/models/v1_update_page_request.rb +191 -0
- data/lib/square_connect/models/v1_update_timecard_request.rb +191 -0
- data/lib/square_connect/models/v1_update_variation_request.rb +191 -0
- data/lib/square_connect/models/v1_variation.rb +3 -3
- data/lib/square_connect/models/v1_variation_inventory_alert_type.rb +23 -0
- data/lib/square_connect/models/v1_variation_pricing_type.rb +19 -0
- data/lib/square_connect/models/weekday.rb +24 -0
- data/lib/square_connect/models/workweek_config.rb +298 -0
- data/lib/square_connect/version.rb +1 -1
- data/spec/api/employees_api_spec.rb +59 -0
- data/spec/api/labor_api_spec.rb +208 -0
- data/spec/models/break_type_spec.rb +81 -0
- data/spec/models/create_break_type_request_spec.rb +45 -0
- data/spec/models/create_break_type_response_spec.rb +45 -0
- data/spec/models/create_shift_request_spec.rb +45 -0
- data/spec/models/create_shift_response_spec.rb +45 -0
- data/spec/models/date_range_spec.rb +45 -0
- data/spec/models/delete_break_type_request_spec.rb +33 -0
- data/spec/models/delete_break_type_response_spec.rb +39 -0
- data/spec/models/delete_shift_request_spec.rb +33 -0
- data/spec/models/delete_shift_response_spec.rb +39 -0
- data/spec/models/employee_spec.rb +79 -0
- data/spec/models/employee_status_spec.rb +33 -0
- data/spec/models/employee_wage_spec.rb +57 -0
- data/spec/models/get_break_type_request_spec.rb +33 -0
- data/spec/models/get_break_type_response_spec.rb +45 -0
- data/spec/models/get_employee_wage_request_spec.rb +33 -0
- data/spec/models/get_employee_wage_response_spec.rb +45 -0
- data/spec/models/get_shift_request_spec.rb +33 -0
- data/spec/models/get_shift_response_spec.rb +45 -0
- data/spec/models/list_break_types_request_spec.rb +51 -0
- data/spec/models/list_break_types_response_spec.rb +51 -0
- data/spec/models/list_employee_wages_request_spec.rb +51 -0
- data/spec/models/list_employee_wages_response_spec.rb +51 -0
- data/spec/models/list_employees_request_spec.rb +61 -0
- data/spec/models/list_employees_response_spec.rb +51 -0
- data/spec/models/list_workweek_configs_request_spec.rb +45 -0
- data/spec/models/list_workweek_configs_response_spec.rb +51 -0
- data/spec/models/model_break_spec.rb +75 -0
- data/spec/models/retrieve_employee_request_spec.rb +33 -0
- data/spec/models/retrieve_employee_response_spec.rb +45 -0
- data/spec/models/search_shifts_request_spec.rb +51 -0
- data/spec/models/search_shifts_response_spec.rb +51 -0
- data/spec/models/shift_filter_spec.rb +73 -0
- data/spec/models/shift_filter_status_spec.rb +33 -0
- data/spec/models/shift_query_spec.rb +45 -0
- data/spec/models/shift_sort_field_spec.rb +33 -0
- data/spec/models/shift_sort_spec.rb +53 -0
- data/spec/models/shift_spec.rb +109 -0
- data/spec/models/shift_status_spec.rb +33 -0
- data/spec/models/shift_wage_spec.rb +45 -0
- data/spec/models/shift_workday_matcher_spec.rb +33 -0
- data/spec/models/shift_workday_spec.rb +55 -0
- data/spec/models/update_break_type_request_spec.rb +39 -0
- data/spec/models/update_break_type_response_spec.rb +45 -0
- data/spec/models/update_shift_request_spec.rb +39 -0
- data/spec/models/update_shift_response_spec.rb +45 -0
- data/spec/models/update_workweek_config_request_spec.rb +39 -0
- data/spec/models/update_workweek_config_response_spec.rb +45 -0
- data/spec/models/v1_adjust_inventory_request_adjustment_type_spec.rb +33 -0
- data/spec/models/v1_apply_fee_request_spec.rb +33 -0
- data/spec/models/v1_apply_modifier_list_request_spec.rb +33 -0
- data/spec/models/v1_bank_account_type_spec.rb +33 -0
- data/spec/models/v1_cash_drawer_event_event_type_spec.rb +33 -0
- data/spec/models/v1_cash_drawer_shift_event_type_spec.rb +33 -0
- data/spec/models/v1_create_category_request_spec.rb +39 -0
- data/spec/models/v1_create_discount_request_spec.rb +39 -0
- data/spec/models/v1_create_employee_role_request_spec.rb +39 -0
- data/spec/models/v1_create_fee_request_spec.rb +39 -0
- data/spec/models/v1_create_item_request_spec.rb +39 -0
- data/spec/models/v1_create_modifier_list_request_spec.rb +39 -0
- data/spec/models/v1_create_modifier_option_request_spec.rb +39 -0
- data/spec/models/v1_create_page_request_spec.rb +39 -0
- data/spec/models/v1_create_refund_request_type_spec.rb +33 -0
- data/spec/models/v1_create_variation_request_spec.rb +39 -0
- data/spec/models/v1_delete_category_request_spec.rb +33 -0
- data/spec/models/v1_delete_discount_request_spec.rb +33 -0
- data/spec/models/v1_delete_fee_request_spec.rb +33 -0
- data/spec/models/v1_delete_item_request_spec.rb +33 -0
- data/spec/models/v1_delete_modifier_list_request_spec.rb +33 -0
- data/spec/models/v1_delete_modifier_option_request_spec.rb +33 -0
- data/spec/models/v1_delete_page_cell_request_spec.rb +45 -0
- data/spec/models/v1_delete_page_request_spec.rb +33 -0
- data/spec/models/v1_delete_timecard_request_spec.rb +33 -0
- data/spec/models/v1_delete_timecard_response_spec.rb +33 -0
- data/spec/models/v1_delete_variation_request_spec.rb +33 -0
- data/spec/models/v1_discount_color_spec.rb +33 -0
- data/spec/models/v1_discount_discount_type_spec.rb +33 -0
- data/spec/models/v1_employee_role_permissions_spec.rb +33 -0
- data/spec/models/v1_employee_status_spec.rb +33 -0
- data/spec/models/v1_fee_adjustment_type_spec.rb +33 -0
- data/spec/models/v1_fee_calculation_phase_spec.rb +33 -0
- data/spec/models/v1_fee_inclusion_type_spec.rb +33 -0
- data/spec/models/v1_fee_type_spec.rb +33 -0
- data/spec/models/v1_item_color_spec.rb +33 -0
- data/spec/models/v1_item_type_spec.rb +33 -0
- data/spec/models/v1_item_visibility_spec.rb +33 -0
- data/spec/models/v1_list_bank_accounts_request_spec.rb +33 -0
- data/spec/models/v1_list_bank_accounts_response_spec.rb +39 -0
- data/spec/models/v1_list_cash_drawer_shifts_request_spec.rb +55 -0
- data/spec/models/v1_list_cash_drawer_shifts_response_spec.rb +39 -0
- data/spec/models/v1_list_categories_request_spec.rb +33 -0
- data/spec/models/v1_list_categories_response_spec.rb +39 -0
- data/spec/models/v1_list_discounts_request_spec.rb +33 -0
- data/spec/models/v1_list_discounts_response_spec.rb +39 -0
- data/spec/models/v1_list_employee_roles_request_spec.rb +55 -0
- data/spec/models/v1_list_employee_roles_response_spec.rb +39 -0
- data/spec/models/v1_list_employees_request_spec.rb +95 -0
- data/spec/models/v1_list_employees_request_status_spec.rb +33 -0
- data/spec/models/v1_list_employees_response_spec.rb +39 -0
- data/spec/models/v1_list_fees_request_spec.rb +33 -0
- data/spec/models/v1_list_fees_response_spec.rb +39 -0
- data/spec/models/v1_list_inventory_request_spec.rb +45 -0
- data/spec/models/v1_list_inventory_response_spec.rb +39 -0
- data/spec/models/v1_list_items_request_spec.rb +39 -0
- data/spec/models/v1_list_items_response_spec.rb +39 -0
- data/spec/models/v1_list_locations_request_spec.rb +33 -0
- data/spec/models/v1_list_locations_response_spec.rb +39 -0
- data/spec/models/v1_list_modifier_lists_request_spec.rb +33 -0
- data/spec/models/v1_list_modifier_lists_response_spec.rb +39 -0
- data/spec/models/v1_list_orders_request_spec.rb +55 -0
- data/spec/models/v1_list_orders_response_spec.rb +39 -0
- data/spec/models/v1_list_pages_request_spec.rb +33 -0
- data/spec/models/v1_list_pages_response_spec.rb +39 -0
- data/spec/models/v1_list_payments_request_spec.rb +73 -0
- data/spec/models/v1_list_payments_response_spec.rb +39 -0
- data/spec/models/v1_list_refunds_request_spec.rb +67 -0
- data/spec/models/v1_list_refunds_response_spec.rb +39 -0
- data/spec/models/v1_list_settlements_request_spec.rb +77 -0
- data/spec/models/v1_list_settlements_request_status_spec.rb +33 -0
- data/spec/models/v1_list_settlements_response_spec.rb +39 -0
- data/spec/models/v1_list_timecard_events_request_spec.rb +39 -0
- data/spec/models/v1_list_timecard_events_response_spec.rb +39 -0
- data/spec/models/v1_list_timecards_request_spec.rb +103 -0
- data/spec/models/v1_list_timecards_response_spec.rb +39 -0
- data/spec/models/v1_merchant_account_type_spec.rb +33 -0
- data/spec/models/v1_merchant_business_type_spec.rb +33 -0
- data/spec/models/v1_modifier_list_selection_type_spec.rb +33 -0
- data/spec/models/v1_order_history_entry_action_spec.rb +33 -0
- data/spec/models/v1_order_state_spec.rb +33 -0
- data/spec/models/v1_page_cell_object_type_spec.rb +33 -0
- data/spec/models/v1_page_cell_placeholder_type_spec.rb +33 -0
- data/spec/models/v1_payment_itemization_itemization_type_spec.rb +33 -0
- data/spec/models/v1_payment_surcharge_type_spec.rb +33 -0
- data/spec/models/v1_payment_tax_inclusion_type_spec.rb +33 -0
- data/spec/models/v1_refund_type_spec.rb +33 -0
- data/spec/models/v1_remove_fee_request_spec.rb +33 -0
- data/spec/models/v1_remove_modifier_list_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_bank_account_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_business_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_cash_drawer_shift_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_employee_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_employee_role_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_item_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_modifier_list_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_order_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_payment_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_settlement_request_spec.rb +33 -0
- data/spec/models/v1_retrieve_timecard_request_spec.rb +33 -0
- data/spec/models/v1_settlement_entry_type_spec.rb +33 -0
- data/spec/models/v1_settlement_status_spec.rb +33 -0
- data/spec/models/v1_tender_entry_method_spec.rb +33 -0
- data/spec/models/v1_tender_type_spec.rb +33 -0
- data/spec/models/v1_timecard_event_event_type_spec.rb +33 -0
- data/spec/models/v1_update_category_request_spec.rb +39 -0
- data/spec/models/v1_update_discount_request_spec.rb +39 -0
- data/spec/models/v1_update_employee_request_spec.rb +39 -0
- data/spec/models/v1_update_employee_role_request_spec.rb +39 -0
- data/spec/models/v1_update_fee_request_spec.rb +39 -0
- data/spec/models/v1_update_item_request_spec.rb +39 -0
- data/spec/models/v1_update_modifier_list_request_selection_type_spec.rb +33 -0
- data/spec/models/v1_update_modifier_option_request_spec.rb +39 -0
- data/spec/models/v1_update_order_request_action_spec.rb +33 -0
- data/spec/models/v1_update_page_cell_request_spec.rb +39 -0
- data/spec/models/v1_update_page_request_spec.rb +39 -0
- data/spec/models/v1_update_timecard_request_spec.rb +39 -0
- data/spec/models/v1_update_variation_request_spec.rb +39 -0
- data/spec/models/v1_variation_inventory_alert_type_spec.rb +33 -0
- data/spec/models/v1_variation_pricing_type_spec.rb +33 -0
- data/spec/models/weekday_spec.rb +33 -0
- data/spec/models/workweek_config_spec.rb +73 -0
- metadata +691 -3
data/docs/V1FeeType.md
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# SquareConnect::V1FeeType
|
|
2
|
+
|
|
3
|
+
### Description
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
## Properties
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
**CA_GST** | string
|
|
11
|
+
**CA_HST** | string
|
|
12
|
+
**CA_PST** | string
|
|
13
|
+
**CA_QST** | string
|
|
14
|
+
**JP_CONSUMPTION_TAX** | string
|
|
15
|
+
**CA_PEI_PST** | string
|
|
16
|
+
**US_SALES_TAX** | string
|
|
17
|
+
**OTHER** | string
|
|
18
|
+
|
|
19
|
+
|
data/docs/V1InventoryEntry.md
CHANGED
data/docs/V1Item.md
CHANGED
|
@@ -2,16 +2,18 @@
|
|
|
2
2
|
|
|
3
3
|
### Description
|
|
4
4
|
|
|
5
|
+
V1Item
|
|
6
|
+
|
|
5
7
|
## Properties
|
|
6
8
|
Name | Type | Description | Notes
|
|
7
9
|
------------ | ------------- | ------------- | -------------
|
|
8
10
|
**id** | **String** | The item's ID. Must be unique among all entity IDs ever provided on behalf of the merchant. You can never reuse an ID. This value can include alphanumeric characters, dashes (-), and underscores (_). | [optional]
|
|
9
11
|
**name** | **String** | The item's name. | [optional]
|
|
10
12
|
**description** | **String** | The item's description. | [optional]
|
|
11
|
-
**type** | **String** | The item's type. This value is NORMAL for almost all items. | [optional]
|
|
12
|
-
**color** | **String** | The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. | [optional]
|
|
13
|
+
**type** | **String** | The item's type. This value is NORMAL for almost all items. See [V1ItemType](#type-v1itemtype) for possible values | [optional]
|
|
14
|
+
**color** | **String** | The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values | [optional]
|
|
13
15
|
**abbreviation** | **String** | The text of the item's display label in Square Register. Only up to the first five characters of the string are used. | [optional]
|
|
14
|
-
**visibility** | **String** | Indicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE. | [optional]
|
|
16
|
+
**visibility** | **String** | Indicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE. See [V1ItemVisibility](#type-v1itemvisibility) for possible values | [optional]
|
|
15
17
|
**available_online** | **BOOLEAN** | If true, the item can be added to shipping orders from the merchant's online store. | [optional]
|
|
16
18
|
**master_image** | [**V1ItemImage**](V1ItemImage.md) | The item's master image, if any. | [optional]
|
|
17
19
|
**category** | [**V1Category**](V1Category.md) | The category the item belongs to, if any. | [optional]
|
data/docs/V1ItemColor.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# SquareConnect::V1ItemColor
|
|
2
|
+
|
|
3
|
+
### Description
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
## Properties
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
**9da2a6** | string
|
|
11
|
+
**4ab200** | string
|
|
12
|
+
**0b8000** | string
|
|
13
|
+
**2952cc** | string
|
|
14
|
+
**a82ee5** | string
|
|
15
|
+
**e5457a** | string
|
|
16
|
+
**b21212** | string
|
|
17
|
+
**593c00** | string
|
|
18
|
+
**e5BF00** | string
|
|
19
|
+
|
|
20
|
+
|
data/docs/V1ItemImage.md
CHANGED
data/docs/V1ItemType.md
ADDED
data/docs/V1ItemsApi.md
CHANGED
|
@@ -4,52 +4,52 @@ All URIs are relative to *https://connect.squareup.com*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**adjust_inventory**](V1ItemsApi.md#adjust_inventory) | **POST** /v1/{location_id}/inventory/{variation_id} |
|
|
8
|
-
[**apply_fee**](V1ItemsApi.md#apply_fee) | **PUT** /v1/{location_id}/items/{item_id}/fees/{fee_id} |
|
|
9
|
-
[**apply_modifier_list**](V1ItemsApi.md#apply_modifier_list) | **PUT** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} |
|
|
10
|
-
[**create_category**](V1ItemsApi.md#create_category) | **POST** /v1/{location_id}/categories |
|
|
11
|
-
[**create_discount**](V1ItemsApi.md#create_discount) | **POST** /v1/{location_id}/discounts |
|
|
12
|
-
[**create_fee**](V1ItemsApi.md#create_fee) | **POST** /v1/{location_id}/fees |
|
|
13
|
-
[**create_item**](V1ItemsApi.md#create_item) | **POST** /v1/{location_id}/items |
|
|
14
|
-
[**create_modifier_list**](V1ItemsApi.md#create_modifier_list) | **POST** /v1/{location_id}/modifier-lists |
|
|
15
|
-
[**create_modifier_option**](V1ItemsApi.md#create_modifier_option) | **POST** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options |
|
|
16
|
-
[**create_page**](V1ItemsApi.md#create_page) | **POST** /v1/{location_id}/pages |
|
|
17
|
-
[**create_variation**](V1ItemsApi.md#create_variation) | **POST** /v1/{location_id}/items/{item_id}/variations |
|
|
18
|
-
[**delete_category**](V1ItemsApi.md#delete_category) | **DELETE** /v1/{location_id}/categories/{category_id} |
|
|
19
|
-
[**delete_discount**](V1ItemsApi.md#delete_discount) | **DELETE** /v1/{location_id}/discounts/{discount_id} |
|
|
20
|
-
[**delete_fee**](V1ItemsApi.md#delete_fee) | **DELETE** /v1/{location_id}/fees/{fee_id} |
|
|
21
|
-
[**delete_item**](V1ItemsApi.md#delete_item) | **DELETE** /v1/{location_id}/items/{item_id} |
|
|
22
|
-
[**delete_modifier_list**](V1ItemsApi.md#delete_modifier_list) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id} |
|
|
23
|
-
[**delete_modifier_option**](V1ItemsApi.md#delete_modifier_option) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} |
|
|
24
|
-
[**delete_page**](V1ItemsApi.md#delete_page) | **DELETE** /v1/{location_id}/pages/{page_id} |
|
|
25
|
-
[**delete_page_cell**](V1ItemsApi.md#delete_page_cell) | **DELETE** /v1/{location_id}/pages/{page_id}/cells |
|
|
26
|
-
[**delete_variation**](V1ItemsApi.md#delete_variation) | **DELETE** /v1/{location_id}/items/{item_id}/variations/{variation_id} |
|
|
27
|
-
[**list_categories**](V1ItemsApi.md#list_categories) | **GET** /v1/{location_id}/categories |
|
|
28
|
-
[**list_discounts**](V1ItemsApi.md#list_discounts) | **GET** /v1/{location_id}/discounts |
|
|
29
|
-
[**list_fees**](V1ItemsApi.md#list_fees) | **GET** /v1/{location_id}/fees |
|
|
30
|
-
[**list_inventory**](V1ItemsApi.md#list_inventory) | **GET** /v1/{location_id}/inventory |
|
|
31
|
-
[**list_items**](V1ItemsApi.md#list_items) | **GET** /v1/{location_id}/items |
|
|
32
|
-
[**list_modifier_lists**](V1ItemsApi.md#list_modifier_lists) | **GET** /v1/{location_id}/modifier-lists |
|
|
33
|
-
[**list_pages**](V1ItemsApi.md#list_pages) | **GET** /v1/{location_id}/pages |
|
|
34
|
-
[**remove_fee**](V1ItemsApi.md#remove_fee) | **DELETE** /v1/{location_id}/items/{item_id}/fees/{fee_id} |
|
|
35
|
-
[**remove_modifier_list**](V1ItemsApi.md#remove_modifier_list) | **DELETE** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} |
|
|
36
|
-
[**retrieve_item**](V1ItemsApi.md#retrieve_item) | **GET** /v1/{location_id}/items/{item_id} |
|
|
37
|
-
[**retrieve_modifier_list**](V1ItemsApi.md#retrieve_modifier_list) | **GET** /v1/{location_id}/modifier-lists/{modifier_list_id} |
|
|
38
|
-
[**update_category**](V1ItemsApi.md#update_category) | **PUT** /v1/{location_id}/categories/{category_id} |
|
|
39
|
-
[**update_discount**](V1ItemsApi.md#update_discount) | **PUT** /v1/{location_id}/discounts/{discount_id} |
|
|
40
|
-
[**update_fee**](V1ItemsApi.md#update_fee) | **PUT** /v1/{location_id}/fees/{fee_id} |
|
|
41
|
-
[**update_item**](V1ItemsApi.md#update_item) | **PUT** /v1/{location_id}/items/{item_id} |
|
|
42
|
-
[**update_modifier_list**](V1ItemsApi.md#update_modifier_list) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id} |
|
|
43
|
-
[**update_modifier_option**](V1ItemsApi.md#update_modifier_option) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} |
|
|
44
|
-
[**update_page**](V1ItemsApi.md#update_page) | **PUT** /v1/{location_id}/pages/{page_id} |
|
|
45
|
-
[**update_page_cell**](V1ItemsApi.md#update_page_cell) | **PUT** /v1/{location_id}/pages/{page_id}/cells |
|
|
46
|
-
[**update_variation**](V1ItemsApi.md#update_variation) | **PUT** /v1/{location_id}/items/{item_id}/variations/{variation_id} |
|
|
7
|
+
[**adjust_inventory**](V1ItemsApi.md#adjust_inventory) | **POST** /v1/{location_id}/inventory/{variation_id} | AdjustInventory
|
|
8
|
+
[**apply_fee**](V1ItemsApi.md#apply_fee) | **PUT** /v1/{location_id}/items/{item_id}/fees/{fee_id} | ApplyFee
|
|
9
|
+
[**apply_modifier_list**](V1ItemsApi.md#apply_modifier_list) | **PUT** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | ApplyModifierList
|
|
10
|
+
[**create_category**](V1ItemsApi.md#create_category) | **POST** /v1/{location_id}/categories | CreateCategory
|
|
11
|
+
[**create_discount**](V1ItemsApi.md#create_discount) | **POST** /v1/{location_id}/discounts | CreateDiscount
|
|
12
|
+
[**create_fee**](V1ItemsApi.md#create_fee) | **POST** /v1/{location_id}/fees | CreateFee
|
|
13
|
+
[**create_item**](V1ItemsApi.md#create_item) | **POST** /v1/{location_id}/items | CreateItem
|
|
14
|
+
[**create_modifier_list**](V1ItemsApi.md#create_modifier_list) | **POST** /v1/{location_id}/modifier-lists | CreateModifierList
|
|
15
|
+
[**create_modifier_option**](V1ItemsApi.md#create_modifier_option) | **POST** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options | CreateModifierOption
|
|
16
|
+
[**create_page**](V1ItemsApi.md#create_page) | **POST** /v1/{location_id}/pages | CreatePage
|
|
17
|
+
[**create_variation**](V1ItemsApi.md#create_variation) | **POST** /v1/{location_id}/items/{item_id}/variations | CreateVariation
|
|
18
|
+
[**delete_category**](V1ItemsApi.md#delete_category) | **DELETE** /v1/{location_id}/categories/{category_id} | DeleteCategory
|
|
19
|
+
[**delete_discount**](V1ItemsApi.md#delete_discount) | **DELETE** /v1/{location_id}/discounts/{discount_id} | DeleteDiscount
|
|
20
|
+
[**delete_fee**](V1ItemsApi.md#delete_fee) | **DELETE** /v1/{location_id}/fees/{fee_id} | DeleteFee
|
|
21
|
+
[**delete_item**](V1ItemsApi.md#delete_item) | **DELETE** /v1/{location_id}/items/{item_id} | DeleteItem
|
|
22
|
+
[**delete_modifier_list**](V1ItemsApi.md#delete_modifier_list) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id} | DeleteModifierList
|
|
23
|
+
[**delete_modifier_option**](V1ItemsApi.md#delete_modifier_option) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | DeleteModifierOption
|
|
24
|
+
[**delete_page**](V1ItemsApi.md#delete_page) | **DELETE** /v1/{location_id}/pages/{page_id} | DeletePage
|
|
25
|
+
[**delete_page_cell**](V1ItemsApi.md#delete_page_cell) | **DELETE** /v1/{location_id}/pages/{page_id}/cells | DeletePageCell
|
|
26
|
+
[**delete_variation**](V1ItemsApi.md#delete_variation) | **DELETE** /v1/{location_id}/items/{item_id}/variations/{variation_id} | DeleteVariation
|
|
27
|
+
[**list_categories**](V1ItemsApi.md#list_categories) | **GET** /v1/{location_id}/categories | ListCategories
|
|
28
|
+
[**list_discounts**](V1ItemsApi.md#list_discounts) | **GET** /v1/{location_id}/discounts | ListDiscounts
|
|
29
|
+
[**list_fees**](V1ItemsApi.md#list_fees) | **GET** /v1/{location_id}/fees | ListFees
|
|
30
|
+
[**list_inventory**](V1ItemsApi.md#list_inventory) | **GET** /v1/{location_id}/inventory | ListInventory
|
|
31
|
+
[**list_items**](V1ItemsApi.md#list_items) | **GET** /v1/{location_id}/items | ListItems
|
|
32
|
+
[**list_modifier_lists**](V1ItemsApi.md#list_modifier_lists) | **GET** /v1/{location_id}/modifier-lists | ListModifierLists
|
|
33
|
+
[**list_pages**](V1ItemsApi.md#list_pages) | **GET** /v1/{location_id}/pages | ListPages
|
|
34
|
+
[**remove_fee**](V1ItemsApi.md#remove_fee) | **DELETE** /v1/{location_id}/items/{item_id}/fees/{fee_id} | RemoveFee
|
|
35
|
+
[**remove_modifier_list**](V1ItemsApi.md#remove_modifier_list) | **DELETE** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | RemoveModifierList
|
|
36
|
+
[**retrieve_item**](V1ItemsApi.md#retrieve_item) | **GET** /v1/{location_id}/items/{item_id} | RetrieveItem
|
|
37
|
+
[**retrieve_modifier_list**](V1ItemsApi.md#retrieve_modifier_list) | **GET** /v1/{location_id}/modifier-lists/{modifier_list_id} | RetrieveModifierList
|
|
38
|
+
[**update_category**](V1ItemsApi.md#update_category) | **PUT** /v1/{location_id}/categories/{category_id} | UpdateCategory
|
|
39
|
+
[**update_discount**](V1ItemsApi.md#update_discount) | **PUT** /v1/{location_id}/discounts/{discount_id} | UpdateDiscount
|
|
40
|
+
[**update_fee**](V1ItemsApi.md#update_fee) | **PUT** /v1/{location_id}/fees/{fee_id} | UpdateFee
|
|
41
|
+
[**update_item**](V1ItemsApi.md#update_item) | **PUT** /v1/{location_id}/items/{item_id} | UpdateItem
|
|
42
|
+
[**update_modifier_list**](V1ItemsApi.md#update_modifier_list) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id} | UpdateModifierList
|
|
43
|
+
[**update_modifier_option**](V1ItemsApi.md#update_modifier_option) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | UpdateModifierOption
|
|
44
|
+
[**update_page**](V1ItemsApi.md#update_page) | **PUT** /v1/{location_id}/pages/{page_id} | UpdatePage
|
|
45
|
+
[**update_page_cell**](V1ItemsApi.md#update_page_cell) | **PUT** /v1/{location_id}/pages/{page_id}/cells | UpdatePageCell
|
|
46
|
+
[**update_variation**](V1ItemsApi.md#update_variation) | **PUT** /v1/{location_id}/items/{item_id}/variations/{variation_id} | UpdateVariation
|
|
47
47
|
|
|
48
48
|
|
|
49
49
|
# **adjust_inventory**
|
|
50
50
|
> V1InventoryEntry adjust_inventory(location_id, variation_id, body)
|
|
51
51
|
|
|
52
|
-
|
|
52
|
+
AdjustInventory
|
|
53
53
|
|
|
54
54
|
Adjusts an item variation's current available inventory.
|
|
55
55
|
|
|
@@ -73,7 +73,7 @@ body = SquareConnect::V1AdjustInventoryRequest.new # V1AdjustInventoryRequest |
|
|
|
73
73
|
|
|
74
74
|
|
|
75
75
|
begin
|
|
76
|
-
#
|
|
76
|
+
#AdjustInventory
|
|
77
77
|
result = api_instance.adjust_inventory(location_id, variation_id, body)
|
|
78
78
|
p result
|
|
79
79
|
rescue SquareConnect::ApiError => e
|
|
@@ -107,7 +107,7 @@ Name | Type | Description | Notes
|
|
|
107
107
|
# **apply_fee**
|
|
108
108
|
> V1Item apply_fee(location_id, item_id, fee_id)
|
|
109
109
|
|
|
110
|
-
|
|
110
|
+
ApplyFee
|
|
111
111
|
|
|
112
112
|
Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register.
|
|
113
113
|
|
|
@@ -131,7 +131,7 @@ fee_id = "fee_id_example" # String | The ID of the fee to apply.
|
|
|
131
131
|
|
|
132
132
|
|
|
133
133
|
begin
|
|
134
|
-
#
|
|
134
|
+
#ApplyFee
|
|
135
135
|
result = api_instance.apply_fee(location_id, item_id, fee_id)
|
|
136
136
|
p result
|
|
137
137
|
rescue SquareConnect::ApiError => e
|
|
@@ -165,7 +165,7 @@ Name | Type | Description | Notes
|
|
|
165
165
|
# **apply_modifier_list**
|
|
166
166
|
> V1Item apply_modifier_list(location_id, modifier_list_id, item_id)
|
|
167
167
|
|
|
168
|
-
|
|
168
|
+
ApplyModifierList
|
|
169
169
|
|
|
170
170
|
Associates a modifier list with an item, meaning modifier options from the list can be applied to the item.
|
|
171
171
|
|
|
@@ -189,7 +189,7 @@ item_id = "item_id_example" # String | The ID of the item to add the modifier li
|
|
|
189
189
|
|
|
190
190
|
|
|
191
191
|
begin
|
|
192
|
-
#
|
|
192
|
+
#ApplyModifierList
|
|
193
193
|
result = api_instance.apply_modifier_list(location_id, modifier_list_id, item_id)
|
|
194
194
|
p result
|
|
195
195
|
rescue SquareConnect::ApiError => e
|
|
@@ -223,7 +223,7 @@ Name | Type | Description | Notes
|
|
|
223
223
|
# **create_category**
|
|
224
224
|
> V1Category create_category(location_id, body)
|
|
225
225
|
|
|
226
|
-
|
|
226
|
+
CreateCategory
|
|
227
227
|
|
|
228
228
|
Creates an item category.
|
|
229
229
|
|
|
@@ -245,7 +245,7 @@ body = SquareConnect::V1Category.new # V1Category | An object containing the fie
|
|
|
245
245
|
|
|
246
246
|
|
|
247
247
|
begin
|
|
248
|
-
#
|
|
248
|
+
#CreateCategory
|
|
249
249
|
result = api_instance.create_category(location_id, body)
|
|
250
250
|
p result
|
|
251
251
|
rescue SquareConnect::ApiError => e
|
|
@@ -278,7 +278,7 @@ Name | Type | Description | Notes
|
|
|
278
278
|
# **create_discount**
|
|
279
279
|
> V1Discount create_discount(location_id, body)
|
|
280
280
|
|
|
281
|
-
|
|
281
|
+
CreateDiscount
|
|
282
282
|
|
|
283
283
|
Creates a discount.
|
|
284
284
|
|
|
@@ -300,7 +300,7 @@ body = SquareConnect::V1Discount.new # V1Discount | An object containing the fie
|
|
|
300
300
|
|
|
301
301
|
|
|
302
302
|
begin
|
|
303
|
-
#
|
|
303
|
+
#CreateDiscount
|
|
304
304
|
result = api_instance.create_discount(location_id, body)
|
|
305
305
|
p result
|
|
306
306
|
rescue SquareConnect::ApiError => e
|
|
@@ -333,7 +333,7 @@ Name | Type | Description | Notes
|
|
|
333
333
|
# **create_fee**
|
|
334
334
|
> V1Fee create_fee(location_id, body)
|
|
335
335
|
|
|
336
|
-
|
|
336
|
+
CreateFee
|
|
337
337
|
|
|
338
338
|
Creates a fee (tax).
|
|
339
339
|
|
|
@@ -355,7 +355,7 @@ body = SquareConnect::V1Fee.new # V1Fee | An object containing the fields to POS
|
|
|
355
355
|
|
|
356
356
|
|
|
357
357
|
begin
|
|
358
|
-
#
|
|
358
|
+
#CreateFee
|
|
359
359
|
result = api_instance.create_fee(location_id, body)
|
|
360
360
|
p result
|
|
361
361
|
rescue SquareConnect::ApiError => e
|
|
@@ -388,9 +388,9 @@ Name | Type | Description | Notes
|
|
|
388
388
|
# **create_item**
|
|
389
389
|
> V1Item create_item(location_id, body)
|
|
390
390
|
|
|
391
|
-
|
|
391
|
+
CreateItem
|
|
392
392
|
|
|
393
|
-
Creates an item and at least one variation for it.
|
|
393
|
+
Creates an item and at least one variation for it. Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify its `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters.
|
|
394
394
|
|
|
395
395
|
### Example
|
|
396
396
|
```ruby
|
|
@@ -410,7 +410,7 @@ body = SquareConnect::V1Item.new # V1Item | An object containing the fields to P
|
|
|
410
410
|
|
|
411
411
|
|
|
412
412
|
begin
|
|
413
|
-
#
|
|
413
|
+
#CreateItem
|
|
414
414
|
result = api_instance.create_item(location_id, body)
|
|
415
415
|
p result
|
|
416
416
|
rescue SquareConnect::ApiError => e
|
|
@@ -443,7 +443,7 @@ Name | Type | Description | Notes
|
|
|
443
443
|
# **create_modifier_list**
|
|
444
444
|
> V1ModifierList create_modifier_list(location_id, body)
|
|
445
445
|
|
|
446
|
-
|
|
446
|
+
CreateModifierList
|
|
447
447
|
|
|
448
448
|
Creates an item modifier list and at least one modifier option for it.
|
|
449
449
|
|
|
@@ -465,7 +465,7 @@ body = SquareConnect::V1ModifierList.new # V1ModifierList | An object containing
|
|
|
465
465
|
|
|
466
466
|
|
|
467
467
|
begin
|
|
468
|
-
#
|
|
468
|
+
#CreateModifierList
|
|
469
469
|
result = api_instance.create_modifier_list(location_id, body)
|
|
470
470
|
p result
|
|
471
471
|
rescue SquareConnect::ApiError => e
|
|
@@ -498,7 +498,7 @@ Name | Type | Description | Notes
|
|
|
498
498
|
# **create_modifier_option**
|
|
499
499
|
> V1ModifierOption create_modifier_option(location_id, modifier_list_id, body)
|
|
500
500
|
|
|
501
|
-
|
|
501
|
+
CreateModifierOption
|
|
502
502
|
|
|
503
503
|
Creates an item modifier option and adds it to a modifier list.
|
|
504
504
|
|
|
@@ -522,7 +522,7 @@ body = SquareConnect::V1ModifierOption.new # V1ModifierOption | An object contai
|
|
|
522
522
|
|
|
523
523
|
|
|
524
524
|
begin
|
|
525
|
-
#
|
|
525
|
+
#CreateModifierOption
|
|
526
526
|
result = api_instance.create_modifier_option(location_id, modifier_list_id, body)
|
|
527
527
|
p result
|
|
528
528
|
rescue SquareConnect::ApiError => e
|
|
@@ -556,7 +556,7 @@ Name | Type | Description | Notes
|
|
|
556
556
|
# **create_page**
|
|
557
557
|
> V1Page create_page(location_id, body)
|
|
558
558
|
|
|
559
|
-
|
|
559
|
+
CreatePage
|
|
560
560
|
|
|
561
561
|
Creates a Favorites page in Square Register.
|
|
562
562
|
|
|
@@ -578,7 +578,7 @@ body = SquareConnect::V1Page.new # V1Page | An object containing the fields to P
|
|
|
578
578
|
|
|
579
579
|
|
|
580
580
|
begin
|
|
581
|
-
#
|
|
581
|
+
#CreatePage
|
|
582
582
|
result = api_instance.create_page(location_id, body)
|
|
583
583
|
p result
|
|
584
584
|
rescue SquareConnect::ApiError => e
|
|
@@ -611,7 +611,7 @@ Name | Type | Description | Notes
|
|
|
611
611
|
# **create_variation**
|
|
612
612
|
> V1Variation create_variation(location_id, item_id, body)
|
|
613
613
|
|
|
614
|
-
|
|
614
|
+
CreateVariation
|
|
615
615
|
|
|
616
616
|
Creates an item variation for an existing item.
|
|
617
617
|
|
|
@@ -635,7 +635,7 @@ body = SquareConnect::V1Variation.new # V1Variation | An object containing the f
|
|
|
635
635
|
|
|
636
636
|
|
|
637
637
|
begin
|
|
638
|
-
#
|
|
638
|
+
#CreateVariation
|
|
639
639
|
result = api_instance.create_variation(location_id, item_id, body)
|
|
640
640
|
p result
|
|
641
641
|
rescue SquareConnect::ApiError => e
|
|
@@ -669,9 +669,9 @@ Name | Type | Description | Notes
|
|
|
669
669
|
# **delete_category**
|
|
670
670
|
> V1Category delete_category(location_id, category_id)
|
|
671
671
|
|
|
672
|
-
|
|
672
|
+
DeleteCategory
|
|
673
673
|
|
|
674
|
-
Deletes an existing item category.
|
|
674
|
+
Deletes an existing item category. *Note**: DeleteCategory returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below.
|
|
675
675
|
|
|
676
676
|
### Example
|
|
677
677
|
```ruby
|
|
@@ -691,7 +691,7 @@ category_id = "category_id_example" # String | The ID of the category to delete.
|
|
|
691
691
|
|
|
692
692
|
|
|
693
693
|
begin
|
|
694
|
-
#
|
|
694
|
+
#DeleteCategory
|
|
695
695
|
result = api_instance.delete_category(location_id, category_id)
|
|
696
696
|
p result
|
|
697
697
|
rescue SquareConnect::ApiError => e
|
|
@@ -724,9 +724,9 @@ Name | Type | Description | Notes
|
|
|
724
724
|
# **delete_discount**
|
|
725
725
|
> V1Discount delete_discount(location_id, discount_id)
|
|
726
726
|
|
|
727
|
-
|
|
727
|
+
DeleteDiscount
|
|
728
728
|
|
|
729
|
-
Deletes an existing discount.
|
|
729
|
+
Deletes an existing discount. *Note**: DeleteDiscount returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below.
|
|
730
730
|
|
|
731
731
|
### Example
|
|
732
732
|
```ruby
|
|
@@ -746,7 +746,7 @@ discount_id = "discount_id_example" # String | The ID of the discount to delete.
|
|
|
746
746
|
|
|
747
747
|
|
|
748
748
|
begin
|
|
749
|
-
#
|
|
749
|
+
#DeleteDiscount
|
|
750
750
|
result = api_instance.delete_discount(location_id, discount_id)
|
|
751
751
|
p result
|
|
752
752
|
rescue SquareConnect::ApiError => e
|
|
@@ -779,9 +779,9 @@ Name | Type | Description | Notes
|
|
|
779
779
|
# **delete_fee**
|
|
780
780
|
> V1Fee delete_fee(location_id, fee_id)
|
|
781
781
|
|
|
782
|
-
|
|
782
|
+
DeleteFee
|
|
783
783
|
|
|
784
|
-
Deletes an existing fee (tax).
|
|
784
|
+
Deletes an existing fee (tax). *Note**: DeleteFee returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below.
|
|
785
785
|
|
|
786
786
|
### Example
|
|
787
787
|
```ruby
|
|
@@ -801,7 +801,7 @@ fee_id = "fee_id_example" # String | The ID of the fee to delete.
|
|
|
801
801
|
|
|
802
802
|
|
|
803
803
|
begin
|
|
804
|
-
#
|
|
804
|
+
#DeleteFee
|
|
805
805
|
result = api_instance.delete_fee(location_id, fee_id)
|
|
806
806
|
p result
|
|
807
807
|
rescue SquareConnect::ApiError => e
|
|
@@ -834,9 +834,9 @@ Name | Type | Description | Notes
|
|
|
834
834
|
# **delete_item**
|
|
835
835
|
> V1Item delete_item(location_id, item_id)
|
|
836
836
|
|
|
837
|
-
|
|
837
|
+
DeleteItem
|
|
838
838
|
|
|
839
|
-
Deletes an existing item and all item variations associated with it.
|
|
839
|
+
Deletes an existing item and all item variations associated with it. *Note**: DeleteItem returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below.
|
|
840
840
|
|
|
841
841
|
### Example
|
|
842
842
|
```ruby
|
|
@@ -856,7 +856,7 @@ item_id = "item_id_example" # String | The ID of the item to modify.
|
|
|
856
856
|
|
|
857
857
|
|
|
858
858
|
begin
|
|
859
|
-
#
|
|
859
|
+
#DeleteItem
|
|
860
860
|
result = api_instance.delete_item(location_id, item_id)
|
|
861
861
|
p result
|
|
862
862
|
rescue SquareConnect::ApiError => e
|
|
@@ -889,9 +889,9 @@ Name | Type | Description | Notes
|
|
|
889
889
|
# **delete_modifier_list**
|
|
890
890
|
> V1ModifierList delete_modifier_list(location_id, modifier_list_id)
|
|
891
891
|
|
|
892
|
-
|
|
892
|
+
DeleteModifierList
|
|
893
893
|
|
|
894
|
-
Deletes an existing item modifier list and all modifier options associated with it.
|
|
894
|
+
Deletes an existing item modifier list and all modifier options associated with it. *Note**: DeleteModifierList returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below.
|
|
895
895
|
|
|
896
896
|
### Example
|
|
897
897
|
```ruby
|
|
@@ -911,7 +911,7 @@ modifier_list_id = "modifier_list_id_example" # String | The ID of the modifier
|
|
|
911
911
|
|
|
912
912
|
|
|
913
913
|
begin
|
|
914
|
-
#
|
|
914
|
+
#DeleteModifierList
|
|
915
915
|
result = api_instance.delete_modifier_list(location_id, modifier_list_id)
|
|
916
916
|
p result
|
|
917
917
|
rescue SquareConnect::ApiError => e
|
|
@@ -944,9 +944,9 @@ Name | Type | Description | Notes
|
|
|
944
944
|
# **delete_modifier_option**
|
|
945
945
|
> V1ModifierOption delete_modifier_option(location_id, modifier_list_id, modifier_option_id)
|
|
946
946
|
|
|
947
|
-
|
|
947
|
+
DeleteModifierOption
|
|
948
948
|
|
|
949
|
-
Deletes an existing item modifier option from a modifier list.
|
|
949
|
+
Deletes an existing item modifier option from a modifier list. *Note**: DeleteModifierOption returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object as documented below.
|
|
950
950
|
|
|
951
951
|
### Example
|
|
952
952
|
```ruby
|
|
@@ -968,7 +968,7 @@ modifier_option_id = "modifier_option_id_example" # String | The ID of the modif
|
|
|
968
968
|
|
|
969
969
|
|
|
970
970
|
begin
|
|
971
|
-
#
|
|
971
|
+
#DeleteModifierOption
|
|
972
972
|
result = api_instance.delete_modifier_option(location_id, modifier_list_id, modifier_option_id)
|
|
973
973
|
p result
|
|
974
974
|
rescue SquareConnect::ApiError => e
|
|
@@ -1002,9 +1002,9 @@ Name | Type | Description | Notes
|
|
|
1002
1002
|
# **delete_page**
|
|
1003
1003
|
> V1Page delete_page(location_id, page_id)
|
|
1004
1004
|
|
|
1005
|
-
|
|
1005
|
+
DeletePage
|
|
1006
1006
|
|
|
1007
|
-
Deletes an existing Favorites page and all of its cells.
|
|
1007
|
+
Deletes an existing Favorites page and all of its cells. *Note**: DeletePage returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object as documented below.
|
|
1008
1008
|
|
|
1009
1009
|
### Example
|
|
1010
1010
|
```ruby
|
|
@@ -1024,7 +1024,7 @@ page_id = "page_id_example" # String | The ID of the page to delete.
|
|
|
1024
1024
|
|
|
1025
1025
|
|
|
1026
1026
|
begin
|
|
1027
|
-
#
|
|
1027
|
+
#DeletePage
|
|
1028
1028
|
result = api_instance.delete_page(location_id, page_id)
|
|
1029
1029
|
p result
|
|
1030
1030
|
rescue SquareConnect::ApiError => e
|
|
@@ -1057,9 +1057,9 @@ Name | Type | Description | Notes
|
|
|
1057
1057
|
# **delete_page_cell**
|
|
1058
1058
|
> V1Page delete_page_cell(location_id, page_id, opts)
|
|
1059
1059
|
|
|
1060
|
-
|
|
1060
|
+
DeletePageCell
|
|
1061
1061
|
|
|
1062
|
-
Deletes a cell from a Favorites page in Square Register.
|
|
1062
|
+
Deletes a cell from a Favorites page in Square Register. *Note**: DeletePageCell returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below.
|
|
1063
1063
|
|
|
1064
1064
|
### Example
|
|
1065
1065
|
```ruby
|
|
@@ -1083,7 +1083,7 @@ opts = {
|
|
|
1083
1083
|
}
|
|
1084
1084
|
|
|
1085
1085
|
begin
|
|
1086
|
-
#
|
|
1086
|
+
#DeletePageCell
|
|
1087
1087
|
result = api_instance.delete_page_cell(location_id, page_id, opts)
|
|
1088
1088
|
p result
|
|
1089
1089
|
rescue SquareConnect::ApiError => e
|
|
@@ -1118,9 +1118,9 @@ Name | Type | Description | Notes
|
|
|
1118
1118
|
# **delete_variation**
|
|
1119
1119
|
> V1Variation delete_variation(location_id, item_id, variation_id)
|
|
1120
1120
|
|
|
1121
|
-
|
|
1121
|
+
DeleteVariation
|
|
1122
1122
|
|
|
1123
|
-
Deletes an existing item variation from an item.
|
|
1123
|
+
Deletes an existing item variation from an item. *Note**: DeleteVariation returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below.
|
|
1124
1124
|
|
|
1125
1125
|
### Example
|
|
1126
1126
|
```ruby
|
|
@@ -1142,7 +1142,7 @@ variation_id = "variation_id_example" # String | The ID of the variation to dele
|
|
|
1142
1142
|
|
|
1143
1143
|
|
|
1144
1144
|
begin
|
|
1145
|
-
#
|
|
1145
|
+
#DeleteVariation
|
|
1146
1146
|
result = api_instance.delete_variation(location_id, item_id, variation_id)
|
|
1147
1147
|
p result
|
|
1148
1148
|
rescue SquareConnect::ApiError => e
|
|
@@ -1176,7 +1176,7 @@ Name | Type | Description | Notes
|
|
|
1176
1176
|
# **list_categories**
|
|
1177
1177
|
> Array<V1Category> list_categories(location_id)
|
|
1178
1178
|
|
|
1179
|
-
|
|
1179
|
+
ListCategories
|
|
1180
1180
|
|
|
1181
1181
|
Lists all of a location's item categories.
|
|
1182
1182
|
|
|
@@ -1196,7 +1196,7 @@ location_id = "location_id_example" # String | The ID of the location to list ca
|
|
|
1196
1196
|
|
|
1197
1197
|
|
|
1198
1198
|
begin
|
|
1199
|
-
#
|
|
1199
|
+
#ListCategories
|
|
1200
1200
|
result = api_instance.list_categories(location_id)
|
|
1201
1201
|
p result
|
|
1202
1202
|
rescue SquareConnect::ApiError => e
|
|
@@ -1228,7 +1228,7 @@ Name | Type | Description | Notes
|
|
|
1228
1228
|
# **list_discounts**
|
|
1229
1229
|
> Array<V1Discount> list_discounts(location_id)
|
|
1230
1230
|
|
|
1231
|
-
|
|
1231
|
+
ListDiscounts
|
|
1232
1232
|
|
|
1233
1233
|
Lists all of a location's discounts.
|
|
1234
1234
|
|
|
@@ -1248,7 +1248,7 @@ location_id = "location_id_example" # String | The ID of the location to list ca
|
|
|
1248
1248
|
|
|
1249
1249
|
|
|
1250
1250
|
begin
|
|
1251
|
-
#
|
|
1251
|
+
#ListDiscounts
|
|
1252
1252
|
result = api_instance.list_discounts(location_id)
|
|
1253
1253
|
p result
|
|
1254
1254
|
rescue SquareConnect::ApiError => e
|
|
@@ -1280,7 +1280,7 @@ Name | Type | Description | Notes
|
|
|
1280
1280
|
# **list_fees**
|
|
1281
1281
|
> Array<V1Fee> list_fees(location_id)
|
|
1282
1282
|
|
|
1283
|
-
|
|
1283
|
+
ListFees
|
|
1284
1284
|
|
|
1285
1285
|
Lists all of a location's fees (taxes).
|
|
1286
1286
|
|
|
@@ -1300,7 +1300,7 @@ location_id = "location_id_example" # String | The ID of the location to list fe
|
|
|
1300
1300
|
|
|
1301
1301
|
|
|
1302
1302
|
begin
|
|
1303
|
-
#
|
|
1303
|
+
#ListFees
|
|
1304
1304
|
result = api_instance.list_fees(location_id)
|
|
1305
1305
|
p result
|
|
1306
1306
|
rescue SquareConnect::ApiError => e
|
|
@@ -1332,7 +1332,7 @@ Name | Type | Description | Notes
|
|
|
1332
1332
|
# **list_inventory**
|
|
1333
1333
|
> Array<V1InventoryEntry> list_inventory(location_id, opts)
|
|
1334
1334
|
|
|
1335
|
-
|
|
1335
|
+
ListInventory
|
|
1336
1336
|
|
|
1337
1337
|
Provides inventory information for all of a merchant's inventory-enabled item variations.
|
|
1338
1338
|
|
|
@@ -1356,7 +1356,7 @@ opts = {
|
|
|
1356
1356
|
}
|
|
1357
1357
|
|
|
1358
1358
|
begin
|
|
1359
|
-
#
|
|
1359
|
+
#ListInventory
|
|
1360
1360
|
result = api_instance.list_inventory(location_id, opts)
|
|
1361
1361
|
p result
|
|
1362
1362
|
rescue SquareConnect::ApiError => e
|
|
@@ -1390,7 +1390,7 @@ Name | Type | Description | Notes
|
|
|
1390
1390
|
# **list_items**
|
|
1391
1391
|
> Array<V1Item> list_items(location_id, opts)
|
|
1392
1392
|
|
|
1393
|
-
|
|
1393
|
+
ListItems
|
|
1394
1394
|
|
|
1395
1395
|
Provides summary information for all of a location's items.
|
|
1396
1396
|
|
|
@@ -1413,7 +1413,7 @@ opts = {
|
|
|
1413
1413
|
}
|
|
1414
1414
|
|
|
1415
1415
|
begin
|
|
1416
|
-
#
|
|
1416
|
+
#ListItems
|
|
1417
1417
|
result = api_instance.list_items(location_id, opts)
|
|
1418
1418
|
p result
|
|
1419
1419
|
rescue SquareConnect::ApiError => e
|
|
@@ -1446,7 +1446,7 @@ Name | Type | Description | Notes
|
|
|
1446
1446
|
# **list_modifier_lists**
|
|
1447
1447
|
> Array<V1ModifierList> list_modifier_lists(location_id)
|
|
1448
1448
|
|
|
1449
|
-
|
|
1449
|
+
ListModifierLists
|
|
1450
1450
|
|
|
1451
1451
|
Lists all of a location's modifier lists.
|
|
1452
1452
|
|
|
@@ -1466,7 +1466,7 @@ location_id = "location_id_example" # String | The ID of the location to list mo
|
|
|
1466
1466
|
|
|
1467
1467
|
|
|
1468
1468
|
begin
|
|
1469
|
-
#
|
|
1469
|
+
#ListModifierLists
|
|
1470
1470
|
result = api_instance.list_modifier_lists(location_id)
|
|
1471
1471
|
p result
|
|
1472
1472
|
rescue SquareConnect::ApiError => e
|
|
@@ -1498,7 +1498,7 @@ Name | Type | Description | Notes
|
|
|
1498
1498
|
# **list_pages**
|
|
1499
1499
|
> Array<V1Page> list_pages(location_id)
|
|
1500
1500
|
|
|
1501
|
-
|
|
1501
|
+
ListPages
|
|
1502
1502
|
|
|
1503
1503
|
Lists all of a location's Favorites pages in Square Register.
|
|
1504
1504
|
|
|
@@ -1518,7 +1518,7 @@ location_id = "location_id_example" # String | The ID of the location to list Fa
|
|
|
1518
1518
|
|
|
1519
1519
|
|
|
1520
1520
|
begin
|
|
1521
|
-
#
|
|
1521
|
+
#ListPages
|
|
1522
1522
|
result = api_instance.list_pages(location_id)
|
|
1523
1523
|
p result
|
|
1524
1524
|
rescue SquareConnect::ApiError => e
|
|
@@ -1550,7 +1550,7 @@ Name | Type | Description | Notes
|
|
|
1550
1550
|
# **remove_fee**
|
|
1551
1551
|
> V1Item remove_fee(location_id, item_id, fee_id)
|
|
1552
1552
|
|
|
1553
|
-
|
|
1553
|
+
RemoveFee
|
|
1554
1554
|
|
|
1555
1555
|
Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register.
|
|
1556
1556
|
|
|
@@ -1574,7 +1574,7 @@ fee_id = "fee_id_example" # String | The ID of the fee to apply.
|
|
|
1574
1574
|
|
|
1575
1575
|
|
|
1576
1576
|
begin
|
|
1577
|
-
#
|
|
1577
|
+
#RemoveFee
|
|
1578
1578
|
result = api_instance.remove_fee(location_id, item_id, fee_id)
|
|
1579
1579
|
p result
|
|
1580
1580
|
rescue SquareConnect::ApiError => e
|
|
@@ -1608,7 +1608,7 @@ Name | Type | Description | Notes
|
|
|
1608
1608
|
# **remove_modifier_list**
|
|
1609
1609
|
> V1Item remove_modifier_list(location_id, modifier_list_id, item_id)
|
|
1610
1610
|
|
|
1611
|
-
|
|
1611
|
+
RemoveModifierList
|
|
1612
1612
|
|
|
1613
1613
|
Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item.
|
|
1614
1614
|
|
|
@@ -1632,7 +1632,7 @@ item_id = "item_id_example" # String | The ID of the item to remove the modifier
|
|
|
1632
1632
|
|
|
1633
1633
|
|
|
1634
1634
|
begin
|
|
1635
|
-
#
|
|
1635
|
+
#RemoveModifierList
|
|
1636
1636
|
result = api_instance.remove_modifier_list(location_id, modifier_list_id, item_id)
|
|
1637
1637
|
p result
|
|
1638
1638
|
rescue SquareConnect::ApiError => e
|
|
@@ -1666,7 +1666,7 @@ Name | Type | Description | Notes
|
|
|
1666
1666
|
# **retrieve_item**
|
|
1667
1667
|
> V1Item retrieve_item(location_id, item_id)
|
|
1668
1668
|
|
|
1669
|
-
|
|
1669
|
+
RetrieveItem
|
|
1670
1670
|
|
|
1671
1671
|
Provides the details for a single item, including associated modifier lists and fees.
|
|
1672
1672
|
|
|
@@ -1688,7 +1688,7 @@ item_id = "item_id_example" # String | The item's ID.
|
|
|
1688
1688
|
|
|
1689
1689
|
|
|
1690
1690
|
begin
|
|
1691
|
-
#
|
|
1691
|
+
#RetrieveItem
|
|
1692
1692
|
result = api_instance.retrieve_item(location_id, item_id)
|
|
1693
1693
|
p result
|
|
1694
1694
|
rescue SquareConnect::ApiError => e
|
|
@@ -1721,7 +1721,7 @@ Name | Type | Description | Notes
|
|
|
1721
1721
|
# **retrieve_modifier_list**
|
|
1722
1722
|
> V1ModifierList retrieve_modifier_list(location_id, modifier_list_id)
|
|
1723
1723
|
|
|
1724
|
-
|
|
1724
|
+
RetrieveModifierList
|
|
1725
1725
|
|
|
1726
1726
|
Provides the details for a single modifier list.
|
|
1727
1727
|
|
|
@@ -1743,7 +1743,7 @@ modifier_list_id = "modifier_list_id_example" # String | The modifier list's ID.
|
|
|
1743
1743
|
|
|
1744
1744
|
|
|
1745
1745
|
begin
|
|
1746
|
-
#
|
|
1746
|
+
#RetrieveModifierList
|
|
1747
1747
|
result = api_instance.retrieve_modifier_list(location_id, modifier_list_id)
|
|
1748
1748
|
p result
|
|
1749
1749
|
rescue SquareConnect::ApiError => e
|
|
@@ -1776,7 +1776,7 @@ Name | Type | Description | Notes
|
|
|
1776
1776
|
# **update_category**
|
|
1777
1777
|
> V1Category update_category(location_id, category_id, body)
|
|
1778
1778
|
|
|
1779
|
-
|
|
1779
|
+
UpdateCategory
|
|
1780
1780
|
|
|
1781
1781
|
Modifies the details of an existing item category.
|
|
1782
1782
|
|
|
@@ -1800,7 +1800,7 @@ body = SquareConnect::V1Category.new # V1Category | An object containing the fie
|
|
|
1800
1800
|
|
|
1801
1801
|
|
|
1802
1802
|
begin
|
|
1803
|
-
#
|
|
1803
|
+
#UpdateCategory
|
|
1804
1804
|
result = api_instance.update_category(location_id, category_id, body)
|
|
1805
1805
|
p result
|
|
1806
1806
|
rescue SquareConnect::ApiError => e
|
|
@@ -1834,7 +1834,7 @@ Name | Type | Description | Notes
|
|
|
1834
1834
|
# **update_discount**
|
|
1835
1835
|
> V1Discount update_discount(location_id, discount_id, body)
|
|
1836
1836
|
|
|
1837
|
-
|
|
1837
|
+
UpdateDiscount
|
|
1838
1838
|
|
|
1839
1839
|
Modifies the details of an existing discount.
|
|
1840
1840
|
|
|
@@ -1858,7 +1858,7 @@ body = SquareConnect::V1Discount.new # V1Discount | An object containing the fie
|
|
|
1858
1858
|
|
|
1859
1859
|
|
|
1860
1860
|
begin
|
|
1861
|
-
#
|
|
1861
|
+
#UpdateDiscount
|
|
1862
1862
|
result = api_instance.update_discount(location_id, discount_id, body)
|
|
1863
1863
|
p result
|
|
1864
1864
|
rescue SquareConnect::ApiError => e
|
|
@@ -1892,7 +1892,7 @@ Name | Type | Description | Notes
|
|
|
1892
1892
|
# **update_fee**
|
|
1893
1893
|
> V1Fee update_fee(location_id, fee_id, body)
|
|
1894
1894
|
|
|
1895
|
-
|
|
1895
|
+
UpdateFee
|
|
1896
1896
|
|
|
1897
1897
|
Modifies the details of an existing fee (tax).
|
|
1898
1898
|
|
|
@@ -1916,7 +1916,7 @@ body = SquareConnect::V1Fee.new # V1Fee | An object containing the fields to POS
|
|
|
1916
1916
|
|
|
1917
1917
|
|
|
1918
1918
|
begin
|
|
1919
|
-
#
|
|
1919
|
+
#UpdateFee
|
|
1920
1920
|
result = api_instance.update_fee(location_id, fee_id, body)
|
|
1921
1921
|
p result
|
|
1922
1922
|
rescue SquareConnect::ApiError => e
|
|
@@ -1950,7 +1950,7 @@ Name | Type | Description | Notes
|
|
|
1950
1950
|
# **update_item**
|
|
1951
1951
|
> V1Item update_item(location_id, item_id, body)
|
|
1952
1952
|
|
|
1953
|
-
|
|
1953
|
+
UpdateItem
|
|
1954
1954
|
|
|
1955
1955
|
Modifies the core details of an existing item.
|
|
1956
1956
|
|
|
@@ -1974,7 +1974,7 @@ body = SquareConnect::V1Item.new # V1Item | An object containing the fields to P
|
|
|
1974
1974
|
|
|
1975
1975
|
|
|
1976
1976
|
begin
|
|
1977
|
-
#
|
|
1977
|
+
#UpdateItem
|
|
1978
1978
|
result = api_instance.update_item(location_id, item_id, body)
|
|
1979
1979
|
p result
|
|
1980
1980
|
rescue SquareConnect::ApiError => e
|
|
@@ -2008,7 +2008,7 @@ Name | Type | Description | Notes
|
|
|
2008
2008
|
# **update_modifier_list**
|
|
2009
2009
|
> V1ModifierList update_modifier_list(location_id, modifier_list_id, body)
|
|
2010
2010
|
|
|
2011
|
-
|
|
2011
|
+
UpdateModifierList
|
|
2012
2012
|
|
|
2013
2013
|
Modifies the details of an existing item modifier list.
|
|
2014
2014
|
|
|
@@ -2032,7 +2032,7 @@ body = SquareConnect::V1UpdateModifierListRequest.new # V1UpdateModifierListRequ
|
|
|
2032
2032
|
|
|
2033
2033
|
|
|
2034
2034
|
begin
|
|
2035
|
-
#
|
|
2035
|
+
#UpdateModifierList
|
|
2036
2036
|
result = api_instance.update_modifier_list(location_id, modifier_list_id, body)
|
|
2037
2037
|
p result
|
|
2038
2038
|
rescue SquareConnect::ApiError => e
|
|
@@ -2066,7 +2066,7 @@ Name | Type | Description | Notes
|
|
|
2066
2066
|
# **update_modifier_option**
|
|
2067
2067
|
> V1ModifierOption update_modifier_option(location_id, modifier_list_id, modifier_option_id, body)
|
|
2068
2068
|
|
|
2069
|
-
|
|
2069
|
+
UpdateModifierOption
|
|
2070
2070
|
|
|
2071
2071
|
Modifies the details of an existing item modifier option.
|
|
2072
2072
|
|
|
@@ -2092,7 +2092,7 @@ body = SquareConnect::V1ModifierOption.new # V1ModifierOption | An object contai
|
|
|
2092
2092
|
|
|
2093
2093
|
|
|
2094
2094
|
begin
|
|
2095
|
-
#
|
|
2095
|
+
#UpdateModifierOption
|
|
2096
2096
|
result = api_instance.update_modifier_option(location_id, modifier_list_id, modifier_option_id, body)
|
|
2097
2097
|
p result
|
|
2098
2098
|
rescue SquareConnect::ApiError => e
|
|
@@ -2127,7 +2127,7 @@ Name | Type | Description | Notes
|
|
|
2127
2127
|
# **update_page**
|
|
2128
2128
|
> V1Page update_page(location_id, page_id, body)
|
|
2129
2129
|
|
|
2130
|
-
|
|
2130
|
+
UpdatePage
|
|
2131
2131
|
|
|
2132
2132
|
Modifies the details of a Favorites page in Square Register.
|
|
2133
2133
|
|
|
@@ -2151,7 +2151,7 @@ body = SquareConnect::V1Page.new # V1Page | An object containing the fields to P
|
|
|
2151
2151
|
|
|
2152
2152
|
|
|
2153
2153
|
begin
|
|
2154
|
-
#
|
|
2154
|
+
#UpdatePage
|
|
2155
2155
|
result = api_instance.update_page(location_id, page_id, body)
|
|
2156
2156
|
p result
|
|
2157
2157
|
rescue SquareConnect::ApiError => e
|
|
@@ -2185,7 +2185,7 @@ Name | Type | Description | Notes
|
|
|
2185
2185
|
# **update_page_cell**
|
|
2186
2186
|
> V1Page update_page_cell(location_id, page_id, body)
|
|
2187
2187
|
|
|
2188
|
-
|
|
2188
|
+
UpdatePageCell
|
|
2189
2189
|
|
|
2190
2190
|
Modifies a cell of a Favorites page in Square Register.
|
|
2191
2191
|
|
|
@@ -2209,7 +2209,7 @@ body = SquareConnect::V1PageCell.new # V1PageCell | An object containing the fie
|
|
|
2209
2209
|
|
|
2210
2210
|
|
|
2211
2211
|
begin
|
|
2212
|
-
#
|
|
2212
|
+
#UpdatePageCell
|
|
2213
2213
|
result = api_instance.update_page_cell(location_id, page_id, body)
|
|
2214
2214
|
p result
|
|
2215
2215
|
rescue SquareConnect::ApiError => e
|
|
@@ -2243,7 +2243,7 @@ Name | Type | Description | Notes
|
|
|
2243
2243
|
# **update_variation**
|
|
2244
2244
|
> V1Variation update_variation(location_id, item_id, variation_id, body)
|
|
2245
2245
|
|
|
2246
|
-
|
|
2246
|
+
UpdateVariation
|
|
2247
2247
|
|
|
2248
2248
|
Modifies the details of an existing item variation.
|
|
2249
2249
|
|
|
@@ -2269,7 +2269,7 @@ body = SquareConnect::V1Variation.new # V1Variation | An object containing the f
|
|
|
2269
2269
|
|
|
2270
2270
|
|
|
2271
2271
|
begin
|
|
2272
|
-
#
|
|
2272
|
+
#UpdateVariation
|
|
2273
2273
|
result = api_instance.update_variation(location_id, item_id, variation_id, body)
|
|
2274
2274
|
p result
|
|
2275
2275
|
rescue SquareConnect::ApiError => e
|