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/Ticket.md
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
# KoronaClient::Ticket
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**entry_id** | **Integer** | | [optional]
|
7
|
+
**personalization** | [**TicketPersonalization**](TicketPersonalization.md) | | [optional]
|
8
|
+
**ticket_number** | **String** | | [optional]
|
9
|
+
**duplicate** | **BOOLEAN** | | [optional]
|
10
|
+
**creation_date** | **DateTime** | | [optional]
|
11
|
+
**locked** | **BOOLEAN** | | [optional]
|
12
|
+
**locked_to** | **DateTime** | | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,127 @@
|
|
1
|
+
# KoronaClient::TicketCreationApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://www.koronacloud.com/web/api/v3*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**add_creation_task**](TicketCreationApi.md#add_creation_task) | **POST** /accounts/{koronaAccountId}/ticketCreation | adds a creation task
|
8
|
+
[**get_creation_tasks**](TicketCreationApi.md#get_creation_tasks) | **GET** /accounts/{koronaAccountId}/ticketCreation | creation tasks, personalization will always be empty for technical reasons
|
9
|
+
|
10
|
+
|
11
|
+
# **add_creation_task**
|
12
|
+
> AddOrUpdateResult add_creation_task(korona_account_id, body)
|
13
|
+
|
14
|
+
adds a creation task
|
15
|
+
|
16
|
+
|
17
|
+
|
18
|
+
### Example
|
19
|
+
```ruby
|
20
|
+
# load the gem
|
21
|
+
require 'korona_client'
|
22
|
+
# setup authorization
|
23
|
+
KoronaClient.configure do |config|
|
24
|
+
# Configure HTTP basic authorization: basicAuth
|
25
|
+
config.username = 'YOUR USERNAME'
|
26
|
+
config.password = 'YOUR PASSWORD'
|
27
|
+
end
|
28
|
+
|
29
|
+
api_instance = KoronaClient::TicketCreationApi.new
|
30
|
+
|
31
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
32
|
+
|
33
|
+
body = KoronaClient::CreationTask.new # CreationTask | a single ticket creation task
|
34
|
+
|
35
|
+
|
36
|
+
begin
|
37
|
+
#adds a creation task
|
38
|
+
result = api_instance.add_creation_task(korona_account_id, body)
|
39
|
+
p result
|
40
|
+
rescue KoronaClient::ApiError => e
|
41
|
+
puts "Exception when calling TicketCreationApi->add_creation_task: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
### Parameters
|
46
|
+
|
47
|
+
Name | Type | Description | Notes
|
48
|
+
------------- | ------------- | ------------- | -------------
|
49
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
50
|
+
**body** | [**CreationTask**](CreationTask.md)| a single ticket creation task |
|
51
|
+
|
52
|
+
### Return type
|
53
|
+
|
54
|
+
[**AddOrUpdateResult**](AddOrUpdateResult.md)
|
55
|
+
|
56
|
+
### Authorization
|
57
|
+
|
58
|
+
[basicAuth](../README.md#basicAuth)
|
59
|
+
|
60
|
+
### HTTP request headers
|
61
|
+
|
62
|
+
- **Content-Type**: application/json
|
63
|
+
- **Accept**: application/json
|
64
|
+
|
65
|
+
|
66
|
+
|
67
|
+
# **get_creation_tasks**
|
68
|
+
> ResultListCreationTask get_creation_tasks(korona_account_id, opts)
|
69
|
+
|
70
|
+
creation tasks, personalization will always be empty for technical reasons
|
71
|
+
|
72
|
+
|
73
|
+
|
74
|
+
### Example
|
75
|
+
```ruby
|
76
|
+
# load the gem
|
77
|
+
require 'korona_client'
|
78
|
+
# setup authorization
|
79
|
+
KoronaClient.configure do |config|
|
80
|
+
# Configure HTTP basic authorization: basicAuth
|
81
|
+
config.username = 'YOUR USERNAME'
|
82
|
+
config.password = 'YOUR PASSWORD'
|
83
|
+
end
|
84
|
+
|
85
|
+
api_instance = KoronaClient::TicketCreationApi.new
|
86
|
+
|
87
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
88
|
+
|
89
|
+
opts = {
|
90
|
+
creation_time_from: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | creation time from
|
91
|
+
creation_time_to: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | creation time to
|
92
|
+
statuses: ['statuses_example'] # Array<String> | creation task statuses
|
93
|
+
}
|
94
|
+
|
95
|
+
begin
|
96
|
+
#creation tasks, personalization will always be empty for technical reasons
|
97
|
+
result = api_instance.get_creation_tasks(korona_account_id, opts)
|
98
|
+
p result
|
99
|
+
rescue KoronaClient::ApiError => e
|
100
|
+
puts "Exception when calling TicketCreationApi->get_creation_tasks: #{e}"
|
101
|
+
end
|
102
|
+
```
|
103
|
+
|
104
|
+
### Parameters
|
105
|
+
|
106
|
+
Name | Type | Description | Notes
|
107
|
+
------------- | ------------- | ------------- | -------------
|
108
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
109
|
+
**creation_time_from** | **DateTime**| creation time from | [optional]
|
110
|
+
**creation_time_to** | **DateTime**| creation time to | [optional]
|
111
|
+
**statuses** | [**Array<String>**](String.md)| creation task statuses | [optional]
|
112
|
+
|
113
|
+
### Return type
|
114
|
+
|
115
|
+
[**ResultListCreationTask**](ResultListCreationTask.md)
|
116
|
+
|
117
|
+
### Authorization
|
118
|
+
|
119
|
+
[basicAuth](../README.md#basicAuth)
|
120
|
+
|
121
|
+
### HTTP request headers
|
122
|
+
|
123
|
+
- **Content-Type**: application/json
|
124
|
+
- **Accept**: application/json
|
125
|
+
|
126
|
+
|
127
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# KoronaClient::TicketPersonalization
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**firstname** | **String** | | [optional]
|
7
|
+
**lastname** | **String** | | [optional]
|
8
|
+
**customer_number** | **String** | | [optional]
|
9
|
+
**image** | **String** | | [optional]
|
10
|
+
|
11
|
+
|
data/docs/TicketingApi.md
CHANGED
@@ -4,18 +4,33 @@ All URIs are relative to *https://www.koronacloud.com/web/api/v3*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**
|
7
|
+
[**add_events**](TicketingApi.md#add_events) | **POST** /accounts/{koronaAccountId}/events | adds a batch of new events
|
8
|
+
[**add_or_update_attendances**](TicketingApi.md#add_or_update_attendances) | **POST** /accounts/{koronaAccountId}/attendance | updates/adds attendances
|
9
|
+
[**add_ticket_definitions**](TicketingApi.md#add_ticket_definitions) | **POST** /accounts/{koronaAccountId}/ticketDefinitions | adds a batch of new ticket definitions
|
10
|
+
[**cancel_attendance**](TicketingApi.md#cancel_attendance) | **DELETE** /accounts/{koronaAccountId}/attendance/{attendanceId} | cancel the attendance
|
11
|
+
[**delete_event**](TicketingApi.md#delete_event) | **DELETE** /accounts/{koronaAccountId}/events/{eventId} | deletes the single event
|
12
|
+
[**delete_ticket_definition**](TicketingApi.md#delete_ticket_definition) | **DELETE** /accounts/{koronaAccountId}/ticketDefinitions/{ticketDefinitionId} | deletes the single ticket definition
|
13
|
+
[**delete_ticket_definitions**](TicketingApi.md#delete_ticket_definitions) | **DELETE** /accounts/{koronaAccountId}/ticketDefinitions | deletes a batch of ticket definitions
|
14
|
+
[**get_attendances**](TicketingApi.md#get_attendances) | **GET** /accounts/{koronaAccountId}/attendance | lists all attendances
|
15
|
+
[**get_entry_gate**](TicketingApi.md#get_entry_gate) | **GET** /accounts/{koronaAccountId}/entryGates/{entryGateId} | returns the single entry gate
|
8
16
|
[**get_entry_gates**](TicketingApi.md#get_entry_gates) | **GET** /accounts/{koronaAccountId}/entryGates | lists all entry gates
|
9
|
-
[**get_event**](TicketingApi.md#get_event) | **GET** /accounts/{koronaAccountId}/events/{
|
17
|
+
[**get_event**](TicketingApi.md#get_event) | **GET** /accounts/{koronaAccountId}/events/{eventId} | returns the single event
|
10
18
|
[**get_events**](TicketingApi.md#get_events) | **GET** /accounts/{koronaAccountId}/events | lists all events
|
11
|
-
[**get_ticket_definition**](TicketingApi.md#get_ticket_definition) | **GET** /accounts/{koronaAccountId}/ticketDefinitions/{
|
19
|
+
[**get_ticket_definition**](TicketingApi.md#get_ticket_definition) | **GET** /accounts/{koronaAccountId}/ticketDefinitions/{ticketDefinitionId} | returns the single ticket definition
|
12
20
|
[**get_ticket_definitions**](TicketingApi.md#get_ticket_definitions) | **GET** /accounts/{koronaAccountId}/ticketDefinitions | lists all ticket definitions
|
21
|
+
[**get_tickets**](TicketingApi.md#get_tickets) | **GET** /accounts/{koronaAccountId}/tickets | lists all tickets
|
22
|
+
[**lock_ticket**](TicketingApi.md#lock_ticket) | **DELETE** /accounts/{koronaAccountId}/tickets/{ticketNumber} | locks the single ticket
|
23
|
+
[**unlock_ticket**](TicketingApi.md#unlock_ticket) | **POST** /accounts/{koronaAccountId}/tickets/{ticketNumber} | unlocks the single ticket
|
24
|
+
[**update_event**](TicketingApi.md#update_event) | **PATCH** /accounts/{koronaAccountId}/events/{eventId} | updates the single event
|
25
|
+
[**update_events**](TicketingApi.md#update_events) | **PATCH** /accounts/{koronaAccountId}/events | updates a batch of events
|
26
|
+
[**update_ticket**](TicketingApi.md#update_ticket) | **PATCH** /accounts/{koronaAccountId}/tickets/{ticketNumber} | updates the single ticket
|
27
|
+
[**update_ticket_definitions**](TicketingApi.md#update_ticket_definitions) | **PATCH** /accounts/{koronaAccountId}/ticketDefinitions | updates a batch of ticket definitions
|
13
28
|
|
14
29
|
|
15
|
-
# **
|
16
|
-
>
|
30
|
+
# **add_events**
|
31
|
+
> Array<AddOrUpdateResult> add_events(korona_account_id, body, opts)
|
17
32
|
|
18
|
-
|
33
|
+
adds a batch of new events
|
19
34
|
|
20
35
|
|
21
36
|
|
@@ -32,17 +47,20 @@ end
|
|
32
47
|
|
33
48
|
api_instance = KoronaClient::TicketingApi.new
|
34
49
|
|
35
|
-
korona_account_id =
|
50
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
36
51
|
|
37
|
-
|
52
|
+
body = [KoronaClient::Event.new] # Array<Event> | an array of new events
|
38
53
|
|
54
|
+
opts = {
|
55
|
+
upsert: true # BOOLEAN | when set to true, updates the object instead of generating a already-exists-error
|
56
|
+
}
|
39
57
|
|
40
58
|
begin
|
41
|
-
#
|
42
|
-
result = api_instance.
|
59
|
+
#adds a batch of new events
|
60
|
+
result = api_instance.add_events(korona_account_id, body, opts)
|
43
61
|
p result
|
44
62
|
rescue KoronaClient::ApiError => e
|
45
|
-
puts "Exception when calling TicketingApi->
|
63
|
+
puts "Exception when calling TicketingApi->add_events: #{e}"
|
46
64
|
end
|
47
65
|
```
|
48
66
|
|
@@ -50,12 +68,13 @@ end
|
|
50
68
|
|
51
69
|
Name | Type | Description | Notes
|
52
70
|
------------- | ------------- | ------------- | -------------
|
53
|
-
**korona_account_id** | **String**| the account
|
54
|
-
**
|
71
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
72
|
+
**body** | [**Array<Event>**](Event.md)| an array of new events |
|
73
|
+
**upsert** | **BOOLEAN**| when set to true, updates the object instead of generating a already-exists-error | [optional]
|
55
74
|
|
56
75
|
### Return type
|
57
76
|
|
58
|
-
[**
|
77
|
+
[**Array<AddOrUpdateResult>**](AddOrUpdateResult.md)
|
59
78
|
|
60
79
|
### Authorization
|
61
80
|
|
@@ -68,10 +87,66 @@ Name | Type | Description | Notes
|
|
68
87
|
|
69
88
|
|
70
89
|
|
71
|
-
# **
|
72
|
-
>
|
90
|
+
# **add_or_update_attendances**
|
91
|
+
> Array<AddOrUpdateResult> add_or_update_attendances(korona_account_id, body)
|
73
92
|
|
74
|
-
|
93
|
+
updates/adds attendances
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
### Example
|
98
|
+
```ruby
|
99
|
+
# load the gem
|
100
|
+
require 'korona_client'
|
101
|
+
# setup authorization
|
102
|
+
KoronaClient.configure do |config|
|
103
|
+
# Configure HTTP basic authorization: basicAuth
|
104
|
+
config.username = 'YOUR USERNAME'
|
105
|
+
config.password = 'YOUR PASSWORD'
|
106
|
+
end
|
107
|
+
|
108
|
+
api_instance = KoronaClient::TicketingApi.new
|
109
|
+
|
110
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
111
|
+
|
112
|
+
body = [KoronaClient::Attendance.new] # Array<Attendance> | an array of attendances
|
113
|
+
|
114
|
+
|
115
|
+
begin
|
116
|
+
#updates/adds attendances
|
117
|
+
result = api_instance.add_or_update_attendances(korona_account_id, body)
|
118
|
+
p result
|
119
|
+
rescue KoronaClient::ApiError => e
|
120
|
+
puts "Exception when calling TicketingApi->add_or_update_attendances: #{e}"
|
121
|
+
end
|
122
|
+
```
|
123
|
+
|
124
|
+
### Parameters
|
125
|
+
|
126
|
+
Name | Type | Description | Notes
|
127
|
+
------------- | ------------- | ------------- | -------------
|
128
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
129
|
+
**body** | [**Array<Attendance>**](Attendance.md)| an array of attendances |
|
130
|
+
|
131
|
+
### Return type
|
132
|
+
|
133
|
+
[**Array<AddOrUpdateResult>**](AddOrUpdateResult.md)
|
134
|
+
|
135
|
+
### Authorization
|
136
|
+
|
137
|
+
[basicAuth](../README.md#basicAuth)
|
138
|
+
|
139
|
+
### HTTP request headers
|
140
|
+
|
141
|
+
- **Content-Type**: application/json
|
142
|
+
- **Accept**: application/json
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
# **add_ticket_definitions**
|
147
|
+
> Array<AddOrUpdateResult> add_ticket_definitions(korona_account_id, body, opts)
|
148
|
+
|
149
|
+
adds a batch of new ticket definitions
|
75
150
|
|
76
151
|
|
77
152
|
|
@@ -88,22 +163,20 @@ end
|
|
88
163
|
|
89
164
|
api_instance = KoronaClient::TicketingApi.new
|
90
165
|
|
91
|
-
korona_account_id =
|
166
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
167
|
+
|
168
|
+
body = [KoronaClient::TicketDefinition.new] # Array<TicketDefinition> | array of new ticket definitions
|
92
169
|
|
93
170
|
opts = {
|
94
|
-
|
95
|
-
size: 56, # Integer | amount of objects to return per page
|
96
|
-
sort: "sort_example", # String | attribute to sort by (multiple separated by comma; max. 5)
|
97
|
-
revision: 789, # Integer | last revision number, objects with a greater revision than this will be returned
|
98
|
-
include_deleted: true # BOOLEAN | indicates deleted objects should be loaded or not (default: false)
|
171
|
+
upsert: true # BOOLEAN | when set to true, updates the object instead of generating a already-exists-error
|
99
172
|
}
|
100
173
|
|
101
174
|
begin
|
102
|
-
#
|
103
|
-
result = api_instance.
|
175
|
+
#adds a batch of new ticket definitions
|
176
|
+
result = api_instance.add_ticket_definitions(korona_account_id, body, opts)
|
104
177
|
p result
|
105
178
|
rescue KoronaClient::ApiError => e
|
106
|
-
puts "Exception when calling TicketingApi->
|
179
|
+
puts "Exception when calling TicketingApi->add_ticket_definitions: #{e}"
|
107
180
|
end
|
108
181
|
```
|
109
182
|
|
@@ -111,16 +184,13 @@ end
|
|
111
184
|
|
112
185
|
Name | Type | Description | Notes
|
113
186
|
------------- | ------------- | ------------- | -------------
|
114
|
-
**korona_account_id** | **String**| the account
|
115
|
-
**
|
116
|
-
**
|
117
|
-
**sort** | **String**| attribute to sort by (multiple separated by comma; max. 5) | [optional]
|
118
|
-
**revision** | **Integer**| last revision number, objects with a greater revision than this will be returned | [optional]
|
119
|
-
**include_deleted** | **BOOLEAN**| indicates deleted objects should be loaded or not (default: false) | [optional]
|
187
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
188
|
+
**body** | [**Array<TicketDefinition>**](TicketDefinition.md)| array of new ticket definitions |
|
189
|
+
**upsert** | **BOOLEAN**| when set to true, updates the object instead of generating a already-exists-error | [optional]
|
120
190
|
|
121
191
|
### Return type
|
122
192
|
|
123
|
-
[**
|
193
|
+
[**Array<AddOrUpdateResult>**](AddOrUpdateResult.md)
|
124
194
|
|
125
195
|
### Authorization
|
126
196
|
|
@@ -133,10 +203,175 @@ Name | Type | Description | Notes
|
|
133
203
|
|
134
204
|
|
135
205
|
|
136
|
-
# **
|
137
|
-
>
|
206
|
+
# **cancel_attendance**
|
207
|
+
> cancel_attendance(korona_account_id, attendance_id)
|
208
|
+
|
209
|
+
cancel the attendance
|
210
|
+
|
211
|
+
|
212
|
+
|
213
|
+
### Example
|
214
|
+
```ruby
|
215
|
+
# load the gem
|
216
|
+
require 'korona_client'
|
217
|
+
# setup authorization
|
218
|
+
KoronaClient.configure do |config|
|
219
|
+
# Configure HTTP basic authorization: basicAuth
|
220
|
+
config.username = 'YOUR USERNAME'
|
221
|
+
config.password = 'YOUR PASSWORD'
|
222
|
+
end
|
223
|
+
|
224
|
+
api_instance = KoronaClient::TicketingApi.new
|
225
|
+
|
226
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
227
|
+
|
228
|
+
attendance_id = 'attendance_id_example' # String | id of the related object (important: id should match the uuid-format)
|
229
|
+
|
230
|
+
|
231
|
+
begin
|
232
|
+
#cancel the attendance
|
233
|
+
api_instance.cancel_attendance(korona_account_id, attendance_id)
|
234
|
+
rescue KoronaClient::ApiError => e
|
235
|
+
puts "Exception when calling TicketingApi->cancel_attendance: #{e}"
|
236
|
+
end
|
237
|
+
```
|
238
|
+
|
239
|
+
### Parameters
|
240
|
+
|
241
|
+
Name | Type | Description | Notes
|
242
|
+
------------- | ------------- | ------------- | -------------
|
243
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
244
|
+
**attendance_id** | **String**| id of the related object (important: id should match the uuid-format) |
|
245
|
+
|
246
|
+
### Return type
|
247
|
+
|
248
|
+
nil (empty response body)
|
249
|
+
|
250
|
+
### Authorization
|
251
|
+
|
252
|
+
[basicAuth](../README.md#basicAuth)
|
253
|
+
|
254
|
+
### HTTP request headers
|
255
|
+
|
256
|
+
- **Content-Type**: application/json
|
257
|
+
- **Accept**: application/json
|
258
|
+
|
259
|
+
|
260
|
+
|
261
|
+
# **delete_event**
|
262
|
+
> delete_event(korona_account_id, event_id)
|
263
|
+
|
264
|
+
deletes the single event
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
### Example
|
269
|
+
```ruby
|
270
|
+
# load the gem
|
271
|
+
require 'korona_client'
|
272
|
+
# setup authorization
|
273
|
+
KoronaClient.configure do |config|
|
274
|
+
# Configure HTTP basic authorization: basicAuth
|
275
|
+
config.username = 'YOUR USERNAME'
|
276
|
+
config.password = 'YOUR PASSWORD'
|
277
|
+
end
|
278
|
+
|
279
|
+
api_instance = KoronaClient::TicketingApi.new
|
138
280
|
|
139
|
-
|
281
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
282
|
+
|
283
|
+
event_id = 'event_id_example' # String | id of the related object (important: id should match the uuid-format)
|
284
|
+
|
285
|
+
|
286
|
+
begin
|
287
|
+
#deletes the single event
|
288
|
+
api_instance.delete_event(korona_account_id, event_id)
|
289
|
+
rescue KoronaClient::ApiError => e
|
290
|
+
puts "Exception when calling TicketingApi->delete_event: #{e}"
|
291
|
+
end
|
292
|
+
```
|
293
|
+
|
294
|
+
### Parameters
|
295
|
+
|
296
|
+
Name | Type | Description | Notes
|
297
|
+
------------- | ------------- | ------------- | -------------
|
298
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
299
|
+
**event_id** | **String**| id of the related object (important: id should match the uuid-format) |
|
300
|
+
|
301
|
+
### Return type
|
302
|
+
|
303
|
+
nil (empty response body)
|
304
|
+
|
305
|
+
### Authorization
|
306
|
+
|
307
|
+
[basicAuth](../README.md#basicAuth)
|
308
|
+
|
309
|
+
### HTTP request headers
|
310
|
+
|
311
|
+
- **Content-Type**: application/json
|
312
|
+
- **Accept**: application/json
|
313
|
+
|
314
|
+
|
315
|
+
|
316
|
+
# **delete_ticket_definition**
|
317
|
+
> delete_ticket_definition(korona_account_id, ticket_definition_id)
|
318
|
+
|
319
|
+
deletes the single ticket definition
|
320
|
+
|
321
|
+
|
322
|
+
|
323
|
+
### Example
|
324
|
+
```ruby
|
325
|
+
# load the gem
|
326
|
+
require 'korona_client'
|
327
|
+
# setup authorization
|
328
|
+
KoronaClient.configure do |config|
|
329
|
+
# Configure HTTP basic authorization: basicAuth
|
330
|
+
config.username = 'YOUR USERNAME'
|
331
|
+
config.password = 'YOUR PASSWORD'
|
332
|
+
end
|
333
|
+
|
334
|
+
api_instance = KoronaClient::TicketingApi.new
|
335
|
+
|
336
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
337
|
+
|
338
|
+
ticket_definition_id = 'ticket_definition_id_example' # String | id of the related object (important: id should match the uuid-format)
|
339
|
+
|
340
|
+
|
341
|
+
begin
|
342
|
+
#deletes the single ticket definition
|
343
|
+
api_instance.delete_ticket_definition(korona_account_id, ticket_definition_id)
|
344
|
+
rescue KoronaClient::ApiError => e
|
345
|
+
puts "Exception when calling TicketingApi->delete_ticket_definition: #{e}"
|
346
|
+
end
|
347
|
+
```
|
348
|
+
|
349
|
+
### Parameters
|
350
|
+
|
351
|
+
Name | Type | Description | Notes
|
352
|
+
------------- | ------------- | ------------- | -------------
|
353
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
354
|
+
**ticket_definition_id** | **String**| id of the related object (important: id should match the uuid-format) |
|
355
|
+
|
356
|
+
### Return type
|
357
|
+
|
358
|
+
nil (empty response body)
|
359
|
+
|
360
|
+
### Authorization
|
361
|
+
|
362
|
+
[basicAuth](../README.md#basicAuth)
|
363
|
+
|
364
|
+
### HTTP request headers
|
365
|
+
|
366
|
+
- **Content-Type**: application/json
|
367
|
+
- **Accept**: application/json
|
368
|
+
|
369
|
+
|
370
|
+
|
371
|
+
# **delete_ticket_definitions**
|
372
|
+
> Array<AddOrUpdateResult> delete_ticket_definitions(korona_account_id, body)
|
373
|
+
|
374
|
+
deletes a batch of ticket definitions
|
140
375
|
|
141
376
|
|
142
377
|
|
@@ -153,17 +388,17 @@ end
|
|
153
388
|
|
154
389
|
api_instance = KoronaClient::TicketingApi.new
|
155
390
|
|
156
|
-
korona_account_id =
|
391
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
157
392
|
|
158
|
-
|
393
|
+
body = [KoronaClient::TicketDefinition.new] # Array<TicketDefinition> | array of existing ticket definitions (id or number required)
|
159
394
|
|
160
395
|
|
161
396
|
begin
|
162
|
-
#
|
163
|
-
result = api_instance.
|
397
|
+
#deletes a batch of ticket definitions
|
398
|
+
result = api_instance.delete_ticket_definitions(korona_account_id, body)
|
164
399
|
p result
|
165
400
|
rescue KoronaClient::ApiError => e
|
166
|
-
puts "Exception when calling TicketingApi->
|
401
|
+
puts "Exception when calling TicketingApi->delete_ticket_definitions: #{e}"
|
167
402
|
end
|
168
403
|
```
|
169
404
|
|
@@ -171,12 +406,12 @@ end
|
|
171
406
|
|
172
407
|
Name | Type | Description | Notes
|
173
408
|
------------- | ------------- | ------------- | -------------
|
174
|
-
**korona_account_id** | **String**| the account
|
175
|
-
**
|
409
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
410
|
+
**body** | [**Array<TicketDefinition>**](TicketDefinition.md)| array of existing ticket definitions (id or number required) |
|
176
411
|
|
177
412
|
### Return type
|
178
413
|
|
179
|
-
[**
|
414
|
+
[**Array<AddOrUpdateResult>**](AddOrUpdateResult.md)
|
180
415
|
|
181
416
|
### Authorization
|
182
417
|
|
@@ -189,10 +424,10 @@ Name | Type | Description | Notes
|
|
189
424
|
|
190
425
|
|
191
426
|
|
192
|
-
# **
|
193
|
-
>
|
427
|
+
# **get_attendances**
|
428
|
+
> ResultListAttendance get_attendances(korona_account_id, opts)
|
194
429
|
|
195
|
-
lists all
|
430
|
+
lists all attendances
|
196
431
|
|
197
432
|
|
198
433
|
|
@@ -209,22 +444,22 @@ end
|
|
209
444
|
|
210
445
|
api_instance = KoronaClient::TicketingApi.new
|
211
446
|
|
212
|
-
korona_account_id =
|
447
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
213
448
|
|
214
449
|
opts = {
|
215
450
|
page: 56, # Integer | number of the page to fetch
|
216
451
|
size: 56, # Integer | amount of objects to return per page
|
217
|
-
sort:
|
452
|
+
sort: 'sort_example', # String | attribute to sort by (multiple separated by comma; max. 5)
|
218
453
|
revision: 789, # Integer | last revision number, objects with a greater revision than this will be returned
|
219
454
|
include_deleted: true # BOOLEAN | indicates deleted objects should be loaded or not (default: false)
|
220
455
|
}
|
221
456
|
|
222
457
|
begin
|
223
|
-
#lists all
|
224
|
-
result = api_instance.
|
458
|
+
#lists all attendances
|
459
|
+
result = api_instance.get_attendances(korona_account_id, opts)
|
225
460
|
p result
|
226
461
|
rescue KoronaClient::ApiError => e
|
227
|
-
puts "Exception when calling TicketingApi->
|
462
|
+
puts "Exception when calling TicketingApi->get_attendances: #{e}"
|
228
463
|
end
|
229
464
|
```
|
230
465
|
|
@@ -232,7 +467,7 @@ end
|
|
232
467
|
|
233
468
|
Name | Type | Description | Notes
|
234
469
|
------------- | ------------- | ------------- | -------------
|
235
|
-
**korona_account_id** | **String**| the account
|
470
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
236
471
|
**page** | **Integer**| number of the page to fetch | [optional]
|
237
472
|
**size** | **Integer**| amount of objects to return per page | [optional]
|
238
473
|
**sort** | **String**| attribute to sort by (multiple separated by comma; max. 5) | [optional]
|
@@ -241,7 +476,7 @@ Name | Type | Description | Notes
|
|
241
476
|
|
242
477
|
### Return type
|
243
478
|
|
244
|
-
[**
|
479
|
+
[**ResultListAttendance**](ResultListAttendance.md)
|
245
480
|
|
246
481
|
### Authorization
|
247
482
|
|
@@ -254,10 +489,10 @@ Name | Type | Description | Notes
|
|
254
489
|
|
255
490
|
|
256
491
|
|
257
|
-
# **
|
258
|
-
>
|
492
|
+
# **get_entry_gate**
|
493
|
+
> EntryGate get_entry_gate(korona_account_id, entry_gate_id)
|
259
494
|
|
260
|
-
|
495
|
+
returns the single entry gate
|
261
496
|
|
262
497
|
|
263
498
|
|
@@ -274,17 +509,17 @@ end
|
|
274
509
|
|
275
510
|
api_instance = KoronaClient::TicketingApi.new
|
276
511
|
|
277
|
-
korona_account_id =
|
512
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
278
513
|
|
279
|
-
|
514
|
+
entry_gate_id = 'entry_gate_id_example' # String | id of the related object (important: id should match the uuid-format)
|
280
515
|
|
281
516
|
|
282
517
|
begin
|
283
|
-
#
|
284
|
-
result = api_instance.
|
518
|
+
#returns the single entry gate
|
519
|
+
result = api_instance.get_entry_gate(korona_account_id, entry_gate_id)
|
285
520
|
p result
|
286
521
|
rescue KoronaClient::ApiError => e
|
287
|
-
puts "Exception when calling TicketingApi->
|
522
|
+
puts "Exception when calling TicketingApi->get_entry_gate: #{e}"
|
288
523
|
end
|
289
524
|
```
|
290
525
|
|
@@ -292,12 +527,12 @@ end
|
|
292
527
|
|
293
528
|
Name | Type | Description | Notes
|
294
529
|
------------- | ------------- | ------------- | -------------
|
295
|
-
**korona_account_id** | **String**| the account
|
296
|
-
**
|
530
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
531
|
+
**entry_gate_id** | **String**| id of the related object (important: id should match the uuid-format) |
|
297
532
|
|
298
533
|
### Return type
|
299
534
|
|
300
|
-
[**
|
535
|
+
[**EntryGate**](EntryGate.md)
|
301
536
|
|
302
537
|
### Authorization
|
303
538
|
|
@@ -310,10 +545,10 @@ Name | Type | Description | Notes
|
|
310
545
|
|
311
546
|
|
312
547
|
|
313
|
-
# **
|
314
|
-
>
|
548
|
+
# **get_entry_gates**
|
549
|
+
> ResultListEntryGate get_entry_gates(korona_account_id, opts)
|
315
550
|
|
316
|
-
lists all
|
551
|
+
lists all entry gates
|
317
552
|
|
318
553
|
|
319
554
|
|
@@ -330,22 +565,23 @@ end
|
|
330
565
|
|
331
566
|
api_instance = KoronaClient::TicketingApi.new
|
332
567
|
|
333
|
-
korona_account_id =
|
568
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
334
569
|
|
335
570
|
opts = {
|
336
571
|
page: 56, # Integer | number of the page to fetch
|
337
572
|
size: 56, # Integer | amount of objects to return per page
|
338
|
-
sort:
|
573
|
+
sort: 'sort_example', # String | attribute to sort by (multiple separated by comma; max. 5)
|
339
574
|
revision: 789, # Integer | last revision number, objects with a greater revision than this will be returned
|
340
|
-
include_deleted: true # BOOLEAN | indicates deleted objects should be loaded or not (default: false)
|
575
|
+
include_deleted: true, # BOOLEAN | indicates deleted objects should be loaded or not (default: false)
|
576
|
+
number: 'number_example' # String | number of the related object
|
341
577
|
}
|
342
578
|
|
343
579
|
begin
|
344
|
-
#lists all
|
345
|
-
result = api_instance.
|
580
|
+
#lists all entry gates
|
581
|
+
result = api_instance.get_entry_gates(korona_account_id, opts)
|
346
582
|
p result
|
347
583
|
rescue KoronaClient::ApiError => e
|
348
|
-
puts "Exception when calling TicketingApi->
|
584
|
+
puts "Exception when calling TicketingApi->get_entry_gates: #{e}"
|
349
585
|
end
|
350
586
|
```
|
351
587
|
|
@@ -353,16 +589,679 @@ end
|
|
353
589
|
|
354
590
|
Name | Type | Description | Notes
|
355
591
|
------------- | ------------- | ------------- | -------------
|
356
|
-
**korona_account_id** | **String**| the account
|
592
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
357
593
|
**page** | **Integer**| number of the page to fetch | [optional]
|
358
594
|
**size** | **Integer**| amount of objects to return per page | [optional]
|
359
595
|
**sort** | **String**| attribute to sort by (multiple separated by comma; max. 5) | [optional]
|
360
596
|
**revision** | **Integer**| last revision number, objects with a greater revision than this will be returned | [optional]
|
361
597
|
**include_deleted** | **BOOLEAN**| indicates deleted objects should be loaded or not (default: false) | [optional]
|
598
|
+
**number** | **String**| number of the related object | [optional]
|
362
599
|
|
363
600
|
### Return type
|
364
601
|
|
365
|
-
[**
|
602
|
+
[**ResultListEntryGate**](ResultListEntryGate.md)
|
603
|
+
|
604
|
+
### Authorization
|
605
|
+
|
606
|
+
[basicAuth](../README.md#basicAuth)
|
607
|
+
|
608
|
+
### HTTP request headers
|
609
|
+
|
610
|
+
- **Content-Type**: application/json
|
611
|
+
- **Accept**: application/json
|
612
|
+
|
613
|
+
|
614
|
+
|
615
|
+
# **get_event**
|
616
|
+
> Event get_event(korona_account_id, event_id)
|
617
|
+
|
618
|
+
returns the single event
|
619
|
+
|
620
|
+
|
621
|
+
|
622
|
+
### Example
|
623
|
+
```ruby
|
624
|
+
# load the gem
|
625
|
+
require 'korona_client'
|
626
|
+
# setup authorization
|
627
|
+
KoronaClient.configure do |config|
|
628
|
+
# Configure HTTP basic authorization: basicAuth
|
629
|
+
config.username = 'YOUR USERNAME'
|
630
|
+
config.password = 'YOUR PASSWORD'
|
631
|
+
end
|
632
|
+
|
633
|
+
api_instance = KoronaClient::TicketingApi.new
|
634
|
+
|
635
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
636
|
+
|
637
|
+
event_id = 'event_id_example' # String | id of the related object (important: id should match the uuid-format)
|
638
|
+
|
639
|
+
|
640
|
+
begin
|
641
|
+
#returns the single event
|
642
|
+
result = api_instance.get_event(korona_account_id, event_id)
|
643
|
+
p result
|
644
|
+
rescue KoronaClient::ApiError => e
|
645
|
+
puts "Exception when calling TicketingApi->get_event: #{e}"
|
646
|
+
end
|
647
|
+
```
|
648
|
+
|
649
|
+
### Parameters
|
650
|
+
|
651
|
+
Name | Type | Description | Notes
|
652
|
+
------------- | ------------- | ------------- | -------------
|
653
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
654
|
+
**event_id** | **String**| id of the related object (important: id should match the uuid-format) |
|
655
|
+
|
656
|
+
### Return type
|
657
|
+
|
658
|
+
[**Event**](Event.md)
|
659
|
+
|
660
|
+
### Authorization
|
661
|
+
|
662
|
+
[basicAuth](../README.md#basicAuth)
|
663
|
+
|
664
|
+
### HTTP request headers
|
665
|
+
|
666
|
+
- **Content-Type**: application/json
|
667
|
+
- **Accept**: application/json
|
668
|
+
|
669
|
+
|
670
|
+
|
671
|
+
# **get_events**
|
672
|
+
> ResultListEvent get_events(korona_account_id, opts)
|
673
|
+
|
674
|
+
lists all events
|
675
|
+
|
676
|
+
|
677
|
+
|
678
|
+
### Example
|
679
|
+
```ruby
|
680
|
+
# load the gem
|
681
|
+
require 'korona_client'
|
682
|
+
# setup authorization
|
683
|
+
KoronaClient.configure do |config|
|
684
|
+
# Configure HTTP basic authorization: basicAuth
|
685
|
+
config.username = 'YOUR USERNAME'
|
686
|
+
config.password = 'YOUR PASSWORD'
|
687
|
+
end
|
688
|
+
|
689
|
+
api_instance = KoronaClient::TicketingApi.new
|
690
|
+
|
691
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
692
|
+
|
693
|
+
opts = {
|
694
|
+
page: 56, # Integer | number of the page to fetch
|
695
|
+
size: 56, # Integer | amount of objects to return per page
|
696
|
+
sort: 'sort_example', # String | attribute to sort by (multiple separated by comma; max. 5)
|
697
|
+
revision: 789, # Integer | last revision number, objects with a greater revision than this will be returned
|
698
|
+
include_deleted: true # BOOLEAN | indicates deleted objects should be loaded or not (default: false)
|
699
|
+
}
|
700
|
+
|
701
|
+
begin
|
702
|
+
#lists all events
|
703
|
+
result = api_instance.get_events(korona_account_id, opts)
|
704
|
+
p result
|
705
|
+
rescue KoronaClient::ApiError => e
|
706
|
+
puts "Exception when calling TicketingApi->get_events: #{e}"
|
707
|
+
end
|
708
|
+
```
|
709
|
+
|
710
|
+
### Parameters
|
711
|
+
|
712
|
+
Name | Type | Description | Notes
|
713
|
+
------------- | ------------- | ------------- | -------------
|
714
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
715
|
+
**page** | **Integer**| number of the page to fetch | [optional]
|
716
|
+
**size** | **Integer**| amount of objects to return per page | [optional]
|
717
|
+
**sort** | **String**| attribute to sort by (multiple separated by comma; max. 5) | [optional]
|
718
|
+
**revision** | **Integer**| last revision number, objects with a greater revision than this will be returned | [optional]
|
719
|
+
**include_deleted** | **BOOLEAN**| indicates deleted objects should be loaded or not (default: false) | [optional]
|
720
|
+
|
721
|
+
### Return type
|
722
|
+
|
723
|
+
[**ResultListEvent**](ResultListEvent.md)
|
724
|
+
|
725
|
+
### Authorization
|
726
|
+
|
727
|
+
[basicAuth](../README.md#basicAuth)
|
728
|
+
|
729
|
+
### HTTP request headers
|
730
|
+
|
731
|
+
- **Content-Type**: application/json
|
732
|
+
- **Accept**: application/json
|
733
|
+
|
734
|
+
|
735
|
+
|
736
|
+
# **get_ticket_definition**
|
737
|
+
> TicketDefinition get_ticket_definition(korona_account_id, ticket_definition_id)
|
738
|
+
|
739
|
+
returns the single ticket definition
|
740
|
+
|
741
|
+
|
742
|
+
|
743
|
+
### Example
|
744
|
+
```ruby
|
745
|
+
# load the gem
|
746
|
+
require 'korona_client'
|
747
|
+
# setup authorization
|
748
|
+
KoronaClient.configure do |config|
|
749
|
+
# Configure HTTP basic authorization: basicAuth
|
750
|
+
config.username = 'YOUR USERNAME'
|
751
|
+
config.password = 'YOUR PASSWORD'
|
752
|
+
end
|
753
|
+
|
754
|
+
api_instance = KoronaClient::TicketingApi.new
|
755
|
+
|
756
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
757
|
+
|
758
|
+
ticket_definition_id = 'ticket_definition_id_example' # String | id of the related object (important: id should match the uuid-format)
|
759
|
+
|
760
|
+
|
761
|
+
begin
|
762
|
+
#returns the single ticket definition
|
763
|
+
result = api_instance.get_ticket_definition(korona_account_id, ticket_definition_id)
|
764
|
+
p result
|
765
|
+
rescue KoronaClient::ApiError => e
|
766
|
+
puts "Exception when calling TicketingApi->get_ticket_definition: #{e}"
|
767
|
+
end
|
768
|
+
```
|
769
|
+
|
770
|
+
### Parameters
|
771
|
+
|
772
|
+
Name | Type | Description | Notes
|
773
|
+
------------- | ------------- | ------------- | -------------
|
774
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
775
|
+
**ticket_definition_id** | **String**| id of the related object (important: id should match the uuid-format) |
|
776
|
+
|
777
|
+
### Return type
|
778
|
+
|
779
|
+
[**TicketDefinition**](TicketDefinition.md)
|
780
|
+
|
781
|
+
### Authorization
|
782
|
+
|
783
|
+
[basicAuth](../README.md#basicAuth)
|
784
|
+
|
785
|
+
### HTTP request headers
|
786
|
+
|
787
|
+
- **Content-Type**: application/json
|
788
|
+
- **Accept**: application/json
|
789
|
+
|
790
|
+
|
791
|
+
|
792
|
+
# **get_ticket_definitions**
|
793
|
+
> ResultListTicketDefinition get_ticket_definitions(korona_account_id, opts)
|
794
|
+
|
795
|
+
lists all ticket definitions
|
796
|
+
|
797
|
+
|
798
|
+
|
799
|
+
### Example
|
800
|
+
```ruby
|
801
|
+
# load the gem
|
802
|
+
require 'korona_client'
|
803
|
+
# setup authorization
|
804
|
+
KoronaClient.configure do |config|
|
805
|
+
# Configure HTTP basic authorization: basicAuth
|
806
|
+
config.username = 'YOUR USERNAME'
|
807
|
+
config.password = 'YOUR PASSWORD'
|
808
|
+
end
|
809
|
+
|
810
|
+
api_instance = KoronaClient::TicketingApi.new
|
811
|
+
|
812
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
813
|
+
|
814
|
+
opts = {
|
815
|
+
page: 56, # Integer | number of the page to fetch
|
816
|
+
size: 56, # Integer | amount of objects to return per page
|
817
|
+
sort: 'sort_example', # String | attribute to sort by (multiple separated by comma; max. 5)
|
818
|
+
revision: 789, # Integer | last revision number, objects with a greater revision than this will be returned
|
819
|
+
include_deleted: true # BOOLEAN | indicates deleted objects should be loaded or not (default: false)
|
820
|
+
}
|
821
|
+
|
822
|
+
begin
|
823
|
+
#lists all ticket definitions
|
824
|
+
result = api_instance.get_ticket_definitions(korona_account_id, opts)
|
825
|
+
p result
|
826
|
+
rescue KoronaClient::ApiError => e
|
827
|
+
puts "Exception when calling TicketingApi->get_ticket_definitions: #{e}"
|
828
|
+
end
|
829
|
+
```
|
830
|
+
|
831
|
+
### Parameters
|
832
|
+
|
833
|
+
Name | Type | Description | Notes
|
834
|
+
------------- | ------------- | ------------- | -------------
|
835
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
836
|
+
**page** | **Integer**| number of the page to fetch | [optional]
|
837
|
+
**size** | **Integer**| amount of objects to return per page | [optional]
|
838
|
+
**sort** | **String**| attribute to sort by (multiple separated by comma; max. 5) | [optional]
|
839
|
+
**revision** | **Integer**| last revision number, objects with a greater revision than this will be returned | [optional]
|
840
|
+
**include_deleted** | **BOOLEAN**| indicates deleted objects should be loaded or not (default: false) | [optional]
|
841
|
+
|
842
|
+
### Return type
|
843
|
+
|
844
|
+
[**ResultListTicketDefinition**](ResultListTicketDefinition.md)
|
845
|
+
|
846
|
+
### Authorization
|
847
|
+
|
848
|
+
[basicAuth](../README.md#basicAuth)
|
849
|
+
|
850
|
+
### HTTP request headers
|
851
|
+
|
852
|
+
- **Content-Type**: application/json
|
853
|
+
- **Accept**: application/json
|
854
|
+
|
855
|
+
|
856
|
+
|
857
|
+
# **get_tickets**
|
858
|
+
> ResultListTicket get_tickets(korona_account_id, page, size, opts)
|
859
|
+
|
860
|
+
lists all tickets
|
861
|
+
|
862
|
+
|
863
|
+
|
864
|
+
### Example
|
865
|
+
```ruby
|
866
|
+
# load the gem
|
867
|
+
require 'korona_client'
|
868
|
+
# setup authorization
|
869
|
+
KoronaClient.configure do |config|
|
870
|
+
# Configure HTTP basic authorization: basicAuth
|
871
|
+
config.username = 'YOUR USERNAME'
|
872
|
+
config.password = 'YOUR PASSWORD'
|
873
|
+
end
|
874
|
+
|
875
|
+
api_instance = KoronaClient::TicketingApi.new
|
876
|
+
|
877
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
878
|
+
|
879
|
+
page = 56 # Integer | number of the page to fetch
|
880
|
+
|
881
|
+
size = 56 # Integer | amount of objects to return per page
|
882
|
+
|
883
|
+
opts = {
|
884
|
+
ticket_number: 'ticket_number_example', # String | ticket number
|
885
|
+
customer_number: 'customer_number_example', # String | customer number
|
886
|
+
creation_date_from: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | creation date from
|
887
|
+
creation_date_to: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | creation date to
|
888
|
+
locked: true, # BOOLEAN | is ticket locked
|
889
|
+
owner_last_name: 'owner_last_name_example', # String | last name of owner
|
890
|
+
owner_first_name: 'owner_first_name_example', # String | first name of owner
|
891
|
+
load_owner_image: true # BOOLEAN | set true if you want to load the owner's image
|
892
|
+
}
|
893
|
+
|
894
|
+
begin
|
895
|
+
#lists all tickets
|
896
|
+
result = api_instance.get_tickets(korona_account_id, page, size, opts)
|
897
|
+
p result
|
898
|
+
rescue KoronaClient::ApiError => e
|
899
|
+
puts "Exception when calling TicketingApi->get_tickets: #{e}"
|
900
|
+
end
|
901
|
+
```
|
902
|
+
|
903
|
+
### Parameters
|
904
|
+
|
905
|
+
Name | Type | Description | Notes
|
906
|
+
------------- | ------------- | ------------- | -------------
|
907
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
908
|
+
**page** | **Integer**| number of the page to fetch |
|
909
|
+
**size** | **Integer**| amount of objects to return per page |
|
910
|
+
**ticket_number** | **String**| ticket number | [optional]
|
911
|
+
**customer_number** | **String**| customer number | [optional]
|
912
|
+
**creation_date_from** | **DateTime**| creation date from | [optional]
|
913
|
+
**creation_date_to** | **DateTime**| creation date to | [optional]
|
914
|
+
**locked** | **BOOLEAN**| is ticket locked | [optional]
|
915
|
+
**owner_last_name** | **String**| last name of owner | [optional]
|
916
|
+
**owner_first_name** | **String**| first name of owner | [optional]
|
917
|
+
**load_owner_image** | **BOOLEAN**| set true if you want to load the owner's image | [optional]
|
918
|
+
|
919
|
+
### Return type
|
920
|
+
|
921
|
+
[**ResultListTicket**](ResultListTicket.md)
|
922
|
+
|
923
|
+
### Authorization
|
924
|
+
|
925
|
+
[basicAuth](../README.md#basicAuth)
|
926
|
+
|
927
|
+
### HTTP request headers
|
928
|
+
|
929
|
+
- **Content-Type**: application/json
|
930
|
+
- **Accept**: application/json
|
931
|
+
|
932
|
+
|
933
|
+
|
934
|
+
# **lock_ticket**
|
935
|
+
> lock_ticket(korona_account_id, ticket_number)
|
936
|
+
|
937
|
+
locks the single ticket
|
938
|
+
|
939
|
+
|
940
|
+
|
941
|
+
### Example
|
942
|
+
```ruby
|
943
|
+
# load the gem
|
944
|
+
require 'korona_client'
|
945
|
+
# setup authorization
|
946
|
+
KoronaClient.configure do |config|
|
947
|
+
# Configure HTTP basic authorization: basicAuth
|
948
|
+
config.username = 'YOUR USERNAME'
|
949
|
+
config.password = 'YOUR PASSWORD'
|
950
|
+
end
|
951
|
+
|
952
|
+
api_instance = KoronaClient::TicketingApi.new
|
953
|
+
|
954
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
955
|
+
|
956
|
+
ticket_number = 'ticket_number_example' # String | id of the related object (important: id should match the uuid-format)
|
957
|
+
|
958
|
+
|
959
|
+
begin
|
960
|
+
#locks the single ticket
|
961
|
+
api_instance.lock_ticket(korona_account_id, ticket_number)
|
962
|
+
rescue KoronaClient::ApiError => e
|
963
|
+
puts "Exception when calling TicketingApi->lock_ticket: #{e}"
|
964
|
+
end
|
965
|
+
```
|
966
|
+
|
967
|
+
### Parameters
|
968
|
+
|
969
|
+
Name | Type | Description | Notes
|
970
|
+
------------- | ------------- | ------------- | -------------
|
971
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
972
|
+
**ticket_number** | **String**| id of the related object (important: id should match the uuid-format) |
|
973
|
+
|
974
|
+
### Return type
|
975
|
+
|
976
|
+
nil (empty response body)
|
977
|
+
|
978
|
+
### Authorization
|
979
|
+
|
980
|
+
[basicAuth](../README.md#basicAuth)
|
981
|
+
|
982
|
+
### HTTP request headers
|
983
|
+
|
984
|
+
- **Content-Type**: application/json
|
985
|
+
- **Accept**: application/json
|
986
|
+
|
987
|
+
|
988
|
+
|
989
|
+
# **unlock_ticket**
|
990
|
+
> unlock_ticket(korona_account_id, ticket_number)
|
991
|
+
|
992
|
+
unlocks the single ticket
|
993
|
+
|
994
|
+
|
995
|
+
|
996
|
+
### Example
|
997
|
+
```ruby
|
998
|
+
# load the gem
|
999
|
+
require 'korona_client'
|
1000
|
+
# setup authorization
|
1001
|
+
KoronaClient.configure do |config|
|
1002
|
+
# Configure HTTP basic authorization: basicAuth
|
1003
|
+
config.username = 'YOUR USERNAME'
|
1004
|
+
config.password = 'YOUR PASSWORD'
|
1005
|
+
end
|
1006
|
+
|
1007
|
+
api_instance = KoronaClient::TicketingApi.new
|
1008
|
+
|
1009
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
1010
|
+
|
1011
|
+
ticket_number = 'ticket_number_example' # String | id of the related object (important: id should match the uuid-format)
|
1012
|
+
|
1013
|
+
|
1014
|
+
begin
|
1015
|
+
#unlocks the single ticket
|
1016
|
+
api_instance.unlock_ticket(korona_account_id, ticket_number)
|
1017
|
+
rescue KoronaClient::ApiError => e
|
1018
|
+
puts "Exception when calling TicketingApi->unlock_ticket: #{e}"
|
1019
|
+
end
|
1020
|
+
```
|
1021
|
+
|
1022
|
+
### Parameters
|
1023
|
+
|
1024
|
+
Name | Type | Description | Notes
|
1025
|
+
------------- | ------------- | ------------- | -------------
|
1026
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
1027
|
+
**ticket_number** | **String**| id of the related object (important: id should match the uuid-format) |
|
1028
|
+
|
1029
|
+
### Return type
|
1030
|
+
|
1031
|
+
nil (empty response body)
|
1032
|
+
|
1033
|
+
### Authorization
|
1034
|
+
|
1035
|
+
[basicAuth](../README.md#basicAuth)
|
1036
|
+
|
1037
|
+
### HTTP request headers
|
1038
|
+
|
1039
|
+
- **Content-Type**: application/json
|
1040
|
+
- **Accept**: application/json
|
1041
|
+
|
1042
|
+
|
1043
|
+
|
1044
|
+
# **update_event**
|
1045
|
+
> update_event(korona_account_id, event_id, body)
|
1046
|
+
|
1047
|
+
updates the single event
|
1048
|
+
|
1049
|
+
|
1050
|
+
|
1051
|
+
### Example
|
1052
|
+
```ruby
|
1053
|
+
# load the gem
|
1054
|
+
require 'korona_client'
|
1055
|
+
# setup authorization
|
1056
|
+
KoronaClient.configure do |config|
|
1057
|
+
# Configure HTTP basic authorization: basicAuth
|
1058
|
+
config.username = 'YOUR USERNAME'
|
1059
|
+
config.password = 'YOUR PASSWORD'
|
1060
|
+
end
|
1061
|
+
|
1062
|
+
api_instance = KoronaClient::TicketingApi.new
|
1063
|
+
|
1064
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
1065
|
+
|
1066
|
+
event_id = 'event_id_example' # String | id of the related object (important: id should match the uuid-format)
|
1067
|
+
|
1068
|
+
body = KoronaClient::Event.new # Event | the properties to update of the event
|
1069
|
+
|
1070
|
+
|
1071
|
+
begin
|
1072
|
+
#updates the single event
|
1073
|
+
api_instance.update_event(korona_account_id, event_id, body)
|
1074
|
+
rescue KoronaClient::ApiError => e
|
1075
|
+
puts "Exception when calling TicketingApi->update_event: #{e}"
|
1076
|
+
end
|
1077
|
+
```
|
1078
|
+
|
1079
|
+
### Parameters
|
1080
|
+
|
1081
|
+
Name | Type | Description | Notes
|
1082
|
+
------------- | ------------- | ------------- | -------------
|
1083
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
1084
|
+
**event_id** | **String**| id of the related object (important: id should match the uuid-format) |
|
1085
|
+
**body** | [**Event**](Event.md)| the properties to update of the event |
|
1086
|
+
|
1087
|
+
### Return type
|
1088
|
+
|
1089
|
+
nil (empty response body)
|
1090
|
+
|
1091
|
+
### Authorization
|
1092
|
+
|
1093
|
+
[basicAuth](../README.md#basicAuth)
|
1094
|
+
|
1095
|
+
### HTTP request headers
|
1096
|
+
|
1097
|
+
- **Content-Type**: application/json
|
1098
|
+
- **Accept**: application/json
|
1099
|
+
|
1100
|
+
|
1101
|
+
|
1102
|
+
# **update_events**
|
1103
|
+
> Array<AddOrUpdateResult> update_events(korona_account_id, body)
|
1104
|
+
|
1105
|
+
updates a batch of events
|
1106
|
+
|
1107
|
+
[number] must be set in the objects, otherwise the object cannot be updated
|
1108
|
+
|
1109
|
+
### Example
|
1110
|
+
```ruby
|
1111
|
+
# load the gem
|
1112
|
+
require 'korona_client'
|
1113
|
+
# setup authorization
|
1114
|
+
KoronaClient.configure do |config|
|
1115
|
+
# Configure HTTP basic authorization: basicAuth
|
1116
|
+
config.username = 'YOUR USERNAME'
|
1117
|
+
config.password = 'YOUR PASSWORD'
|
1118
|
+
end
|
1119
|
+
|
1120
|
+
api_instance = KoronaClient::TicketingApi.new
|
1121
|
+
|
1122
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
1123
|
+
|
1124
|
+
body = [KoronaClient::Event.new] # Array<Event> | an array of existing events
|
1125
|
+
|
1126
|
+
|
1127
|
+
begin
|
1128
|
+
#updates a batch of events
|
1129
|
+
result = api_instance.update_events(korona_account_id, body)
|
1130
|
+
p result
|
1131
|
+
rescue KoronaClient::ApiError => e
|
1132
|
+
puts "Exception when calling TicketingApi->update_events: #{e}"
|
1133
|
+
end
|
1134
|
+
```
|
1135
|
+
|
1136
|
+
### Parameters
|
1137
|
+
|
1138
|
+
Name | Type | Description | Notes
|
1139
|
+
------------- | ------------- | ------------- | -------------
|
1140
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
1141
|
+
**body** | [**Array<Event>**](Event.md)| an array of existing events |
|
1142
|
+
|
1143
|
+
### Return type
|
1144
|
+
|
1145
|
+
[**Array<AddOrUpdateResult>**](AddOrUpdateResult.md)
|
1146
|
+
|
1147
|
+
### Authorization
|
1148
|
+
|
1149
|
+
[basicAuth](../README.md#basicAuth)
|
1150
|
+
|
1151
|
+
### HTTP request headers
|
1152
|
+
|
1153
|
+
- **Content-Type**: application/json
|
1154
|
+
- **Accept**: application/json
|
1155
|
+
|
1156
|
+
|
1157
|
+
|
1158
|
+
# **update_ticket**
|
1159
|
+
> update_ticket(korona_account_id, ticket_number, opts)
|
1160
|
+
|
1161
|
+
updates the single ticket
|
1162
|
+
|
1163
|
+
|
1164
|
+
|
1165
|
+
### Example
|
1166
|
+
```ruby
|
1167
|
+
# load the gem
|
1168
|
+
require 'korona_client'
|
1169
|
+
# setup authorization
|
1170
|
+
KoronaClient.configure do |config|
|
1171
|
+
# Configure HTTP basic authorization: basicAuth
|
1172
|
+
config.username = 'YOUR USERNAME'
|
1173
|
+
config.password = 'YOUR PASSWORD'
|
1174
|
+
end
|
1175
|
+
|
1176
|
+
api_instance = KoronaClient::TicketingApi.new
|
1177
|
+
|
1178
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
1179
|
+
|
1180
|
+
ticket_number = 'ticket_number_example' # String | old ticket number
|
1181
|
+
|
1182
|
+
opts = {
|
1183
|
+
new_ticket_number: 'new_ticket_number_example', # String | new ticket number
|
1184
|
+
first_name: 'first_name_example', # String | ticket owner's first name
|
1185
|
+
last_name: 'last_name_example' # String | ticket owner's last name
|
1186
|
+
}
|
1187
|
+
|
1188
|
+
begin
|
1189
|
+
#updates the single ticket
|
1190
|
+
api_instance.update_ticket(korona_account_id, ticket_number, opts)
|
1191
|
+
rescue KoronaClient::ApiError => e
|
1192
|
+
puts "Exception when calling TicketingApi->update_ticket: #{e}"
|
1193
|
+
end
|
1194
|
+
```
|
1195
|
+
|
1196
|
+
### Parameters
|
1197
|
+
|
1198
|
+
Name | Type | Description | Notes
|
1199
|
+
------------- | ------------- | ------------- | -------------
|
1200
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
1201
|
+
**ticket_number** | **String**| old ticket number |
|
1202
|
+
**new_ticket_number** | **String**| new ticket number | [optional]
|
1203
|
+
**first_name** | **String**| ticket owner's first name | [optional]
|
1204
|
+
**last_name** | **String**| ticket owner's last name | [optional]
|
1205
|
+
|
1206
|
+
### Return type
|
1207
|
+
|
1208
|
+
nil (empty response body)
|
1209
|
+
|
1210
|
+
### Authorization
|
1211
|
+
|
1212
|
+
[basicAuth](../README.md#basicAuth)
|
1213
|
+
|
1214
|
+
### HTTP request headers
|
1215
|
+
|
1216
|
+
- **Content-Type**: application/json
|
1217
|
+
- **Accept**: application/json
|
1218
|
+
|
1219
|
+
|
1220
|
+
|
1221
|
+
# **update_ticket_definitions**
|
1222
|
+
> Array<AddOrUpdateResult> update_ticket_definitions(korona_account_id, body)
|
1223
|
+
|
1224
|
+
updates a batch of ticket definitions
|
1225
|
+
|
1226
|
+
|
1227
|
+
|
1228
|
+
### Example
|
1229
|
+
```ruby
|
1230
|
+
# load the gem
|
1231
|
+
require 'korona_client'
|
1232
|
+
# setup authorization
|
1233
|
+
KoronaClient.configure do |config|
|
1234
|
+
# Configure HTTP basic authorization: basicAuth
|
1235
|
+
config.username = 'YOUR USERNAME'
|
1236
|
+
config.password = 'YOUR PASSWORD'
|
1237
|
+
end
|
1238
|
+
|
1239
|
+
api_instance = KoronaClient::TicketingApi.new
|
1240
|
+
|
1241
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
1242
|
+
|
1243
|
+
body = [KoronaClient::TicketDefinition.new] # Array<TicketDefinition> | array of existing ticket definitions (id or number required)
|
1244
|
+
|
1245
|
+
|
1246
|
+
begin
|
1247
|
+
#updates a batch of ticket definitions
|
1248
|
+
result = api_instance.update_ticket_definitions(korona_account_id, body)
|
1249
|
+
p result
|
1250
|
+
rescue KoronaClient::ApiError => e
|
1251
|
+
puts "Exception when calling TicketingApi->update_ticket_definitions: #{e}"
|
1252
|
+
end
|
1253
|
+
```
|
1254
|
+
|
1255
|
+
### Parameters
|
1256
|
+
|
1257
|
+
Name | Type | Description | Notes
|
1258
|
+
------------- | ------------- | ------------- | -------------
|
1259
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
1260
|
+
**body** | [**Array<TicketDefinition>**](TicketDefinition.md)| array of existing ticket definitions (id or number required) |
|
1261
|
+
|
1262
|
+
### Return type
|
1263
|
+
|
1264
|
+
[**Array<AddOrUpdateResult>**](AddOrUpdateResult.md)
|
366
1265
|
|
367
1266
|
### Authorization
|
368
1267
|
|