korona-cloud-client 1.0.1 → 1.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +71 -4
- data/docs/AddressInformation.md +2 -0
- data/docs/Cashier.md +16 -6
- data/docs/CashierRole.md +27 -0
- data/docs/CashierRolesApi.md +402 -0
- data/docs/CashiersApi.md +286 -2
- data/docs/CloudSubscriptionDetails.md +19 -0
- data/docs/CurrenciesApi.md +166 -0
- data/docs/Customer.md +5 -1
- data/docs/EconomicZonesApi.md +166 -0
- data/docs/FiscalTransaction.md +43 -0
- data/docs/FiscalUnit.md +51 -0
- data/docs/FiscalUnitCertificateInfo.md +19 -0
- data/docs/FiscalUnitState.md +27 -0
- data/docs/FiscalUnitStateUsageLevel.md +23 -0
- data/docs/FiscalUnitStateUsageLevelValue.md +19 -0
- data/docs/FiscalUnitStateVersionInfo.md +21 -0
- data/docs/FiscalUnitsApi.md +299 -0
- data/docs/InfoTextsApi.md +166 -0
- data/docs/KoronaAccount.md +2 -0
- data/docs/OrganizationalUnit.md +9 -7
- data/docs/PaymentMethod.md +2 -0
- data/docs/PointsOfSaleApi.md +6 -2
- data/docs/Pos.md +10 -4
- data/docs/PriceGroupsApi.md +166 -0
- data/docs/ProductionType.md +33 -0
- data/docs/ProductionTypesApi.md +294 -0
- data/docs/Receipt.md +18 -8
- data/docs/ReceiptItem.md +3 -1
- data/docs/ReceiptMaxRevisions.md +27 -0
- data/docs/ReceiptsApi.md +9 -3
- data/docs/ResultListCashierRole.md +27 -0
- data/docs/ResultListFiscalUnit.md +27 -0
- data/docs/ResultListProductionType.md +27 -0
- data/docs/ResultListStockOrder.md +27 -0
- data/docs/SalesTax.md +2 -0
- data/docs/SalesTaxesApi.md +166 -0
- data/docs/SectorsApi.md +54 -0
- data/docs/Service.md +19 -0
- data/docs/StockOrder.md +73 -0
- data/docs/StockOrderItem.md +39 -0
- data/docs/StockOrdersApi.md +195 -0
- data/docs/StockReceipt.md +4 -0
- data/docs/SuppliersApi.md +166 -0
- data/docs/TicketingApi.md +223 -3
- data/docs/VoidedReceiptItem.md +25 -0
- data/korona-cloud-client-1.0.1.gem +0 -0
- data/korona-cloud-client.gemspec +2 -2
- data/lib/korona-cloud-client.rb +24 -1
- data/lib/korona-cloud-client/api/accounts_api.rb +1 -1
- data/lib/korona-cloud-client/api/additional_receipt_info_types_api.rb +1 -1
- data/lib/korona-cloud-client/api/assortments_api.rb +1 -1
- data/lib/korona-cloud-client/api/cashier_roles_api.rb +513 -0
- data/lib/korona-cloud-client/api/cashiers_api.rb +366 -1
- data/lib/korona-cloud-client/api/commodity_groups_api.rb +1 -1
- data/lib/korona-cloud-client/api/currencies_api.rb +208 -1
- data/lib/korona-cloud-client/api/customer_groups_api.rb +1 -1
- data/lib/korona-cloud-client/api/customer_orders_api.rb +1 -1
- data/lib/korona-cloud-client/api/customers_api.rb +1 -1
- data/lib/korona-cloud-client/api/delivery_notes_api.rb +1 -1
- data/lib/korona-cloud-client/api/economic_zones_api.rb +208 -1
- data/lib/korona-cloud-client/api/external_system_calls_api.rb +1 -1
- data/lib/korona-cloud-client/api/fiscal_units_api.rb +389 -0
- data/lib/korona-cloud-client/api/images_api.rb +1 -1
- data/lib/korona-cloud-client/api/info_texts_api.rb +208 -1
- data/lib/korona-cloud-client/api/inventories_api.rb +1 -1
- data/lib/korona-cloud-client/api/korona_account_api.rb +1 -1
- data/lib/korona-cloud-client/api/organizational_units_api.rb +1 -1
- data/lib/korona-cloud-client/api/payment_methods_api.rb +1 -1
- data/lib/korona-cloud-client/api/points_of_sale_api.rb +7 -1
- data/lib/korona-cloud-client/api/price_groups_api.rb +208 -1
- data/lib/korona-cloud-client/api/production_types_api.rb +373 -0
- data/lib/korona-cloud-client/api/products_api.rb +1 -1
- data/lib/korona-cloud-client/api/receipts_api.rb +7 -1
- data/lib/korona-cloud-client/api/sales_taxes_api.rb +208 -1
- data/lib/korona-cloud-client/api/sectors_api.rb +69 -1
- data/lib/korona-cloud-client/api/statistics_api.rb +1 -1
- data/lib/korona-cloud-client/api/stock_orders_api.rb +257 -0
- data/lib/korona-cloud-client/api/stock_receipts_api.rb +1 -1
- data/lib/korona-cloud-client/api/suppliers_api.rb +208 -1
- data/lib/korona-cloud-client/api/tags_api.rb +1 -1
- data/lib/korona-cloud-client/api/ticket_creation_api.rb +1 -1
- data/lib/korona-cloud-client/api/ticketing_api.rb +277 -4
- data/lib/korona-cloud-client/api/time_tracking_api.rb +1 -1
- data/lib/korona-cloud-client/api_client.rb +1 -1
- data/lib/korona-cloud-client/api_error.rb +1 -1
- data/lib/korona-cloud-client/configuration.rb +1 -1
- data/lib/korona-cloud-client/models/account.rb +1 -1
- data/lib/korona-cloud-client/models/account_summary.rb +1 -1
- data/lib/korona-cloud-client/models/account_transaction.rb +1 -1
- data/lib/korona-cloud-client/models/add_or_update_result.rb +1 -1
- data/lib/korona-cloud-client/models/additional_info.rb +1 -1
- data/lib/korona-cloud-client/models/additional_receipt_info_type.rb +1 -1
- data/lib/korona-cloud-client/models/address_information.rb +11 -2
- data/lib/korona-cloud-client/models/admission.rb +1 -1
- data/lib/korona-cloud-client/models/amount.rb +1 -1
- data/lib/korona-cloud-client/models/amount_count_data.rb +1 -1
- data/lib/korona-cloud-client/models/assortment.rb +1 -1
- data/lib/korona-cloud-client/models/attendance.rb +1 -1
- data/lib/korona-cloud-client/models/bad_request_error.rb +1 -1
- data/lib/korona-cloud-client/models/capacity.rb +1 -1
- data/lib/korona-cloud-client/models/cashier.rb +55 -10
- data/lib/korona-cloud-client/models/cashier_role.rb +279 -0
- data/lib/korona-cloud-client/models/cashier_summary.rb +1 -1
- data/lib/korona-cloud-client/models/category.rb +1 -1
- data/lib/korona-cloud-client/models/cloud_subscription.rb +1 -1
- data/lib/korona-cloud-client/models/cloud_subscription_details.rb +249 -0
- data/lib/korona-cloud-client/models/commodity_group.rb +1 -1
- data/lib/korona-cloud-client/models/commodity_group_summary.rb +1 -1
- data/lib/korona-cloud-client/models/company_identification.rb +1 -1
- data/lib/korona-cloud-client/models/creation_task.rb +1 -1
- data/lib/korona-cloud-client/models/currency.rb +1 -1
- data/lib/korona-cloud-client/models/currency_denomination.rb +1 -1
- data/lib/korona-cloud-client/models/currency_exchange_rate.rb +1 -1
- data/lib/korona-cloud-client/models/customer.rb +23 -5
- data/lib/korona-cloud-client/models/customer_card.rb +1 -1
- data/lib/korona-cloud-client/models/customer_data.rb +1 -1
- data/lib/korona-cloud-client/models/customer_group.rb +1 -1
- data/lib/korona-cloud-client/models/customer_group_summary.rb +1 -1
- data/lib/korona-cloud-client/models/customer_information.rb +1 -1
- data/lib/korona-cloud-client/models/customer_order.rb +1 -1
- data/lib/korona-cloud-client/models/day_rating.rb +1 -1
- data/lib/korona-cloud-client/models/day_time_period.rb +1 -1
- data/lib/korona-cloud-client/models/delivery_note.rb +1 -1
- data/lib/korona-cloud-client/models/delivery_note_item.rb +1 -1
- data/lib/korona-cloud-client/models/deposit.rb +1 -1
- data/lib/korona-cloud-client/models/device_information.rb +1 -1
- data/lib/korona-cloud-client/models/discount.rb +1 -1
- data/lib/korona-cloud-client/models/economic_zone.rb +1 -1
- data/lib/korona-cloud-client/models/end_of_day_statement.rb +1 -1
- data/lib/korona-cloud-client/models/end_of_day_statement_summary.rb +1 -1
- data/lib/korona-cloud-client/models/entry_gate.rb +1 -1
- data/lib/korona-cloud-client/models/event.rb +1 -1
- data/lib/korona-cloud-client/models/external_system_call.rb +1 -1
- data/lib/korona-cloud-client/models/fiscal_transaction.rb +342 -0
- data/lib/korona-cloud-client/models/fiscal_unit.rb +415 -0
- data/lib/korona-cloud-client/models/fiscal_unit_certificate_info.rb +233 -0
- data/lib/korona-cloud-client/models/fiscal_unit_state.rb +287 -0
- data/lib/korona-cloud-client/models/fiscal_unit_state_usage_level.rb +233 -0
- data/lib/korona-cloud-client/models/fiscal_unit_state_usage_level_value.rb +215 -0
- data/lib/korona-cloud-client/models/fiscal_unit_state_version_info.rb +224 -0
- data/lib/korona-cloud-client/models/forbidden_error.rb +1 -1
- data/lib/korona-cloud-client/models/geo_location.rb +1 -1
- data/lib/korona-cloud-client/models/info_text.rb +1 -1
- data/lib/korona-cloud-client/models/interval.rb +1 -1
- data/lib/korona-cloud-client/models/inventory.rb +1 -1
- data/lib/korona-cloud-client/models/inventory_list.rb +1 -1
- data/lib/korona-cloud-client/models/inventory_list_item.rb +1 -1
- data/lib/korona-cloud-client/models/inventory_list_item_stock.rb +1 -1
- data/lib/korona-cloud-client/models/korona_account.rb +13 -2
- data/lib/korona-cloud-client/models/media_url.rb +1 -1
- data/lib/korona-cloud-client/models/method_not_allowed_error.rb +1 -1
- data/lib/korona-cloud-client/models/model_reference.rb +1 -1
- data/lib/korona-cloud-client/models/not_found_error.rb +1 -1
- data/lib/korona-cloud-client/models/opening_hours.rb +1 -1
- data/lib/korona-cloud-client/models/organizational_unit.rb +43 -34
- data/lib/korona-cloud-client/models/payment.rb +1 -1
- data/lib/korona-cloud-client/models/payment_method.rb +11 -2
- data/lib/korona-cloud-client/models/payment_summary.rb +1 -1
- data/lib/korona-cloud-client/models/period.rb +1 -1
- data/lib/korona-cloud-client/models/period_list_top_seller.rb +1 -1
- data/lib/korona-cloud-client/models/period_map_string_revenue_data.rb +1 -1
- data/lib/korona-cloud-client/models/period_object.rb +1 -1
- data/lib/korona-cloud-client/models/period_revenue_data.rb +1 -1
- data/lib/korona-cloud-client/models/pos.rb +44 -17
- data/lib/korona-cloud-client/models/price_group.rb +1 -1
- data/lib/korona-cloud-client/models/product.rb +1 -1
- data/lib/korona-cloud-client/models/product_code.rb +1 -1
- data/lib/korona-cloud-client/models/product_description.rb +1 -1
- data/lib/korona-cloud-client/models/product_price.rb +1 -1
- data/lib/korona-cloud-client/models/product_stock.rb +1 -1
- data/lib/korona-cloud-client/models/product_subproduct.rb +1 -1
- data/lib/korona-cloud-client/models/product_supplier_price.rb +1 -1
- data/lib/korona-cloud-client/models/product_transfer_involved_party_information.rb +1 -1
- data/lib/korona-cloud-client/models/product_transfer_involved_party_information_data.rb +1 -1
- data/lib/korona-cloud-client/models/production_type.rb +328 -0
- data/lib/korona-cloud-client/models/rating.rb +1 -1
- data/lib/korona-cloud-client/models/receipt.rb +82 -31
- data/lib/korona-cloud-client/models/receipt_item.rb +14 -5
- data/lib/korona-cloud-client/models/receipt_max_revisions.rb +251 -0
- data/lib/korona-cloud-client/models/result_list.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_account.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_additional_receipt_info_type.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_assortment.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_attendance.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_cashier.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_cashier_role.rb +291 -0
- data/lib/korona-cloud-client/models/result_list_commodity_group.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_creation_task.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_currency.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_customer.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_customer_group.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_customer_order.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_day_rating.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_delivery_note.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_economic_zone.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_end_of_day_statement.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_entry_gate.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_event.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_external_system_call.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_fiscal_unit.rb +291 -0
- data/lib/korona-cloud-client/models/result_list_info_text.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_inventory.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_inventory_list.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_inventory_list_item.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_organizational_unit.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_payment_method.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_pos.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_price_group.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_product.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_product_stock.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_production_type.rb +291 -0
- data/lib/korona-cloud-client/models/result_list_receipt.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_sales_tax.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_sector.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_stock_order.rb +291 -0
- data/lib/korona-cloud-client/models/result_list_stock_receipt.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_stock_receipt_item.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_supplier.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_tag.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_ticket.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_ticket_definition.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_time_tracking_entity.rb +1 -1
- data/lib/korona-cloud-client/models/result_list_time_tracking_entry.rb +1 -1
- data/lib/korona-cloud-client/models/revenue_data.rb +1 -1
- data/lib/korona-cloud-client/models/sales_tax.rb +45 -2
- data/lib/korona-cloud-client/models/sales_tax_rate.rb +1 -1
- data/lib/korona-cloud-client/models/sector.rb +1 -1
- data/lib/korona-cloud-client/models/sector_revenue_account_item.rb +1 -1
- data/lib/korona-cloud-client/models/sector_sales_tax_item.rb +1 -1
- data/lib/korona-cloud-client/models/service.rb +249 -0
- data/lib/korona-cloud-client/models/signature.rb +1 -1
- data/lib/korona-cloud-client/models/statistic.rb +1 -1
- data/lib/korona-cloud-client/models/statistic_list_top_seller.rb +1 -1
- data/lib/korona-cloud-client/models/statistic_map_string_revenue_data.rb +1 -1
- data/lib/korona-cloud-client/models/statistic_revenue_data.rb +1 -1
- data/lib/korona-cloud-client/models/stock_order.rb +498 -0
- data/lib/korona-cloud-client/models/stock_order_item.rb +305 -0
- data/lib/korona-cloud-client/models/stock_receipt.rb +20 -2
- data/lib/korona-cloud-client/models/stock_receipt_item.rb +1 -1
- data/lib/korona-cloud-client/models/stock_receipt_item_amount.rb +1 -1
- data/lib/korona-cloud-client/models/stock_receipt_item_identification.rb +1 -1
- data/lib/korona-cloud-client/models/stock_receipt_item_purchase_price.rb +1 -1
- data/lib/korona-cloud-client/models/supplier.rb +1 -1
- data/lib/korona-cloud-client/models/supplier_contact.rb +1 -1
- data/lib/korona-cloud-client/models/supplier_contact_person.rb +1 -1
- data/lib/korona-cloud-client/models/supplier_payment_information.rb +1 -1
- data/lib/korona-cloud-client/models/tag.rb +1 -1
- data/lib/korona-cloud-client/models/tax_payment.rb +1 -1
- data/lib/korona-cloud-client/models/tax_summary.rb +1 -1
- data/lib/korona-cloud-client/models/ticket.rb +1 -1
- data/lib/korona-cloud-client/models/ticket_data.rb +1 -1
- data/lib/korona-cloud-client/models/ticket_definition.rb +1 -1
- data/lib/korona-cloud-client/models/ticket_personalization.rb +1 -1
- data/lib/korona-cloud-client/models/time_period.rb +1 -1
- data/lib/korona-cloud-client/models/time_tracking_entity.rb +1 -1
- data/lib/korona-cloud-client/models/time_tracking_entry.rb +1 -1
- data/lib/korona-cloud-client/models/too_many_requests_error.rb +1 -1
- data/lib/korona-cloud-client/models/top_seller.rb +1 -1
- data/lib/korona-cloud-client/models/total_period.rb +1 -1
- data/lib/korona-cloud-client/models/total_price.rb +1 -1
- data/lib/korona-cloud-client/models/validity.rb +1 -1
- data/lib/korona-cloud-client/models/voided_receipt_item.rb +242 -0
- data/lib/korona-cloud-client/models/weather.rb +1 -1
- data/lib/korona-cloud-client/version.rb +2 -2
- data/spec/api/cashier_roles_api_spec.rb +126 -0
- data/spec/api/fiscal_units_api_spec.rb +104 -0
- data/spec/api/production_types_api_spec.rb +101 -0
- data/spec/api/stock_orders_api_spec.rb +83 -0
- data/spec/models/cashier_role_spec.rb +75 -0
- data/spec/models/cloud_subscription_details_spec.rb +51 -0
- data/spec/models/fiscal_transaction_spec.rb +119 -0
- data/spec/models/fiscal_unit_certificate_info_spec.rb +47 -0
- data/spec/models/fiscal_unit_spec.rb +147 -0
- data/spec/models/fiscal_unit_state_spec.rb +75 -0
- data/spec/models/fiscal_unit_state_usage_level_spec.rb +59 -0
- data/spec/models/fiscal_unit_state_usage_level_value_spec.rb +47 -0
- data/spec/models/fiscal_unit_state_version_info_spec.rb +53 -0
- data/spec/models/production_type_spec.rb +97 -0
- data/spec/models/receipt_max_revisions_spec.rb +71 -0
- data/spec/models/result_list_cashier_role_spec.rb +71 -0
- data/spec/models/result_list_fiscal_unit_spec.rb +71 -0
- data/spec/models/result_list_production_type_spec.rb +71 -0
- data/spec/models/result_list_stock_order_spec.rb +71 -0
- data/spec/models/service_spec.rb +51 -0
- data/spec/models/stock_order_item_spec.rb +107 -0
- data/spec/models/stock_order_spec.rb +213 -0
- data/spec/models/voided_receipt_item_spec.rb +65 -0
- metadata +96 -3
data/docs/CashiersApi.md
CHANGED
@@ -4,14 +4,181 @@ All URIs are relative to *https://www.koronacloud.com/web/api/v3*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**add_cashiers**](CashiersApi.md#add_cashiers) | **POST** /accounts/{koronaAccountId}/cashiers | adds a batch of new cashiers
|
8
|
+
[**delete_cashier**](CashiersApi.md#delete_cashier) | **DELETE** /accounts/{koronaAccountId}/cashiers/{cashierId} | deletes the single cashier
|
9
|
+
[**delete_cashiers**](CashiersApi.md#delete_cashiers) | **DELETE** /accounts/{koronaAccountId}/cashiers | deletes a batch of cashiers
|
7
10
|
[**get_cashier**](CashiersApi.md#get_cashier) | **GET** /accounts/{koronaAccountId}/cashiers/{cashierId} | returns the single cashier
|
8
11
|
[**get_cashiers**](CashiersApi.md#get_cashiers) | **GET** /accounts/{koronaAccountId}/cashiers | lists all cashiers
|
12
|
+
[**update_cashier**](CashiersApi.md#update_cashier) | **PATCH** /accounts/{koronaAccountId}/cashiers/{cashierId} | updates the single cashier
|
13
|
+
[**update_cashiers**](CashiersApi.md#update_cashiers) | **PATCH** /accounts/{koronaAccountId}/cashiers | updates a batch of cashiers
|
9
14
|
|
10
15
|
|
11
16
|
|
17
|
+
## add_cashiers
|
18
|
+
|
19
|
+
> Array<AddOrUpdateResult> add_cashiers(korona_account_id, body, opts)
|
20
|
+
|
21
|
+
adds a batch of new cashiers
|
22
|
+
|
23
|
+
### Example
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
# load the gem
|
27
|
+
require 'korona-cloud-client'
|
28
|
+
# setup authorization
|
29
|
+
KoronaCloudClient.configure do |config|
|
30
|
+
# Configure HTTP basic authorization: basicAuth
|
31
|
+
config.username = 'YOUR USERNAME'
|
32
|
+
config.password = 'YOUR PASSWORD'
|
33
|
+
end
|
34
|
+
|
35
|
+
api_instance = KoronaCloudClient::CashiersApi.new
|
36
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
37
|
+
body = [KoronaCloudClient::Cashier.new] # Array<Cashier> | array of new cashiers
|
38
|
+
opts = {
|
39
|
+
upsert: true # Boolean | when set to true, updates the object instead of generating a already-exists-error
|
40
|
+
}
|
41
|
+
|
42
|
+
begin
|
43
|
+
#adds a batch of new cashiers
|
44
|
+
result = api_instance.add_cashiers(korona_account_id, body, opts)
|
45
|
+
p result
|
46
|
+
rescue KoronaCloudClient::ApiError => e
|
47
|
+
puts "Exception when calling CashiersApi->add_cashiers: #{e}"
|
48
|
+
end
|
49
|
+
```
|
50
|
+
|
51
|
+
### Parameters
|
52
|
+
|
53
|
+
|
54
|
+
Name | Type | Description | Notes
|
55
|
+
------------- | ------------- | ------------- | -------------
|
56
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
57
|
+
**body** | [**Array<Cashier>**](Cashier.md)| array of new cashiers |
|
58
|
+
**upsert** | **Boolean**| when set to true, updates the object instead of generating a already-exists-error | [optional]
|
59
|
+
|
60
|
+
### Return type
|
61
|
+
|
62
|
+
[**Array<AddOrUpdateResult>**](AddOrUpdateResult.md)
|
63
|
+
|
64
|
+
### Authorization
|
65
|
+
|
66
|
+
[basicAuth](../README.md#basicAuth)
|
67
|
+
|
68
|
+
### HTTP request headers
|
69
|
+
|
70
|
+
- **Content-Type**: application/json
|
71
|
+
- **Accept**: application/json
|
72
|
+
|
73
|
+
|
74
|
+
## delete_cashier
|
75
|
+
|
76
|
+
> delete_cashier(korona_account_id, cashier_id)
|
77
|
+
|
78
|
+
deletes the single cashier
|
79
|
+
|
80
|
+
### Example
|
81
|
+
|
82
|
+
```ruby
|
83
|
+
# load the gem
|
84
|
+
require 'korona-cloud-client'
|
85
|
+
# setup authorization
|
86
|
+
KoronaCloudClient.configure do |config|
|
87
|
+
# Configure HTTP basic authorization: basicAuth
|
88
|
+
config.username = 'YOUR USERNAME'
|
89
|
+
config.password = 'YOUR PASSWORD'
|
90
|
+
end
|
91
|
+
|
92
|
+
api_instance = KoronaCloudClient::CashiersApi.new
|
93
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
94
|
+
cashier_id = 'cashier_id_example' # String | id of the related object (important: id should match the uuid-format)
|
95
|
+
|
96
|
+
begin
|
97
|
+
#deletes the single cashier
|
98
|
+
api_instance.delete_cashier(korona_account_id, cashier_id)
|
99
|
+
rescue KoronaCloudClient::ApiError => e
|
100
|
+
puts "Exception when calling CashiersApi->delete_cashier: #{e}"
|
101
|
+
end
|
102
|
+
```
|
103
|
+
|
104
|
+
### Parameters
|
105
|
+
|
106
|
+
|
107
|
+
Name | Type | Description | Notes
|
108
|
+
------------- | ------------- | ------------- | -------------
|
109
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
110
|
+
**cashier_id** | **String**| id of the related object (important: id should match the uuid-format) |
|
111
|
+
|
112
|
+
### Return type
|
113
|
+
|
114
|
+
nil (empty response body)
|
115
|
+
|
116
|
+
### Authorization
|
117
|
+
|
118
|
+
[basicAuth](../README.md#basicAuth)
|
119
|
+
|
120
|
+
### HTTP request headers
|
121
|
+
|
122
|
+
- **Content-Type**: Not defined
|
123
|
+
- **Accept**: application/json
|
124
|
+
|
125
|
+
|
126
|
+
## delete_cashiers
|
127
|
+
|
128
|
+
> Array<AddOrUpdateResult> delete_cashiers(korona_account_id, body)
|
129
|
+
|
130
|
+
deletes a batch of cashiers
|
131
|
+
|
132
|
+
### Example
|
133
|
+
|
134
|
+
```ruby
|
135
|
+
# load the gem
|
136
|
+
require 'korona-cloud-client'
|
137
|
+
# setup authorization
|
138
|
+
KoronaCloudClient.configure do |config|
|
139
|
+
# Configure HTTP basic authorization: basicAuth
|
140
|
+
config.username = 'YOUR USERNAME'
|
141
|
+
config.password = 'YOUR PASSWORD'
|
142
|
+
end
|
143
|
+
|
144
|
+
api_instance = KoronaCloudClient::CashiersApi.new
|
145
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
146
|
+
body = [KoronaCloudClient::Cashier.new] # Array<Cashier> | array of existing cashiers (id or number required)
|
147
|
+
|
148
|
+
begin
|
149
|
+
#deletes a batch of cashiers
|
150
|
+
result = api_instance.delete_cashiers(korona_account_id, body)
|
151
|
+
p result
|
152
|
+
rescue KoronaCloudClient::ApiError => e
|
153
|
+
puts "Exception when calling CashiersApi->delete_cashiers: #{e}"
|
154
|
+
end
|
155
|
+
```
|
156
|
+
|
157
|
+
### Parameters
|
158
|
+
|
159
|
+
|
160
|
+
Name | Type | Description | Notes
|
161
|
+
------------- | ------------- | ------------- | -------------
|
162
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
163
|
+
**body** | [**Array<Cashier>**](Cashier.md)| array of existing cashiers (id or number required) |
|
164
|
+
|
165
|
+
### Return type
|
166
|
+
|
167
|
+
[**Array<AddOrUpdateResult>**](AddOrUpdateResult.md)
|
168
|
+
|
169
|
+
### Authorization
|
170
|
+
|
171
|
+
[basicAuth](../README.md#basicAuth)
|
172
|
+
|
173
|
+
### HTTP request headers
|
174
|
+
|
175
|
+
- **Content-Type**: application/json
|
176
|
+
- **Accept**: application/json
|
177
|
+
|
178
|
+
|
12
179
|
## get_cashier
|
13
180
|
|
14
|
-
> Cashier get_cashier(korona_account_id, cashier_id)
|
181
|
+
> Cashier get_cashier(korona_account_id, cashier_id, opts)
|
15
182
|
|
16
183
|
returns the single cashier
|
17
184
|
|
@@ -30,10 +197,13 @@ end
|
|
30
197
|
api_instance = KoronaCloudClient::CashiersApi.new
|
31
198
|
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
32
199
|
cashier_id = 'cashier_id_example' # String | id of the related object (important: id should match the uuid-format)
|
200
|
+
opts = {
|
201
|
+
display_cashier_credentials: 'display_cashier_credentials_example' # String | display cashier credentials loginCode and loginPassword as (HASH|PLAIN|NONE)
|
202
|
+
}
|
33
203
|
|
34
204
|
begin
|
35
205
|
#returns the single cashier
|
36
|
-
result = api_instance.get_cashier(korona_account_id, cashier_id)
|
206
|
+
result = api_instance.get_cashier(korona_account_id, cashier_id, opts)
|
37
207
|
p result
|
38
208
|
rescue KoronaCloudClient::ApiError => e
|
39
209
|
puts "Exception when calling CashiersApi->get_cashier: #{e}"
|
@@ -47,6 +217,7 @@ Name | Type | Description | Notes
|
|
47
217
|
------------- | ------------- | ------------- | -------------
|
48
218
|
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
49
219
|
**cashier_id** | **String**| id of the related object (important: id should match the uuid-format) |
|
220
|
+
**display_cashier_credentials** | **String**| display cashier credentials loginCode and loginPassword as (HASH|PLAIN|NONE) | [optional]
|
50
221
|
|
51
222
|
### Return type
|
52
223
|
|
@@ -88,6 +259,7 @@ opts = {
|
|
88
259
|
sort: 'sort_example', # String | attribute to sort by (multiple separated by comma; max. 5)
|
89
260
|
revision: 56, # Integer | last revision number, objects with a greater revision than this will be returned
|
90
261
|
include_deleted: true, # Boolean | indicates deleted objects should be loaded or not (default: false)
|
262
|
+
display_cashier_credentials: 'display_cashier_credentials_example', # String | display cashier credentials loginCode and loginPassword as (HASH|PLAIN|NONE)
|
91
263
|
number: 'number_example' # String | number of the related object
|
92
264
|
}
|
93
265
|
|
@@ -111,6 +283,7 @@ Name | Type | Description | Notes
|
|
111
283
|
**sort** | **String**| attribute to sort by (multiple separated by comma; max. 5) | [optional]
|
112
284
|
**revision** | **Integer**| last revision number, objects with a greater revision than this will be returned | [optional]
|
113
285
|
**include_deleted** | **Boolean**| indicates deleted objects should be loaded or not (default: false) | [optional]
|
286
|
+
**display_cashier_credentials** | **String**| display cashier credentials loginCode and loginPassword as (HASH|PLAIN|NONE) | [optional]
|
114
287
|
**number** | **String**| number of the related object | [optional]
|
115
288
|
|
116
289
|
### Return type
|
@@ -126,3 +299,114 @@ Name | Type | Description | Notes
|
|
126
299
|
- **Content-Type**: Not defined
|
127
300
|
- **Accept**: application/json
|
128
301
|
|
302
|
+
|
303
|
+
## update_cashier
|
304
|
+
|
305
|
+
> update_cashier(korona_account_id, cashier_id, body)
|
306
|
+
|
307
|
+
updates the single cashier
|
308
|
+
|
309
|
+
if [number] is set, the number of the object will change and the resource location as well
|
310
|
+
|
311
|
+
### Example
|
312
|
+
|
313
|
+
```ruby
|
314
|
+
# load the gem
|
315
|
+
require 'korona-cloud-client'
|
316
|
+
# setup authorization
|
317
|
+
KoronaCloudClient.configure do |config|
|
318
|
+
# Configure HTTP basic authorization: basicAuth
|
319
|
+
config.username = 'YOUR USERNAME'
|
320
|
+
config.password = 'YOUR PASSWORD'
|
321
|
+
end
|
322
|
+
|
323
|
+
api_instance = KoronaCloudClient::CashiersApi.new
|
324
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
325
|
+
cashier_id = 'cashier_id_example' # String | id of the related object (important: id should match the uuid-format)
|
326
|
+
body = KoronaCloudClient::Cashier.new # Cashier | the properties to update of the cashier
|
327
|
+
|
328
|
+
begin
|
329
|
+
#updates the single cashier
|
330
|
+
api_instance.update_cashier(korona_account_id, cashier_id, body)
|
331
|
+
rescue KoronaCloudClient::ApiError => e
|
332
|
+
puts "Exception when calling CashiersApi->update_cashier: #{e}"
|
333
|
+
end
|
334
|
+
```
|
335
|
+
|
336
|
+
### Parameters
|
337
|
+
|
338
|
+
|
339
|
+
Name | Type | Description | Notes
|
340
|
+
------------- | ------------- | ------------- | -------------
|
341
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
342
|
+
**cashier_id** | **String**| id of the related object (important: id should match the uuid-format) |
|
343
|
+
**body** | [**Cashier**](Cashier.md)| the properties to update of the cashier |
|
344
|
+
|
345
|
+
### Return type
|
346
|
+
|
347
|
+
nil (empty response body)
|
348
|
+
|
349
|
+
### Authorization
|
350
|
+
|
351
|
+
[basicAuth](../README.md#basicAuth)
|
352
|
+
|
353
|
+
### HTTP request headers
|
354
|
+
|
355
|
+
- **Content-Type**: application/json
|
356
|
+
- **Accept**: application/json
|
357
|
+
|
358
|
+
|
359
|
+
## update_cashiers
|
360
|
+
|
361
|
+
> Array<AddOrUpdateResult> update_cashiers(korona_account_id, body)
|
362
|
+
|
363
|
+
updates a batch of cashiers
|
364
|
+
|
365
|
+
[number] must be set in the objects, otherwise the object cannot be updated
|
366
|
+
|
367
|
+
### Example
|
368
|
+
|
369
|
+
```ruby
|
370
|
+
# load the gem
|
371
|
+
require 'korona-cloud-client'
|
372
|
+
# setup authorization
|
373
|
+
KoronaCloudClient.configure do |config|
|
374
|
+
# Configure HTTP basic authorization: basicAuth
|
375
|
+
config.username = 'YOUR USERNAME'
|
376
|
+
config.password = 'YOUR PASSWORD'
|
377
|
+
end
|
378
|
+
|
379
|
+
api_instance = KoronaCloudClient::CashiersApi.new
|
380
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
381
|
+
body = [KoronaCloudClient::Cashier.new] # Array<Cashier> | an array of existing cashiers
|
382
|
+
|
383
|
+
begin
|
384
|
+
#updates a batch of cashiers
|
385
|
+
result = api_instance.update_cashiers(korona_account_id, body)
|
386
|
+
p result
|
387
|
+
rescue KoronaCloudClient::ApiError => e
|
388
|
+
puts "Exception when calling CashiersApi->update_cashiers: #{e}"
|
389
|
+
end
|
390
|
+
```
|
391
|
+
|
392
|
+
### Parameters
|
393
|
+
|
394
|
+
|
395
|
+
Name | Type | Description | Notes
|
396
|
+
------------- | ------------- | ------------- | -------------
|
397
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
398
|
+
**body** | [**Array<Cashier>**](Cashier.md)| an array of existing cashiers |
|
399
|
+
|
400
|
+
### Return type
|
401
|
+
|
402
|
+
[**Array<AddOrUpdateResult>**](AddOrUpdateResult.md)
|
403
|
+
|
404
|
+
### Authorization
|
405
|
+
|
406
|
+
[basicAuth](../README.md#basicAuth)
|
407
|
+
|
408
|
+
### HTTP request headers
|
409
|
+
|
410
|
+
- **Content-Type**: application/json
|
411
|
+
- **Accept**: application/json
|
412
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# KoronaCloudClient::CloudSubscriptionDetails
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**amount** | **Integer** | | [optional]
|
8
|
+
**package_type** | **String** | | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'KoronaCloudClient'
|
14
|
+
|
15
|
+
instance = KoronaCloudClient::CloudSubscriptionDetails.new(amount: null,
|
16
|
+
package_type: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/CurrenciesApi.md
CHANGED
@@ -4,11 +4,124 @@ All URIs are relative to *https://www.koronacloud.com/web/api/v3*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**add_currencies**](CurrenciesApi.md#add_currencies) | **POST** /accounts/{koronaAccountId}/currencies | adds a batch of new currencies
|
8
|
+
[**delete_currencies**](CurrenciesApi.md#delete_currencies) | **DELETE** /accounts/{koronaAccountId}/currencies | deletes a batch of currencies
|
7
9
|
[**get_currencies**](CurrenciesApi.md#get_currencies) | **GET** /accounts/{koronaAccountId}/currencies | lists all currencies
|
8
10
|
[**get_currency**](CurrenciesApi.md#get_currency) | **GET** /accounts/{koronaAccountId}/currencies/{currencyId} | returns the single currency
|
11
|
+
[**update_currencies**](CurrenciesApi.md#update_currencies) | **PATCH** /accounts/{koronaAccountId}/currencies | updates a batch of currencies
|
9
12
|
|
10
13
|
|
11
14
|
|
15
|
+
## add_currencies
|
16
|
+
|
17
|
+
> Array<AddOrUpdateResult> add_currencies(korona_account_id, body, opts)
|
18
|
+
|
19
|
+
adds a batch of new currencies
|
20
|
+
|
21
|
+
### Example
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
# load the gem
|
25
|
+
require 'korona-cloud-client'
|
26
|
+
# setup authorization
|
27
|
+
KoronaCloudClient.configure do |config|
|
28
|
+
# Configure HTTP basic authorization: basicAuth
|
29
|
+
config.username = 'YOUR USERNAME'
|
30
|
+
config.password = 'YOUR PASSWORD'
|
31
|
+
end
|
32
|
+
|
33
|
+
api_instance = KoronaCloudClient::CurrenciesApi.new
|
34
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
35
|
+
body = [KoronaCloudClient::Currency.new] # Array<Currency> | array of new currencies
|
36
|
+
opts = {
|
37
|
+
upsert: true # Boolean | when set to true, updates the object instead of generating a already-exists-error
|
38
|
+
}
|
39
|
+
|
40
|
+
begin
|
41
|
+
#adds a batch of new currencies
|
42
|
+
result = api_instance.add_currencies(korona_account_id, body, opts)
|
43
|
+
p result
|
44
|
+
rescue KoronaCloudClient::ApiError => e
|
45
|
+
puts "Exception when calling CurrenciesApi->add_currencies: #{e}"
|
46
|
+
end
|
47
|
+
```
|
48
|
+
|
49
|
+
### Parameters
|
50
|
+
|
51
|
+
|
52
|
+
Name | Type | Description | Notes
|
53
|
+
------------- | ------------- | ------------- | -------------
|
54
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
55
|
+
**body** | [**Array<Currency>**](Currency.md)| array of new currencies |
|
56
|
+
**upsert** | **Boolean**| when set to true, updates the object instead of generating a already-exists-error | [optional]
|
57
|
+
|
58
|
+
### Return type
|
59
|
+
|
60
|
+
[**Array<AddOrUpdateResult>**](AddOrUpdateResult.md)
|
61
|
+
|
62
|
+
### Authorization
|
63
|
+
|
64
|
+
[basicAuth](../README.md#basicAuth)
|
65
|
+
|
66
|
+
### HTTP request headers
|
67
|
+
|
68
|
+
- **Content-Type**: application/json
|
69
|
+
- **Accept**: application/json
|
70
|
+
|
71
|
+
|
72
|
+
## delete_currencies
|
73
|
+
|
74
|
+
> Array<AddOrUpdateResult> delete_currencies(korona_account_id, body)
|
75
|
+
|
76
|
+
deletes a batch of currencies
|
77
|
+
|
78
|
+
### Example
|
79
|
+
|
80
|
+
```ruby
|
81
|
+
# load the gem
|
82
|
+
require 'korona-cloud-client'
|
83
|
+
# setup authorization
|
84
|
+
KoronaCloudClient.configure do |config|
|
85
|
+
# Configure HTTP basic authorization: basicAuth
|
86
|
+
config.username = 'YOUR USERNAME'
|
87
|
+
config.password = 'YOUR PASSWORD'
|
88
|
+
end
|
89
|
+
|
90
|
+
api_instance = KoronaCloudClient::CurrenciesApi.new
|
91
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
92
|
+
body = [KoronaCloudClient::Currency.new] # Array<Currency> | array of existing currencies (id or number required)
|
93
|
+
|
94
|
+
begin
|
95
|
+
#deletes a batch of currencies
|
96
|
+
result = api_instance.delete_currencies(korona_account_id, body)
|
97
|
+
p result
|
98
|
+
rescue KoronaCloudClient::ApiError => e
|
99
|
+
puts "Exception when calling CurrenciesApi->delete_currencies: #{e}"
|
100
|
+
end
|
101
|
+
```
|
102
|
+
|
103
|
+
### Parameters
|
104
|
+
|
105
|
+
|
106
|
+
Name | Type | Description | Notes
|
107
|
+
------------- | ------------- | ------------- | -------------
|
108
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
109
|
+
**body** | [**Array<Currency>**](Currency.md)| array of existing currencies (id or number required) |
|
110
|
+
|
111
|
+
### Return type
|
112
|
+
|
113
|
+
[**Array<AddOrUpdateResult>**](AddOrUpdateResult.md)
|
114
|
+
|
115
|
+
### Authorization
|
116
|
+
|
117
|
+
[basicAuth](../README.md#basicAuth)
|
118
|
+
|
119
|
+
### HTTP request headers
|
120
|
+
|
121
|
+
- **Content-Type**: application/json
|
122
|
+
- **Accept**: application/json
|
123
|
+
|
124
|
+
|
12
125
|
## get_currencies
|
13
126
|
|
14
127
|
> ResultListCurrency get_currencies(korona_account_id, opts)
|
@@ -126,3 +239,56 @@ Name | Type | Description | Notes
|
|
126
239
|
- **Content-Type**: Not defined
|
127
240
|
- **Accept**: application/json
|
128
241
|
|
242
|
+
|
243
|
+
## update_currencies
|
244
|
+
|
245
|
+
> Array<AddOrUpdateResult> update_currencies(korona_account_id, body)
|
246
|
+
|
247
|
+
updates a batch of currencies
|
248
|
+
|
249
|
+
### Example
|
250
|
+
|
251
|
+
```ruby
|
252
|
+
# load the gem
|
253
|
+
require 'korona-cloud-client'
|
254
|
+
# setup authorization
|
255
|
+
KoronaCloudClient.configure do |config|
|
256
|
+
# Configure HTTP basic authorization: basicAuth
|
257
|
+
config.username = 'YOUR USERNAME'
|
258
|
+
config.password = 'YOUR PASSWORD'
|
259
|
+
end
|
260
|
+
|
261
|
+
api_instance = KoronaCloudClient::CurrenciesApi.new
|
262
|
+
korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
|
263
|
+
body = [KoronaCloudClient::Currency.new] # Array<Currency> | array of existing currencies (id or number required)
|
264
|
+
|
265
|
+
begin
|
266
|
+
#updates a batch of currencies
|
267
|
+
result = api_instance.update_currencies(korona_account_id, body)
|
268
|
+
p result
|
269
|
+
rescue KoronaCloudClient::ApiError => e
|
270
|
+
puts "Exception when calling CurrenciesApi->update_currencies: #{e}"
|
271
|
+
end
|
272
|
+
```
|
273
|
+
|
274
|
+
### Parameters
|
275
|
+
|
276
|
+
|
277
|
+
Name | Type | Description | Notes
|
278
|
+
------------- | ------------- | ------------- | -------------
|
279
|
+
**korona_account_id** | **String**| account id of the KORONA.cloud account |
|
280
|
+
**body** | [**Array<Currency>**](Currency.md)| array of existing currencies (id or number required) |
|
281
|
+
|
282
|
+
### Return type
|
283
|
+
|
284
|
+
[**Array<AddOrUpdateResult>**](AddOrUpdateResult.md)
|
285
|
+
|
286
|
+
### Authorization
|
287
|
+
|
288
|
+
[basicAuth](../README.md#basicAuth)
|
289
|
+
|
290
|
+
### HTTP request headers
|
291
|
+
|
292
|
+
- **Content-Type**: application/json
|
293
|
+
- **Accept**: application/json
|
294
|
+
|