korona_client 1.0.0 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +171 -89
- data/config.json +6 -0
- data/docs/AccountTransaction.md +2 -0
- data/docs/AccountsApi.md +12 -12
- data/docs/AddOrUpdateResult.md +1 -0
- data/docs/AdditionalInfo.md +9 -0
- data/docs/AdditionalReceiptInfoType.md +22 -0
- data/docs/AdditionalReceiptInfoTypesApi.md +133 -0
- data/docs/AssortmentsApi.md +217 -48
- data/docs/Attendance.md +17 -0
- data/docs/Cashier.md +1 -0
- data/docs/CashiersApi.md +15 -13
- data/docs/Category.md +1 -0
- data/docs/CommodityGroupsApi.md +423 -0
- data/docs/CreationTask.md +17 -0
- data/docs/CurrenciesApi.md +15 -13
- data/docs/CustomerGroupsApi.md +15 -13
- data/docs/CustomerOrder.md +2 -2
- data/docs/CustomerOrdersApi.md +52 -46
- data/docs/CustomersApi.md +108 -45
- data/docs/DayTimePeriod.md +9 -0
- data/docs/DeliveryNote.md +22 -0
- data/docs/DeliveryNoteItem.md +14 -0
- data/docs/DeliveryNotesApi.md +316 -0
- data/docs/Deposit.md +12 -0
- data/docs/Discount.md +10 -0
- data/docs/EconomicZonesApi.md +15 -13
- data/docs/EndOfDayStatement.md +1 -1
- data/docs/Event.md +2 -0
- data/docs/ExternalSystemCall.md +20 -0
- data/docs/ExternalSystemCallsApi.md +423 -0
- data/docs/ImagesApi.md +8 -7
- data/docs/InfoTextsApi.md +15 -13
- data/docs/InventoriesApi.md +894 -0
- data/docs/KoronaAccount.md +1 -0
- data/docs/KoronaAccountApi.md +5 -5
- data/docs/MediaUrl.md +8 -0
- data/docs/OrganizationalUnit.md +1 -0
- data/docs/OrganizationalUnitsApi.md +108 -104
- data/docs/PaymentMethod.md +3 -0
- data/docs/PaymentMethodsApi.md +15 -13
- data/docs/PointsOfSaleApi.md +85 -74
- data/docs/Pos.md +5 -3
- data/docs/PriceGroupsApi.md +15 -13
- data/docs/Product.md +2 -0
- data/docs/ProductsApi.md +121 -58
- data/docs/Receipt.md +5 -1
- data/docs/ReceiptItem.md +3 -0
- data/docs/ReceiptsApi.md +20 -14
- data/docs/ResultListAdditionalReceiptInfoType.md +13 -0
- data/docs/ResultListAttendance.md +13 -0
- data/docs/ResultListCreationTask.md +13 -0
- data/docs/ResultListDeliveryNote.md +13 -0
- data/docs/ResultListExternalSystemCall.md +13 -0
- data/docs/ResultListTicket.md +13 -0
- data/docs/ResultListTimeTrackingEntity.md +13 -0
- data/docs/ResultListTimeTrackingEntry.md +13 -0
- data/docs/SalesTaxesApi.md +15 -13
- data/docs/Sector.md +1 -0
- data/docs/SectorRevenueAccountItem.md +9 -0
- data/docs/SectorsApi.md +15 -13
- data/docs/Signature.md +10 -0
- data/docs/StatisticsApi.md +28 -28
- data/docs/StockReceipt.md +1 -0
- data/docs/StockReceiptsApi.md +687 -0
- data/docs/SuppliersApi.md +15 -13
- data/docs/TagsApi.md +303 -13
- data/docs/Ticket.md +14 -0
- data/docs/TicketCreationApi.md +127 -0
- data/docs/TicketPersonalization.md +11 -0
- data/docs/TicketingApi.md +975 -76
- data/docs/TimeTrackingApi.md +388 -0
- data/docs/TimeTrackingEntity.md +13 -0
- data/docs/TimeTrackingEntry.md +14 -0
- data/docs/TotalPeriod.md +9 -0
- data/docs/Validity.md +11 -0
- data/korona_client-1.0.0.gem +0 -0
- data/korona_client.gemspec +7 -8
- data/lib/korona_client.rb +38 -5
- data/lib/korona_client/api/accounts_api.rb +24 -26
- data/lib/korona_client/api/additional_receipt_info_types_api.rb +155 -0
- data/lib/korona_client/api/assortments_api.rb +259 -82
- data/lib/korona_client/api/cashiers_api.rb +27 -26
- data/lib/korona_client/api/commodity_groups_api.rb +462 -0
- data/lib/korona_client/api/currencies_api.rb +27 -26
- data/lib/korona_client/api/customer_groups_api.rb +27 -26
- data/lib/korona_client/api/customer_orders_api.rb +78 -78
- data/lib/korona_client/api/customers_api.rb +137 -77
- data/lib/korona_client/api/delivery_notes_api.rb +354 -0
- data/lib/korona_client/api/economic_zones_api.rb +27 -26
- data/lib/korona_client/api/external_system_calls_api.rb +462 -0
- data/lib/korona_client/api/images_api.rb +16 -16
- data/lib/korona_client/api/info_texts_api.rb +27 -26
- data/lib/korona_client/api/inventories_api.rb +1014 -0
- data/lib/korona_client/api/korona_account_api.rb +11 -12
- data/lib/korona_client/api/organizational_units_api.rb +157 -162
- data/lib/korona_client/api/payment_methods_api.rb +27 -26
- data/lib/korona_client/api/points_of_sale_api.rb +127 -121
- data/lib/korona_client/api/price_groups_api.rb +27 -26
- data/lib/korona_client/api/products_api.rb +154 -95
- data/lib/korona_client/api/receipts_api.rb +27 -20
- data/lib/korona_client/api/sales_taxes_api.rb +27 -26
- data/lib/korona_client/api/sectors_api.rb +27 -26
- data/lib/korona_client/api/statistics_api.rb +32 -36
- data/lib/korona_client/api/stock_receipts_api.rb +769 -0
- data/lib/korona_client/api/suppliers_api.rb +27 -26
- data/lib/korona_client/api/tags_api.rb +326 -21
- data/lib/korona_client/api/ticket_creation_api.rb +149 -0
- data/lib/korona_client/api/ticketing_api.rb +1084 -132
- data/lib/korona_client/api/time_tracking_api.rb +425 -0
- data/lib/korona_client/api_client.rb +11 -11
- data/lib/korona_client/api_error.rb +3 -3
- data/lib/korona_client/configuration.rb +4 -4
- data/lib/korona_client/models/account.rb +11 -15
- data/lib/korona_client/models/account_summary.rb +8 -13
- data/lib/korona_client/models/account_transaction.rb +32 -15
- data/lib/korona_client/models/add_or_update_result.rb +24 -19
- data/lib/korona_client/models/additional_info.rb +192 -0
- data/lib/korona_client/models/additional_receipt_info_type.rb +319 -0
- data/lib/korona_client/models/address_information.rb +8 -13
- data/lib/korona_client/models/admission.rb +8 -13
- data/lib/korona_client/models/amount.rb +8 -13
- data/lib/korona_client/models/amount_count_data.rb +8 -13
- data/lib/korona_client/models/assortment.rb +8 -13
- data/lib/korona_client/models/attendance.rb +268 -0
- data/lib/korona_client/models/bad_request_error.rb +11 -15
- data/lib/korona_client/models/capacity.rb +8 -13
- data/lib/korona_client/models/cashier.rb +21 -16
- data/lib/korona_client/models/cashier_summary.rb +8 -13
- data/lib/korona_client/models/category.rb +19 -15
- data/lib/korona_client/models/cloud_subscription.rb +11 -15
- data/lib/korona_client/models/commodity_group.rb +8 -13
- data/lib/korona_client/models/commodity_group_summary.rb +8 -13
- data/lib/korona_client/models/company_identification.rb +8 -13
- data/lib/korona_client/models/creation_task.rb +298 -0
- data/lib/korona_client/models/currency.rb +8 -13
- data/lib/korona_client/models/currency_denomination.rb +11 -15
- data/lib/korona_client/models/currency_exchange_rate.rb +8 -13
- data/lib/korona_client/models/customer.rb +11 -15
- data/lib/korona_client/models/customer_card.rb +11 -15
- data/lib/korona_client/models/customer_data.rb +8 -13
- data/lib/korona_client/models/customer_group.rb +8 -13
- data/lib/korona_client/models/customer_group_summary.rb +8 -13
- data/lib/korona_client/models/customer_information.rb +8 -13
- data/lib/korona_client/models/customer_order.rb +28 -29
- data/lib/korona_client/models/day_rating.rb +8 -13
- data/lib/korona_client/models/day_time_period.rb +192 -0
- data/lib/korona_client/models/delivery_note.rb +316 -0
- data/lib/korona_client/models/delivery_note_item.rb +239 -0
- data/lib/korona_client/models/deposit.rb +219 -0
- data/lib/korona_client/models/device_information.rb +8 -13
- data/lib/korona_client/models/discount.rb +201 -0
- data/lib/korona_client/models/economic_zone.rb +8 -13
- data/lib/korona_client/models/end_of_day_statement.rb +15 -20
- data/lib/korona_client/models/end_of_day_statement_summary.rb +8 -13
- data/lib/korona_client/models/entry_gate.rb +8 -13
- data/lib/korona_client/models/event.rb +30 -15
- data/lib/korona_client/models/external_system_call.rb +295 -0
- data/lib/korona_client/models/forbidden_error.rb +11 -15
- data/lib/korona_client/models/geo_location.rb +8 -13
- data/lib/korona_client/models/info_text.rb +11 -15
- data/lib/korona_client/models/interval.rb +8 -13
- data/lib/korona_client/models/inventory.rb +14 -18
- data/lib/korona_client/models/inventory_list.rb +11 -15
- data/lib/korona_client/models/inventory_list_item.rb +8 -13
- data/lib/korona_client/models/inventory_list_item_stock.rb +8 -13
- data/lib/korona_client/models/korona_account.rb +41 -13
- data/lib/korona_client/models/media_url.rb +183 -0
- data/lib/korona_client/models/method_not_allowed_error.rb +11 -15
- data/lib/korona_client/models/model_reference.rb +8 -12
- data/lib/korona_client/models/not_found_error.rb +11 -15
- data/lib/korona_client/models/organizational_unit.rb +20 -16
- data/lib/korona_client/models/payment.rb +8 -13
- data/lib/korona_client/models/payment_method.rb +37 -15
- data/lib/korona_client/models/payment_summary.rb +8 -13
- data/lib/korona_client/models/period.rb +8 -13
- data/lib/korona_client/models/period_list_top_seller.rb +8 -13
- data/lib/korona_client/models/period_map_string_revenue_data.rb +8 -13
- data/lib/korona_client/models/period_object.rb +8 -13
- data/lib/korona_client/models/period_revenue_data.rb +8 -13
- data/lib/korona_client/models/pos.rb +31 -15
- data/lib/korona_client/models/price_group.rb +8 -13
- data/lib/korona_client/models/product.rb +35 -19
- data/lib/korona_client/models/product_code.rb +8 -13
- data/lib/korona_client/models/product_description.rb +11 -15
- data/lib/korona_client/models/product_price.rb +8 -13
- data/lib/korona_client/models/product_stock.rb +8 -13
- data/lib/korona_client/models/product_subproduct.rb +8 -13
- data/lib/korona_client/models/product_supplier_price.rb +8 -13
- data/lib/korona_client/models/product_transfer_involved_party_information.rb +8 -13
- data/lib/korona_client/models/product_transfer_involved_party_information_data.rb +8 -13
- data/lib/korona_client/models/rating.rb +8 -13
- data/lib/korona_client/models/receipt.rb +55 -20
- data/lib/korona_client/models/receipt_item.rb +40 -14
- data/lib/korona_client/models/result_list.rb +14 -19
- data/lib/korona_client/models/result_list_account.rb +14 -19
- data/lib/korona_client/models/result_list_additional_receipt_info_type.rb +268 -0
- data/lib/korona_client/models/result_list_assortment.rb +14 -19
- data/lib/korona_client/models/result_list_attendance.rb +268 -0
- data/lib/korona_client/models/result_list_cashier.rb +14 -19
- data/lib/korona_client/models/result_list_commodity_group.rb +14 -19
- data/lib/korona_client/models/result_list_creation_task.rb +268 -0
- data/lib/korona_client/models/result_list_currency.rb +14 -19
- data/lib/korona_client/models/result_list_customer.rb +14 -19
- data/lib/korona_client/models/result_list_customer_group.rb +14 -19
- data/lib/korona_client/models/result_list_customer_order.rb +14 -19
- data/lib/korona_client/models/result_list_day_rating.rb +14 -19
- data/lib/korona_client/models/result_list_delivery_note.rb +268 -0
- data/lib/korona_client/models/result_list_economic_zone.rb +14 -19
- data/lib/korona_client/models/result_list_end_of_day_statement.rb +14 -19
- data/lib/korona_client/models/result_list_entry_gate.rb +14 -19
- data/lib/korona_client/models/result_list_event.rb +14 -19
- data/lib/korona_client/models/result_list_external_system_call.rb +268 -0
- data/lib/korona_client/models/result_list_info_text.rb +14 -19
- data/lib/korona_client/models/result_list_inventory.rb +14 -19
- data/lib/korona_client/models/result_list_inventory_list.rb +14 -19
- data/lib/korona_client/models/result_list_inventory_list_item.rb +14 -19
- data/lib/korona_client/models/result_list_organizational_unit.rb +14 -19
- data/lib/korona_client/models/result_list_payment_method.rb +14 -19
- data/lib/korona_client/models/result_list_pos.rb +14 -19
- data/lib/korona_client/models/result_list_price_group.rb +14 -19
- data/lib/korona_client/models/result_list_product.rb +14 -19
- data/lib/korona_client/models/result_list_product_stock.rb +14 -19
- data/lib/korona_client/models/result_list_receipt.rb +14 -19
- data/lib/korona_client/models/result_list_sales_tax.rb +14 -19
- data/lib/korona_client/models/result_list_sector.rb +14 -19
- data/lib/korona_client/models/result_list_stock_receipt.rb +14 -19
- data/lib/korona_client/models/result_list_stock_receipt_item.rb +14 -19
- data/lib/korona_client/models/result_list_supplier.rb +14 -19
- data/lib/korona_client/models/result_list_tag.rb +14 -19
- data/lib/korona_client/models/result_list_ticket.rb +268 -0
- data/lib/korona_client/models/result_list_ticket_definition.rb +14 -19
- data/lib/korona_client/models/result_list_time_tracking_entity.rb +268 -0
- data/lib/korona_client/models/result_list_time_tracking_entry.rb +268 -0
- data/lib/korona_client/models/revenue_data.rb +8 -13
- data/lib/korona_client/models/sales_tax.rb +8 -13
- data/lib/korona_client/models/sales_tax_rate.rb +8 -13
- data/lib/korona_client/models/sector.rb +21 -15
- data/lib/korona_client/models/sector_revenue_account_item.rb +192 -0
- data/lib/korona_client/models/sector_sales_tax_item.rb +8 -13
- data/lib/korona_client/models/signature.rb +216 -0
- data/lib/korona_client/models/statistic.rb +8 -13
- data/lib/korona_client/models/statistic_list_top_seller.rb +8 -13
- data/lib/korona_client/models/statistic_map_string_revenue_data.rb +8 -13
- data/lib/korona_client/models/statistic_revenue_data.rb +8 -13
- data/lib/korona_client/models/stock_receipt.rb +21 -16
- data/lib/korona_client/models/stock_receipt_item.rb +8 -13
- data/lib/korona_client/models/stock_receipt_item_amount.rb +8 -13
- data/lib/korona_client/models/stock_receipt_item_identification.rb +8 -13
- data/lib/korona_client/models/stock_receipt_item_purchase_price.rb +8 -13
- data/lib/korona_client/models/supplier.rb +8 -13
- data/lib/korona_client/models/supplier_contact.rb +8 -13
- data/lib/korona_client/models/supplier_contact_person.rb +8 -13
- data/lib/korona_client/models/supplier_payment_information.rb +11 -15
- data/lib/korona_client/models/tag.rb +8 -13
- data/lib/korona_client/models/tax_payment.rb +8 -13
- data/lib/korona_client/models/tax_summary.rb +8 -13
- data/lib/korona_client/models/ticket.rb +237 -0
- data/lib/korona_client/models/ticket_definition.rb +8 -13
- data/lib/korona_client/models/ticket_personalization.rb +225 -0
- data/lib/korona_client/models/time_period.rb +8 -13
- data/lib/korona_client/models/time_tracking_entity.rb +232 -0
- data/lib/korona_client/models/time_tracking_entry.rb +240 -0
- data/lib/korona_client/models/too_many_requests_error.rb +11 -15
- data/lib/korona_client/models/top_seller.rb +8 -13
- data/lib/korona_client/models/total_period.rb +192 -0
- data/lib/korona_client/models/total_price.rb +10 -14
- data/lib/korona_client/models/validity.rb +236 -0
- data/lib/korona_client/models/weather.rb +11 -15
- data/lib/korona_client/version.rb +4 -4
- data/node_modules/.yarn-integrity +12 -0
- data/spec/api/additional_receipt_info_types_api_spec.rb +66 -0
- data/spec/api/commodity_groups_api_spec.rb +133 -0
- data/spec/api/delivery_notes_api_spec.rb +112 -0
- data/spec/api/external_system_calls_api_spec.rb +133 -0
- data/spec/api/inventories_api_spec.rb +253 -0
- data/spec/api/stock_receipts_api_spec.rb +201 -0
- data/spec/api/ticket_creation_api_spec.rb +63 -0
- data/spec/api/time_tracking_api_spec.rb +129 -0
- data/spec/models/additional_info_spec.rb +47 -0
- data/spec/models/additional_receipt_info_type_spec.rb +125 -0
- data/spec/models/attendance_spec.rb +95 -0
- data/spec/models/creation_task_spec.rb +99 -0
- data/spec/models/day_time_period_spec.rb +47 -0
- data/spec/models/delivery_note_item_spec.rb +77 -0
- data/spec/models/delivery_note_spec.rb +125 -0
- data/spec/models/deposit_spec.rb +65 -0
- data/spec/models/discount_spec.rb +53 -0
- data/spec/models/external_system_call_spec.rb +113 -0
- data/spec/models/media_url_spec.rb +41 -0
- data/spec/models/result_list_additional_receipt_info_type_spec.rb +71 -0
- data/spec/models/result_list_attendance_spec.rb +71 -0
- data/spec/models/result_list_creation_task_spec.rb +71 -0
- data/spec/models/result_list_delivery_note_spec.rb +71 -0
- data/spec/models/result_list_external_system_call_spec.rb +71 -0
- data/spec/models/result_list_ticket_spec.rb +71 -0
- data/spec/models/result_list_time_tracking_entity_spec.rb +71 -0
- data/spec/models/result_list_time_tracking_entry_spec.rb +71 -0
- data/spec/models/sector_revenue_account_item_spec.rb +47 -0
- data/spec/models/signature_spec.rb +53 -0
- data/spec/models/ticket_personalization_spec.rb +59 -0
- data/spec/models/ticket_spec.rb +77 -0
- data/spec/models/time_tracking_entity_spec.rb +71 -0
- data/spec/models/time_tracking_entry_spec.rb +77 -0
- data/spec/models/total_period_spec.rb +47 -0
- data/spec/models/validity_spec.rb +63 -0
- data/yarn.lock +4 -0
- metadata +162 -18
data/docs/PaymentMethod.md
CHANGED
@@ -13,5 +13,8 @@ Name | Type | Description | Notes
|
|
13
13
|
**force_print** | **BOOLEAN** | | [optional]
|
14
14
|
**name** | **String** | | [optional]
|
15
15
|
**print_copies** | **Integer** | | [optional]
|
16
|
+
**tag** | [**ModelReference**](ModelReference.md) | | [optional]
|
17
|
+
**use_cash_drawer** | **BOOLEAN** | | [optional]
|
18
|
+
**revenue_account** | [**ModelReference**](ModelReference.md) | | [optional]
|
16
19
|
|
17
20
|
|
data/docs/PaymentMethodsApi.md
CHANGED
@@ -4,14 +4,14 @@ All URIs are relative to *https://www.koronacloud.com/web/api/v3*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**get_payment_method**](PaymentMethodsApi.md#get_payment_method) | **GET** /accounts/{koronaAccountId}/paymentMethods/{
|
7
|
+
[**get_payment_method**](PaymentMethodsApi.md#get_payment_method) | **GET** /accounts/{koronaAccountId}/paymentMethods/{paymentMethodId} | returns the single payment method
|
8
8
|
[**get_payment_methods**](PaymentMethodsApi.md#get_payment_methods) | **GET** /accounts/{koronaAccountId}/paymentMethods | lists all payment methods
|
9
9
|
|
10
10
|
|
11
11
|
# **get_payment_method**
|
12
|
-
> PaymentMethod get_payment_method(korona_account_id,
|
12
|
+
> PaymentMethod get_payment_method(korona_account_id, payment_method_id)
|
13
13
|
|
14
|
-
|
14
|
+
returns the single payment method
|
15
15
|
|
16
16
|
|
17
17
|
|
@@ -28,14 +28,14 @@ end
|
|
28
28
|
|
29
29
|
api_instance = KoronaClient::PaymentMethodsApi.new
|
30
30
|
|
31
|
-
korona_account_id =
|
31
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
32
32
|
|
33
|
-
|
33
|
+
payment_method_id = 'payment_method_id_example' # String | id of the related object (important: id should match the uuid-format)
|
34
34
|
|
35
35
|
|
36
36
|
begin
|
37
|
-
#
|
38
|
-
result = api_instance.get_payment_method(korona_account_id,
|
37
|
+
#returns the single payment method
|
38
|
+
result = api_instance.get_payment_method(korona_account_id, payment_method_id)
|
39
39
|
p result
|
40
40
|
rescue KoronaClient::ApiError => e
|
41
41
|
puts "Exception when calling PaymentMethodsApi->get_payment_method: #{e}"
|
@@ -46,8 +46,8 @@ end
|
|
46
46
|
|
47
47
|
Name | Type | Description | Notes
|
48
48
|
------------- | ------------- | ------------- | -------------
|
49
|
-
**korona_account_id** | **String**| the account
|
50
|
-
**
|
49
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
50
|
+
**payment_method_id** | **String**| id of the related object (important: id should match the uuid-format) |
|
51
51
|
|
52
52
|
### Return type
|
53
53
|
|
@@ -84,14 +84,15 @@ end
|
|
84
84
|
|
85
85
|
api_instance = KoronaClient::PaymentMethodsApi.new
|
86
86
|
|
87
|
-
korona_account_id =
|
87
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
88
88
|
|
89
89
|
opts = {
|
90
90
|
page: 56, # Integer | number of the page to fetch
|
91
91
|
size: 56, # Integer | amount of objects to return per page
|
92
|
-
sort:
|
92
|
+
sort: 'sort_example', # String | attribute to sort by (multiple separated by comma; max. 5)
|
93
93
|
revision: 789, # Integer | last revision number, objects with a greater revision than this will be returned
|
94
|
-
include_deleted: true # BOOLEAN | indicates deleted objects should be loaded or not (default: false)
|
94
|
+
include_deleted: true, # BOOLEAN | indicates deleted objects should be loaded or not (default: false)
|
95
|
+
number: 'number_example' # String | number of the related object
|
95
96
|
}
|
96
97
|
|
97
98
|
begin
|
@@ -107,12 +108,13 @@ end
|
|
107
108
|
|
108
109
|
Name | Type | Description | Notes
|
109
110
|
------------- | ------------- | ------------- | -------------
|
110
|
-
**korona_account_id** | **String**| the account
|
111
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
111
112
|
**page** | **Integer**| number of the page to fetch | [optional]
|
112
113
|
**size** | **Integer**| amount of objects to return per page | [optional]
|
113
114
|
**sort** | **String**| attribute to sort by (multiple separated by comma; max. 5) | [optional]
|
114
115
|
**revision** | **Integer**| last revision number, objects with a greater revision than this will be returned | [optional]
|
115
116
|
**include_deleted** | **BOOLEAN**| indicates deleted objects should be loaded or not (default: false) | [optional]
|
117
|
+
**number** | **String**| number of the related object | [optional]
|
116
118
|
|
117
119
|
### Return type
|
118
120
|
|
data/docs/PointsOfSaleApi.md
CHANGED
@@ -4,18 +4,18 @@ All URIs are relative to *https://www.koronacloud.com/web/api/v3*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**add_point_of_sale_end_of_day_statements**](PointsOfSaleApi.md#add_point_of_sale_end_of_day_statements) | **POST** /accounts/{koronaAccountId}/pointsOfSale/{
|
8
|
-
[**add_point_of_sale_receipts**](PointsOfSaleApi.md#add_point_of_sale_receipts) | **POST** /accounts/{koronaAccountId}/pointsOfSale/{
|
9
|
-
[**get_point_of_sale**](PointsOfSaleApi.md#get_point_of_sale) | **GET** /accounts/{koronaAccountId}/pointsOfSale/{
|
10
|
-
[**get_point_of_sale_end_of_day_statements**](PointsOfSaleApi.md#get_point_of_sale_end_of_day_statements) | **GET** /accounts/{koronaAccountId}/pointsOfSale/{
|
11
|
-
[**get_point_of_sale_receipt**](PointsOfSaleApi.md#get_point_of_sale_receipt) | **GET** /accounts/{koronaAccountId}/pointsOfSale/{
|
12
|
-
[**get_point_of_sale_receipts**](PointsOfSaleApi.md#get_point_of_sale_receipts) | **GET** /accounts/{koronaAccountId}/pointsOfSale/{
|
13
|
-
[**get_points_of_sale**](PointsOfSaleApi.md#get_points_of_sale) | **GET** /accounts/{koronaAccountId}/pointsOfSale | lists all
|
14
|
-
[**update_point_of_sale**](PointsOfSaleApi.md#update_point_of_sale) | **PATCH** /accounts/{koronaAccountId}/pointsOfSale/{
|
7
|
+
[**add_point_of_sale_end_of_day_statements**](PointsOfSaleApi.md#add_point_of_sale_end_of_day_statements) | **POST** /accounts/{koronaAccountId}/pointsOfSale/{pointOfSaleId}/endOfDayStatements | adds a batch of point of sale-related end-of-day-statements
|
8
|
+
[**add_point_of_sale_receipts**](PointsOfSaleApi.md#add_point_of_sale_receipts) | **POST** /accounts/{koronaAccountId}/pointsOfSale/{pointOfSaleId}/receipts | adds a batch of point of sale-related receipts
|
9
|
+
[**get_point_of_sale**](PointsOfSaleApi.md#get_point_of_sale) | **GET** /accounts/{koronaAccountId}/pointsOfSale/{pointOfSaleId} | returns the single point of sale
|
10
|
+
[**get_point_of_sale_end_of_day_statements**](PointsOfSaleApi.md#get_point_of_sale_end_of_day_statements) | **GET** /accounts/{koronaAccountId}/pointsOfSale/{pointOfSaleId}/endOfDayStatements | lists all point of sale-related end-of-day-statements
|
11
|
+
[**get_point_of_sale_receipt**](PointsOfSaleApi.md#get_point_of_sale_receipt) | **GET** /accounts/{koronaAccountId}/pointsOfSale/{pointOfSaleId}/receipts/{receiptId} | returns the single point of sale-related receipt
|
12
|
+
[**get_point_of_sale_receipts**](PointsOfSaleApi.md#get_point_of_sale_receipts) | **GET** /accounts/{koronaAccountId}/pointsOfSale/{pointOfSaleId}/receipts | lists all point of sale-related receipts
|
13
|
+
[**get_points_of_sale**](PointsOfSaleApi.md#get_points_of_sale) | **GET** /accounts/{koronaAccountId}/pointsOfSale | lists all points of sale
|
14
|
+
[**update_point_of_sale**](PointsOfSaleApi.md#update_point_of_sale) | **PATCH** /accounts/{koronaAccountId}/pointsOfSale/{pointOfSaleId} | updates a point of sale (works only for coupling (attribute 'couplingId') or updating device information (attribute 'deviceInformation'))
|
15
15
|
|
16
16
|
|
17
17
|
# **add_point_of_sale_end_of_day_statements**
|
18
|
-
> Array<AddOrUpdateResult> add_point_of_sale_end_of_day_statements(korona_account_id,
|
18
|
+
> Array<AddOrUpdateResult> add_point_of_sale_end_of_day_statements(korona_account_id, point_of_sale_id, coupling_id, opts)
|
19
19
|
|
20
20
|
adds a batch of point of sale-related end-of-day-statements
|
21
21
|
|
@@ -34,11 +34,11 @@ end
|
|
34
34
|
|
35
35
|
api_instance = KoronaClient::PointsOfSaleApi.new
|
36
36
|
|
37
|
-
korona_account_id =
|
37
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
38
38
|
|
39
|
-
|
39
|
+
point_of_sale_id = 'point_of_sale_id_example' # String | id of the related object (important: id should match the uuid-format)
|
40
40
|
|
41
|
-
coupling_id =
|
41
|
+
coupling_id = 'coupling_id_example' # String | the coupling-id of the device
|
42
42
|
|
43
43
|
opts = {
|
44
44
|
body: [KoronaClient::EndOfDayStatement.new] # Array<EndOfDayStatement> | the end-of-day-statements to add
|
@@ -46,7 +46,7 @@ opts = {
|
|
46
46
|
|
47
47
|
begin
|
48
48
|
#adds a batch of point of sale-related end-of-day-statements
|
49
|
-
result = api_instance.add_point_of_sale_end_of_day_statements(korona_account_id,
|
49
|
+
result = api_instance.add_point_of_sale_end_of_day_statements(korona_account_id, point_of_sale_id, coupling_id, opts)
|
50
50
|
p result
|
51
51
|
rescue KoronaClient::ApiError => e
|
52
52
|
puts "Exception when calling PointsOfSaleApi->add_point_of_sale_end_of_day_statements: #{e}"
|
@@ -57,8 +57,8 @@ end
|
|
57
57
|
|
58
58
|
Name | Type | Description | Notes
|
59
59
|
------------- | ------------- | ------------- | -------------
|
60
|
-
**korona_account_id** | **String**| the account
|
61
|
-
**
|
60
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
61
|
+
**point_of_sale_id** | **String**| id of the related object (important: id should match the uuid-format) |
|
62
62
|
**coupling_id** | **String**| the coupling-id of the device |
|
63
63
|
**body** | [**Array<EndOfDayStatement>**](EndOfDayStatement.md)| the end-of-day-statements to add | [optional]
|
64
64
|
|
@@ -78,7 +78,7 @@ Name | Type | Description | Notes
|
|
78
78
|
|
79
79
|
|
80
80
|
# **add_point_of_sale_receipts**
|
81
|
-
> Array<AddOrUpdateResult> add_point_of_sale_receipts(korona_account_id,
|
81
|
+
> Array<AddOrUpdateResult> add_point_of_sale_receipts(korona_account_id, point_of_sale_id, coupling_id, opts)
|
82
82
|
|
83
83
|
adds a batch of point of sale-related receipts
|
84
84
|
|
@@ -97,11 +97,11 @@ end
|
|
97
97
|
|
98
98
|
api_instance = KoronaClient::PointsOfSaleApi.new
|
99
99
|
|
100
|
-
korona_account_id =
|
100
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
101
101
|
|
102
|
-
|
102
|
+
point_of_sale_id = 'point_of_sale_id_example' # String | id of the related object (important: id should match the uuid-format)
|
103
103
|
|
104
|
-
coupling_id =
|
104
|
+
coupling_id = 'coupling_id_example' # String | the coupling-id of the device
|
105
105
|
|
106
106
|
opts = {
|
107
107
|
body: [KoronaClient::Receipt.new] # Array<Receipt> | the receipts to add
|
@@ -109,7 +109,7 @@ opts = {
|
|
109
109
|
|
110
110
|
begin
|
111
111
|
#adds a batch of point of sale-related receipts
|
112
|
-
result = api_instance.add_point_of_sale_receipts(korona_account_id,
|
112
|
+
result = api_instance.add_point_of_sale_receipts(korona_account_id, point_of_sale_id, coupling_id, opts)
|
113
113
|
p result
|
114
114
|
rescue KoronaClient::ApiError => e
|
115
115
|
puts "Exception when calling PointsOfSaleApi->add_point_of_sale_receipts: #{e}"
|
@@ -120,8 +120,8 @@ end
|
|
120
120
|
|
121
121
|
Name | Type | Description | Notes
|
122
122
|
------------- | ------------- | ------------- | -------------
|
123
|
-
**korona_account_id** | **String**| the account
|
124
|
-
**
|
123
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
124
|
+
**point_of_sale_id** | **String**| id of the related object (important: id should match the uuid-format) |
|
125
125
|
**coupling_id** | **String**| the coupling-id of the device |
|
126
126
|
**body** | [**Array<Receipt>**](Receipt.md)| the receipts to add | [optional]
|
127
127
|
|
@@ -141,9 +141,9 @@ Name | Type | Description | Notes
|
|
141
141
|
|
142
142
|
|
143
143
|
# **get_point_of_sale**
|
144
|
-
> Pos get_point_of_sale(korona_account_id,
|
144
|
+
> Pos get_point_of_sale(korona_account_id, point_of_sale_id, opts)
|
145
145
|
|
146
|
-
|
146
|
+
returns the single point of sale
|
147
147
|
|
148
148
|
|
149
149
|
|
@@ -160,17 +160,17 @@ end
|
|
160
160
|
|
161
161
|
api_instance = KoronaClient::PointsOfSaleApi.new
|
162
162
|
|
163
|
-
korona_account_id =
|
163
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
164
164
|
|
165
|
-
|
165
|
+
point_of_sale_id = 'point_of_sale_id_example' # String | the number of the point of sale
|
166
166
|
|
167
167
|
opts = {
|
168
|
-
coupling_id:
|
168
|
+
coupling_id: 'coupling_id_example' # String | the coupling-id of the device. It can be set to check whether your coupling-id is correct or not (works only, if point of sale is external).
|
169
169
|
}
|
170
170
|
|
171
171
|
begin
|
172
|
-
#
|
173
|
-
result = api_instance.get_point_of_sale(korona_account_id,
|
172
|
+
#returns the single point of sale
|
173
|
+
result = api_instance.get_point_of_sale(korona_account_id, point_of_sale_id, opts)
|
174
174
|
p result
|
175
175
|
rescue KoronaClient::ApiError => e
|
176
176
|
puts "Exception when calling PointsOfSaleApi->get_point_of_sale: #{e}"
|
@@ -181,8 +181,8 @@ end
|
|
181
181
|
|
182
182
|
Name | Type | Description | Notes
|
183
183
|
------------- | ------------- | ------------- | -------------
|
184
|
-
**korona_account_id** | **String**| the account
|
185
|
-
**
|
184
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
185
|
+
**point_of_sale_id** | **String**| the number of the point of sale |
|
186
186
|
**coupling_id** | **String**| the coupling-id of the device. It can be set to check whether your coupling-id is correct or not (works only, if point of sale is external). | [optional]
|
187
187
|
|
188
188
|
### Return type
|
@@ -201,7 +201,7 @@ Name | Type | Description | Notes
|
|
201
201
|
|
202
202
|
|
203
203
|
# **get_point_of_sale_end_of_day_statements**
|
204
|
-
> ResultListEndOfDayStatement get_point_of_sale_end_of_day_statements(korona_account_id,
|
204
|
+
> ResultListEndOfDayStatement get_point_of_sale_end_of_day_statements(korona_account_id, point_of_sale_id, opts)
|
205
205
|
|
206
206
|
lists all point of sale-related end-of-day-statements
|
207
207
|
|
@@ -220,22 +220,21 @@ end
|
|
220
220
|
|
221
221
|
api_instance = KoronaClient::PointsOfSaleApi.new
|
222
222
|
|
223
|
-
korona_account_id =
|
223
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
224
224
|
|
225
|
-
|
226
|
-
|
227
|
-
coupling_id = "coupling_id_example" # String | the coupling-id of the device
|
225
|
+
point_of_sale_id = 'point_of_sale_id_example' # String | id of the related object (important: id should match the uuid-format)
|
228
226
|
|
229
227
|
opts = {
|
228
|
+
coupling_id: 'coupling_id_example', # String | the coupling-id of the device. It can be set to check whether your coupling-id is correct or not (works only, if point of sale is external).
|
230
229
|
page: 56, # Integer | number of the page to fetch
|
231
230
|
size: 56, # Integer | amount of objects to return per page
|
232
|
-
sort:
|
231
|
+
sort: 'sort_example', # String | attribute to sort by (multiple separated by comma; max. 5)
|
233
232
|
revision: 789 # Integer | last revision number, objects with a greater revision than this will be returned
|
234
233
|
}
|
235
234
|
|
236
235
|
begin
|
237
236
|
#lists all point of sale-related end-of-day-statements
|
238
|
-
result = api_instance.get_point_of_sale_end_of_day_statements(korona_account_id,
|
237
|
+
result = api_instance.get_point_of_sale_end_of_day_statements(korona_account_id, point_of_sale_id, opts)
|
239
238
|
p result
|
240
239
|
rescue KoronaClient::ApiError => e
|
241
240
|
puts "Exception when calling PointsOfSaleApi->get_point_of_sale_end_of_day_statements: #{e}"
|
@@ -246,9 +245,9 @@ end
|
|
246
245
|
|
247
246
|
Name | Type | Description | Notes
|
248
247
|
------------- | ------------- | ------------- | -------------
|
249
|
-
**korona_account_id** | **String**| the account
|
250
|
-
**
|
251
|
-
**coupling_id** | **String**| the coupling-id of the device |
|
248
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
249
|
+
**point_of_sale_id** | **String**| id of the related object (important: id should match the uuid-format) |
|
250
|
+
**coupling_id** | **String**| the coupling-id of the device. It can be set to check whether your coupling-id is correct or not (works only, if point of sale is external). | [optional]
|
252
251
|
**page** | **Integer**| number of the page to fetch | [optional]
|
253
252
|
**size** | **Integer**| amount of objects to return per page | [optional]
|
254
253
|
**sort** | **String**| attribute to sort by (multiple separated by comma; max. 5) | [optional]
|
@@ -270,9 +269,9 @@ Name | Type | Description | Notes
|
|
270
269
|
|
271
270
|
|
272
271
|
# **get_point_of_sale_receipt**
|
273
|
-
> Receipt get_point_of_sale_receipt(korona_account_id,
|
272
|
+
> Receipt get_point_of_sale_receipt(korona_account_id, point_of_sale_id, receipt_id, opts)
|
274
273
|
|
275
|
-
|
274
|
+
returns the single point of sale-related receipt
|
276
275
|
|
277
276
|
|
278
277
|
|
@@ -289,19 +288,19 @@ end
|
|
289
288
|
|
290
289
|
api_instance = KoronaClient::PointsOfSaleApi.new
|
291
290
|
|
292
|
-
korona_account_id =
|
291
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
293
292
|
|
294
|
-
|
293
|
+
point_of_sale_id = 'point_of_sale_id_example' # String | id of the related object (important: id should match the uuid-format)
|
295
294
|
|
296
|
-
receipt_id =
|
295
|
+
receipt_id = 'receipt_id_example' # String | the id of the receipt
|
297
296
|
|
298
297
|
opts = {
|
299
|
-
coupling_id:
|
298
|
+
coupling_id: 'coupling_id_example' # String | the coupling-id of the device. It can be set to check whether your coupling-id is correct or not (works only, if point of sale is external).
|
300
299
|
}
|
301
300
|
|
302
301
|
begin
|
303
|
-
#
|
304
|
-
result = api_instance.get_point_of_sale_receipt(korona_account_id,
|
302
|
+
#returns the single point of sale-related receipt
|
303
|
+
result = api_instance.get_point_of_sale_receipt(korona_account_id, point_of_sale_id, receipt_id, opts)
|
305
304
|
p result
|
306
305
|
rescue KoronaClient::ApiError => e
|
307
306
|
puts "Exception when calling PointsOfSaleApi->get_point_of_sale_receipt: #{e}"
|
@@ -312,8 +311,8 @@ end
|
|
312
311
|
|
313
312
|
Name | Type | Description | Notes
|
314
313
|
------------- | ------------- | ------------- | -------------
|
315
|
-
**korona_account_id** | **String**| the account
|
316
|
-
**
|
314
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
315
|
+
**point_of_sale_id** | **String**| id of the related object (important: id should match the uuid-format) |
|
317
316
|
**receipt_id** | **String**| the id of the receipt |
|
318
317
|
**coupling_id** | **String**| the coupling-id of the device. It can be set to check whether your coupling-id is correct or not (works only, if point of sale is external). | [optional]
|
319
318
|
|
@@ -333,7 +332,7 @@ Name | Type | Description | Notes
|
|
333
332
|
|
334
333
|
|
335
334
|
# **get_point_of_sale_receipts**
|
336
|
-
> ResultListReceipt get_point_of_sale_receipts(korona_account_id,
|
335
|
+
> ResultListReceipt get_point_of_sale_receipts(korona_account_id, point_of_sale_id, opts)
|
337
336
|
|
338
337
|
lists all point of sale-related receipts
|
339
338
|
|
@@ -352,24 +351,27 @@ end
|
|
352
351
|
|
353
352
|
api_instance = KoronaClient::PointsOfSaleApi.new
|
354
353
|
|
355
|
-
korona_account_id =
|
354
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
356
355
|
|
357
|
-
|
356
|
+
point_of_sale_id = 'point_of_sale_id_example' # String | id of the related object (important: id should match the uuid-format)
|
358
357
|
|
359
358
|
opts = {
|
360
|
-
coupling_id:
|
359
|
+
coupling_id: 'coupling_id_example', # String | the coupling-id of the device. It can be set to check whether your coupling-id is correct or not (works only, if point of sale is external).
|
361
360
|
page: 56, # Integer | number of the page to fetch
|
362
361
|
size: 56, # Integer | amount of objects to return per page
|
363
|
-
sort:
|
362
|
+
sort: 'sort_example', # String | attribute to sort by (multiple separated by comma; max. 5)
|
364
363
|
revision: 789, # Integer | last revision number, objects with a greater revision than this will be returned
|
365
364
|
z_count: 789, # Integer | z-count of the receipt
|
366
|
-
min_create_time: DateTime.parse(
|
367
|
-
max_create_time: DateTime.parse(
|
365
|
+
min_create_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | min (inclusive) create time of the receipt (ISO 8601; date, time and timezone)
|
366
|
+
max_create_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | max (inclusive) create time of the receipt (ISO 8601; date, time and timezone)
|
367
|
+
number: 'number_example', # String | number of the related object
|
368
|
+
min_booking_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | min (inclusive) booking time of the receipt (ISO 8601; date, time and timezone)
|
369
|
+
max_booking_time: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | max (inclusive) booking time of the receipt (ISO 8601; date, time and timezone)
|
368
370
|
}
|
369
371
|
|
370
372
|
begin
|
371
373
|
#lists all point of sale-related receipts
|
372
|
-
result = api_instance.get_point_of_sale_receipts(korona_account_id,
|
374
|
+
result = api_instance.get_point_of_sale_receipts(korona_account_id, point_of_sale_id, opts)
|
373
375
|
p result
|
374
376
|
rescue KoronaClient::ApiError => e
|
375
377
|
puts "Exception when calling PointsOfSaleApi->get_point_of_sale_receipts: #{e}"
|
@@ -380,8 +382,8 @@ end
|
|
380
382
|
|
381
383
|
Name | Type | Description | Notes
|
382
384
|
------------- | ------------- | ------------- | -------------
|
383
|
-
**korona_account_id** | **String**| the account
|
384
|
-
**
|
385
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
386
|
+
**point_of_sale_id** | **String**| id of the related object (important: id should match the uuid-format) |
|
385
387
|
**coupling_id** | **String**| the coupling-id of the device. It can be set to check whether your coupling-id is correct or not (works only, if point of sale is external). | [optional]
|
386
388
|
**page** | **Integer**| number of the page to fetch | [optional]
|
387
389
|
**size** | **Integer**| amount of objects to return per page | [optional]
|
@@ -390,6 +392,9 @@ Name | Type | Description | Notes
|
|
390
392
|
**z_count** | **Integer**| z-count of the receipt | [optional]
|
391
393
|
**min_create_time** | **DateTime**| min (inclusive) create time of the receipt (ISO 8601; date, time and timezone) | [optional]
|
392
394
|
**max_create_time** | **DateTime**| max (inclusive) create time of the receipt (ISO 8601; date, time and timezone) | [optional]
|
395
|
+
**number** | **String**| number of the related object | [optional]
|
396
|
+
**min_booking_time** | **DateTime**| min (inclusive) booking time of the receipt (ISO 8601; date, time and timezone) | [optional]
|
397
|
+
**max_booking_time** | **DateTime**| max (inclusive) booking time of the receipt (ISO 8601; date, time and timezone) | [optional]
|
393
398
|
|
394
399
|
### Return type
|
395
400
|
|
@@ -409,7 +414,7 @@ Name | Type | Description | Notes
|
|
409
414
|
# **get_points_of_sale**
|
410
415
|
> ResultListPos get_points_of_sale(korona_account_id, opts)
|
411
416
|
|
412
|
-
lists all
|
417
|
+
lists all points of sale
|
413
418
|
|
414
419
|
|
415
420
|
|
@@ -426,18 +431,21 @@ end
|
|
426
431
|
|
427
432
|
api_instance = KoronaClient::PointsOfSaleApi.new
|
428
433
|
|
429
|
-
korona_account_id =
|
434
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
430
435
|
|
431
436
|
opts = {
|
432
437
|
page: 56, # Integer | number of the page to fetch
|
433
438
|
size: 56, # Integer | amount of objects to return per page
|
434
|
-
sort:
|
439
|
+
sort: 'sort_example', # String | attribute to sort by (multiple separated by comma; max. 5)
|
435
440
|
revision: 789, # Integer | last revision number, objects with a greater revision than this will be returned
|
436
|
-
include_deleted: true # BOOLEAN | indicates deleted objects should be loaded or not (default: false)
|
441
|
+
include_deleted: true, # BOOLEAN | indicates deleted objects should be loaded or not (default: false)
|
442
|
+
number: 'number_example', # String | number of the related object
|
443
|
+
external: true, # BOOLEAN | indicates external/internal devices should be loaded (default: null (load all))
|
444
|
+
coupled: true # BOOLEAN | indicates coupled/not coupled devices should be loaded (default: null (load all))
|
437
445
|
}
|
438
446
|
|
439
447
|
begin
|
440
|
-
#lists all
|
448
|
+
#lists all points of sale
|
441
449
|
result = api_instance.get_points_of_sale(korona_account_id, opts)
|
442
450
|
p result
|
443
451
|
rescue KoronaClient::ApiError => e
|
@@ -449,12 +457,15 @@ end
|
|
449
457
|
|
450
458
|
Name | Type | Description | Notes
|
451
459
|
------------- | ------------- | ------------- | -------------
|
452
|
-
**korona_account_id** | **String**| the account
|
460
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
453
461
|
**page** | **Integer**| number of the page to fetch | [optional]
|
454
462
|
**size** | **Integer**| amount of objects to return per page | [optional]
|
455
463
|
**sort** | **String**| attribute to sort by (multiple separated by comma; max. 5) | [optional]
|
456
464
|
**revision** | **Integer**| last revision number, objects with a greater revision than this will be returned | [optional]
|
457
465
|
**include_deleted** | **BOOLEAN**| indicates deleted objects should be loaded or not (default: false) | [optional]
|
466
|
+
**number** | **String**| number of the related object | [optional]
|
467
|
+
**external** | **BOOLEAN**| indicates external/internal devices should be loaded (default: null (load all)) | [optional]
|
468
|
+
**coupled** | **BOOLEAN**| indicates coupled/not coupled devices should be loaded (default: null (load all)) | [optional]
|
458
469
|
|
459
470
|
### Return type
|
460
471
|
|
@@ -472,7 +483,7 @@ Name | Type | Description | Notes
|
|
472
483
|
|
473
484
|
|
474
485
|
# **update_point_of_sale**
|
475
|
-
> update_point_of_sale(korona_account_id,
|
486
|
+
> update_point_of_sale(korona_account_id, point_of_sale_id, body, opts)
|
476
487
|
|
477
488
|
updates a point of sale (works only for coupling (attribute 'couplingId') or updating device information (attribute 'deviceInformation'))
|
478
489
|
|
@@ -491,20 +502,20 @@ end
|
|
491
502
|
|
492
503
|
api_instance = KoronaClient::PointsOfSaleApi.new
|
493
504
|
|
494
|
-
korona_account_id =
|
505
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
495
506
|
|
496
|
-
|
507
|
+
point_of_sale_id = 'point_of_sale_id_example' # String | id of the related object (important: id should match the uuid-format)
|
497
508
|
|
498
509
|
body = KoronaClient::Pos.new # Pos | the properties to update of the point of sale ('couplingId' only)
|
499
510
|
|
500
511
|
opts = {
|
501
|
-
coupling_id:
|
512
|
+
coupling_id: 'coupling_id_example', # String | the coupling-id of the device (required if already coupled)
|
502
513
|
decouple: true # BOOLEAN | executes uncoupling, if set to true, device will be uncoupled if point of sale is already coupled
|
503
514
|
}
|
504
515
|
|
505
516
|
begin
|
506
517
|
#updates a point of sale (works only for coupling (attribute 'couplingId') or updating device information (attribute 'deviceInformation'))
|
507
|
-
api_instance.update_point_of_sale(korona_account_id,
|
518
|
+
api_instance.update_point_of_sale(korona_account_id, point_of_sale_id, body, opts)
|
508
519
|
rescue KoronaClient::ApiError => e
|
509
520
|
puts "Exception when calling PointsOfSaleApi->update_point_of_sale: #{e}"
|
510
521
|
end
|
@@ -514,8 +525,8 @@ end
|
|
514
525
|
|
515
526
|
Name | Type | Description | Notes
|
516
527
|
------------- | ------------- | ------------- | -------------
|
517
|
-
**korona_account_id** | **String**| the account
|
518
|
-
**
|
528
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
529
|
+
**point_of_sale_id** | **String**| id of the related object (important: id should match the uuid-format) |
|
519
530
|
**body** | [**Pos**](Pos.md)| the properties to update of the point of sale ('couplingId' only) |
|
520
531
|
**coupling_id** | **String**| the coupling-id of the device (required if already coupled) | [optional]
|
521
532
|
**decouple** | **BOOLEAN**| executes uncoupling, if set to true, device will be uncoupled if point of sale is already coupled | [optional]
|