@springtree/eva-services-core-management 3.0.0-beta.15 → 3.0.0-beta.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- import { DataModelsBookingFlags, DataModelsAccountType, ServiceError, ResponseMessageMetadata, FinanceListAccountsFilter, PageConfig, FinanceListAccountsItem, PagedResult, AuditingModelsAuditingSettingType, DataModelsCustomFieldKeyValue, DataModelsCasePriority, DataModelsInteractionType, DataModelsCaseStatusAction, DataModelsCustomFieldValueWithOptions, DataModelsSerialNumberRegistrationStatus, DataModelsRepairStatus, APIEnumDto, SearchIProductSearchItem, InteractionsListCaseInteractionsFilter, PageTokenConfig, CasesListCaseStatusesFilter, CasesListCaseTopicsFilter, CasesListCasesFilter, TAnyValue, DataModelsUserAccountType, AddressesAddressDataDto, AddressesAddressDto, DataModelsCompanyType, CompaniesListCompaniesFilter, CompaniesListCompaniesItem, ConfigurationSettingRemovalReason, ConfigurationSettingModel, ConfigurationAppSettingsAppSettingAutocompleteInfo, SortDirection, ConfigurationSettingValueEntityTypes, ConfigurationSettingSensitivityTypes, ConfigurationAppSettingsListAppSettingsHistoryFilter, ConfigurationAppSettingsListAppSettingsFilter, ConfigurationSettingsListSettingsHistoryFilter, SecurityFunctionalityScope, InternationalizationCultureFilter, InternationalizationOrganizationUnitCountryFilter, InternationalizationOrganizationUnitLanguageFilter, DataModelsCustomFieldDataTypes, UserTypes, DataModelsCustomFieldMetadata, DataModelsCustomFieldOptions, DataModelsCustomFieldValueOperator, CustomFieldsListCustomFieldOptionsFilter, DataModelsCustomFieldValue, CustomFieldsListCustomFieldsFilter, DiscountsIDiscountActionData, DataModelsDiscountAppliesTo, DataModelsDiscountCompliancyRule, DataModelsDiscountConditionTypes, DaysOfWeek, DataModelsDiscountOrderTypes, DataModelsFinancialDespersionType, DataModelsDiscountTriggers, IConditionData, DataModelsDiscountDeactivationReasons, DataModelsOrganizationUnitSetTypes, DiscountsSearchDiscountsByQueryFilter, DiscountsListDiscountCouponsFilter, DataModelsListDiscountCampaignsFilter, DiscountsListDiscountLayerFilter, DataModelsListDiscountTemplatesFilter, CustomFieldsCustomFieldValidationErrorData, DataModelsEntityFieldValidatorUserTypes, DataModelsEntityFieldValidatorEntityTypes, EntityFieldValidatorsValidatorsEntityFieldValidatorBase, DataModelsEntityFieldValidatorType, EntityFieldValidatorsListEntityFieldValidatorsFilter, SearchFilterModel, StockMutationsListProductCostPriceLedgerFilter, StockMutationsListProductCostPriceLedgerItem, StockMutationsListStockMutationUnitCostSourceLedgerFilter, StockMutationsListStockMutationUnitCostSourceLedgerItem, DataModelsCashExpenseAmountTypes, FinanceCashListCashCorrectionReasonsFilter, FinanceCashListCashExpenseTypesFilter, ExchangeRatesListExchangeRatesFilter, GiftCardsConfigurationGiftCardConfigurationUsageTypes, GiftCardsConfigurationProductGiftCardCommunicationOptions, GiftCardsListGiftCardConfigurationsFilter, GiftCardsListProductGiftCardsFilter, DataModelsClientApplicationType, DevicesIDeviceTypeData, NotificationsListClientApplicationsFilter, InquiriesListInquiriesFilter, DataModelsAllowUnsubscribeByType, DataModelsLoyaltyPointUsageOptions, DataModelsLoyaltyProgramOptions, DataModelsResubscribeHandlingType, DataModelsLoyaltyProgramStatus, DataModelsLoyaltyPaymentTaxHandlingType, DataModelsUserBudgetDeduction, LoyaltyRulesIPointAwardingConditionData, DataModelsLoyaltyProgramGroupDeactivationReasons, DataModelsLoyaltyProgramDeactivationReasons, LoyaltyListLoyaltyProgramGroupFilter, LoyaltyListLoyaltyProgramsFilter, LoyaltyListPointAwardingRuleFilter, DataModelsMessageTemplateDestinations, DataModelsPaperProperties, DataModelsMessageTemplateTypes, MessageTemplatesMessageTemplateFilter, MessageTemplatesMessageTargetContentTypes, OrdersCheckoutOptionsICheckoutOptionConfigData, OrdersCheckoutOptionsListCheckoutOptionCategoriesFilter, OrdersCheckoutOptionsListCheckoutOptionsFilter, OrdersReturnsListRefundCorrectionReasonsFilter, OrdersCorrectionsListUnitPriceCorrectionReasonsFilter, DataModelsReturnReasonType, DataModelsOrganizationUnitSetOperatorTypes, DataModelsOrganizationUnitSetDefinition, OrganizationUnitsListOrganizationUnitSetsFilter, OrganizationUnitsListOrganizationUnitSetsItem, OrganizationUnitsDtoOpeningHoursDataDto, FinanceCashListCashHandlersFilter, OrganizationUnitsListOldOpeningHoursFilter, OrganizationUnitsDtoOpeningHoursDto, OrganizationUnitsOrganizationUnitCurrencyFilter, OrganizationUnitsDtoDayOpeningHours, DataModelsPaymentTypeCaptureMoment, DataModelsPaymentCashJournalMethod, DataModelsPaymentTypeCategory, DataModelsPaymentTypeOptions, DataModelsPaymentReturnActions, PaymentsListOrganizationUnitSetPaymentTypesFilter, PaymentsListPaymentMethodsFilter, PaymentsListPaymentTransactionCapturesFilter, DataModelsPaymentTransactionCaptureStatuses, PaymentsListPaymentTransactionsFilter, DataModelsPaymentStatuses, PaymentsListPaymentTypesFilter, PaymentsSettlementsListSettlementFilesFilter, DataModelsPaymentTransactionSettlementFileStatus, PaymentsSettlementsListSettlementsFilter, PersonalizedPromotionsListPersonalizedPromotionsFilter, PricingIPriceListAdjustmentData, DataModelsPriceListAdjustmentSystemType, PricingListPriceListAdjustmentsFilter, PricingListManualInputAdjustmentsFilter, PricingListPriceListOrganizationUnitsFilter, PricingListPriceListsFilter, PricingListPriceListsForOrganizationUnitFilter, PricingListProductPriceLedgerFilter, PricingRoundingData, DataModelsProductRequirementDataTypes, DataModelsOrderTypes, DataModelsProductRequirementOptions, SearchAggregationFilterModel, DataModelsProductSearchTemplateTypes, DataModelsProductStatus, ProductsListProductBarcodesFilter, DataModelsProductBarcodeOrigin, ProductsListProductRequirementsFilter, SearchListProductSearchTemplateResultsFilter, SearchListProductSearchTemplateResultItem, SearchProductSearchTemplateFilters, ProductsListProductUnitOfMeasuresFilter, ProductsListSupplierProductsFilter, UsersListRolesFilter, OrganizationUnitsListUserOrganizationUnitRolesFilter, DataModelsShippingMethodDeliveryTypes, DataModelsShippingRestrictionType, ShippingListCarriersFilter, ShippingListShippingMethodsFilter, ShippingListOrganizationUnitShippingMethodsFilter, ShippingListShippingCostsFilter, ShippingListTransportationTimesFilter, ShippingShippingMethodTransportationTimeItem, ShippingListShippingRestrictionsFilter, DataModelsStockAllocationRuleTypes, DataModelsStockAllocationRuleValueTypes, SuppliersListStockAllocationRulesFilter, StockMutationsListCumulativeStockFilter, SuppliersListStockAllocationRulesItem, StockMutationsListStockMutationReasonsModelFilters, StockMutationsStockMutationFilters, ScrollablePageConfig, StockMutationsSearchStockMutationResult, ScrollablePagedResult, PricingListTaxRateModelFilters, UsersUserRequirementsUserRequirementFor, UsersUserRequirementsUserRequirementProperties, UsersUserRequirementsUserRequirementForSubscriptionResponse, UsersUserRequirementsUserRequirementResponse, UsersSubscriptionsListSubscriptionUsersFilter, DataModelsSubscriptionStatus, DataModelsSubscriptionType, UsersUserRequirementsListUserRequirementSetsFilter, UsersUserRequirementsListUserRequirementsFilter, WishlistsListWishlistsFilter, VisibilityGroupsListVisibilityGroupConfigurationsFilter, VisibilityGroupsListVisibilityGroupsFilter, DataModelsProductTypes, ProductsListAssortmentProductsFilter, FinanceListGeneralLedgersFilter, DataModelsFraudDataType, AddressesListFraudItemsFilter, UserBoughtProductsListUserBoughtProductsFilter, SearchIProductSearchItemPrimaryImage } from '@springtree/eva-services-core';
1
+ import { DataModelsBookingFlags, DataModelsAccountType, ServiceError, ResponseMessageMetadata, FinanceListAccountsFilter, PageConfig, FinanceListAccountsItem, PagedResult, AuditingModelsAuditingSettingType, DataModelsCustomFieldKeyValue, DataModelsCasePriority, DataModelsInteractionType, DataModelsCaseStatusAction, DataModelsCustomFieldValueWithOptions, DataModelsSerialNumberRegistrationStatus, DataModelsRepairStatus, EVAFrameworkAPIEnumDto, SearchIProductSearchItem, InteractionsListCaseInteractionsFilter, PageTokenConfig, CasesListCaseStatusesFilter, CasesListCaseTopicsFilter, CasesListCasesFilter, TAnyValue, DataModelsUserAccountType, AddressesAddressDataDto, AddressesAddressDto, DataModelsCompanyType, CompaniesListCompaniesFilter, CompaniesListCompaniesItem, ConfigurationSettingRemovalReason, ConfigurationSettingModel, ConfigurationAppSettingsAppSettingAutocompleteInfo, SortDirection, ConfigurationSettingValueEntityTypes, ConfigurationSettingSensitivityTypes, ConfigurationAppSettingsListAppSettingsHistoryFilter, ConfigurationAppSettingsListAppSettingsFilter, ConfigurationSettingsListSettingsHistoryFilter, SecurityFunctionalityScope, InternationalizationCultureFilter, InternationalizationOrganizationUnitCountryFilter, InternationalizationOrganizationUnitLanguageFilter, DataModelsCustomFieldDataTypes, UserTypes, DataModelsCustomFieldMetadata, DataModelsCustomFieldOptions, DataModelsCustomFieldValueOperator, CustomFieldsListCustomFieldOptionsFilter, DataModelsCustomFieldValue, CustomFieldsListCustomFieldsFilter, DiscountsIDiscountActionData, DataModelsDiscountAppliesTo, DataModelsDiscountCompliancyRule, DataModelsDiscountConditionTypes, DaysOfWeek, DataModelsDiscountOrderTypes, DataModelsFinancialDespersionType, DataModelsDiscountTriggers, IConditionData, DataModelsDiscountDeactivationReasons, DataModelsOrganizationUnitSetTypes, DiscountsSearchDiscountsByQueryFilter, DiscountsListDiscountCouponsFilter, DataModelsListDiscountCampaignsFilter, DiscountsListDiscountLayerFilter, DataModelsListDiscountTemplatesFilter, CustomFieldsCustomFieldValidationErrorData, DataModelsEntityFieldValidatorUserTypes, DataModelsEntityFieldValidatorEntityTypes, EntityFieldValidatorsValidatorsEntityFieldValidatorBase, DataModelsEntityFieldValidatorType, EntityFieldValidatorsListEntityFieldValidatorsFilter, SearchFilterModel, StockMutationsListProductCostPriceLedgerFilter, StockMutationsListProductCostPriceLedgerItem, StockMutationsListStockMutationUnitCostSourceLedgerFilter, StockMutationsListStockMutationUnitCostSourceLedgerItem, DataModelsCashExpenseAmountTypes, FinanceCashListCashCorrectionReasonsFilter, FinanceCashListCashExpenseTypesFilter, ExchangeRatesListExchangeRatesFilter, GiftCardsConfigurationGiftCardConfigurationUsageTypes, GiftCardsConfigurationProductGiftCardCommunicationOptions, GiftCardsListGiftCardConfigurationsFilter, GiftCardsListProductGiftCardsFilter, DataModelsClientApplicationType, DevicesIDeviceTypeData, NotificationsListClientApplicationsFilter, InquiriesListInquiriesFilter, DataModelsAllowUnsubscribeByType, DataModelsLoyaltyPointUsageOptions, DataModelsLoyaltyProgramOptions, DataModelsResubscribeHandlingType, DataModelsLoyaltyProgramStatus, DataModelsLoyaltyPaymentTaxHandlingType, DataModelsUserBudgetDeduction, LoyaltyRulesIPointAwardingConditionData, DataModelsLoyaltyProgramGroupDeactivationReasons, DataModelsLoyaltyProgramDeactivationReasons, LoyaltyListLoyaltyProgramGroupFilter, LoyaltyListLoyaltyProgramsFilter, LoyaltyListPointAwardingRuleFilter, DataModelsMessageTemplateDestinations, DataModelsPaperProperties, DataModelsMessageTemplateTypes, MessageTemplatesMessageTemplateFilter, MessageTemplatesMessageTargetContentTypes, OrdersCheckoutOptionsICheckoutOptionConfigData, OrdersCheckoutOptionsListCheckoutOptionCategoriesFilter, OrdersCheckoutOptionsListCheckoutOptionsFilter, OrdersReturnsListRefundCorrectionReasonsFilter, OrdersCorrectionsListUnitPriceCorrectionReasonsFilter, DataModelsReturnReasonType, DataModelsOrganizationUnitSetOperatorTypes, DataModelsOrganizationUnitSetDefinition, OrganizationUnitsListOrganizationUnitSetsFilter, OrganizationUnitsListOrganizationUnitSetsItem, OrganizationUnitsDtoOpeningHoursDataDto, FinanceCashListCashHandlersFilter, OrganizationUnitsListOldOpeningHoursFilter, OrganizationUnitsDtoOpeningHoursDto, OrganizationUnitsOrganizationUnitCurrencyFilter, OrganizationUnitsDtoDayOpeningHours, DataModelsPaymentTypeCaptureMoment, DataModelsPaymentCashJournalMethod, DataModelsPaymentTypeCategory, DataModelsPaymentTypeOptions, DataModelsPaymentReturnActions, PaymentsListOrganizationUnitSetPaymentTypesFilter, PaymentsListPaymentMethodsFilter, PaymentsListPaymentTransactionCapturesFilter, DataModelsPaymentTransactionCaptureStatuses, PaymentsListPaymentTransactionsFilter, DataModelsPaymentStatuses, PaymentsListPaymentTypesFilter, PaymentsSettlementsListSettlementFilesFilter, DataModelsPaymentTransactionSettlementFileStatus, PaymentsSettlementsListSettlementsFilter, PersonalizedPromotionsListPersonalizedPromotionsFilter, PricingIPriceListAdjustmentData, DataModelsPriceListAdjustmentSystemType, PricingListPriceListAdjustmentsFilter, PricingListManualInputAdjustmentsFilter, PricingListPriceListOrganizationUnitsFilter, PricingListPriceListsFilter, PricingListPriceListsForOrganizationUnitFilter, PricingListProductPriceLedgerFilter, PricingRoundingData, DataModelsProductRequirementDataTypes, DataModelsOrderTypes, DataModelsProductRequirementOptions, SearchAggregationFilterModel, DataModelsProductSearchTemplateTypes, DataModelsProductStatus, ProductsListProductBarcodesFilter, DataModelsProductBarcodeOrigin, ProductsListProductRequirementsFilter, SearchListProductSearchTemplateResultsFilter, SearchListProductSearchTemplateResultItem, SearchProductSearchTemplateFilters, ProductsListProductUnitOfMeasuresFilter, ProductsListSupplierProductsFilter, UsersListRolesFilter, OrganizationUnitsListUserOrganizationUnitRolesFilter, DataModelsShippingMethodDeliveryTypes, DataModelsShippingRestrictionType, ShippingListCarriersFilter, ShippingListShippingMethodsFilter, ShippingListOrganizationUnitShippingMethodsFilter, ShippingListShippingCostsFilter, ShippingListTransportationTimesFilter, ShippingShippingMethodTransportationTimeItem, ShippingListShippingRestrictionsFilter, DataModelsStockAllocationRuleTypes, DataModelsStockAllocationRuleValueTypes, SuppliersListStockAllocationRulesFilter, StockMutationsListCumulativeStockFilter, SuppliersListStockAllocationRulesItem, StockMutationsListStockMutationReasonsModelFilters, StockMutationsStockMutationFilters, ScrollablePageConfig, StockMutationsSearchStockMutationResult, ScrollablePagedResult, PricingListTaxRateModelFilters, UsersUserRequirementsUserRequirementFor, UsersUserRequirementsUserRequirementProperties, UsersUserRequirementsUserRequirementForSubscriptionResponse, UsersUserRequirementsUserRequirementResponse, UsersSubscriptionsListSubscriptionUsersFilter, DataModelsSubscriptionStatus, DataModelsSubscriptionType, UsersUserRequirementsListUserRequirementSetsFilter, UsersUserRequirementsListUserRequirementsFilter, WishlistsListWishlistsFilter, VisibilityGroupsListVisibilityGroupConfigurationsFilter, VisibilityGroupsListVisibilityGroupsFilter, DataModelsProductTypes, ProductsListAssortmentProductsFilter, FinanceListGeneralLedgersFilter, DataModelsFraudDataType, AddressesListFraudItemsFilter, UserBoughtProductsListUserBoughtProductsFilter, SearchIProductSearchItemPrimaryImage } from '@springtree/eva-services-core';
2
2
  export declare const enum Errors {
3
3
  /**
4
4
  * CashExpenseType {:string} already exists.
@@ -29,6 +29,10 @@ export declare const enum Errors {
29
29
  */
30
30
  Cultures_CurrencyAlreadyExists = "Cultures:CurrencyAlreadyExists",
31
31
  /**
32
+ * Additional currency must differ from main currency.
33
+ */
34
+ Cultures_AdditionalCurrencyMustDifferFromMainCurrency = "Cultures:AdditionalCurrencyMustDifferFromMainCurrency",
35
+ /**
32
36
  * The selected cashhandler is not available for the given currency
33
37
  */
34
38
  Cultures_CashHandlerCurrencyMismatch = "Cultures:CashHandlerCurrencyMismatch",
@@ -328,6 +332,14 @@ export interface CreateAccount {
328
332
  Subsidiary?: string;
329
333
  Type?: DataModelsAccountType;
330
334
  }
335
+ export interface CreateAccountResponse {
336
+ Error?: ServiceError;
337
+ /**
338
+ * Entity type: Account
339
+ */
340
+ ID: string;
341
+ Metadata?: ResponseMessageMetadata;
342
+ }
331
343
  /**
332
344
  * Delete an existing Account
333
345
  */
@@ -675,6 +687,9 @@ export interface GetCaseByIDResponse {
675
687
  ClosingTime?: string;
676
688
  CreatedBy?: CasesGetCaseByIDResponse_User;
677
689
  CreationTime: string;
690
+ /**
691
+ * Entity type: CustomField
692
+ */
678
693
  CustomFieldValuesWithOptions?: Record<string, DataModelsCustomFieldValueWithOptions>;
679
694
  Customer?: CasesGetCaseByIDResponse_CustomerInfo;
680
695
  /**
@@ -747,7 +762,7 @@ export interface CasesGetCaseByIDResponse_CaseRepairTask {
747
762
  * Entity type: RepairTask
748
763
  */
749
764
  ID: string;
750
- UserTaskSubType?: APIEnumDto;
765
+ UserTaskSubType?: EVAFrameworkAPIEnumDto;
751
766
  }
752
767
  export interface CasesGetCaseByIDResponse_CaseTopicData {
753
768
  CaseTopic?: CasesGetCaseByIDResponse_CaseTopicData;
@@ -1453,6 +1468,14 @@ export interface CreateCompany {
1453
1468
  VisitorsAddress?: AddressesAddressDataDto;
1454
1469
  WasteDisposalNumber?: string;
1455
1470
  }
1471
+ export interface CreateCompanyResponse {
1472
+ Error?: ServiceError;
1473
+ /**
1474
+ * Entity type: Company
1475
+ */
1476
+ ID: string;
1477
+ Metadata?: ResponseMessageMetadata;
1478
+ }
1456
1479
  /**
1457
1480
  * Deletes a Company. If a Company is still in use by Users or OrganizationUnits this service will return an error.
1458
1481
  */
@@ -1917,6 +1940,9 @@ export interface ListSettingsPerOrganizationUnit {
1917
1940
  export interface ListSettingsPerOrganizationUnitResponse {
1918
1941
  Error?: ServiceError;
1919
1942
  Metadata?: ResponseMessageMetadata;
1943
+ /**
1944
+ * Entity type: OrganizationUnit
1945
+ */
1920
1946
  Result?: Record<string, Record<string, ConfigurationSettingDto> | null>;
1921
1947
  }
1922
1948
  export interface ListSettingsResponse {
@@ -2398,7 +2424,7 @@ export interface GetCustomFieldMetadataResponse {
2398
2424
  export interface GetCustomFieldTypes {
2399
2425
  }
2400
2426
  export interface GetCustomFieldTypesResponse {
2401
- CustomFieldTypes?: APIEnumDto[];
2427
+ CustomFieldTypes?: EVAFrameworkAPIEnumDto[];
2402
2428
  Error?: ServiceError;
2403
2429
  Metadata?: ResponseMessageMetadata;
2404
2430
  }
@@ -2416,6 +2442,9 @@ export interface GetCustomFields {
2416
2442
  TypeID: string;
2417
2443
  }
2418
2444
  export interface GetCustomFieldsResponse {
2445
+ /**
2446
+ * Entity type: CustomField
2447
+ */
2419
2448
  CustomFieldOptions?: Record<string, DataModelsCustomFieldOptions>;
2420
2449
  Error?: ServiceError;
2421
2450
  Metadata?: ResponseMessageMetadata;
@@ -2688,6 +2717,7 @@ export interface CreateDiscount {
2688
2717
  OrganizationUnitSetID: string;
2689
2718
  PromotionLabel?: string;
2690
2719
  /**
2720
+ * Entity type: CustomField
2691
2721
  * For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
2692
2722
  */
2693
2723
  RequiredCustomFields?: string[];
@@ -2724,6 +2754,14 @@ export interface CreateDiscountCampaign {
2724
2754
  Name: string;
2725
2755
  StartDate?: string;
2726
2756
  }
2757
+ export interface CreateDiscountCampaignResponse {
2758
+ Error?: ServiceError;
2759
+ /**
2760
+ * Entity type: DiscountCampaign
2761
+ */
2762
+ ID: string;
2763
+ Metadata?: ResponseMessageMetadata;
2764
+ }
2727
2765
  /**
2728
2766
  * Create a DiscountCoupon
2729
2767
  */
@@ -2866,6 +2904,14 @@ export interface DiscountsCreateDiscountTemplate_Condition {
2866
2904
  Data: IConditionData;
2867
2905
  Type: 'V2:COUPONORIGINATINGORDERORGANIZATIONUNIT' | 'V2:COUPONVALIDITY' | 'V2:CUSTOMERAGE' | 'V2:CUSTOMER' | 'V2:LOYALTYPOINTS' | 'V2:MAXIMUMUSEPERUSER' | 'V2:USERFIELD' | 'V2:ORDERAMOUNT' | 'V2:ORDERCUSTOMFIELD' | 'V2:ORDERLINECUSTOMFIELD' | 'V2:ORDERPROPERTIES' | 'V2:ORDERTYPE' | 'V2:OBS:ORGANIZATIONUNIT' | 'V2:OBS:ORGANIZATIONUNITTYPE' | 'V2:PRODUCT' | 'V2:PRODUCTREQUIREMENT' | 'V2:STOCKLABEL' | 'V2:USERCUSTOMFIELD' | 'V2:USERROLE' | 'V2:USERTYPE' | 'DEFAULT' | 'RITUALSLOYALTY' | 'V2:RITUALSLOYALTY' | 'RITUALSWELCOMEGIFT' | 'V2:RITUALSWELCOMEGIFT' | 'RITUALSEMPLOYEE' | 'V2:RITUALSEMPLOYEE';
2868
2906
  }
2907
+ export interface CreateDiscountTemplateResponse {
2908
+ Error?: ServiceError;
2909
+ /**
2910
+ * Entity type: DiscountTemplate
2911
+ */
2912
+ ID: string;
2913
+ Metadata?: ResponseMessageMetadata;
2914
+ }
2869
2915
  /**
2870
2916
  * Delete a DiscountCampaign
2871
2917
  */
@@ -3011,6 +3057,9 @@ export interface GetCouponByTokenResponse {
3011
3057
  DiscountID: string;
3012
3058
  DiscountMarketingDescription?: string;
3013
3059
  Error?: ServiceError;
3060
+ /**
3061
+ * Entity type: OrderLine
3062
+ */
3014
3063
  FromCancelledLines?: Record<string, number>;
3015
3064
  Metadata?: ResponseMessageMetadata;
3016
3065
  /**
@@ -3053,6 +3102,9 @@ export interface GetDiscountByIDResponse {
3053
3102
  * Entity type: Currency
3054
3103
  */
3055
3104
  CurrencyID?: string;
3105
+ /**
3106
+ * Entity type: CustomField
3107
+ */
3056
3108
  CustomFieldValuesWithOptions?: Record<string, DataModelsCustomFieldValueWithOptions>;
3057
3109
  /**
3058
3110
  * Entity type: CustomField
@@ -3106,6 +3158,9 @@ export interface GetDiscountByIDResponse {
3106
3158
  OrganizationUnitSetName?: string;
3107
3159
  OrganizationUnitSetType?: DataModelsOrganizationUnitSetTypes;
3108
3160
  PromotionLabel?: string;
3161
+ /**
3162
+ * Entity type: CustomField
3163
+ */
3109
3164
  RequiredCustomFields?: string[];
3110
3165
  /**
3111
3166
  * Entity type: OrganizationUnit
@@ -3124,6 +3179,9 @@ export interface GetDiscountByIDResponse {
3124
3179
  }
3125
3180
  export interface DiscountsGetDiscountByIDResponse_DiscountCondition {
3126
3181
  Data?: IConditionData;
3182
+ /**
3183
+ * Entity type: DiscountCondition
3184
+ */
3127
3185
  ID: string;
3128
3186
  Type?: 'V2:COUPONORIGINATINGORDERORGANIZATIONUNIT' | 'V2:COUPONVALIDITY' | 'V2:CUSTOMERAGE' | 'V2:CUSTOMER' | 'V2:LOYALTYPOINTS' | 'V2:MAXIMUMUSEPERUSER' | 'V2:USERFIELD' | 'V2:ORDERAMOUNT' | 'V2:ORDERCUSTOMFIELD' | 'V2:ORDERLINECUSTOMFIELD' | 'V2:ORDERPROPERTIES' | 'V2:ORDERTYPE' | 'V2:OBS:ORGANIZATIONUNIT' | 'V2:OBS:ORGANIZATIONUNITTYPE' | 'V2:PRODUCT' | 'V2:PRODUCTREQUIREMENT' | 'V2:STOCKLABEL' | 'V2:USERCUSTOMFIELD' | 'V2:USERROLE' | 'V2:USERTYPE' | 'DEFAULT' | 'RITUALSLOYALTY' | 'V2:RITUALSLOYALTY' | 'RITUALSWELCOMEGIFT' | 'V2:RITUALSWELCOMEGIFT' | 'RITUALSEMPLOYEE' | 'V2:RITUALSEMPLOYEE';
3129
3187
  UseAsActionCondition: boolean;
@@ -3503,6 +3561,9 @@ export interface ListDiscountLayersResponse {
3503
3561
  }
3504
3562
  export interface DiscountsListDiscountLayersResponse_DiscountLayerDto {
3505
3563
  Description?: string;
3564
+ /**
3565
+ * Entity type: DiscountLayer
3566
+ */
3506
3567
  ID: string;
3507
3568
  IsExclusive: boolean;
3508
3569
  /**
@@ -3805,6 +3866,7 @@ export interface UpdateDiscount {
3805
3866
  OrganizationUnitSetID: string;
3806
3867
  PromotionLabel?: string;
3807
3868
  /**
3869
+ * Entity type: CustomField
3808
3870
  * For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
3809
3871
  */
3810
3872
  RequiredCustomFields?: string[] | null;
@@ -3812,6 +3874,9 @@ export interface UpdateDiscount {
3812
3874
  * Entity type: OrganizationUnit
3813
3875
  */
3814
3876
  RestitutionOrganizationUnitID?: string;
3877
+ /**
3878
+ * Entity type: Role
3879
+ */
3815
3880
  RoleIDs?: string[];
3816
3881
  StartDate?: string;
3817
3882
  Trigger?: DataModelsDiscountTriggers;
@@ -4038,6 +4103,7 @@ export interface ValidateDiscount {
4038
4103
  */
4039
4104
  OrganizationUnitSetID: string;
4040
4105
  /**
4106
+ * Entity type: CustomField
4041
4107
  * For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
4042
4108
  */
4043
4109
  RequiredCustomFields?: string[];
@@ -4055,6 +4121,9 @@ export interface DiscountsValidateDiscount_DiscountConditionDto {
4055
4121
  }
4056
4122
  export interface ValidateDiscountResponse {
4057
4123
  ActionMessages?: string[];
4124
+ /**
4125
+ * Entity type: DiscountCondition
4126
+ */
4058
4127
  ConditionMessages?: Record<string, string[] | null>;
4059
4128
  CustomFieldMessages?: DiscountsValidateDiscountResponse_CustomFieldMessage;
4060
4129
  Error?: ServiceError;
@@ -4141,6 +4210,9 @@ export interface CreateEntityFieldValidator {
4141
4210
  }
4142
4211
  export interface CreateEntityFieldValidatorResponse {
4143
4212
  Error?: ServiceError;
4213
+ /**
4214
+ * Entity type: EntityFieldValidator
4215
+ */
4144
4216
  ID: string;
4145
4217
  Metadata?: ResponseMessageMetadata;
4146
4218
  }
@@ -4205,6 +4277,9 @@ export interface EntityFieldValidatorsListEntityFieldValidatorsResponse_ListEnti
4205
4277
  ApplyFor: DataModelsEntityFieldValidatorUserTypes;
4206
4278
  Entity: DataModelsEntityFieldValidatorEntityTypes;
4207
4279
  EntityFieldName?: string;
4280
+ /**
4281
+ * Entity type: EntityFieldValidator
4282
+ */
4208
4283
  ID: string;
4209
4284
  ValidatorData?: EntityFieldValidatorsValidatorsEntityFieldValidatorBase;
4210
4285
  ValidatorType: DataModelsEntityFieldValidatorType;
@@ -4716,6 +4791,14 @@ export interface CreateDevice {
4716
4791
  StationID?: string;
4717
4792
  TypeID: string;
4718
4793
  }
4794
+ export interface CreateDeviceResponse {
4795
+ Error?: ServiceError;
4796
+ /**
4797
+ * Entity type: Device
4798
+ */
4799
+ ID: string;
4800
+ Metadata?: ResponseMessageMetadata;
4801
+ }
4719
4802
  /**
4720
4803
  * Creates a new OpenCashDrawerReason. Name and Description can both be localized through the LocalizeOpenCashDrawerReason service later.
4721
4804
  */
@@ -4754,6 +4837,14 @@ export interface CreateStation {
4754
4837
  */
4755
4838
  OrganizationUnitID: string;
4756
4839
  }
4840
+ export interface CreateStationResponse {
4841
+ Error?: ServiceError;
4842
+ /**
4843
+ * Entity type: Station
4844
+ */
4845
+ ID: string;
4846
+ Metadata?: ResponseMessageMetadata;
4847
+ }
4757
4848
  /**
4758
4849
  * Delete a ClientApplication
4759
4850
  */
@@ -5011,6 +5102,9 @@ export interface CreateInquiry {
5011
5102
  Name: string;
5012
5103
  OneTimeUseOnly?: boolean;
5013
5104
  PromptUser?: boolean;
5105
+ /**
5106
+ * Entity type: Script
5107
+ */
5014
5108
  ScriptID?: string;
5015
5109
  }
5016
5110
  export interface InquiriesCreateInquiry_ItemData {
@@ -5197,10 +5291,6 @@ export interface CreateLoyaltyProgram {
5197
5291
  * Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
5198
5292
  */
5199
5293
  AllowUnsubscribeBy?: DataModelsAllowUnsubscribeByType;
5200
- /**
5201
- * When true, the loyalty program will not automatically be applied to the order when a customer is attached and all conditions are met.
5202
- * When false, the loyalty program will automatically be applied if all conditions are met.
5203
- */
5204
5294
  ApplyManuallyOnly?: boolean;
5205
5295
  /**
5206
5296
  * When true, if a non anonymous customer is attached to the order they will be automatically subscribed on finishing the order.
@@ -5219,6 +5309,9 @@ export interface CreateLoyaltyProgram {
5219
5309
  EndDate?: string;
5220
5310
  Handler: string;
5221
5311
  LoyaltyPointUsageOptions?: DataModelsLoyaltyPointUsageOptions;
5312
+ /**
5313
+ * Entity type: LoyaltyProgramGroup
5314
+ */
5222
5315
  LoyaltyProgramGroupID?: string;
5223
5316
  Name: string;
5224
5317
  Options?: DataModelsLoyaltyProgramOptions;
@@ -5331,6 +5424,7 @@ export interface CreateLoyaltyProgramGroupResponse {
5331
5424
  * Create a new LoyaltyProgramPaymentType
5332
5425
  */
5333
5426
  export interface CreateLoyaltyProgramPaymentType {
5427
+ AllowPartialPayment?: boolean;
5334
5428
  BackendID?: string;
5335
5429
  Budget?: number;
5336
5430
  ExcludeFromProgramBudget?: boolean;
@@ -5624,6 +5718,7 @@ export interface GetLoyaltyProgramPaymentType {
5624
5718
  ID: string;
5625
5719
  }
5626
5720
  export interface GetLoyaltyProgramPaymentTypeResponse {
5721
+ AllowPartialPayment: boolean;
5627
5722
  BackendID?: string;
5628
5723
  Budget?: number;
5629
5724
  BudgetRemaining?: number;
@@ -5683,8 +5778,7 @@ export interface GetLoyaltyProgramProductLimitationResponse {
5683
5778
  export interface GetLoyaltyProgramResponse {
5684
5779
  AllowUnsubscribeBy?: DataModelsAllowUnsubscribeByType;
5685
5780
  /**
5686
- * When true, the loyalty program will not automatically be applied to the order when a customer is attached and all conditions are met.
5687
- * When false, the loyalty program will automatically be applied if all conditions are met.
5781
+ * This property has been deprecated. A loyaltyprogram should always be manually applied.
5688
5782
  */
5689
5783
  ApplyManuallyOnly: boolean;
5690
5784
  /**
@@ -5936,6 +6030,7 @@ export interface ListLoyaltyProgramPaymentTypesResponse {
5936
6030
  Results?: LoyaltyListLoyaltyProgramPaymentTypesResponse_Item[];
5937
6031
  }
5938
6032
  export interface LoyaltyListLoyaltyProgramPaymentTypesResponse_Item {
6033
+ AllowPartialPayment: boolean;
5939
6034
  BackendID?: string;
5940
6035
  Budget?: number;
5941
6036
  ExcludeFromProgramBudget: boolean;
@@ -6153,10 +6248,6 @@ export interface LoyaltyPushLoyaltyProgram {
6153
6248
  * Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
6154
6249
  */
6155
6250
  AllowUnsubscribeBy?: DataModelsAllowUnsubscribeByType;
6156
- /**
6157
- * When true, the loyalty program will not automatically be applied to the order when a customer is attached and all conditions are met.
6158
- * When false, the loyalty program will automatically be applied if all conditions are met.
6159
- */
6160
6251
  ApplyManuallyOnly?: boolean;
6161
6252
  /**
6162
6253
  * When true, if a non anonymous customer is attached to the order they will be automatically subscribed on finishing the order.
@@ -6271,6 +6362,7 @@ export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramOrganizationUnitSet
6271
6362
  OrganizationUnitSetID?: string;
6272
6363
  }
6273
6364
  export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType {
6365
+ AllowPartialPayment?: boolean;
6274
6366
  Budget?: number;
6275
6367
  ExcludeFromProgramBudget?: boolean;
6276
6368
  /**
@@ -6411,10 +6503,6 @@ export interface PushLoyaltyProgram_Async {
6411
6503
  * Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
6412
6504
  */
6413
6505
  AllowUnsubscribeBy?: DataModelsAllowUnsubscribeByType;
6414
- /**
6415
- * When true, the loyalty program will not automatically be applied to the order when a customer is attached and all conditions are met.
6416
- * When false, the loyalty program will automatically be applied if all conditions are met.
6417
- */
6418
6506
  ApplyManuallyOnly?: boolean;
6419
6507
  /**
6420
6508
  * When true, if a non anonymous customer is attached to the order they will be automatically subscribed on finishing the order.
@@ -6600,8 +6688,7 @@ export interface UpdateLoyaltyProgram {
6600
6688
  */
6601
6689
  AllowUnsubscribeBy?: DataModelsAllowUnsubscribeByType;
6602
6690
  /**
6603
- * When true, the loyalty program will not automatically be applied to the order when a customer is attached and all conditions are met.
6604
- * When false, the loyalty program will automatically be applied if all conditions are met.
6691
+ * This property has been deprecated. A loyaltyprogram should always be manually applied.
6605
6692
  */
6606
6693
  ApplyManuallyOnly?: boolean;
6607
6694
  /**
@@ -6757,6 +6844,7 @@ export interface UpdateLoyaltyProgramGroupBudget {
6757
6844
  * Update an existing LoyaltyProgramPaymentType
6758
6845
  */
6759
6846
  export interface UpdateLoyaltyProgramPaymentType {
6847
+ AllowPartialPayment?: boolean;
6760
6848
  BackendID?: string;
6761
6849
  Budget?: number;
6762
6850
  ExcludeFromProgramBudget?: boolean;
@@ -7230,6 +7318,9 @@ export interface CreateOrderLedgerType {
7230
7318
  export interface CreateOrderLedgerTypeResponse {
7231
7319
  Description?: string;
7232
7320
  Error?: ServiceError;
7321
+ /**
7322
+ * Entity type: OrderLedgerType
7323
+ */
7233
7324
  ID: string;
7234
7325
  Metadata?: ResponseMessageMetadata;
7235
7326
  Name?: string;
@@ -7298,6 +7389,9 @@ export interface DeleteCheckoutOptionCategory {
7298
7389
  * Delete existing "OrderLedgerType"
7299
7390
  */
7300
7391
  export interface DeleteOrderLedgerType {
7392
+ /**
7393
+ * Entity type: OrderLedgerType
7394
+ */
7301
7395
  ID: string;
7302
7396
  }
7303
7397
  /**
@@ -7390,6 +7484,9 @@ export interface ListOrderLedgerTypesResponse {
7390
7484
  }
7391
7485
  export interface OrdersListOrderLedgerTypesResponse_ResponseModel {
7392
7486
  Description?: string;
7487
+ /**
7488
+ * Entity type: OrderLedgerType
7489
+ */
7393
7490
  ID: string;
7394
7491
  Name?: string;
7395
7492
  }
@@ -7624,12 +7721,18 @@ export interface UpdateCheckoutOptionSequences {
7624
7721
  */
7625
7722
  export interface UpdateOrderLedgerType {
7626
7723
  Description?: string;
7724
+ /**
7725
+ * Entity type: OrderLedgerType
7726
+ */
7627
7727
  ID: string;
7628
7728
  Name: string;
7629
7729
  }
7630
7730
  export interface UpdateOrderLedgerTypeResponse {
7631
7731
  Description?: string;
7632
7732
  Error?: ServiceError;
7733
+ /**
7734
+ * Entity type: OrderLedgerType
7735
+ */
7633
7736
  ID: string;
7634
7737
  Metadata?: ResponseMessageMetadata;
7635
7738
  Name?: string;
@@ -7724,6 +7827,14 @@ export interface OrganizationUnitSetsCreateOrganizationUnitSet_OrganizationUnitS
7724
7827
  ID: string;
7725
7828
  OperatorType?: DataModelsOrganizationUnitSetOperatorTypes;
7726
7829
  }
7830
+ export interface CreateOrganizationUnitSetResponse {
7831
+ Error?: ServiceError;
7832
+ /**
7833
+ * Entity type: OrganizationUnitSet
7834
+ */
7835
+ ID: string;
7836
+ Metadata?: ResponseMessageMetadata;
7837
+ }
7727
7838
  /**
7728
7839
  * Creates a new OrganizationUnitSetScope.
7729
7840
  *
@@ -7736,6 +7847,9 @@ export interface CreateOrganizationUnitSetScope {
7736
7847
  }
7737
7848
  export interface CreateOrganizationUnitSetScopeResponse {
7738
7849
  Error?: ServiceError;
7850
+ /**
7851
+ * Entity type: OrganizationUnitSetScope
7852
+ */
7739
7853
  ID: string;
7740
7854
  Metadata?: ResponseMessageMetadata;
7741
7855
  }
@@ -7756,6 +7870,9 @@ export interface DeleteOrganizationUnitSet {
7756
7870
  * It's not possible to delete a scope that is still in use by an OrganizationUnitSet.
7757
7871
  */
7758
7872
  export interface DeleteOrganizationUnitSetScope {
7873
+ /**
7874
+ * Entity type: OrganizationUnitSetScope
7875
+ */
7759
7876
  ID: string;
7760
7877
  }
7761
7878
  /**
@@ -7821,7 +7938,7 @@ export interface GetOrganizationUnitSetResponse {
7821
7938
  * Entity type: OrganizationUnit
7822
7939
  */
7823
7940
  OrganizationUnitID?: string;
7824
- Scope?: APIEnumDto;
7941
+ Scope?: EVAFrameworkAPIEnumDto;
7825
7942
  Type: DataModelsOrganizationUnitSetTypes;
7826
7943
  }
7827
7944
  /**
@@ -7836,6 +7953,9 @@ export interface GetOrganizationUnitSetScopesResponse {
7836
7953
  }
7837
7954
  export interface OrganizationUnitSetsGetOrganizationUnitSetScopesResponse_OrganizationUnitSetScope {
7838
7955
  Description?: string;
7956
+ /**
7957
+ * Entity type: OrganizationUnitSetScope
7958
+ */
7839
7959
  ID: string;
7840
7960
  Name?: string;
7841
7961
  OrganizationUnitUniqueInScope: boolean;
@@ -7869,7 +7989,7 @@ export interface OrganizationUnitSetsOrganizationUnitSetDetails {
7869
7989
  * Entity type: OrganizationUnit
7870
7990
  */
7871
7991
  OrganizationUnitID?: string;
7872
- Scope?: APIEnumDto;
7992
+ Scope?: EVAFrameworkAPIEnumDto;
7873
7993
  Subsets?: OrganizationUnitSetsOrganizationUnitSetDetails[];
7874
7994
  Type: DataModelsOrganizationUnitSetTypes;
7875
7995
  }
@@ -8088,6 +8208,9 @@ export interface GetOpeningHoursTypesResponse {
8088
8208
  export interface OrganizationUnitsGetOpeningHoursTypesResponse_OpeningHoursTypeDto {
8089
8209
  BackendID?: string;
8090
8210
  Description?: string;
8211
+ /**
8212
+ * Entity type: Enum
8213
+ */
8091
8214
  ID: string;
8092
8215
  /**
8093
8216
  * Usually an internal & unchangable code - for display, use `Description`
@@ -8466,6 +8589,9 @@ export interface GetPaymentMethodsResponse {
8466
8589
  }
8467
8590
  export interface PaymentMethodsGetPaymentMethodsResponse_PaymentMethodDto {
8468
8591
  Code?: string;
8592
+ /**
8593
+ * Entity type: PaymentMethod
8594
+ */
8469
8595
  ID: string;
8470
8596
  Name?: string;
8471
8597
  }
@@ -8540,6 +8666,7 @@ export interface PaymentMethodsGetPaymentTypeCustomFieldsResponse_CustomFieldDto
8540
8666
  BackendID?: string;
8541
8667
  DataType: DataModelsCustomFieldDataTypes;
8542
8668
  DisplayName?: string;
8669
+ EnumValues?: Record<string, string | null>;
8543
8670
  /**
8544
8671
  * Entity type: CustomField
8545
8672
  */
@@ -8761,7 +8888,7 @@ export interface PaymentMethodsListPaymentTransactionsSettlementsResponse_Result
8761
8888
  MerchantReference?: string;
8762
8889
  PaymentReference?: string;
8763
8890
  Subtype?: string;
8764
- Type?: APIEnumDto;
8891
+ Type?: EVAFrameworkAPIEnumDto;
8765
8892
  }
8766
8893
  /**
8767
8894
  * List PaymentTypes. Returns a paged response.
@@ -9353,6 +9480,9 @@ export interface CreatePriceListOrganizationUnit {
9353
9480
  }
9354
9481
  export interface CreatePriceListOrganizationUnitResponse {
9355
9482
  Error?: ServiceError;
9483
+ /**
9484
+ * Entity type: PriceListOrganizationUnit
9485
+ */
9356
9486
  ID: string;
9357
9487
  Metadata?: ResponseMessageMetadata;
9358
9488
  }
@@ -9682,11 +9812,23 @@ export interface ListPriceListOrganizationUnitsResponse {
9682
9812
  Result?: PagedResult<PricingListPriceListOrganizationUnitsResponse_PriceListOrganizationUnitDto>;
9683
9813
  }
9684
9814
  export interface PricingListPriceListOrganizationUnitsResponse_PriceListOrganizationUnitDto {
9815
+ /**
9816
+ * Entity type: PriceListOrganizationUnit
9817
+ */
9685
9818
  ID: string;
9819
+ /**
9820
+ * Entity type: OrganizationUnit
9821
+ */
9686
9822
  OrganizationUnitID: string;
9687
9823
  OrganizationUnitName?: string;
9688
9824
  PriceList?: PricingListPriceListOrganizationUnitsResponse_PriceListOrganizationUnitDto_PriceListDto;
9825
+ /**
9826
+ * Entity type: PriceList
9827
+ */
9689
9828
  PriceListID: string;
9829
+ /**
9830
+ * Entity type: PriceListUsageType
9831
+ */
9690
9832
  PriceListUsageTypeID: string;
9691
9833
  PriceListUsageTypeName?: string;
9692
9834
  PricingGroupID?: string;
@@ -10014,6 +10156,33 @@ export interface UpdatePrinterType {
10014
10156
  PaperWidth?: number;
10015
10157
  }
10016
10158
  /**
10159
+ * Returns the product count within the persisted product search template
10160
+ * When product id is given, it wil checks if a product is part of the persisted product search template result.
10161
+ * NOTE THAT after product search template creation/update if can take a few minutes for the result to be updated.
10162
+ */
10163
+ export interface CheckProductSearchTemplate {
10164
+ /**
10165
+ * Entity type: Product
10166
+ */
10167
+ ProductID?: string;
10168
+ /**
10169
+ * Entity type: ProductSearchTemplate
10170
+ */
10171
+ ProductSearchTemplateID: string;
10172
+ }
10173
+ export interface CheckProductSearchTemplateResponse {
10174
+ Error?: ServiceError;
10175
+ /**
10176
+ * Will return true/false is the given product is present. If no product is given it will return null
10177
+ */
10178
+ IsPresent?: boolean;
10179
+ Metadata?: ResponseMessageMetadata;
10180
+ /**
10181
+ * Total count of products withing the product search template result.
10182
+ */
10183
+ ResultCount: number;
10184
+ }
10185
+ /**
10017
10186
  * Creates a barcode for a product for a specific unit of measure.
10018
10187
  *
10019
10188
  * Optionally adds a record in the ProductUnitOfMeasure conversion table for the supplied Quantity.
@@ -10026,6 +10195,9 @@ export interface CreateProductBarcode {
10026
10195
  */
10027
10196
  ProductID: string;
10028
10197
  Quantity?: number;
10198
+ /**
10199
+ * Entity type: UnitOfMeasure
10200
+ */
10029
10201
  UnitOfMeasureID: string;
10030
10202
  }
10031
10203
  /**
@@ -10065,6 +10237,9 @@ export interface CreateProductSearchTemplate {
10065
10237
  }
10066
10238
  export interface CreateProductSearchTemplateResponse {
10067
10239
  Error?: ServiceError;
10240
+ /**
10241
+ * Entity type: ProductSearchTemplate
10242
+ */
10068
10243
  ID: string;
10069
10244
  Metadata?: ResponseMessageMetadata;
10070
10245
  }
@@ -10108,6 +10283,9 @@ export interface CreateSupplierProduct {
10108
10283
  }
10109
10284
  export interface CreateSupplierProductResponse {
10110
10285
  Error?: ServiceError;
10286
+ /**
10287
+ * Entity type: Product
10288
+ */
10111
10289
  ID: string;
10112
10290
  Metadata?: ResponseMessageMetadata;
10113
10291
  }
@@ -10121,6 +10299,9 @@ export interface CreateUnitOfMeasure {
10121
10299
  }
10122
10300
  export interface CreateUnitOfMeasureResponse {
10123
10301
  Error?: ServiceError;
10302
+ /**
10303
+ * Entity type: UnitOfMeasure
10304
+ */
10124
10305
  ID: string;
10125
10306
  Metadata?: ResponseMessageMetadata;
10126
10307
  }
@@ -10342,7 +10523,7 @@ export interface GetSupplierProductByIDResponse {
10342
10523
  QuantityOnHand: number;
10343
10524
  RecommendedRecommendedRetailPrice?: number;
10344
10525
  Status: DataModelsProductStatus;
10345
- TaxCode?: APIEnumDto;
10526
+ TaxCode?: EVAFrameworkAPIEnumDto;
10346
10527
  }
10347
10528
  /**
10348
10529
  * Retrieves the suppliers (Organization Units) for the given Product.
@@ -10366,6 +10547,9 @@ export interface GetUnitOfMeasuresResponse {
10366
10547
  export interface ProductsGetUnitOfMeasuresResponse_UnitOfMeasureDto {
10367
10548
  BackendID?: string;
10368
10549
  Description?: string;
10550
+ /**
10551
+ * Entity type: Enum
10552
+ */
10369
10553
  ID: string;
10370
10554
  /**
10371
10555
  * Usually an internal & unchangable code - for display, use `Description`
@@ -10394,7 +10578,7 @@ export interface ProductsListProductBarcodesResponse_ProductBarcodeDto {
10394
10578
  ProductDisplayValue?: string;
10395
10579
  ProductID: string;
10396
10580
  Quantity: number;
10397
- UnitOfMeasure?: APIEnumDto;
10581
+ UnitOfMeasure?: EVAFrameworkAPIEnumDto;
10398
10582
  }
10399
10583
  /**
10400
10584
  * List existing Product Requirements
@@ -10469,7 +10653,7 @@ export interface ProductsListProductUnitOfMeasuresResponse_ProductUnitOfMeasureD
10469
10653
  ProductID: string;
10470
10654
  ProductName?: string;
10471
10655
  Quantity: number;
10472
- UnitOfMeasure?: APIEnumDto;
10656
+ UnitOfMeasure?: EVAFrameworkAPIEnumDto;
10473
10657
  UnitOfMeasureID: string;
10474
10658
  }
10475
10659
  /**
@@ -10497,7 +10681,7 @@ export interface ProductsListSupplierProductsResponse_SupplierProductDto {
10497
10681
  QuantityOnHand: number;
10498
10682
  RecommendedRecommendedRetailPrice?: number;
10499
10683
  Status: DataModelsProductStatus;
10500
- TaxCode?: APIEnumDto;
10684
+ TaxCode?: EVAFrameworkAPIEnumDto;
10501
10685
  }
10502
10686
  export interface ProductsProductRequirementDto {
10503
10687
  BackendID?: string;
@@ -10719,6 +10903,9 @@ export interface CreateRoleSet {
10719
10903
  }
10720
10904
  export interface CreateRoleSetResponse {
10721
10905
  Error?: ServiceError;
10906
+ /**
10907
+ * Entity type: RoleSet
10908
+ */
10722
10909
  ID: string;
10723
10910
  Metadata?: ResponseMessageMetadata;
10724
10911
  }
@@ -10749,8 +10936,8 @@ export interface DetachFunctionalitiesFromRole {
10749
10936
  }
10750
10937
  export interface RightsFunctionalityWithScope {
10751
10938
  Functionality: string;
10752
- RequiresElevation: boolean;
10753
- Scope: SecurityFunctionalityScope;
10939
+ RequiresElevation?: boolean;
10940
+ Scope?: SecurityFunctionalityScope;
10754
10941
  }
10755
10942
  export interface GetAvailableRoles {
10756
10943
  UserID: string;
@@ -10808,11 +10995,17 @@ export interface GetRoleResponse {
10808
10995
  Result?: RightsRoleWithFunctionalitiesDto;
10809
10996
  }
10810
10997
  export interface GetRoleSetByID {
10998
+ /**
10999
+ * Entity type: RoleSet
11000
+ */
10811
11001
  ID: string;
10812
11002
  }
10813
11003
  export interface GetRoleSetByIDResponse {
10814
11004
  BackendID?: string;
10815
11005
  Error?: ServiceError;
11006
+ /**
11007
+ * Entity type: RoleSet
11008
+ */
10816
11009
  ID: string;
10817
11010
  Metadata?: ResponseMessageMetadata;
10818
11011
  Name?: string;
@@ -10924,6 +11117,9 @@ export interface ListRoleSetsResponse {
10924
11117
  }
10925
11118
  export interface RightsListRoleSetsResponse_RoleSetDto {
10926
11119
  BackendID?: string;
11120
+ /**
11121
+ * Entity type: RoleSet
11122
+ */
10927
11123
  ID: string;
10928
11124
  Name?: string;
10929
11125
  }
@@ -11153,6 +11349,9 @@ export interface AddPackageToCarrier {
11153
11349
  export interface ShippingCarrierDto {
11154
11350
  BackendID?: string;
11155
11351
  Code?: string;
11352
+ /**
11353
+ * Entity type: Carrier
11354
+ */
11156
11355
  ID: string;
11157
11356
  Name?: string;
11158
11357
  }
@@ -11166,6 +11365,9 @@ export interface CreateCarrier {
11166
11365
  }
11167
11366
  export interface CreateCarrierResponse {
11168
11367
  Error?: ServiceError;
11368
+ /**
11369
+ * Entity type: Carrier
11370
+ */
11169
11371
  ID: string;
11170
11372
  Metadata?: ResponseMessageMetadata;
11171
11373
  }
@@ -11218,6 +11420,9 @@ export interface CreatePackage {
11218
11420
  }
11219
11421
  export interface CreatePackageResponse {
11220
11422
  Error?: ServiceError;
11423
+ /**
11424
+ * Entity type: Package
11425
+ */
11221
11426
  ID: string;
11222
11427
  Metadata?: ResponseMessageMetadata;
11223
11428
  }
@@ -11274,6 +11479,14 @@ export interface CreateShippingMethod {
11274
11479
  ShippingHandledByCarrier?: boolean;
11275
11480
  SupportsPickupAddress?: boolean;
11276
11481
  }
11482
+ export interface CreateShippingMethodResponse {
11483
+ Error?: ServiceError;
11484
+ /**
11485
+ * Entity type: ShippingMethod
11486
+ */
11487
+ ID: string;
11488
+ Metadata?: ResponseMessageMetadata;
11489
+ }
11277
11490
  /**
11278
11491
  * Creates a new ShippingMethodTransportationTime.
11279
11492
  */
@@ -11292,6 +11505,14 @@ export interface CreateShippingMethodTransportationTime {
11292
11505
  */
11293
11506
  ToCountryID?: string;
11294
11507
  }
11508
+ export interface CreateShippingMethodTransportationTimeResponse {
11509
+ Error?: ServiceError;
11510
+ /**
11511
+ * Entity type: ShippingMethodTransportationTime
11512
+ */
11513
+ ID: string;
11514
+ Metadata?: ResponseMessageMetadata;
11515
+ }
11295
11516
  /**
11296
11517
  * Creates a new ShippingRestriction.
11297
11518
  */
@@ -11320,6 +11541,9 @@ export interface CreateShippingRestriction {
11320
11541
  */
11321
11542
  ProductPropertyTypeID?: string;
11322
11543
  ProductPropertyTypeValues?: string[];
11544
+ /**
11545
+ * Entity type: ProductSearchTemplate
11546
+ */
11323
11547
  ProductSearchTemplateID?: string;
11324
11548
  /**
11325
11549
  * Entity type: Script
@@ -11331,6 +11555,9 @@ export interface CreateShippingRestriction {
11331
11555
  }
11332
11556
  export interface CreateShippingRestrictionResponse {
11333
11557
  Error?: ServiceError;
11558
+ /**
11559
+ * Entity type: ShippingRestriction
11560
+ */
11334
11561
  ID: string;
11335
11562
  Metadata?: ResponseMessageMetadata;
11336
11563
  }
@@ -11501,6 +11728,9 @@ export interface GetShippingMethodByIDResponse {
11501
11728
  Error?: ServiceError;
11502
11729
  ExcludeProductsFromShippingMethod: boolean;
11503
11730
  Handler?: string;
11731
+ /**
11732
+ * Entity type: ShippingMethod
11733
+ */
11504
11734
  ID: string;
11505
11735
  InvoicingHandledByCarrier: boolean;
11506
11736
  Metadata?: ResponseMessageMetadata;
@@ -11526,16 +11756,28 @@ export interface GetShippingRestrictionByIDResponse {
11526
11756
  CountryID?: string;
11527
11757
  CountryName?: string;
11528
11758
  Error?: ServiceError;
11759
+ /**
11760
+ * Entity type: ShippingRestriction
11761
+ */
11529
11762
  ID: string;
11530
11763
  Metadata?: ResponseMessageMetadata;
11764
+ /**
11765
+ * Entity type: OrganizationUnit
11766
+ */
11531
11767
  OrganizationUnitID?: string;
11532
11768
  OrganizationUnitName?: string;
11533
11769
  OrganizationUnitSetDescription?: string;
11770
+ /**
11771
+ * Entity type: OrganizationUnitSet
11772
+ */
11534
11773
  OrganizationUnitSetID?: string;
11535
11774
  OrganizationUnitSetName?: string;
11536
11775
  OrganizationUnitSetType?: DataModelsOrganizationUnitSetTypes;
11537
11776
  ProductPropertyTypeID?: string;
11538
11777
  ProductPropertyTypeValues?: string[];
11778
+ /**
11779
+ * Entity type: ProductSearchTemplate
11780
+ */
11539
11781
  ProductSearchTemplateID?: string;
11540
11782
  /**
11541
11783
  * Entity type: Script
@@ -11569,15 +11811,24 @@ export interface ListManagementShippingMethodsResponse {
11569
11811
  }
11570
11812
  export interface ShippingListManagementShippingMethodsResponse_Data {
11571
11813
  CarrierCode?: string;
11814
+ /**
11815
+ * Entity type: Carrier
11816
+ */
11572
11817
  CarrierID: string;
11573
11818
  CarrierName?: string;
11574
11819
  Code?: string;
11575
11820
  DeliveryType: DataModelsShippingMethodDeliveryTypes;
11576
11821
  Handler?: string;
11822
+ /**
11823
+ * Entity type: ShippingMethod
11824
+ */
11577
11825
  ID: string;
11578
11826
  InvoicingHandledByCarrier: boolean;
11579
11827
  Name?: string;
11580
11828
  PaymentHandledByCarrier: boolean;
11829
+ /**
11830
+ * Entity type: ProductSearchTemplate
11831
+ */
11581
11832
  ProductSearchTemplateID?: string;
11582
11833
  ProductSearchTemplateName?: string;
11583
11834
  ShippingHandledByCarrier: boolean;
@@ -11674,6 +11925,9 @@ export interface ShippingPackageDto {
11674
11925
  Code?: string;
11675
11926
  Description?: string;
11676
11927
  Height: number;
11928
+ /**
11929
+ * Entity type: Package
11930
+ */
11677
11931
  ID: string;
11678
11932
  IsDefault: boolean;
11679
11933
  Length: number;
@@ -11953,6 +12207,9 @@ export interface CreateStockAllocationRule {
11953
12207
  * In case there is not enough stock, Priority is used to determine who gets preference. A higher Priority means a higher preference.
11954
12208
  */
11955
12209
  Priority?: number;
12210
+ /**
12211
+ * Entity type: Product
12212
+ */
11956
12213
  ProductID?: string;
11957
12214
  /**
11958
12215
  * Entity type: ProductSearchTemplate
@@ -11964,6 +12221,14 @@ export interface CreateStockAllocationRule {
11964
12221
  Value?: number;
11965
12222
  ValueType?: DataModelsStockAllocationRuleValueTypes;
11966
12223
  }
12224
+ export interface CreateStockAllocationRuleResponse {
12225
+ Error?: ServiceError;
12226
+ /**
12227
+ * Entity type: StockAllocationRule
12228
+ */
12229
+ ID: string;
12230
+ Metadata?: ResponseMessageMetadata;
12231
+ }
11967
12232
  /**
11968
12233
  * Create a new StockLabel
11969
12234
  *
@@ -11987,6 +12252,9 @@ export interface CreateStockLabelResponse {
11987
12252
  * Deletes a StockAllocationRule.
11988
12253
  */
11989
12254
  export interface DeleteStockAllocationRule {
12255
+ /**
12256
+ * Entity type: StockAllocationRule
12257
+ */
11990
12258
  ID: string;
11991
12259
  }
11992
12260
  /**
@@ -12018,6 +12286,9 @@ export interface ListCumulativeStockResponse {
12018
12286
  }
12019
12287
  export interface StockListCumulativeStockResponse_Model {
12020
12288
  OrganizationUnitBackendID?: string;
12289
+ /**
12290
+ * Entity type: OrganizationUnit
12291
+ */
12021
12292
  OrganizationUnitID: string;
12022
12293
  OrganizationUnitName?: string;
12023
12294
  Product?: SearchIProductSearchItem;
@@ -12043,6 +12314,9 @@ export interface RefillStockAllocation {
12043
12314
  */
12044
12315
  export interface UpdateStockAllocationRule {
12045
12316
  EndDate?: string;
12317
+ /**
12318
+ * Entity type: StockAllocationRule
12319
+ */
12046
12320
  ID: string;
12047
12321
  /**
12048
12322
  * In case there is not enough stock, Priority is used to determine who gets preference. A higher Priority means a higher preference.
@@ -12730,6 +13004,9 @@ export interface GetUserOriginsResponse {
12730
13004
  export interface UsersGetUserOriginsResponse_UserOriginDto {
12731
13005
  BackendID?: string;
12732
13006
  Description?: string;
13007
+ /**
13008
+ * Entity type: Enum
13009
+ */
12733
13010
  ID: string;
12734
13011
  /**
12735
13012
  * Usually an internal & unchangable code - for display, use `Description`
@@ -13186,7 +13463,7 @@ export interface UpdateUserRequirementSet {
13186
13463
  * Entity type: UserRequirementSet
13187
13464
  */
13188
13465
  ID: string;
13189
- Name?: string | null;
13466
+ Name?: string;
13190
13467
  /**
13191
13468
  * Entity type: OrganizationUnitSet
13192
13469
  */
@@ -13234,6 +13511,9 @@ export interface GetWishlist {
13234
13511
  }
13235
13512
  export interface GetWishlistResponse {
13236
13513
  CreatedOn: string;
13514
+ /**
13515
+ * Entity type: CustomField
13516
+ */
13237
13517
  CustomFieldValuesWithOptions?: Record<string, DataModelsCustomFieldValueWithOptions>;
13238
13518
  Description?: string;
13239
13519
  Error?: ServiceError;
@@ -13654,6 +13934,9 @@ export interface EVACoreServicesAssortmentsGetAssortmentRootProductsResponse_Ass
13654
13934
  MixedProductStatuses: DataModelsProductStatus;
13655
13935
  ProductBackendID?: string;
13656
13936
  ProductDetails?: SearchIProductSearchItem;
13937
+ /**
13938
+ * Entity type: Product
13939
+ */
13657
13940
  ProductID: string;
13658
13941
  ProductStatus: DataModelsProductStatus;
13659
13942
  ProductType: DataModelsProductTypes;
@@ -13876,7 +14159,10 @@ export interface ListRestockedProducts {
13876
14159
  export interface ListRestockedProductsResponse {
13877
14160
  Error?: ServiceError;
13878
14161
  Metadata?: ResponseMessageMetadata;
13879
- Results?: Record<string, number[] | null>;
14162
+ /**
14163
+ * Entity type: StockLabel
14164
+ */
14165
+ Results?: Record<string, string[] | null>;
13880
14166
  }
13881
14167
  /**
13882
14168
  * List the Stock per product/stocklabel for a subset of OrganizationUnits.
@@ -13938,6 +14224,9 @@ export interface EVACoreServicesStockListStockForOrganizationUnitsFilter {
13938
14224
  export interface ListStockForOrganizationUnitsResponse {
13939
14225
  Error?: ServiceError;
13940
14226
  Metadata?: ResponseMessageMetadata;
14227
+ /**
14228
+ * Entity type: Product
14229
+ */
13941
14230
  Products?: Record<string, EVACoreServicesStockListStockForOrganizationUnitsResponse_ProductDto>;
13942
14231
  Result?: PagedResult<EVACoreServicesStockListStockForOrganizationUnitsResponse_StockDto>;
13943
14232
  Url?: string;
@@ -13947,14 +14236,26 @@ export interface EVACoreServicesStockListStockForOrganizationUnitsResponse_Produ
13947
14236
  }
13948
14237
  export interface EVACoreServicesStockListStockForOrganizationUnitsResponse_StockDto {
13949
14238
  OrganizationUnitCurrencyID?: string;
14239
+ /**
14240
+ * Entity type: OrganizationUnit
14241
+ */
13950
14242
  OrganizationUnitID?: string;
13951
14243
  OrganizationUnitName?: string;
14244
+ /**
14245
+ * Entity type: Product
14246
+ */
13952
14247
  ProductID: string;
13953
14248
  QuantityAvailable: number;
13954
14249
  QuantityCommitted: number;
13955
14250
  QuantityOnHand: number;
14251
+ /**
14252
+ * Entity type: StockLabel
14253
+ */
13956
14254
  StockLabel: string;
13957
14255
  StockLabelName?: string;
14256
+ /**
14257
+ * Entity type: TaxCode
14258
+ */
13958
14259
  TaxCodeID: string;
13959
14260
  TaxRate: number;
13960
14261
  /**
@@ -13990,6 +14291,10 @@ export interface AddUserBoughtProductDetail {
13990
14291
  * Entity type: OrderLine
13991
14292
  */
13992
14293
  OrderLineID?: string;
14294
+ /**
14295
+ * Entity type: OrganizationUnit
14296
+ */
14297
+ OrganizationUnitID?: string;
13993
14298
  PurchaseDate?: string;
13994
14299
  PurchasedQuantity?: number;
13995
14300
  /**
@@ -14071,6 +14376,16 @@ export interface GetUserBoughtProduct {
14071
14376
  */
14072
14377
  IncludedProductProperties?: string[];
14073
14378
  }
14379
+ /**
14380
+ * Get a user bought product by a product's serial number.
14381
+ */
14382
+ export interface GetUserBoughtProductBySerialNumber {
14383
+ /**
14384
+ * Entity type: ProductPropertyType
14385
+ */
14386
+ IncludedProductProperties?: string[];
14387
+ SerialNumber: string;
14388
+ }
14074
14389
  export interface GetUserBoughtProductResponse {
14075
14390
  AdditionalWarrantyInfo?: string;
14076
14391
  Details?: EVACoreServicesUsersGetUserBoughtProductResponse_Detail[];
@@ -14110,6 +14425,10 @@ export interface EVACoreServicesUsersGetUserBoughtProductResponse_Detail {
14110
14425
  * Entity type: OrderLine
14111
14426
  */
14112
14427
  OrderLineID?: string;
14428
+ /**
14429
+ * Entity type: OrganizationUnit
14430
+ */
14431
+ OrganizationUnitID?: string;
14113
14432
  PurchaseDate?: string;
14114
14433
  PurchasedQuantity?: number;
14115
14434
  }
@@ -14241,6 +14560,11 @@ export interface EVACoreServicesUsersPushUserBoughtProduct_PushedBoughtProductDe
14241
14560
  * Entity type: OrderLine
14242
14561
  */
14243
14562
  OrderLineID?: string;
14563
+ /**
14564
+ * Entity type: OrganizationUnit
14565
+ * Organization unit that the user bought product is registered in. Ignored when an order/line organization unit is present. When omitted, registration is under the current organization unit.
14566
+ */
14567
+ OrganizationUnitID?: string;
14244
14568
  PurchaseDate?: string;
14245
14569
  PurchasedQuantity?: number;
14246
14570
  }
@@ -14266,6 +14590,11 @@ export interface EVACoreServicesUsersPushedBoughtProduct_PushedBoughtProductDeta
14266
14590
  * Entity type: OrderLine
14267
14591
  */
14268
14592
  OrderLineID?: string;
14593
+ /**
14594
+ * Entity type: OrganizationUnit
14595
+ * Organization unit that the user bought product is registered in. Ignored when an order/line organization unit is present. When omitted, registration is under the current organization unit.
14596
+ */
14597
+ OrganizationUnitID?: string;
14269
14598
  PurchaseDate?: string;
14270
14599
  PurchasedQuantity?: number;
14271
14600
  }
@@ -14284,6 +14613,11 @@ export interface RegisterUserBoughtProduct {
14284
14613
  */
14285
14614
  OrderLineID?: string;
14286
14615
  /**
14616
+ * Entity type: OrganizationUnit
14617
+ * Organization unit that the user bought product is registered in. Ignored when an order/line organization unit is present. When omitted, registration is under the current organization unit.
14618
+ */
14619
+ OrganizationUnitID?: string;
14620
+ /**
14287
14621
  * Entity type: Product
14288
14622
  */
14289
14623
  ProductID: string;
@@ -14312,6 +14646,11 @@ export interface UpdateUserBoughtProductDetail {
14312
14646
  * Entity type: OrderLine
14313
14647
  */
14314
14648
  OrderLineID?: string;
14649
+ /**
14650
+ * Entity type: OrganizationUnit
14651
+ * Organization unit that the user bought product is registered in. Ignored when an order/line organization unit is present. When omitted, registration is under the current organization unit.
14652
+ */
14653
+ OrganizationUnitID?: string;
14315
14654
  PurchaseDate?: string;
14316
14655
  PurchasedQuantity?: number;
14317
14656
  }