@springtree/eva-services-core-management 3.0.0-beta.2 → 3.0.0-beta.20

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.
Files changed (9) hide show
  1. package/lib/eva-services-core-management.d.ts +1306 -459
  2. package/lib/eva-services-core-management.d.ts.map +1 -1
  3. package/lib/eva-services-core-management.js +8 -0
  4. package/lib/eva-services-core-management.js.map +1 -1
  5. package/lib/eva-services-core-management.services.d.ts +124 -40
  6. package/lib/eva-services-core-management.services.d.ts.map +1 -1
  7. package/lib/eva-services-core-management.services.js +111 -27
  8. package/lib/eva-services-core-management.services.js.map +1 -1
  9. package/package.json +3 -3
package/lib/eva-services-core-management.d.ts CHANGED
@@ -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, SearchIProductSearchItemPrimaryImage, 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 } 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",
@@ -109,6 +113,10 @@ export declare const enum Errors {
109
113
  */
110
114
  GiftCards_InvalidProductType = "GiftCards:InvalidProductType",
111
115
  /**
116
+ * Field '{:string}' is required for the creation of a new Loyalty Program.
117
+ */
118
+ LoyaltyProgram_MissingFieldOnLoyaltyProgramCreation = "LoyaltyProgram:MissingFieldOnLoyaltyProgramCreation",
119
+ /**
112
120
  * There already exists opening hours for organization {organizationUnitName:string} and day {dayOfWeek:EVA.Core.DayOfWeek}
113
121
  */
114
122
  OpeningHours_DuplicateOpeningHoursDayOfWeek = "OpeningHours:DuplicateOpeningHoursDayOfWeek",
@@ -324,6 +332,14 @@ export interface CreateAccount {
324
332
  Subsidiary?: string;
325
333
  Type?: DataModelsAccountType;
326
334
  }
335
+ export interface CreateAccountResponse {
336
+ Error?: ServiceError;
337
+ /**
338
+ * Entity type: Account
339
+ */
340
+ ID: string;
341
+ Metadata?: ResponseMessageMetadata;
342
+ }
327
343
  /**
328
344
  * Delete an existing Account
329
345
  */
@@ -375,7 +391,7 @@ export interface ListAccountsResponse {
375
391
  * Update an existing Account. Make sure all properties are filled.
376
392
  */
377
393
  export interface UpdateAccount {
378
- BackendCode: string | null | undefined;
394
+ BackendCode?: string | null;
379
395
  BookingFlags?: DataModelsBookingFlags;
380
396
  /**
381
397
  * Entity type: Account
@@ -383,7 +399,7 @@ export interface UpdateAccount {
383
399
  ID: string;
384
400
  Name?: string;
385
401
  ObjectAccount?: string;
386
- Subsidiary: string | null | undefined;
402
+ Subsidiary?: string | null;
387
403
  Type?: DataModelsAccountType;
388
404
  }
389
405
  export interface AuditingConfigurationResponse {
@@ -523,7 +539,7 @@ export interface CreateCase {
523
539
  * Can only be set once. Can be updated when not set on create.
524
540
  */
525
541
  OriginatingOrganizationUnitID?: string;
526
- Priority: DataModelsCasePriority;
542
+ Priority?: DataModelsCasePriority;
527
543
  Title: string;
528
544
  /**
529
545
  * Entity type: CaseTopic
@@ -539,7 +555,7 @@ export interface CreateCaseInteraction {
539
555
  * Entity type: Case
540
556
  */
541
557
  CaseID: string;
542
- InteractionType: DataModelsInteractionType;
558
+ InteractionType?: DataModelsInteractionType;
543
559
  Text: string;
544
560
  }
545
561
  export interface CreateCaseInteractionResponse {
@@ -562,7 +578,7 @@ export interface CreateCaseResponse {
562
578
  * Creates a new case status
563
579
  */
564
580
  export interface CreateCaseStatus {
565
- Action: DataModelsCaseStatusAction;
581
+ Action?: DataModelsCaseStatusAction;
566
582
  BackendID?: string;
567
583
  Color?: string;
568
584
  Description?: string;
@@ -666,10 +682,14 @@ export interface GetCaseByIDResponse {
666
682
  * Entity type: Blob
667
683
  */
668
684
  BlobIDs?: string[];
685
+ Blobs?: CasesGetCaseByIDResponse_CaseBlobModel[];
669
686
  CaseTopic?: CasesGetCaseByIDResponse_CaseTopicData;
670
687
  ClosingTime?: string;
671
688
  CreatedBy?: CasesGetCaseByIDResponse_User;
672
689
  CreationTime: string;
690
+ /**
691
+ * Entity type: CustomField
692
+ */
673
693
  CustomFieldValuesWithOptions?: Record<string, DataModelsCustomFieldValueWithOptions>;
674
694
  Customer?: CasesGetCaseByIDResponse_CustomerInfo;
675
695
  /**
@@ -717,11 +737,13 @@ export interface GetCaseByIDResponse {
717
737
  */
718
738
  SummaryLastModifiedByID?: string;
719
739
  Title?: string;
740
+ }
741
+ export interface CasesGetCaseByIDResponse_CaseBlobModel {
720
742
  /**
721
- * Entity type: CaseTopic
743
+ * Entity type: Blob
722
744
  */
723
- TopicID?: string;
724
- TopicName?: string;
745
+ ID: string;
746
+ Url?: string;
725
747
  }
726
748
  export interface CasesGetCaseByIDResponse_CaseRepair {
727
749
  CompletionTime?: string;
@@ -740,10 +762,12 @@ export interface CasesGetCaseByIDResponse_CaseRepairTask {
740
762
  * Entity type: RepairTask
741
763
  */
742
764
  ID: string;
743
- UserTaskSubType?: APIEnumDto;
765
+ UserTaskSubType?: EVAFrameworkAPIEnumDto;
744
766
  }
745
767
  export interface CasesGetCaseByIDResponse_CaseTopicData {
746
768
  CaseTopic?: CasesGetCaseByIDResponse_CaseTopicData;
769
+ TopicBackendID?: string;
770
+ TopicDisplayName?: string;
747
771
  /**
748
772
  * Entity type: CaseTopic
749
773
  */
@@ -751,6 +775,7 @@ export interface CasesGetCaseByIDResponse_CaseTopicData {
751
775
  TopicName?: string;
752
776
  }
753
777
  export interface CasesGetCaseByIDResponse_CustomerInfo {
778
+ BackendID?: string;
754
779
  EmailAddress?: string;
755
780
  FirstName?: string;
756
781
  FullName?: string;
@@ -854,6 +879,7 @@ export interface GetCaseTopic {
854
879
  export interface GetCaseTopicResponse {
855
880
  BackendID?: string;
856
881
  Description?: string;
882
+ DisplayName?: string;
857
883
  Error?: ServiceError;
858
884
  /**
859
885
  * Entity type: CaseTopic
@@ -885,6 +911,7 @@ export interface CasesListBlobsForCaseResponse_Blob {
885
911
  CreationTime: string;
886
912
  MimeType?: string;
887
913
  Name?: string;
914
+ Url?: string;
888
915
  }
889
916
  /**
890
917
  * List the case interactions
@@ -977,6 +1004,7 @@ export interface ListCaseTopicsResponse {
977
1004
  export interface CasesListCaseTopicsResponse_CaseTopic {
978
1005
  BackendID?: string;
979
1006
  Description?: string;
1007
+ DisplayName?: string;
980
1008
  /**
981
1009
  * Entity type: CaseTopic
982
1010
  */
@@ -1078,11 +1106,10 @@ export interface PushCase {
1078
1106
  AssignedOrganizationUnitBackendID?: string;
1079
1107
  Assignee?: CasesPushCase_PushCaseAssignee;
1080
1108
  BackendID: string;
1081
- BackendSystemID?: string;
1082
1109
  CaseRelatedItems?: CasesPushCase_PushCaseRelatedItems;
1083
1110
  ClosingTime?: string;
1084
1111
  CustomFields?: Record<string, TAnyValue | null>;
1085
- Customer: CasesPushCase_PushCaseCustomer | undefined;
1112
+ Customer?: CasesPushCase_PushCaseCustomer;
1086
1113
  Description: string;
1087
1114
  /**
1088
1115
  * Setting this to true will try to suppress as many event exports as possible that might result from this call.
@@ -1091,7 +1118,7 @@ export interface PushCase {
1091
1118
  Interactions?: CasesPushCase_PushCaseInteraction[];
1092
1119
  LastInteractionTime?: string;
1093
1120
  OriginatingOrganizationUnitBackendID?: string;
1094
- Priority: DataModelsCasePriority;
1121
+ Priority?: DataModelsCasePriority;
1095
1122
  ReportingTime?: string;
1096
1123
  Solution?: string;
1097
1124
  Status: string;
@@ -1191,7 +1218,7 @@ export interface CasesPushCase_PushCaseInteraction {
1191
1218
  */
1192
1219
  Delete?: boolean;
1193
1220
  Text?: string;
1194
- Type: DataModelsInteractionType;
1221
+ Type?: DataModelsInteractionType;
1195
1222
  }
1196
1223
  export interface CasesPushCase_PushCaseRelatedItem {
1197
1224
  /**
@@ -1298,18 +1325,18 @@ export interface UpdateCase {
1298
1325
  * Entity type: OrganizationUnit
1299
1326
  * OU the case is assigned to. When set this will influence visibility.
1300
1327
  */
1301
- AssignedOrganizationUnitID: string | null | undefined;
1302
- BackendID: string | null | undefined;
1328
+ AssignedOrganizationUnitID?: string | null;
1329
+ BackendID?: string | null;
1303
1330
  /**
1304
1331
  * Optional additional custom fields
1305
1332
  */
1306
- CustomFields: DataModelsCustomFieldKeyValue[] | null | undefined;
1333
+ CustomFields?: DataModelsCustomFieldKeyValue[] | null;
1307
1334
  /**
1308
1335
  * Entity type: User
1309
1336
  */
1310
- CustomerID: string | null | undefined;
1337
+ CustomerID?: string | null;
1311
1338
  Description?: string;
1312
- ExternalOrderIdentifier: string | null | undefined;
1339
+ ExternalOrderIdentifier?: string | null;
1313
1340
  /**
1314
1341
  * Entity type: Case
1315
1342
  */
@@ -1318,7 +1345,7 @@ export interface UpdateCase {
1318
1345
  * Entity type: OrganizationUnit
1319
1346
  * Can only be set once. Can be updated when not set on create.
1320
1347
  */
1321
- OriginatingOrganizationUnitID: string | null | undefined;
1348
+ OriginatingOrganizationUnitID?: string | null;
1322
1349
  Title?: string;
1323
1350
  /**
1324
1351
  * Entity type: CaseTopic
@@ -1329,7 +1356,7 @@ export interface UpdateCase {
1329
1356
  * Update a case interaction
1330
1357
  */
1331
1358
  export interface UpdateCaseInteraction {
1332
- BackendID: string | null | undefined;
1359
+ BackendID?: string | null;
1333
1360
  /**
1334
1361
  * Entity type: Interaction
1335
1362
  */
@@ -1343,7 +1370,7 @@ export interface UpdateCaseState {
1343
1370
  /**
1344
1371
  * Entity type: User
1345
1372
  */
1346
- AssigneeID: string | null | undefined;
1373
+ AssigneeID?: string | null;
1347
1374
  /**
1348
1375
  * Entity type: Case
1349
1376
  */
@@ -1352,7 +1379,7 @@ export interface UpdateCaseState {
1352
1379
  /**
1353
1380
  * The solution for the case
1354
1381
  */
1355
- Solution: string | null | undefined;
1382
+ Solution?: string | null;
1356
1383
  /**
1357
1384
  * Entity type: CaseStatus
1358
1385
  */
@@ -1368,9 +1395,9 @@ export interface UpdateCaseStateResponse {
1368
1395
  */
1369
1396
  export interface UpdateCaseStatus {
1370
1397
  Action?: DataModelsCaseStatusAction;
1371
- BackendID: string | null | undefined;
1372
- Color: string | null | undefined;
1373
- Description: string | null | undefined;
1398
+ BackendID?: string | null;
1399
+ Color?: string | null;
1400
+ Description?: string | null;
1374
1401
  /**
1375
1402
  * Entity type: CaseStatus
1376
1403
  */
@@ -1380,7 +1407,7 @@ export interface UpdateCaseStatus {
1380
1407
  /**
1381
1408
  * Entity type: Script
1382
1409
  */
1383
- ScriptID: string | null | undefined;
1410
+ ScriptID?: string | null;
1384
1411
  }
1385
1412
  /**
1386
1413
  * Update an existing case summary.
@@ -1399,8 +1426,8 @@ export interface UpdateCaseSummary {
1399
1426
  * Update a case topic
1400
1427
  */
1401
1428
  export interface UpdateCaseTopic {
1402
- BackendID: string | null | undefined;
1403
- Description: string | null | undefined;
1429
+ BackendID?: string | null;
1430
+ Description?: string | null;
1404
1431
  /**
1405
1432
  * Entity type: CaseTopic
1406
1433
  */
@@ -1441,6 +1468,14 @@ export interface CreateCompany {
1441
1468
  VisitorsAddress?: AddressesAddressDataDto;
1442
1469
  WasteDisposalNumber?: string;
1443
1470
  }
1471
+ export interface CreateCompanyResponse {
1472
+ Error?: ServiceError;
1473
+ /**
1474
+ * Entity type: Company
1475
+ */
1476
+ ID: string;
1477
+ Metadata?: ResponseMessageMetadata;
1478
+ }
1444
1479
  /**
1445
1480
  * Deletes a Company. If a Company is still in use by Users or OrganizationUnits this service will return an error.
1446
1481
  */
@@ -1515,34 +1550,34 @@ export interface ListCompaniesResponse {
1515
1550
  * Updates a Company. Fields not provided in the request are ignored.
1516
1551
  */
1517
1552
  export interface UpdateCompany {
1518
- AccountHolderName: string | null | undefined;
1519
- BIC: string | null | undefined;
1520
- BackendID: string | null | undefined;
1521
- ContactEmailAddress: string | null | undefined;
1522
- ContactPhoneNumber: string | null | undefined;
1523
- EntityType: string | null | undefined;
1524
- EstablishedDate: string | null | undefined;
1525
- FiscalID: string | null | undefined;
1526
- IBAN: string | null | undefined;
1553
+ AccountHolderName?: string | null;
1554
+ BIC?: string | null;
1555
+ BackendID?: string | null;
1556
+ ContactEmailAddress?: string | null;
1557
+ ContactPhoneNumber?: string | null;
1558
+ EntityType?: string | null;
1559
+ EstablishedDate?: string | null;
1560
+ FiscalID?: string | null;
1561
+ IBAN?: string | null;
1527
1562
  /**
1528
1563
  * Entity type: Company
1529
1564
  */
1530
1565
  ID: string;
1531
- IndustryCode: string | null | undefined;
1532
- InvoiceAddress: AddressesAddressDataDto | undefined;
1533
- InvoiceEmailAddress: string | null | undefined;
1534
- LogoID: string | null | undefined;
1535
- Name: string | null | undefined;
1536
- RegistrationCity: string | null | undefined;
1537
- RegistrationCountryID: string | null | undefined;
1538
- RegistrationCountrySubdivisionID: string | null | undefined;
1539
- RegistrationNumber: string | null | undefined;
1540
- SocialCapital: number | null | undefined;
1541
- TaxOfficeNumber: string | null | undefined;
1566
+ IndustryCode?: string | null;
1567
+ InvoiceAddress?: AddressesAddressDataDto;
1568
+ InvoiceEmailAddress?: string | null;
1569
+ LogoID?: string | null;
1570
+ Name?: string | null;
1571
+ RegistrationCity?: string | null;
1572
+ RegistrationCountryID?: string | null;
1573
+ RegistrationCountrySubdivisionID?: string | null;
1574
+ RegistrationNumber?: string | null;
1575
+ SocialCapital?: number | null;
1576
+ TaxOfficeNumber?: string | null;
1542
1577
  Type?: DataModelsCompanyType;
1543
- VatNumber: string | null | undefined;
1544
- VisitorsAddress: AddressesAddressDataDto | undefined;
1545
- WasteDisposalNumber: string | null | undefined;
1578
+ VatNumber?: string | null;
1579
+ VisitorsAddress?: AddressesAddressDataDto;
1580
+ WasteDisposalNumber?: string | null;
1546
1581
  }
1547
1582
  export interface ValidateCompany {
1548
1583
  AccountHolderName?: string;
@@ -1677,7 +1712,7 @@ export interface GetAppSettingsForOrganizationUnit {
1677
1712
  * Entity type: OrganizationUnit
1678
1713
  */
1679
1714
  OrganizationUnitID: string;
1680
- SortDirection: SortDirection;
1715
+ SortDirection?: SortDirection;
1681
1716
  SortProperty?: string;
1682
1717
  }
1683
1718
  export interface GetAppSettingsForOrganizationUnitResponse {
@@ -1886,7 +1921,7 @@ export interface ListSettings {
1886
1921
  */
1887
1922
  OrganizationUnitID: string;
1888
1923
  ShowDeprecationsOnly?: boolean;
1889
- SortDirection: SortDirection;
1924
+ SortDirection?: SortDirection;
1890
1925
  SortProperty?: string;
1891
1926
  TypedFilter?: ConfigurationListSettingsTypedFilters;
1892
1927
  }
@@ -1898,13 +1933,16 @@ export interface ListSettingsPerOrganizationUnit {
1898
1933
  FunctionalityCategory?: string;
1899
1934
  Key?: string;
1900
1935
  ShowDeprecationsOnly?: boolean;
1901
- SortDirection: SortDirection;
1936
+ SortDirection?: SortDirection;
1902
1937
  SortProperty?: string;
1903
1938
  TypedFilter?: ConfigurationListSettingsTypedFilters;
1904
1939
  }
1905
1940
  export interface ListSettingsPerOrganizationUnitResponse {
1906
1941
  Error?: ServiceError;
1907
1942
  Metadata?: ResponseMessageMetadata;
1943
+ /**
1944
+ * Entity type: OrganizationUnit
1945
+ */
1908
1946
  Result?: Record<string, Record<string, ConfigurationSettingDto> | null>;
1909
1947
  }
1910
1948
  export interface ListSettingsResponse {
@@ -2119,13 +2157,13 @@ export interface CostPriceCalculationsGetCostPriceCalculationsResponse_Item {
2119
2157
  Name: string;
2120
2158
  }
2121
2159
  export interface UpdateCostPriceCalculation {
2122
- BackendID: string | null | undefined;
2160
+ BackendID?: string | null;
2123
2161
  Factor?: number;
2124
2162
  /**
2125
2163
  * Entity type: CostPriceCalculation
2126
2164
  */
2127
2165
  ID: string;
2128
- Name: string | null | undefined;
2166
+ Name?: string | null;
2129
2167
  }
2130
2168
  /**
2131
2169
  * Create a new Culture
@@ -2310,7 +2348,7 @@ export interface CulturesListOrganizationUnitLanguagesResponse_OrganizationUnitL
2310
2348
  */
2311
2349
  export interface CreateCustomField {
2312
2350
  BackendID?: string;
2313
- DataType: DataModelsCustomFieldDataTypes;
2351
+ DataType?: DataModelsCustomFieldDataTypes;
2314
2352
  DisplayName?: string;
2315
2353
  EnumValues?: Record<string, string | null>;
2316
2354
  InputHint?: string;
@@ -2386,7 +2424,7 @@ export interface GetCustomFieldMetadataResponse {
2386
2424
  export interface GetCustomFieldTypes {
2387
2425
  }
2388
2426
  export interface GetCustomFieldTypesResponse {
2389
- CustomFieldTypes?: APIEnumDto[];
2427
+ CustomFieldTypes?: EVAFrameworkAPIEnumDto[];
2390
2428
  Error?: ServiceError;
2391
2429
  Metadata?: ResponseMessageMetadata;
2392
2430
  }
@@ -2404,6 +2442,9 @@ export interface GetCustomFields {
2404
2442
  TypeID: string;
2405
2443
  }
2406
2444
  export interface GetCustomFieldsResponse {
2445
+ /**
2446
+ * Entity type: CustomField
2447
+ */
2407
2448
  CustomFieldOptions?: Record<string, DataModelsCustomFieldOptions>;
2408
2449
  Error?: ServiceError;
2409
2450
  Metadata?: ResponseMessageMetadata;
@@ -2522,23 +2563,23 @@ export interface CustomFieldsListCustomFieldsResponse_CustomFieldDto {
2522
2563
  * Set options for custom fields
2523
2564
  */
2524
2565
  export interface SetCustomFieldOptions {
2525
- CustomFieldDefaultValue: DataModelsCustomFieldValue | undefined;
2566
+ CustomFieldDefaultValue?: DataModelsCustomFieldValue;
2526
2567
  /**
2527
2568
  * Entity type: CustomField
2528
2569
  */
2529
2570
  CustomFieldID: string;
2530
- EditableByUserTypes: UserTypes | undefined;
2571
+ EditableByUserTypes?: UserTypes;
2531
2572
  /**
2532
2573
  * Entity type: Script
2533
2574
  */
2534
- EligibilityScriptID: string | null | undefined;
2535
- IsRequired: boolean | null | undefined;
2536
- MaximumDate: string | null | undefined;
2537
- MaximumLength: number | null | undefined;
2538
- MaximumValue: number | null | undefined;
2539
- MinimumDate: string | null | undefined;
2540
- MinimumLength: number | null | undefined;
2541
- MinimumValue: number | null | undefined;
2575
+ EligibilityScriptID?: string | null;
2576
+ IsRequired?: boolean | null;
2577
+ MaximumDate?: string | null;
2578
+ MaximumLength?: number | null;
2579
+ MaximumValue?: number | null;
2580
+ MinimumDate?: string | null;
2581
+ MinimumLength?: number | null;
2582
+ MinimumValue?: number | null;
2542
2583
  /**
2543
2584
  * Entity type: OrganizationUnitSet
2544
2585
  */
@@ -2546,8 +2587,8 @@ export interface SetCustomFieldOptions {
2546
2587
  /**
2547
2588
  * Entity type: Script
2548
2589
  */
2549
- SecurityScriptID: string | null | undefined;
2550
- VisibleByUserTypes: UserTypes | undefined;
2590
+ SecurityScriptID?: string | null;
2591
+ VisibleByUserTypes?: UserTypes;
2551
2592
  }
2552
2593
  export interface UnsetCustomFieldOptions {
2553
2594
  /**
@@ -2563,17 +2604,30 @@ export interface UnsetCustomFieldOptions {
2563
2604
  * Update an existing custom CustomField.
2564
2605
  */
2565
2606
  export interface UpdateCustomField {
2566
- BackendID: string | null | undefined;
2567
- DisplayName: string | null | undefined;
2568
- EnumValues: Record<string, string | null> | null | undefined;
2607
+ BackendID?: string | null;
2608
+ DisplayName?: string | null;
2609
+ EnumValues?: Record<string, string | null> | null;
2569
2610
  /**
2570
2611
  * Entity type: CustomField
2571
2612
  */
2572
2613
  ID: string;
2573
- InputHint: string | null | undefined;
2574
- Name: string | null | undefined;
2614
+ InputHint?: string | null;
2615
+ Name?: string | null;
2575
2616
  Order?: number;
2576
- TypeKey: string | null | undefined;
2617
+ TypeKey?: string | null;
2618
+ }
2619
+ /**
2620
+ * Add required custom fields to ManualDiscount
2621
+ */
2622
+ export interface AddRequiredCustomFieldsToManualDiscount {
2623
+ /**
2624
+ * Entity type: CustomField
2625
+ */
2626
+ CustomFieldIDs: string[];
2627
+ /**
2628
+ * Entity type: Discount
2629
+ */
2630
+ DiscountID: string;
2577
2631
  }
2578
2632
  /**
2579
2633
  * Add security roles to ManualDiscount
@@ -2611,8 +2665,8 @@ export interface CreateDiscount {
2611
2665
  */
2612
2666
  CampaignID?: string;
2613
2667
  CannotApplyToOwnOrder?: boolean;
2614
- CompliancyRule: DataModelsDiscountCompliancyRule;
2615
- ConditionType: DataModelsDiscountConditionTypes;
2668
+ CompliancyRule?: DataModelsDiscountCompliancyRule;
2669
+ ConditionType?: DataModelsDiscountConditionTypes;
2616
2670
  Conditions?: DiscountsCreateDiscount_DiscountConditionDto[];
2617
2671
  CouponHandler?: string;
2618
2672
  CouponsGeneratedByOtherDiscount?: boolean;
@@ -2631,10 +2685,10 @@ export interface CreateDiscount {
2631
2685
  DaysApplicable?: DaysOfWeek;
2632
2686
  DeactivateWhenBudgetReached?: boolean;
2633
2687
  Description: string;
2634
- DiscountOrderType: DataModelsDiscountOrderTypes;
2688
+ DiscountOrderType?: DataModelsDiscountOrderTypes;
2635
2689
  Enable?: boolean;
2636
2690
  EndDate?: string;
2637
- FinancialDispersion: DataModelsFinancialDespersionType;
2691
+ FinancialDispersion?: DataModelsFinancialDespersionType;
2638
2692
  /**
2639
2693
  * Entity type: Blob
2640
2694
  */
@@ -2663,6 +2717,11 @@ export interface CreateDiscount {
2663
2717
  OrganizationUnitSetID: string;
2664
2718
  PromotionLabel?: string;
2665
2719
  /**
2720
+ * Entity type: CustomField
2721
+ * For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
2722
+ */
2723
+ RequiredCustomFields?: string[];
2724
+ /**
2666
2725
  * Entity type: OrganizationUnit
2667
2726
  */
2668
2727
  RestitutionOrganizationUnitID?: string;
@@ -2671,7 +2730,7 @@ export interface CreateDiscount {
2671
2730
  */
2672
2731
  RoleIDs?: string[];
2673
2732
  StartDate?: string;
2674
- Trigger: DataModelsDiscountTriggers;
2733
+ Trigger?: DataModelsDiscountTriggers;
2675
2734
  UserUsageLimit?: number;
2676
2735
  UserUsageReloadStrategy?: string;
2677
2736
  }
@@ -2695,6 +2754,14 @@ export interface CreateDiscountCampaign {
2695
2754
  Name: string;
2696
2755
  StartDate?: string;
2697
2756
  }
2757
+ export interface CreateDiscountCampaignResponse {
2758
+ Error?: ServiceError;
2759
+ /**
2760
+ * Entity type: DiscountCampaign
2761
+ */
2762
+ ID: string;
2763
+ Metadata?: ResponseMessageMetadata;
2764
+ }
2698
2765
  /**
2699
2766
  * Create a DiscountCoupon
2700
2767
  */
@@ -2720,12 +2787,12 @@ export interface CreateDiscountCouponResponse {
2720
2787
  * Create a discount from the given template with the overwrites with the values given in the request.
2721
2788
  */
2722
2789
  export interface CreateDiscountFromTemplate {
2723
- BackendID: string | null | undefined;
2790
+ BackendID?: string | null;
2724
2791
  /**
2725
2792
  * Entity type: DiscountCampaign
2726
2793
  */
2727
- CampaignID: string | null | undefined;
2728
- CompliancyRule: DataModelsDiscountCompliancyRule;
2794
+ CampaignID?: string | null;
2795
+ CompliancyRule?: DataModelsDiscountCompliancyRule;
2729
2796
  CreateAsActive?: boolean;
2730
2797
  /**
2731
2798
  * Entity type: Currency
@@ -2733,12 +2800,12 @@ export interface CreateDiscountFromTemplate {
2733
2800
  CurrencyID: string;
2734
2801
  Description: string;
2735
2802
  EndDate?: string;
2736
- FinancialDispersion: DataModelsFinancialDespersionType;
2803
+ FinancialDispersion?: DataModelsFinancialDespersionType;
2737
2804
  /**
2738
2805
  * Entity type: DiscountTemplate
2739
2806
  */
2740
2807
  ID: string;
2741
- ImageBlobID: string | null | undefined;
2808
+ ImageBlobID?: string | null;
2742
2809
  IsExclusive?: boolean;
2743
2810
  /**
2744
2811
  * Entity type: DiscountLayer
@@ -2747,16 +2814,16 @@ export interface CreateDiscountFromTemplate {
2747
2814
  /**
2748
2815
  * Entity type: LedgerClass
2749
2816
  */
2750
- LedgerClassID: string | null | undefined;
2817
+ LedgerClassID?: string | null;
2751
2818
  LoyaltyPointWithdrawal?: number;
2752
2819
  /**
2753
2820
  * Entity type: LoyaltyProgram
2754
2821
  */
2755
2822
  LoyaltyProgramID?: string;
2756
2823
  MarketingDescription?: string;
2757
- MaximumUsage: number | null | undefined;
2758
- MaximumUsagePerOrder: number | null | undefined;
2759
- MaximumUsagePerUser: number | null | undefined;
2824
+ MaximumUsage?: number | null;
2825
+ MaximumUsagePerOrder?: number | null;
2826
+ MaximumUsagePerUser?: number | null;
2760
2827
  NeedsReason?: boolean;
2761
2828
  /**
2762
2829
  * Entity type: OrganizationUnitSet
@@ -2768,8 +2835,8 @@ export interface CreateDiscountFromTemplate {
2768
2835
  */
2769
2836
  RestitutionOrganizationUnitID?: string;
2770
2837
  StartDate?: string;
2771
- UserUsageLimit: number | null | undefined;
2772
- UserUsageReloadStrategy: string | null | undefined;
2838
+ UserUsageLimit?: number | null;
2839
+ UserUsageReloadStrategy?: string | null;
2773
2840
  }
2774
2841
  /**
2775
2842
  * Create a new DiscountLayer
@@ -2802,18 +2869,18 @@ export interface CreateDiscountResponse {
2802
2869
  export interface CreateDiscountTemplate {
2803
2870
  ActionData: DiscountsIDiscountActionData;
2804
2871
  ActionType: 'V2:DISCOUNTAMOUNT' | 'V2:CUSTOMERAGE' | 'V2:TIEREDCUSTOMERAGE' | 'V2:GENERATEDISCOUNTCOUPON' | 'V2:GETAPRODUCT' | 'V2:LOYALTYTIEREDDISCOUNTAMOUNT' | 'V2:LOYALTYTIEREDDISCOUNTPERCENTAGE' | 'V2:ORDERTIEREDDISCOUNTAMOUNT' | 'V2:ORDERTIEREDDISCOUNTPERCENTAGE' | 'V2:ORIGINATINGORDERDISCOUNT' | 'V2:OTHERCOSTS' | 'V2:DISCOUNTPERCENTAGE' | 'V2:TIEREDPICKAPRODUCT' | 'V2:PRODUCTAMOUNTTIEREDDISCOUNTAMOUNT' | 'V2:PRODUCTAMOUNTTIEREDDISCOUNTPERCENTAGE' | 'V2:PRODUCTQUANTITYTIEREDDISCOUNTAMOUNT' | 'V2:PRODUCTQUANTITYTIEREDDISCOUNTPERCENTAGE' | 'V2:PRODUCTSETDISCOUNTAMOUNT' | 'V2:PRODUCTSETFIXEDPRICE' | 'V2:PRODUCTSETFREEPRODUCT' | 'V2:PRODUCTSETDISCOUNTPERCENTAGE' | 'V2:CUSTOMFIELDVALUEDETERMINEDDISCOUNT' | 'DEFAULT' | 'RITUALSEMPLOYEE' | 'V2:RITUALSEMPLOYEE';
2805
- AppliesTo: DataModelsDiscountAppliesTo;
2872
+ AppliesTo?: DataModelsDiscountAppliesTo;
2806
2873
  BackendID?: string;
2807
2874
  /**
2808
2875
  * Entity type: DiscountCampaign
2809
2876
  */
2810
2877
  CampaignID?: string;
2811
- ConditionType: DataModelsDiscountConditionTypes;
2878
+ ConditionType?: DataModelsDiscountConditionTypes;
2812
2879
  Conditions?: DiscountsCreateDiscountTemplate_Condition[];
2813
2880
  CouponHandler?: string;
2814
2881
  CouponsGeneratedByOtherDiscount?: boolean;
2815
2882
  Description: string;
2816
- DiscountOrderType: DataModelsDiscountOrderTypes;
2883
+ DiscountOrderType?: DataModelsDiscountOrderTypes;
2817
2884
  ImageBlobID?: string;
2818
2885
  IsActive?: boolean;
2819
2886
  IsExclusive?: boolean;
@@ -2829,7 +2896,7 @@ export interface CreateDiscountTemplate {
2829
2896
  * Entity type: OrganizationUnit
2830
2897
  */
2831
2898
  RestitutionOrganizationUnitID?: string;
2832
- Trigger: DataModelsDiscountTriggers;
2899
+ Trigger?: DataModelsDiscountTriggers;
2833
2900
  UserUsageLimit?: number;
2834
2901
  UserUsageReloadStrategy?: string;
2835
2902
  }
@@ -2837,6 +2904,14 @@ export interface DiscountsCreateDiscountTemplate_Condition {
2837
2904
  Data: IConditionData;
2838
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';
2839
2906
  }
2907
+ export interface CreateDiscountTemplateResponse {
2908
+ Error?: ServiceError;
2909
+ /**
2910
+ * Entity type: DiscountTemplate
2911
+ */
2912
+ ID: string;
2913
+ Metadata?: ResponseMessageMetadata;
2914
+ }
2840
2915
  /**
2841
2916
  * Delete a DiscountCampaign
2842
2917
  */
@@ -2949,6 +3024,24 @@ export interface GenerateDiscountCoupons {
2949
3024
  Quantity?: number;
2950
3025
  Suffix?: string;
2951
3026
  }
3027
+ export interface GenerateDiscountCoupons_Async {
3028
+ /**
3029
+ * Entity type: Discount
3030
+ */
3031
+ DiscountID: string;
3032
+ MaximumUsage?: number;
3033
+ Prefix?: string;
3034
+ Quantity?: number;
3035
+ Suffix?: string;
3036
+ }
3037
+ export interface GenerateDiscountCoupons_AsyncResponse {
3038
+ Error?: ServiceError;
3039
+ JobID?: string;
3040
+ Metadata?: ResponseMessageMetadata;
3041
+ }
3042
+ export interface GenerateDiscountCoupons_AsyncResult {
3043
+ JobID?: string;
3044
+ }
2952
3045
  /**
2953
3046
  * Get a coupon by it's token. When a customer calls this service, the service will only resolve tokens from coupons on which the user is registered. Employees and API's can resolve all coupon tokens.
2954
3047
  */
@@ -2964,6 +3057,9 @@ export interface GetCouponByTokenResponse {
2964
3057
  DiscountID: string;
2965
3058
  DiscountMarketingDescription?: string;
2966
3059
  Error?: ServiceError;
3060
+ /**
3061
+ * Entity type: OrderLine
3062
+ */
2967
3063
  FromCancelledLines?: Record<string, number>;
2968
3064
  Metadata?: ResponseMessageMetadata;
2969
3065
  /**
@@ -2994,6 +3090,7 @@ export interface GetDiscountByIDResponse {
2994
3090
  * Entity type: DiscountCampaign
2995
3091
  */
2996
3092
  CampaignID?: string;
3093
+ CannotApplyToOwnOrder: boolean;
2997
3094
  CompliancyRule: DataModelsDiscountCompliancyRule;
2998
3095
  ConditionType: DataModelsDiscountConditionTypes;
2999
3096
  Conditions?: DiscountsGetDiscountByIDResponse_DiscountCondition[];
@@ -3005,6 +3102,9 @@ export interface GetDiscountByIDResponse {
3005
3102
  * Entity type: Currency
3006
3103
  */
3007
3104
  CurrencyID?: string;
3105
+ /**
3106
+ * Entity type: CustomField
3107
+ */
3008
3108
  CustomFieldValuesWithOptions?: Record<string, DataModelsCustomFieldValueWithOptions>;
3009
3109
  /**
3010
3110
  * Entity type: CustomField
@@ -3059,6 +3159,10 @@ export interface GetDiscountByIDResponse {
3059
3159
  OrganizationUnitSetType?: DataModelsOrganizationUnitSetTypes;
3060
3160
  PromotionLabel?: string;
3061
3161
  /**
3162
+ * Entity type: CustomField
3163
+ */
3164
+ RequiredCustomFields?: string[];
3165
+ /**
3062
3166
  * Entity type: OrganizationUnit
3063
3167
  */
3064
3168
  RestitutionOrganizationUnitID?: string;
@@ -3075,6 +3179,9 @@ export interface GetDiscountByIDResponse {
3075
3179
  }
3076
3180
  export interface DiscountsGetDiscountByIDResponse_DiscountCondition {
3077
3181
  Data?: IConditionData;
3182
+ /**
3183
+ * Entity type: DiscountCondition
3184
+ */
3078
3185
  ID: string;
3079
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';
3080
3187
  UseAsActionCondition: boolean;
@@ -3454,6 +3561,9 @@ export interface ListDiscountLayersResponse {
3454
3561
  }
3455
3562
  export interface DiscountsListDiscountLayersResponse_DiscountLayerDto {
3456
3563
  Description?: string;
3564
+ /**
3565
+ * Entity type: DiscountLayer
3566
+ */
3457
3567
  ID: string;
3458
3568
  IsExclusive: boolean;
3459
3569
  /**
@@ -3548,6 +3658,55 @@ export interface MoveDiscountLayer {
3548
3658
  ID: string;
3549
3659
  }
3550
3660
  /**
3661
+ * Push a DiscountCoupon
3662
+ */
3663
+ export interface PushDiscountCoupons {
3664
+ Coupons?: DiscountsPushDiscountCoupons_PushedCoupon[];
3665
+ /**
3666
+ * Entity type: Discount
3667
+ */
3668
+ DiscountID?: string;
3669
+ }
3670
+ export interface DiscountsPushDiscountCoupons_PushedCoupon {
3671
+ CouponCode?: string;
3672
+ IsActive?: boolean;
3673
+ MaximumUsage?: number;
3674
+ /**
3675
+ * Entity type: Order
3676
+ */
3677
+ OrderID?: string;
3678
+ /**
3679
+ * Entity type: User
3680
+ */
3681
+ UserID?: string;
3682
+ }
3683
+ export interface PushDiscountCouponsResponse {
3684
+ CreatedCoupons?: DiscountsPushDiscountCouponsResponse_CreatedCoupon[];
3685
+ Error?: ServiceError;
3686
+ Metadata?: ResponseMessageMetadata;
3687
+ }
3688
+ export interface DiscountsPushDiscountCouponsResponse_CreatedCoupon {
3689
+ /**
3690
+ * Entity type: DiscountCoupon
3691
+ */
3692
+ ID: string;
3693
+ IsDuplicateCoupon: boolean;
3694
+ }
3695
+ /**
3696
+ * Remove required custom fields from ManualDiscount
3697
+ */
3698
+ export interface RemoveRequiredCustomFieldsFromManualDiscount {
3699
+ /**
3700
+ * Entity type: CustomField
3701
+ */
3702
+ CustomFieldIDs?: string[];
3703
+ /**
3704
+ * Entity type: Discount
3705
+ */
3706
+ DiscountID: string;
3707
+ RemoveAllRequiredCustomFields?: boolean;
3708
+ }
3709
+ /**
3551
3710
  * Remove security roles from ManualDiscount
3552
3711
  */
3553
3712
  export interface RemoveRolesFromManualDiscount {
@@ -3632,6 +3791,15 @@ export interface DiscountsSearchDiscountsByQueryResponse_DiscountDto {
3632
3791
  UserUsageReloadStrategy?: string;
3633
3792
  }
3634
3793
  /**
3794
+ * Takes in all discount layers and sets their sequences. All layers except the system layer are required.
3795
+ */
3796
+ export interface SetDiscountLayerSequences {
3797
+ /**
3798
+ * Entity type: DiscountLayer
3799
+ */
3800
+ Layers: string[];
3801
+ }
3802
+ /**
3635
3803
  * Update an existing discount
3636
3804
  */
3637
3805
  export interface UpdateDiscount {
@@ -3645,10 +3813,10 @@ export interface UpdateDiscount {
3645
3813
  */
3646
3814
  CampaignID?: string;
3647
3815
  CannotApplyToOwnOrder?: boolean;
3648
- CompliancyRule: DataModelsDiscountCompliancyRule;
3649
- ConditionType: DataModelsDiscountConditionTypes;
3816
+ CompliancyRule?: DataModelsDiscountCompliancyRule;
3817
+ ConditionType?: DataModelsDiscountConditionTypes;
3650
3818
  Conditions?: DiscountsUpdateDiscount_DiscountConditionDto[];
3651
- CouponHandler: string | null | undefined;
3819
+ CouponHandler?: string | null;
3652
3820
  CouponsGeneratedByOtherDiscount?: boolean;
3653
3821
  /**
3654
3822
  * Entity type: Currency
@@ -3657,7 +3825,7 @@ export interface UpdateDiscount {
3657
3825
  /**
3658
3826
  * Optional additional custom fields
3659
3827
  */
3660
- CustomFields: DataModelsCustomFieldKeyValue[] | null | undefined;
3828
+ CustomFields?: DataModelsCustomFieldKeyValue[] | null;
3661
3829
  /**
3662
3830
  * Entity type: CustomField
3663
3831
  */
@@ -3665,10 +3833,10 @@ export interface UpdateDiscount {
3665
3833
  DaysApplicable?: DaysOfWeek;
3666
3834
  DeactivateWhenBudgetReached?: boolean;
3667
3835
  Description: string;
3668
- DiscountOrderType: DataModelsDiscountOrderTypes;
3836
+ DiscountOrderType?: DataModelsDiscountOrderTypes;
3669
3837
  Enable?: boolean;
3670
3838
  EndDate?: string;
3671
- FinancialDispersion: DataModelsFinancialDespersionType;
3839
+ FinancialDispersion?: DataModelsFinancialDespersionType;
3672
3840
  /**
3673
3841
  * Entity type: Discount
3674
3842
  */
@@ -3698,12 +3866,20 @@ export interface UpdateDiscount {
3698
3866
  OrganizationUnitSetID: string;
3699
3867
  PromotionLabel?: string;
3700
3868
  /**
3869
+ * Entity type: CustomField
3870
+ * For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
3871
+ */
3872
+ RequiredCustomFields?: string[] | null;
3873
+ /**
3701
3874
  * Entity type: OrganizationUnit
3702
3875
  */
3703
3876
  RestitutionOrganizationUnitID?: string;
3877
+ /**
3878
+ * Entity type: Role
3879
+ */
3704
3880
  RoleIDs?: string[];
3705
3881
  StartDate?: string;
3706
- Trigger: DataModelsDiscountTriggers;
3882
+ Trigger?: DataModelsDiscountTriggers;
3707
3883
  UserUsageLimit?: number;
3708
3884
  UserUsageReloadStrategy?: string;
3709
3885
  }
@@ -3719,21 +3895,21 @@ export interface DiscountsUpdateDiscount_DiscountConditionDto {
3719
3895
  * Update an existing DiscountCampaign
3720
3896
  */
3721
3897
  export interface UpdateDiscountCampaign {
3722
- BackendID: string | null | undefined;
3723
- BackendSystemID: string | null | undefined;
3898
+ BackendID?: string | null;
3899
+ BackendSystemID?: string | null;
3724
3900
  /**
3725
3901
  * Entity type: Currency
3726
3902
  */
3727
- CurrencyID: string | null | undefined;
3728
- Description: string | null | undefined;
3729
- EndDate: string | null | undefined;
3903
+ CurrencyID?: string | null;
3904
+ Description?: string | null;
3905
+ EndDate?: string | null;
3730
3906
  /**
3731
3907
  * Entity type: DiscountCampaign
3732
3908
  */
3733
3909
  ID: string;
3734
3910
  KeepDiscountsWithinCampaignTimespan?: boolean;
3735
- Name: string | null | undefined;
3736
- StartDate: string | null | undefined;
3911
+ Name?: string | null;
3912
+ StartDate?: string | null;
3737
3913
  }
3738
3914
  /**
3739
3915
  * Update the budget on the discount campaign.
@@ -3745,7 +3921,7 @@ export interface UpdateDiscountCampaignBudget {
3745
3921
  /**
3746
3922
  * Entity type: Currency
3747
3923
  */
3748
- CurrencyID: string | null | undefined;
3924
+ CurrencyID?: string | null;
3749
3925
  DeactivateDiscountsWhenBudgetIsReached?: boolean;
3750
3926
  /**
3751
3927
  * Entity type: DiscountCampaign
@@ -3757,7 +3933,7 @@ export interface UpdateDiscountCampaignBudget {
3757
3933
  * Update an existing DiscountCoupon
3758
3934
  */
3759
3935
  export interface UpdateDiscountCoupon {
3760
- CouponCode: string;
3936
+ CouponCode?: string;
3761
3937
  /**
3762
3938
  * Entity type: DiscountCoupon
3763
3939
  */
@@ -3789,18 +3965,18 @@ export interface UpdateDiscountLayer {
3789
3965
  export interface UpdateDiscountTemplate {
3790
3966
  ActionData: DiscountsIDiscountActionData;
3791
3967
  ActionType: 'V2:DISCOUNTAMOUNT' | 'V2:CUSTOMERAGE' | 'V2:TIEREDCUSTOMERAGE' | 'V2:GENERATEDISCOUNTCOUPON' | 'V2:GETAPRODUCT' | 'V2:LOYALTYTIEREDDISCOUNTAMOUNT' | 'V2:LOYALTYTIEREDDISCOUNTPERCENTAGE' | 'V2:ORDERTIEREDDISCOUNTAMOUNT' | 'V2:ORDERTIEREDDISCOUNTPERCENTAGE' | 'V2:ORIGINATINGORDERDISCOUNT' | 'V2:OTHERCOSTS' | 'V2:DISCOUNTPERCENTAGE' | 'V2:TIEREDPICKAPRODUCT' | 'V2:PRODUCTAMOUNTTIEREDDISCOUNTAMOUNT' | 'V2:PRODUCTAMOUNTTIEREDDISCOUNTPERCENTAGE' | 'V2:PRODUCTQUANTITYTIEREDDISCOUNTAMOUNT' | 'V2:PRODUCTQUANTITYTIEREDDISCOUNTPERCENTAGE' | 'V2:PRODUCTSETDISCOUNTAMOUNT' | 'V2:PRODUCTSETFIXEDPRICE' | 'V2:PRODUCTSETFREEPRODUCT' | 'V2:PRODUCTSETDISCOUNTPERCENTAGE' | 'V2:CUSTOMFIELDVALUEDETERMINEDDISCOUNT' | 'DEFAULT' | 'RITUALSEMPLOYEE' | 'V2:RITUALSEMPLOYEE';
3792
- AppliesTo: DataModelsDiscountAppliesTo;
3968
+ AppliesTo?: DataModelsDiscountAppliesTo;
3793
3969
  BackendID?: string;
3794
3970
  /**
3795
3971
  * Entity type: DiscountCampaign
3796
3972
  */
3797
3973
  CampaignID?: string;
3798
- ConditionType: DataModelsDiscountConditionTypes;
3974
+ ConditionType?: DataModelsDiscountConditionTypes;
3799
3975
  Conditions?: DiscountsUpdateDiscountTemplate_Condition[];
3800
3976
  CouponHandler?: string;
3801
3977
  CouponsGeneratedByOtherDiscount?: boolean;
3802
3978
  Description: string;
3803
- DiscountOrderType: DataModelsDiscountOrderTypes;
3979
+ DiscountOrderType?: DataModelsDiscountOrderTypes;
3804
3980
  /**
3805
3981
  * Entity type: DiscountTemplate
3806
3982
  */
@@ -3820,7 +3996,7 @@ export interface UpdateDiscountTemplate {
3820
3996
  * Entity type: OrganizationUnit
3821
3997
  */
3822
3998
  RestitutionOrganizationUnitID?: string;
3823
- Trigger: DataModelsDiscountTriggers;
3999
+ Trigger?: DataModelsDiscountTriggers;
3824
4000
  UserUsageLimit?: number;
3825
4001
  UserUsageReloadStrategy?: string;
3826
4002
  }
@@ -3877,8 +4053,8 @@ export interface ValidateDiscount {
3877
4053
  ActionType?: 'V2:DISCOUNTAMOUNT' | 'V2:CUSTOMERAGE' | 'V2:TIEREDCUSTOMERAGE' | 'V2:GENERATEDISCOUNTCOUPON' | 'V2:GETAPRODUCT' | 'V2:LOYALTYTIEREDDISCOUNTAMOUNT' | 'V2:LOYALTYTIEREDDISCOUNTPERCENTAGE' | 'V2:ORDERTIEREDDISCOUNTAMOUNT' | 'V2:ORDERTIEREDDISCOUNTPERCENTAGE' | 'V2:ORIGINATINGORDERDISCOUNT' | 'V2:OTHERCOSTS' | 'V2:DISCOUNTPERCENTAGE' | 'V2:TIEREDPICKAPRODUCT' | 'V2:PRODUCTAMOUNTTIEREDDISCOUNTAMOUNT' | 'V2:PRODUCTAMOUNTTIEREDDISCOUNTPERCENTAGE' | 'V2:PRODUCTQUANTITYTIEREDDISCOUNTAMOUNT' | 'V2:PRODUCTQUANTITYTIEREDDISCOUNTPERCENTAGE' | 'V2:PRODUCTSETDISCOUNTAMOUNT' | 'V2:PRODUCTSETFIXEDPRICE' | 'V2:PRODUCTSETFREEPRODUCT' | 'V2:PRODUCTSETDISCOUNTPERCENTAGE' | 'V2:CUSTOMFIELDVALUEDETERMINEDDISCOUNT' | 'DEFAULT' | 'RITUALSEMPLOYEE' | 'V2:RITUALSEMPLOYEE';
3878
4054
  AppliesTo?: DataModelsDiscountAppliesTo;
3879
4055
  BackendID?: string;
3880
- CompliancyRule: DataModelsDiscountCompliancyRule;
3881
- ConditionType: DataModelsDiscountConditionTypes;
4056
+ CompliancyRule?: DataModelsDiscountCompliancyRule;
4057
+ ConditionType?: DataModelsDiscountConditionTypes;
3882
4058
  Conditions?: DiscountsValidateDiscount_DiscountConditionDto[];
3883
4059
  CouponHandler?: string;
3884
4060
  CouponsGeneratedByOtherDiscount?: boolean;
@@ -3896,9 +4072,9 @@ export interface ValidateDiscount {
3896
4072
  CustomUserUsageLimitFieldID?: string;
3897
4073
  DaysApplicable?: DaysOfWeek;
3898
4074
  Description?: string;
3899
- DiscountOrderType: DataModelsDiscountOrderTypes;
4075
+ DiscountOrderType?: DataModelsDiscountOrderTypes;
3900
4076
  EndDate?: string;
3901
- FinancialDispersion: DataModelsFinancialDespersionType;
4077
+ FinancialDispersion?: DataModelsFinancialDespersionType;
3902
4078
  /**
3903
4079
  * Entity type: Discount
3904
4080
  */
@@ -3927,11 +4103,16 @@ export interface ValidateDiscount {
3927
4103
  */
3928
4104
  OrganizationUnitSetID: string;
3929
4105
  /**
4106
+ * Entity type: CustomField
4107
+ * For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
4108
+ */
4109
+ RequiredCustomFields?: string[];
4110
+ /**
3930
4111
  * Entity type: OrganizationUnit
3931
4112
  */
3932
4113
  RestitutionOrganizationUnitID?: string;
3933
4114
  StartDate: string;
3934
- Trigger: DataModelsDiscountTriggers;
4115
+ Trigger?: DataModelsDiscountTriggers;
3935
4116
  }
3936
4117
  export interface DiscountsValidateDiscount_DiscountConditionDto {
3937
4118
  Data?: IConditionData;
@@ -3940,6 +4121,9 @@ export interface DiscountsValidateDiscount_DiscountConditionDto {
3940
4121
  }
3941
4122
  export interface ValidateDiscountResponse {
3942
4123
  ActionMessages?: string[];
4124
+ /**
4125
+ * Entity type: DiscountCondition
4126
+ */
3943
4127
  ConditionMessages?: Record<string, string[] | null>;
3944
4128
  CustomFieldMessages?: DiscountsValidateDiscountResponse_CustomFieldMessage;
3945
4129
  Error?: ServiceError;
@@ -3957,14 +4141,14 @@ export interface DiscountsValidateDiscountResponse_CustomFieldMessage {
3957
4141
  export interface ValidateDiscountTemplate {
3958
4142
  ActionData: DiscountsIDiscountActionData;
3959
4143
  ActionType: 'V2:DISCOUNTAMOUNT' | 'V2:CUSTOMERAGE' | 'V2:TIEREDCUSTOMERAGE' | 'V2:GENERATEDISCOUNTCOUPON' | 'V2:GETAPRODUCT' | 'V2:LOYALTYTIEREDDISCOUNTAMOUNT' | 'V2:LOYALTYTIEREDDISCOUNTPERCENTAGE' | 'V2:ORDERTIEREDDISCOUNTAMOUNT' | 'V2:ORDERTIEREDDISCOUNTPERCENTAGE' | 'V2:ORIGINATINGORDERDISCOUNT' | 'V2:OTHERCOSTS' | 'V2:DISCOUNTPERCENTAGE' | 'V2:TIEREDPICKAPRODUCT' | 'V2:PRODUCTAMOUNTTIEREDDISCOUNTAMOUNT' | 'V2:PRODUCTAMOUNTTIEREDDISCOUNTPERCENTAGE' | 'V2:PRODUCTQUANTITYTIEREDDISCOUNTAMOUNT' | 'V2:PRODUCTQUANTITYTIEREDDISCOUNTPERCENTAGE' | 'V2:PRODUCTSETDISCOUNTAMOUNT' | 'V2:PRODUCTSETFIXEDPRICE' | 'V2:PRODUCTSETFREEPRODUCT' | 'V2:PRODUCTSETDISCOUNTPERCENTAGE' | 'V2:CUSTOMFIELDVALUEDETERMINEDDISCOUNT' | 'DEFAULT' | 'RITUALSEMPLOYEE' | 'V2:RITUALSEMPLOYEE';
3960
- AppliesTo: DataModelsDiscountAppliesTo;
4144
+ AppliesTo?: DataModelsDiscountAppliesTo;
3961
4145
  BackendID?: string;
3962
- ConditionType: DataModelsDiscountConditionTypes;
4146
+ ConditionType?: DataModelsDiscountConditionTypes;
3963
4147
  Conditions?: DiscountsValidateDiscountTemplate_Condition[];
3964
4148
  CouponHandler?: string;
3965
4149
  CouponsGeneratedByOtherDiscount?: boolean;
3966
4150
  Description: string;
3967
- DiscountOrderType: DataModelsDiscountOrderTypes;
4151
+ DiscountOrderType?: DataModelsDiscountOrderTypes;
3968
4152
  IsExclusive?: boolean;
3969
4153
  /**
3970
4154
  * Entity type: LedgerClass
@@ -3978,7 +4162,7 @@ export interface ValidateDiscountTemplate {
3978
4162
  * Entity type: OrganizationUnit
3979
4163
  */
3980
4164
  RestitutionOrganizationUnitID?: string;
3981
- Trigger: DataModelsDiscountTriggers;
4165
+ Trigger?: DataModelsDiscountTriggers;
3982
4166
  UserUsageLimit?: number;
3983
4167
  UserUsageReloadStrategy?: string;
3984
4168
  }
@@ -4015,17 +4199,20 @@ export interface VerifyDiscount {
4015
4199
  * Create a new entity field validator
4016
4200
  */
4017
4201
  export interface CreateEntityFieldValidator {
4018
- ApplyFor: DataModelsEntityFieldValidatorUserTypes;
4019
- Entity: DataModelsEntityFieldValidatorEntityTypes;
4202
+ ApplyFor?: DataModelsEntityFieldValidatorUserTypes;
4203
+ Entity?: DataModelsEntityFieldValidatorEntityTypes;
4020
4204
  EntityFieldName: string;
4021
4205
  /**
4022
4206
  * This must be of object that inherits the class EntityFieldValidatorBase. For example StringEntityFieldValidator or DefaultEntityFieldValidator
4023
4207
  */
4024
4208
  ValidatorData: EntityFieldValidatorsValidatorsEntityFieldValidatorBase;
4025
- ValidatorType: DataModelsEntityFieldValidatorType;
4209
+ ValidatorType?: DataModelsEntityFieldValidatorType;
4026
4210
  }
4027
4211
  export interface CreateEntityFieldValidatorResponse {
4028
4212
  Error?: ServiceError;
4213
+ /**
4214
+ * Entity type: EntityFieldValidator
4215
+ */
4029
4216
  ID: string;
4030
4217
  Metadata?: ResponseMessageMetadata;
4031
4218
  }
@@ -4090,6 +4277,9 @@ export interface EntityFieldValidatorsListEntityFieldValidatorsResponse_ListEnti
4090
4277
  ApplyFor: DataModelsEntityFieldValidatorUserTypes;
4091
4278
  Entity: DataModelsEntityFieldValidatorEntityTypes;
4092
4279
  EntityFieldName?: string;
4280
+ /**
4281
+ * Entity type: EntityFieldValidator
4282
+ */
4093
4283
  ID: string;
4094
4284
  ValidatorData?: EntityFieldValidatorsValidatorsEntityFieldValidatorBase;
4095
4285
  ValidatorType: DataModelsEntityFieldValidatorType;
@@ -4103,7 +4293,7 @@ export interface UpdateEntityFieldValidator {
4103
4293
  * Entity type: EntityFieldValidator
4104
4294
  */
4105
4295
  ID: string;
4106
- ValidatorData: EntityFieldValidatorsValidatorsEntityFieldValidatorBase | null | undefined;
4296
+ ValidatorData?: EntityFieldValidatorsValidatorsEntityFieldValidatorBase | null;
4107
4297
  }
4108
4298
  /**
4109
4299
  * -
@@ -4186,7 +4376,7 @@ export interface FinanceCashExpenseTypeOrganizationUnitSet {
4186
4376
  * An example of this might be tips left by a customer.
4187
4377
  */
4188
4378
  export interface CreateCashExpenseType {
4189
- AmountType: DataModelsCashExpenseAmountTypes;
4379
+ AmountType?: DataModelsCashExpenseAmountTypes;
4190
4380
  BackendID?: string;
4191
4381
  Description?: string;
4192
4382
  LedgerClassID?: string;
@@ -4329,7 +4519,7 @@ export interface FinanceListExchangeRatesResponse_ExchangeRateDto {
4329
4519
  * Updates a cash expense type. All properties except for its Name can be updated.
4330
4520
  */
4331
4521
  export interface UpdateCashExpenseType {
4332
- AmountType: DataModelsCashExpenseAmountTypes;
4522
+ AmountType?: DataModelsCashExpenseAmountTypes;
4333
4523
  BackendID?: string;
4334
4524
  Description?: string;
4335
4525
  /**
@@ -4361,7 +4551,7 @@ export interface CreateGiftCardConfiguration {
4361
4551
  Data?: TAnyValue;
4362
4552
  Handler: string;
4363
4553
  Name: string;
4364
- UsageType: GiftCardsConfigurationGiftCardConfigurationUsageTypes;
4554
+ UsageType?: GiftCardsConfigurationGiftCardConfigurationUsageTypes;
4365
4555
  }
4366
4556
  export interface CreateGiftCardConfigurationResponse {
4367
4557
  Error?: ServiceError;
@@ -4483,6 +4673,10 @@ export interface GiftCardsListGiftCardConfigurationsResponse_GiftCardConfigurati
4483
4673
  * `ProductGiftCard`: an item that describes the giftcard properties of a product with type GiftCard
4484
4674
  */
4485
4675
  export interface ListProductGiftCards {
4676
+ /**
4677
+ * Entity type: ProductPropertyType
4678
+ */
4679
+ IncludedProductProperties?: string[];
4486
4680
  PageConfig?: PageConfig<GiftCardsListProductGiftCardsFilter>;
4487
4681
  }
4488
4682
  export interface ListProductGiftCardsResponse {
@@ -4505,6 +4699,7 @@ export interface GiftCardsListProductGiftCardsResponse_ProductGiftCardDto {
4505
4699
  */
4506
4700
  ID: string;
4507
4701
  IsDigital: boolean;
4702
+ Product?: SearchIProductSearchItem;
4508
4703
  /**
4509
4704
  * Entity type: Product
4510
4705
  */
@@ -4521,8 +4716,8 @@ export interface UpdateGiftCardConfiguration {
4521
4716
  /**
4522
4717
  * Some gift card handlers are able to handle multiple types of cards. With this property you can set the card the handler should work with.
4523
4718
  */
4524
- CardType: string | null | undefined;
4525
- Data: TAnyValue | null | undefined;
4719
+ CardType?: string | null;
4720
+ Data?: TAnyValue | null;
4526
4721
  Handler?: string;
4527
4722
  /**
4528
4723
  * Entity type: GiftCardConfiguration
@@ -4538,11 +4733,11 @@ export interface UpdateProductGiftCard {
4538
4733
  /**
4539
4734
  * Communication options for digital giftcards
4540
4735
  */
4541
- CommunicationOptions: GiftCardsConfigurationProductGiftCardCommunicationOptions | undefined;
4736
+ CommunicationOptions?: GiftCardsConfigurationProductGiftCardCommunicationOptions;
4542
4737
  /**
4543
4738
  * Entity type: GiftCardConfiguration
4544
4739
  */
4545
- GiftCardConfigurationID: string | null | undefined;
4740
+ GiftCardConfigurationID?: string | null;
4546
4741
  /**
4547
4742
  * Entity type: ProductGiftCard
4548
4743
  */
@@ -4563,7 +4758,7 @@ export interface CreateClientApplication {
4563
4758
  BackendID: string;
4564
4759
  Name: string;
4565
4760
  NotificationConfiguration?: string;
4566
- Type: DataModelsClientApplicationType;
4761
+ Type?: DataModelsClientApplicationType;
4567
4762
  }
4568
4763
  export interface CreateClientApplicationResponse {
4569
4764
  Error?: ServiceError;
@@ -4596,6 +4791,14 @@ export interface CreateDevice {
4596
4791
  StationID?: string;
4597
4792
  TypeID: string;
4598
4793
  }
4794
+ export interface CreateDeviceResponse {
4795
+ Error?: ServiceError;
4796
+ /**
4797
+ * Entity type: Device
4798
+ */
4799
+ ID: string;
4800
+ Metadata?: ResponseMessageMetadata;
4801
+ }
4599
4802
  /**
4600
4803
  * Creates a new OpenCashDrawerReason. Name and Description can both be localized through the LocalizeOpenCashDrawerReason service later.
4601
4804
  */
@@ -4634,6 +4837,14 @@ export interface CreateStation {
4634
4837
  */
4635
4838
  OrganizationUnitID: string;
4636
4839
  }
4840
+ export interface CreateStationResponse {
4841
+ Error?: ServiceError;
4842
+ /**
4843
+ * Entity type: Station
4844
+ */
4845
+ ID: string;
4846
+ Metadata?: ResponseMessageMetadata;
4847
+ }
4637
4848
  /**
4638
4849
  * Delete a ClientApplication
4639
4850
  */
@@ -4816,17 +5027,17 @@ export interface UpdateClientApplication {
4816
5027
  */
4817
5028
  ID: string;
4818
5029
  Name?: string;
4819
- NotificationConfiguration: string | null | undefined;
5030
+ NotificationConfiguration?: string | null;
4820
5031
  Type?: DataModelsClientApplicationType;
4821
5032
  }
4822
5033
  /**
4823
5034
  * Updates a device
4824
5035
  */
4825
5036
  export interface UpdateDevice {
4826
- Address: string | null | undefined;
4827
- AssemblyName: string | null | undefined;
4828
- BackendID: string | null | undefined;
4829
- Data: DevicesIDeviceTypeData | null | undefined;
5037
+ Address?: string | null;
5038
+ AssemblyName?: string | null;
5039
+ BackendID?: string | null;
5040
+ Data?: DevicesIDeviceTypeData | null;
4830
5041
  /**
4831
5042
  * Entity type: Device
4832
5043
  */
@@ -4835,15 +5046,15 @@ export interface UpdateDevice {
4835
5046
  /**
4836
5047
  * Entity type: OrganizationUnit
4837
5048
  */
4838
- OrganizationUnitID: string | null | undefined;
5049
+ OrganizationUnitID?: string | null;
4839
5050
  /**
4840
5051
  * Entity type: PrinterType
4841
5052
  */
4842
- PrinterTypeID: string | null | undefined;
5053
+ PrinterTypeID?: string | null;
4843
5054
  /**
4844
5055
  * Entity type: Station
4845
5056
  */
4846
- StationID: string | null | undefined;
5057
+ StationID?: string | null;
4847
5058
  TypeID?: string;
4848
5059
  }
4849
5060
  /**
@@ -4858,24 +5069,14 @@ export interface UpdateOpenCashDrawerReason {
4858
5069
  Name: string;
4859
5070
  }
4860
5071
  /**
4861
- * Update the Public IpAddress of an OrganizationUnit, identified by it's ID, if changed
4862
- */
4863
- export interface UpdateOrganizationUnitPublicIpAddress {
4864
- /**
4865
- * Entity type: OrganizationUnit
4866
- */
4867
- OrganizationUnitID: string;
4868
- PublicIpAddress: string;
4869
- }
4870
- /**
4871
5072
  * Updates a station.
4872
5073
  */
4873
5074
  export interface UpdateStation {
4874
- BackendID: string | null | undefined;
5075
+ BackendID?: string | null;
4875
5076
  /**
4876
5077
  * Optional additional custom fields
4877
5078
  */
4878
- CustomFields: DataModelsCustomFieldKeyValue[] | null | undefined;
5079
+ CustomFields?: DataModelsCustomFieldKeyValue[] | null;
4879
5080
  /**
4880
5081
  * Entity type: Station
4881
5082
  */
@@ -4891,6 +5092,9 @@ export interface CreateInquiry {
4891
5092
  Name: string;
4892
5093
  OneTimeUseOnly?: boolean;
4893
5094
  PromptUser?: boolean;
5095
+ /**
5096
+ * Entity type: Script
5097
+ */
4894
5098
  ScriptID?: string;
4895
5099
  }
4896
5100
  export interface InquiriesCreateInquiry_ItemData {
@@ -4980,7 +5184,7 @@ export interface ListInquiriesResponse {
4980
5184
  * Update an inquiry
4981
5185
  */
4982
5186
  export interface UpdateInquiry {
4983
- Description: string | null | undefined;
5187
+ Description?: string | null;
4984
5188
  /**
4985
5189
  * Entity type: Inquiry
4986
5190
  */
@@ -4988,13 +5192,13 @@ export interface UpdateInquiry {
4988
5192
  Name?: string;
4989
5193
  OneTimeUseOnly?: boolean;
4990
5194
  PromptUser?: boolean;
4991
- ScriptID: string | null | undefined;
5195
+ ScriptID?: string | null;
4992
5196
  }
4993
5197
  /**
4994
5198
  * Updates an inquiry item
4995
5199
  */
4996
5200
  export interface UpdateInquiryItem {
4997
- Description: string | null | undefined;
5201
+ Description?: string | null;
4998
5202
  /**
4999
5203
  * Entity type: InquiryItem
5000
5204
  */
@@ -5027,6 +5231,19 @@ export interface AddLoyaltyProgramPriceList {
5027
5231
  PriceListID: string;
5028
5232
  }
5029
5233
  /**
5234
+ * Add a custom field requirement to the loyalty program. NOTE THAT a custom field can only be set once as a requirement.
5235
+ */
5236
+ export interface AddLoyaltyProgramRequiredCustomField {
5237
+ /**
5238
+ * Entity type: CustomField
5239
+ */
5240
+ CustomFieldID: string;
5241
+ /**
5242
+ * Entity type: LoyaltyProgram
5243
+ */
5244
+ LoyaltyProgramID: string;
5245
+ }
5246
+ /**
5030
5247
  * Archive a point awarding rule
5031
5248
  */
5032
5249
  export interface ArchivePointAwardingRule {
@@ -5036,20 +5253,7 @@ export interface ArchivePointAwardingRule {
5036
5253
  ID: string;
5037
5254
  }
5038
5255
  /**
5039
- * Attach a product limitation to a payment type.
5040
- */
5041
- export interface AttachLoyaltyProgramProductLimitationToPaymentType {
5042
- /**
5043
- * Entity type: LoyaltyProgramPaymentType
5044
- */
5045
- LoyaltyProgramPaymentTypeID: string;
5046
- /**
5047
- * Entity type: LoyaltyProgramProductLimitation
5048
- */
5049
- LoyaltyProgramProductLimitationID: string;
5050
- }
5051
- /**
5052
- * Attach a loyalty program to an order
5256
+ * Attach a loyalty program to an order
5053
5257
  */
5054
5258
  export interface AttachLoyaltyProgramToOrder {
5055
5259
  /**
@@ -5064,6 +5268,9 @@ export interface AttachLoyaltyProgramToOrder {
5064
5268
  * Entity type: User
5065
5269
  */
5066
5270
  UserID?: string;
5271
+ /**
5272
+ * When set, the UserID will also become required so we can verify the UserIdentifier.
5273
+ */
5067
5274
  UserIdentifier?: string;
5068
5275
  }
5069
5276
  /**
@@ -5074,10 +5281,6 @@ export interface CreateLoyaltyProgram {
5074
5281
  * Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
5075
5282
  */
5076
5283
  AllowUnsubscribeBy?: DataModelsAllowUnsubscribeByType;
5077
- /**
5078
- * When true, the loyalty program will not automatically be applied to the order when a customer is attached and all conditions are met.
5079
- * When false, the loyalty program will automatically be applied if all conditions are met.
5080
- */
5081
5284
  ApplyManuallyOnly?: boolean;
5082
5285
  /**
5083
5286
  * When true, if a non anonymous customer is attached to the order they will be automatically subscribed on finishing the order.
@@ -5096,9 +5299,12 @@ export interface CreateLoyaltyProgram {
5096
5299
  EndDate?: string;
5097
5300
  Handler: string;
5098
5301
  LoyaltyPointUsageOptions?: DataModelsLoyaltyPointUsageOptions;
5302
+ /**
5303
+ * Entity type: LoyaltyProgramGroup
5304
+ */
5099
5305
  LoyaltyProgramGroupID?: string;
5100
5306
  Name: string;
5101
- Options: DataModelsLoyaltyProgramOptions;
5307
+ Options?: DataModelsLoyaltyProgramOptions;
5102
5308
  PointExpirationPolicyData?: Record<string, TAnyValue>;
5103
5309
  PointExpirationPolicyType?: string;
5104
5310
  PointPendingPolicyData?: Record<string, TAnyValue>;
@@ -5136,7 +5342,7 @@ export interface CreateLoyaltyProgram {
5136
5342
  */
5137
5343
  ResubscribeHandling?: DataModelsResubscribeHandlingType;
5138
5344
  StartDate?: string;
5139
- Status: DataModelsLoyaltyProgramStatus;
5345
+ Status?: DataModelsLoyaltyProgramStatus;
5140
5346
  UserBudget?: number;
5141
5347
  /**
5142
5348
  * Attention!
@@ -5193,7 +5399,7 @@ export interface CreateLoyaltyProgramGroup {
5193
5399
  EndDate?: string;
5194
5400
  Name: string;
5195
5401
  StartDate?: string;
5196
- Status: DataModelsLoyaltyProgramStatus;
5402
+ Status?: DataModelsLoyaltyProgramStatus;
5197
5403
  TaxExemptionCode?: string;
5198
5404
  }
5199
5405
  export interface CreateLoyaltyProgramGroupResponse {
@@ -5208,6 +5414,7 @@ export interface CreateLoyaltyProgramGroupResponse {
5208
5414
  * Create a new LoyaltyProgramPaymentType
5209
5415
  */
5210
5416
  export interface CreateLoyaltyProgramPaymentType {
5417
+ AllowPartialPayment?: boolean;
5211
5418
  BackendID?: string;
5212
5419
  Budget?: number;
5213
5420
  ExcludeFromProgramBudget?: boolean;
@@ -5221,11 +5428,12 @@ export interface CreateLoyaltyProgramPaymentType {
5221
5428
  * Entity type: PaymentType
5222
5429
  */
5223
5430
  PaymentTypeID: string;
5431
+ ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
5224
5432
  Required?: boolean;
5225
5433
  Sequence?: number;
5226
- TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
5434
+ TaxHandling?: DataModelsLoyaltyPaymentTaxHandlingType;
5227
5435
  UserBudget?: number;
5228
- UserBudgetDeduction: DataModelsUserBudgetDeduction;
5436
+ UserBudgetDeduction?: DataModelsUserBudgetDeduction;
5229
5437
  UserMaximumUsage?: number;
5230
5438
  }
5231
5439
  export interface CreateLoyaltyProgramPaymentTypeResponse {
@@ -5264,6 +5472,10 @@ export interface CreateLoyaltyProgramResponse {
5264
5472
  */
5265
5473
  ID: string;
5266
5474
  Metadata?: ResponseMessageMetadata;
5475
+ /**
5476
+ * Entity type: Subscription
5477
+ */
5478
+ SubscriptionID: string;
5267
5479
  }
5268
5480
  /**
5269
5481
  * Create a point awarding rule.
@@ -5382,19 +5594,6 @@ export interface DetachLoyaltyProgramFromOrder {
5382
5594
  OrderID: string;
5383
5595
  }
5384
5596
  /**
5385
- * Detach a product limitation from a payment type.
5386
- */
5387
- export interface DetachLoyaltyProgramProductLimitationFromPaymentType {
5388
- /**
5389
- * Entity type: LoyaltyProgramPaymentType
5390
- */
5391
- LoyaltyProgramPaymentTypeID: string;
5392
- /**
5393
- * Entity type: LoyaltyProgramProductLimitation
5394
- */
5395
- LoyaltyProgramProductLimitationID: string;
5396
- }
5397
- /**
5398
5597
  * Disable a point awarding rule
5399
5598
  */
5400
5599
  export interface DisablePointAwardingRule {
@@ -5509,6 +5708,7 @@ export interface GetLoyaltyProgramPaymentType {
5509
5708
  ID: string;
5510
5709
  }
5511
5710
  export interface GetLoyaltyProgramPaymentTypeResponse {
5711
+ AllowPartialPayment: boolean;
5512
5712
  BackendID?: string;
5513
5713
  Budget?: number;
5514
5714
  BudgetRemaining?: number;
@@ -5531,6 +5731,7 @@ export interface GetLoyaltyProgramPaymentTypeResponse {
5531
5731
  */
5532
5732
  PaymentTypeID: string;
5533
5733
  PaymentTypeName?: string;
5734
+ ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
5534
5735
  Required: boolean;
5535
5736
  Sequence: number;
5536
5737
  TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
@@ -5567,8 +5768,7 @@ export interface GetLoyaltyProgramProductLimitationResponse {
5567
5768
  export interface GetLoyaltyProgramResponse {
5568
5769
  AllowUnsubscribeBy?: DataModelsAllowUnsubscribeByType;
5569
5770
  /**
5570
- * When true, the loyalty program will not automatically be applied to the order when a customer is attached and all conditions are met.
5571
- * When false, the loyalty program will automatically be applied if all conditions are met.
5771
+ * This property has been deprecated. A loyaltyprogram should always be manually applied.
5572
5772
  */
5573
5773
  ApplyManuallyOnly: boolean;
5574
5774
  /**
@@ -5646,6 +5846,78 @@ export interface GetLoyaltyProgramResponse {
5646
5846
  UserMaximumUsage?: number;
5647
5847
  }
5648
5848
  /**
5849
+ * Get the loyalty program user usage
5850
+ */
5851
+ export interface GetLoyaltyProgramUserUsage {
5852
+ /**
5853
+ * Entity type: ProductPropertyType
5854
+ */
5855
+ IncludedProductProperties?: string[];
5856
+ /**
5857
+ * Entity type: LoyaltyProgram
5858
+ */
5859
+ LoyaltyProgramID: string;
5860
+ /**
5861
+ * Entity type: User
5862
+ */
5863
+ UserID?: string;
5864
+ }
5865
+ export interface GetLoyaltyProgramUserUsageResponse {
5866
+ Error?: ServiceError;
5867
+ Metadata?: ResponseMessageMetadata;
5868
+ PaymentUsages?: LoyaltyGetLoyaltyProgramUserUsageResponse_PaymentUsage[];
5869
+ ProductUsages?: LoyaltyGetLoyaltyProgramUserUsageResponse_ProductUsage[];
5870
+ }
5871
+ export interface LoyaltyGetLoyaltyProgramUserUsageResponse_PaymentUsage {
5872
+ AmountUsage: number;
5873
+ /**
5874
+ * Entity type: LoyaltyProgramPaymentType
5875
+ */
5876
+ LoyaltyProgramPaymentTypeID: string;
5877
+ ProductUsage?: LoyaltyGetLoyaltyProgramUserUsageResponse_ProductUsage[];
5878
+ }
5879
+ export interface LoyaltyGetLoyaltyProgramUserUsageResponse_ProductUsage {
5880
+ ConsumedQuantity: number;
5881
+ PrimaryImage?: SearchIProductSearchItemPrimaryImage;
5882
+ /**
5883
+ * Entity type: Product
5884
+ */
5885
+ ProductBackendID?: string;
5886
+ /**
5887
+ * Entity type: Product
5888
+ */
5889
+ ProductID: string;
5890
+ ProductName?: string;
5891
+ }
5892
+ /**
5893
+ * Get the available loyalty program payment methods for the given order.
5894
+ */
5895
+ export interface GetOrderLoyaltyProgramPaymentTypes {
5896
+ /**
5897
+ * Entity type: Order
5898
+ */
5899
+ OrderID: string;
5900
+ }
5901
+ export interface GetOrderLoyaltyProgramPaymentTypesResponse {
5902
+ Error?: ServiceError;
5903
+ Metadata?: ResponseMessageMetadata;
5904
+ Options?: LoyaltyGetOrderLoyaltyProgramPaymentTypesResponse_Option[];
5905
+ }
5906
+ export interface LoyaltyGetOrderLoyaltyProgramPaymentTypesResponse_Option {
5907
+ BackendID?: string;
5908
+ /**
5909
+ * Entity type: LoyaltyProgramPaymentType
5910
+ */
5911
+ ID: string;
5912
+ /**
5913
+ * Entity type: PaymentType
5914
+ */
5915
+ PaymentTypeID: string;
5916
+ PaymentTypeName?: string;
5917
+ Required: boolean;
5918
+ Sequence: number;
5919
+ }
5920
+ /**
5649
5921
  * Get loyalty point rule.
5650
5922
  */
5651
5923
  export interface GetPointAwardingRule {
@@ -5792,6 +6064,7 @@ export interface ListLoyaltyProgramPaymentTypesResponse {
5792
6064
  Results?: LoyaltyListLoyaltyProgramPaymentTypesResponse_Item[];
5793
6065
  }
5794
6066
  export interface LoyaltyListLoyaltyProgramPaymentTypesResponse_Item {
6067
+ AllowPartialPayment: boolean;
5795
6068
  BackendID?: string;
5796
6069
  Budget?: number;
5797
6070
  ExcludeFromProgramBudget: boolean;
@@ -5862,10 +6135,50 @@ export interface LoyaltyListLoyaltyProgramProductLimitationsResponse_Item {
5862
6135
  */
5863
6136
  ID: string;
5864
6137
  Name?: string;
6138
+ /**
6139
+ * The quantity limit over the entire product limitation product set per order.
6140
+ */
6141
+ OverallQuantityLimitPerOrder?: number;
6142
+ /**
6143
+ * The quantity limit over the entire product limitation product set per user.
6144
+ */
6145
+ OverallQuantityLimitPerUser?: number;
6146
+ /**
6147
+ * The quantity limit per product within the product limitation product set per order.
6148
+ */
5865
6149
  QuantityLimitPerOrder?: number;
6150
+ /**
6151
+ * The quantity limit per product within the product limitation product set per user.
6152
+ */
5866
6153
  QuantityLimitPerUser?: number;
5867
6154
  }
5868
6155
  /**
6156
+ * List the loyalty program CustomFieldRequirements
6157
+ */
6158
+ export interface ListLoyaltyProgramRequiredCustomFields {
6159
+ InitialPageConfig?: PageTokenConfig<Record<string, string | null> | null>;
6160
+ /**
6161
+ * Entity type: LoyaltyProgram
6162
+ */
6163
+ LoyaltyProgramID: string;
6164
+ PageToken?: string;
6165
+ }
6166
+ export interface ListLoyaltyProgramRequiredCustomFieldsResponse {
6167
+ Error?: ServiceError;
6168
+ Metadata?: ResponseMessageMetadata;
6169
+ NextPageToken?: string;
6170
+ PreviousPageToken?: string;
6171
+ Results?: LoyaltyListLoyaltyProgramRequiredCustomFieldsResponse_CustomField[];
6172
+ }
6173
+ export interface LoyaltyListLoyaltyProgramRequiredCustomFieldsResponse_CustomField {
6174
+ BackendID?: string;
6175
+ /**
6176
+ * Entity type: CustomField
6177
+ */
6178
+ ID: string;
6179
+ Name?: string;
6180
+ }
6181
+ /**
5869
6182
  * List the LoyaltyPrograms
5870
6183
  */
5871
6184
  export interface ListLoyaltyPrograms {
@@ -5935,6 +6248,14 @@ export interface LoyaltyListPointAwardingRulesResponse_Rule {
5935
6248
  export interface LoyaltyLoyaltyProgramProductLimitationData {
5936
6249
  Filters?: Record<string, SearchFilterModel>;
5937
6250
  /**
6251
+ * The quantity limit over the entire product limitation product set per order.
6252
+ */
6253
+ OverallQuantityLimitPerOrder?: number;
6254
+ /**
6255
+ * The quantity limit over the entire product limitation product set per user.
6256
+ */
6257
+ OverallQuantityLimitPerUser?: number;
6258
+ /**
5938
6259
  * Entity type: Product
5939
6260
  */
5940
6261
  ProductIDs?: string[];
@@ -5942,21 +6263,25 @@ export interface LoyaltyLoyaltyProgramProductLimitationData {
5942
6263
  * Entity type: ProductSearchTemplate
5943
6264
  */
5944
6265
  ProductSearchID?: string;
6266
+ /**
6267
+ * The quantity limit per product within the product limitation product set per order.
6268
+ */
5945
6269
  QuantityLimitPerOrder?: number;
6270
+ /**
6271
+ * The quantity limit per product within the product limitation product set per user.
6272
+ */
5946
6273
  QuantityLimitPerUser?: number;
5947
6274
  }
5948
6275
  /**
5949
6276
  * Push a LoyaltyProgram.
6277
+ * If it doesn't exist it will be created, otherwise is will be updated.
6278
+ * Sub entities will also be created or updated, but will not be removed.
5950
6279
  */
5951
- export interface PushLoyaltyProgram {
6280
+ export interface LoyaltyPushLoyaltyProgram {
5952
6281
  /**
5953
6282
  * Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
5954
6283
  */
5955
6284
  AllowUnsubscribeBy?: DataModelsAllowUnsubscribeByType;
5956
- /**
5957
- * When true, the loyalty program will not automatically be applied to the order when a customer is attached and all conditions are met.
5958
- * When false, the loyalty program will automatically be applied if all conditions are met.
5959
- */
5960
6285
  ApplyManuallyOnly?: boolean;
5961
6286
  /**
5962
6287
  * When true, if a non anonymous customer is attached to the order they will be automatically subscribed on finishing the order.
@@ -5965,17 +6290,17 @@ export interface PushLoyaltyProgram {
5965
6290
  * This is ignore when`RequiresSubscribedCustomer` or `RequiresSubscriptionValidation` is set to true.
5966
6291
  */
5967
6292
  AutoSubscribeCustomer?: boolean;
5968
- Budget?: number;
6293
+ Budget?: number | null;
5969
6294
  /**
5970
6295
  * Entity type: Currency
5971
6296
  */
5972
- BudgetCurrencyID?: string;
6297
+ BudgetCurrencyID?: string | null;
5973
6298
  Conditions?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramCondition[];
5974
- Data?: TAnyValue;
6299
+ Data?: TAnyValue | null;
5975
6300
  DeactivateWhenBudgetIsReached?: boolean;
5976
- Description?: string;
5977
- EndDate?: string;
5978
- Handler: string;
6301
+ Description?: string | null;
6302
+ EndDate?: string | null;
6303
+ Handler?: string;
5979
6304
  /**
5980
6305
  * Entity type: LoyaltyProgram
5981
6306
  */
@@ -5984,23 +6309,23 @@ export interface PushLoyaltyProgram {
5984
6309
  /**
5985
6310
  * Entity type: LoyaltyProgramGroup
5986
6311
  */
5987
- LoyaltyProgramGroupID?: string;
5988
- Name: string;
5989
- Options: DataModelsLoyaltyProgramOptions;
6312
+ LoyaltyProgramGroupID?: string | null;
6313
+ Name?: string;
6314
+ Options?: DataModelsLoyaltyProgramOptions;
5990
6315
  OrganizationUnitSets?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramOrganizationUnitSet[];
5991
6316
  PaymentTypes?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType[];
5992
6317
  PointAwardingRules?: LoyaltyPushLoyaltyProgram_PushPointAwardingRule[];
5993
- PointExpirationPolicyData?: TAnyValue;
5994
- PointExpirationPolicyType?: string;
5995
- PointPendingPolicyData?: TAnyValue;
5996
- PointPendingPolicyType?: string;
6318
+ PointExpirationPolicyData?: Record<string, TAnyValue> | null;
6319
+ PointExpirationPolicyType?: string | null;
6320
+ PointPendingPolicyData?: Record<string, TAnyValue> | null;
6321
+ PointPendingPolicyType?: string | null;
5997
6322
  /**
5998
- * Entity type: LoyaltyProgramCondition
6323
+ * Entity type: PriceList
5999
6324
  */
6000
6325
  PriceLists?: string[];
6001
6326
  ProductLimitations?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation[];
6002
6327
  ReactivateProgramWhenPossible?: boolean;
6003
- ReloadPolicy?: string;
6328
+ ReloadPolicy?: string | null;
6004
6329
  /**
6005
6330
  * When true, the loyalty program will only be applied when a customer is attached to the order.
6006
6331
  *
@@ -6013,7 +6338,8 @@ export interface PushLoyaltyProgram {
6013
6338
  * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6014
6339
  * When this is not the case on create, this can be introduced on update. This value cannot be changed after it is set in either the create or update.
6015
6340
  */
6016
- RequireManualUserIdentifier?: boolean;
6341
+ RequireManualUserIdentifier?: boolean | null;
6342
+ RequiredCustomFields?: string[];
6017
6343
  /**
6018
6344
  * When true, the loyalty program will only be applied when a customer is attached to the order that is already subscribed to the loyalty program.
6019
6345
  * Also, this will make the `RequireCustomer` automatically true and `AutoSubscribeCustomer` false.
@@ -6032,31 +6358,31 @@ export interface PushLoyaltyProgram {
6032
6358
  * Handling when a user is unsubscribed and re-subscribes.
6033
6359
  */
6034
6360
  ResubscribeHandling?: DataModelsResubscribeHandlingType;
6035
- StartDate?: string;
6036
- Status: DataModelsLoyaltyProgramStatus;
6037
- UserBudget?: number;
6361
+ StartDate?: string | null;
6362
+ Status?: DataModelsLoyaltyProgramStatus;
6363
+ UserBudget?: number | null;
6038
6364
  /**
6039
6365
  * Attention!
6040
6366
  * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6041
6367
  * When this is not the case on create, this can be introduced on update. This value cannot be changed after it is set in either the create or update.
6042
6368
  */
6043
- UserIdentifierPrefix?: string;
6369
+ UserIdentifierPrefix?: string | null;
6044
6370
  /**
6045
6371
  * Attention!
6046
6372
  * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6047
6373
  * When this is not the case on create, this can be introduced on update. This value cannot be changed after it is set in either the create or update.
6048
6374
  */
6049
- UserIdentifierStartNumber?: string;
6375
+ UserIdentifierStartNumber?: string | null;
6050
6376
  /**
6051
6377
  * Attention!
6052
6378
  * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6053
6379
  * When this is not the case on create, this can be introduced on update. This value cannot be changed after it is set in either the create or update.
6054
6380
  */
6055
- UserIdentifierSuffix?: string;
6056
- UserMaximumUsage?: number;
6381
+ UserIdentifierSuffix?: string | null;
6382
+ UserMaximumUsage?: number | null;
6057
6383
  }
6058
6384
  export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramCondition {
6059
- Data: TAnyValue;
6385
+ Data: Record<string, TAnyValue>;
6060
6386
  /**
6061
6387
  * Entity type: LoyaltyProgramCondition
6062
6388
  */
@@ -6070,6 +6396,7 @@ export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramOrganizationUnitSet
6070
6396
  OrganizationUnitSetID?: string;
6071
6397
  }
6072
6398
  export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType {
6399
+ AllowPartialPayment?: boolean;
6073
6400
  Budget?: number;
6074
6401
  ExcludeFromProgramBudget?: boolean;
6075
6402
  /**
@@ -6082,18 +6409,48 @@ export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType {
6082
6409
  * Entity type: PaymentType
6083
6410
  */
6084
6411
  PaymentTypeID: string;
6085
- ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
6412
+ ProductLimitation?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType_ProductLimitationData;
6086
6413
  Required?: boolean;
6087
6414
  Sequence?: number;
6088
- TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
6415
+ TaxHandling?: DataModelsLoyaltyPaymentTaxHandlingType;
6089
6416
  UserBudget?: number;
6090
- UserBudgetDeduction: DataModelsUserBudgetDeduction;
6417
+ UserBudgetDeduction?: DataModelsUserBudgetDeduction;
6091
6418
  UserMaximumUsage?: number;
6092
6419
  }
6420
+ export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType_ProductLimitationData {
6421
+ Filters?: Record<string, SearchFilterModel>;
6422
+ /**
6423
+ * The quantity limit over the entire product limitation product set per order.
6424
+ */
6425
+ OverallQuantityLimitPerOrder?: number;
6426
+ /**
6427
+ * The quantity limit over the entire product limitation product set per user.
6428
+ */
6429
+ OverallQuantityLimitPerUser?: number;
6430
+ /**
6431
+ * Entity type: Product
6432
+ */
6433
+ ProductIDs?: string[];
6434
+ /**
6435
+ * Entity type: ProductSearchTemplate
6436
+ */
6437
+ ProductSearchID?: string;
6438
+ /**
6439
+ * The quantity limit per product within the product limitation product set per order.
6440
+ */
6441
+ QuantityLimitPerOrder?: number;
6442
+ /**
6443
+ * The quantity limit per product within the product limitation product set per user.
6444
+ */
6445
+ QuantityLimitPerUser?: number;
6446
+ }
6093
6447
  export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation {
6448
+ ApplyToPriceList?: boolean;
6094
6449
  Filters?: Record<string, SearchFilterModel>;
6095
6450
  ID: string;
6096
6451
  Name: string;
6452
+ OverallQuantityLimitPerOrder?: number;
6453
+ OverallQuantityLimitPerUser?: number;
6097
6454
  /**
6098
6455
  * Entity type: Product
6099
6456
  */
@@ -6127,9 +6484,42 @@ export interface LoyaltyPushLoyaltyProgram_PushPointAwardingRule {
6127
6484
  }
6128
6485
  export interface LoyaltyPushLoyaltyProgram_PushPointAwardingRuleCondition {
6129
6486
  Data?: LoyaltyRulesIPointAwardingConditionData;
6130
- ID?: string;
6487
+ ID: string;
6131
6488
  Type: 'ORDERAMOUNT' | 'PRODUCT' | 'USERCUSTOMFIELD';
6132
6489
  }
6490
+ export interface PushLoyaltyProgramGroupResponse {
6491
+ Error?: ServiceError;
6492
+ /**
6493
+ * Entity type: LoyaltyProgram
6494
+ */
6495
+ ID: string;
6496
+ Metadata?: ResponseMessageMetadata;
6497
+ }
6498
+ export interface PushLoyaltyProgramGroup_Async {
6499
+ Budget?: number;
6500
+ /**
6501
+ * Entity type: Currency
6502
+ */
6503
+ BudgetCurrencyID?: string;
6504
+ DeactivateWhenBudgetIsReached?: boolean;
6505
+ EndDate?: string;
6506
+ /**
6507
+ * Entity type: LoyaltyProgramGroup
6508
+ */
6509
+ ID: string;
6510
+ Name: string;
6511
+ StartDate?: string;
6512
+ Status?: DataModelsLoyaltyProgramStatus;
6513
+ TaxExemptionCode?: string;
6514
+ }
6515
+ export interface PushLoyaltyProgramGroup_AsyncResponse {
6516
+ Error?: ServiceError;
6517
+ JobID?: string;
6518
+ Metadata?: ResponseMessageMetadata;
6519
+ }
6520
+ export interface PushLoyaltyProgramGroup_AsyncResult {
6521
+ JobID?: string;
6522
+ }
6133
6523
  export interface PushLoyaltyProgramResponse {
6134
6524
  Error?: ServiceError;
6135
6525
  /**
@@ -6137,6 +6527,122 @@ export interface PushLoyaltyProgramResponse {
6137
6527
  */
6138
6528
  ID: string;
6139
6529
  Metadata?: ResponseMessageMetadata;
6530
+ /**
6531
+ * Entity type: Subscription
6532
+ */
6533
+ SubscriptionID: string;
6534
+ }
6535
+ export interface PushLoyaltyProgram_Async {
6536
+ /**
6537
+ * Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
6538
+ */
6539
+ AllowUnsubscribeBy?: DataModelsAllowUnsubscribeByType;
6540
+ ApplyManuallyOnly?: boolean;
6541
+ /**
6542
+ * When true, if a non anonymous customer is attached to the order they will be automatically subscribed on finishing the order.
6543
+ * When false, the customer will not be subscribed.
6544
+ *
6545
+ * This is ignore when`RequiresSubscribedCustomer` or `RequiresSubscriptionValidation` is set to true.
6546
+ */
6547
+ AutoSubscribeCustomer?: boolean;
6548
+ Budget?: number | null;
6549
+ /**
6550
+ * Entity type: Currency
6551
+ */
6552
+ BudgetCurrencyID?: string | null;
6553
+ Conditions?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramCondition[];
6554
+ Data?: TAnyValue | null;
6555
+ DeactivateWhenBudgetIsReached?: boolean;
6556
+ Description?: string | null;
6557
+ EndDate?: string | null;
6558
+ Handler?: string;
6559
+ /**
6560
+ * Entity type: LoyaltyProgram
6561
+ */
6562
+ ID: string;
6563
+ LoyaltyPointUsageOptions?: DataModelsLoyaltyPointUsageOptions;
6564
+ /**
6565
+ * Entity type: LoyaltyProgramGroup
6566
+ */
6567
+ LoyaltyProgramGroupID?: string | null;
6568
+ Name?: string;
6569
+ Options?: DataModelsLoyaltyProgramOptions;
6570
+ OrganizationUnitSets?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramOrganizationUnitSet[];
6571
+ PaymentTypes?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType[];
6572
+ PointAwardingRules?: LoyaltyPushLoyaltyProgram_PushPointAwardingRule[];
6573
+ PointExpirationPolicyData?: Record<string, TAnyValue> | null;
6574
+ PointExpirationPolicyType?: string | null;
6575
+ PointPendingPolicyData?: Record<string, TAnyValue> | null;
6576
+ PointPendingPolicyType?: string | null;
6577
+ /**
6578
+ * Entity type: PriceList
6579
+ */
6580
+ PriceLists?: string[];
6581
+ ProductLimitations?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation[];
6582
+ ReactivateProgramWhenPossible?: boolean;
6583
+ ReloadPolicy?: string | null;
6584
+ /**
6585
+ * When true, the loyalty program will only be applied when a customer is attached to the order.
6586
+ *
6587
+ * When false, the loyalty program can be attached to the order even if there is no customer attached.
6588
+ */
6589
+ RequireCustomer?: boolean;
6590
+ /**
6591
+ * When set to true, subscribing the user will require a UserIdentifier to be given.
6592
+ * Attention!
6593
+ * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6594
+ * When this is not the case on create, this can be introduced on update. This value cannot be changed after it is set in either the create or update.
6595
+ */
6596
+ RequireManualUserIdentifier?: boolean | null;
6597
+ RequiredCustomFields?: string[];
6598
+ /**
6599
+ * When true, the loyalty program will only be applied when a customer is attached to the order that is already subscribed to the loyalty program.
6600
+ * Also, this will make the `RequireCustomer` automatically true and `AutoSubscribeCustomer` false.
6601
+ *
6602
+ * When false, the loyalty program can be attached to the order if a customer is attached that isn't already subscribed to the loyalty program.
6603
+ */
6604
+ RequiresSubscribedCustomer?: boolean;
6605
+ /**
6606
+ * When true, the order will require that the attached customer on the order will be validated by providing the UserIdentifier in the `AttachBenefitProgramToOrder` service.
6607
+ * Also, this will make the `RequireCustomer` and `RequiresSubscribedCustomer` automatically true and `AutoSubscribeCustomer` false.
6608
+ *
6609
+ * When false, this validation isn't required.
6610
+ */
6611
+ RequiresSubscriptionValidation?: boolean;
6612
+ /**
6613
+ * Handling when a user is unsubscribed and re-subscribes.
6614
+ */
6615
+ ResubscribeHandling?: DataModelsResubscribeHandlingType;
6616
+ StartDate?: string | null;
6617
+ Status?: DataModelsLoyaltyProgramStatus;
6618
+ UserBudget?: number | null;
6619
+ /**
6620
+ * Attention!
6621
+ * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6622
+ * When this is not the case on create, this can be introduced on update. This value cannot be changed after it is set in either the create or update.
6623
+ */
6624
+ UserIdentifierPrefix?: string | null;
6625
+ /**
6626
+ * Attention!
6627
+ * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6628
+ * When this is not the case on create, this can be introduced on update. This value cannot be changed after it is set in either the create or update.
6629
+ */
6630
+ UserIdentifierStartNumber?: string | null;
6631
+ /**
6632
+ * Attention!
6633
+ * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6634
+ * When this is not the case on create, this can be introduced on update. This value cannot be changed after it is set in either the create or update.
6635
+ */
6636
+ UserIdentifierSuffix?: string | null;
6637
+ UserMaximumUsage?: number | null;
6638
+ }
6639
+ export interface PushLoyaltyProgram_AsyncResponse {
6640
+ Error?: ServiceError;
6641
+ JobID?: string;
6642
+ Metadata?: ResponseMessageMetadata;
6643
+ }
6644
+ export interface PushLoyaltyProgram_AsyncResult {
6645
+ JobID?: string;
6140
6646
  }
6141
6647
  /**
6142
6648
  * Rebalance loyalty points of a user
@@ -6181,16 +6687,42 @@ export interface RemoveLoyaltyProgramPriceList {
6181
6687
  PriceListID: string;
6182
6688
  }
6183
6689
  /**
6690
+ * Removes a custom field requirement from a loyalty program.
6691
+ */
6692
+ export interface RemoveLoyaltyProgramRequiredCustomField {
6693
+ /**
6694
+ * Entity type: CustomField
6695
+ */
6696
+ CustomFieldID: string;
6697
+ /**
6698
+ * Entity type: LoyaltyProgram
6699
+ */
6700
+ LoyaltyProgramID: string;
6701
+ }
6702
+ /**
6703
+ * Set the optional loyalty program payment types for the order.
6704
+ */
6705
+ export interface SetOrderLoyaltyProgramPaymentTypes {
6706
+ /**
6707
+ * Entity type: Order
6708
+ */
6709
+ OrderID: string;
6710
+ /**
6711
+ * Entity type: LoyaltyProgramPaymentType
6712
+ * When left empty no optional payment types will be available. Required payment types cannot be unselected.
6713
+ */
6714
+ SelectedLoyaltyProgramPaymentTypes: string[];
6715
+ }
6716
+ /**
6184
6717
  * Update an existing LoyaltyProgram
6185
6718
  */
6186
6719
  export interface UpdateLoyaltyProgram {
6187
6720
  /**
6188
6721
  * Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
6189
6722
  */
6190
- AllowUnsubscribeBy: DataModelsAllowUnsubscribeByType | undefined;
6723
+ AllowUnsubscribeBy?: DataModelsAllowUnsubscribeByType;
6191
6724
  /**
6192
- * When true, the loyalty program will not automatically be applied to the order when a customer is attached and all conditions are met.
6193
- * When false, the loyalty program will automatically be applied if all conditions are met.
6725
+ * This property has been deprecated. A loyaltyprogram should always be manually applied.
6194
6726
  */
6195
6727
  ApplyManuallyOnly?: boolean;
6196
6728
  /**
@@ -6200,27 +6732,27 @@ export interface UpdateLoyaltyProgram {
6200
6732
  * This is ignore when`RequiresSubscribedCustomer` or `RequiresSubscriptionValidation` is set to true.
6201
6733
  */
6202
6734
  AutoSubscribeCustomer?: boolean;
6203
- BackendID: string | null | undefined;
6735
+ BackendID?: string | null;
6204
6736
  /**
6205
6737
  * Entity type: Currency
6206
6738
  */
6207
- BudgetCurrencyID: string | null | undefined;
6208
- Data: TAnyValue | null | undefined;
6209
- Description: string | null | undefined;
6210
- EndDate: string | null | undefined;
6739
+ BudgetCurrencyID?: string | null;
6740
+ Data?: TAnyValue | null;
6741
+ Description?: string | null;
6742
+ EndDate?: string | null;
6211
6743
  /**
6212
6744
  * Entity type: LoyaltyProgram
6213
6745
  */
6214
6746
  ID: string;
6215
6747
  LoyaltyPointUsageOptions?: DataModelsLoyaltyPointUsageOptions;
6216
- LoyaltyProgramGroupID: string | null | undefined;
6748
+ LoyaltyProgramGroupID?: string | null;
6217
6749
  Name?: string;
6218
6750
  Options?: DataModelsLoyaltyProgramOptions;
6219
- PointExpirationPolicyData: Record<string, TAnyValue> | null | undefined;
6220
- PointExpirationPolicyType: string | null | undefined;
6221
- PointPendingPolicyData: Record<string, TAnyValue> | null | undefined;
6222
- PointPendingPolicyType: string | null | undefined;
6223
- ReloadPolicy: string | null | undefined;
6751
+ PointExpirationPolicyData?: Record<string, TAnyValue> | null;
6752
+ PointExpirationPolicyType?: string | null;
6753
+ PointPendingPolicyData?: Record<string, TAnyValue> | null;
6754
+ PointPendingPolicyType?: string | null;
6755
+ ReloadPolicy?: string | null;
6224
6756
  /**
6225
6757
  * When true, the loyalty program will only be applied when a customer is attached to the order.
6226
6758
  *
@@ -6233,7 +6765,7 @@ export interface UpdateLoyaltyProgram {
6233
6765
  * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6234
6766
  * This value cannot be changed after it is set in either the create or update.
6235
6767
  */
6236
- RequireManualUserIdentifier: boolean | null | undefined;
6768
+ RequireManualUserIdentifier?: boolean | null;
6237
6769
  /**
6238
6770
  * When true, the loyalty program will only be applied when a customer is attached to the order that is already subscribed to the loyalty program.
6239
6771
  * Also, this will make the `RequireCustomer` automatically true and `AutoSubscribeCustomer` false.
@@ -6251,29 +6783,29 @@ export interface UpdateLoyaltyProgram {
6251
6783
  /**
6252
6784
  * Handling when a user is unsubscribed and re-subscribes.
6253
6785
  */
6254
- ResubscribeHandling: DataModelsResubscribeHandlingType | undefined;
6255
- StartDate: string | null | undefined;
6786
+ ResubscribeHandling?: DataModelsResubscribeHandlingType;
6787
+ StartDate?: string | null;
6256
6788
  Status?: DataModelsLoyaltyProgramStatus;
6257
- UserBudget: number | null | undefined;
6789
+ UserBudget?: number | null;
6258
6790
  /**
6259
6791
  * Attention!
6260
6792
  * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6261
6793
  * This value cannot be changed after it is set in either the create or update.
6262
6794
  */
6263
- UserIdentifierPrefix: string | null | undefined;
6795
+ UserIdentifierPrefix?: string | null;
6264
6796
  /**
6265
6797
  * Attention!
6266
6798
  * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6267
6799
  * This value cannot be changed after it is set in either the create or update.
6268
6800
  */
6269
- UserIdentifierStartNumber: string | null | undefined;
6801
+ UserIdentifierStartNumber?: string | null;
6270
6802
  /**
6271
6803
  * Attention!
6272
6804
  * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6273
6805
  * This value cannot be changed after it is set in either the create or update.
6274
6806
  */
6275
- UserIdentifierSuffix: string | null | undefined;
6276
- UserMaximumUsage: number | null | undefined;
6807
+ UserIdentifierSuffix?: string | null;
6808
+ UserMaximumUsage?: number | null;
6277
6809
  }
6278
6810
  /**
6279
6811
  * Update the budget on the loyalty program group.
@@ -6311,21 +6843,21 @@ export interface UpdateLoyaltyProgramCondition {
6311
6843
  * When a change to Status, StartDate, EndDate or Currency leads to the group being reactivate, all related loyalty programs will also be reactive when the option ReactivateProgramsWhenPossible is set to true. Otherwise all deactivated programs need to be manually reactivated.
6312
6844
  */
6313
6845
  export interface UpdateLoyaltyProgramGroup {
6314
- BackendID?: string;
6846
+ BackendID?: string | null;
6315
6847
  /**
6316
6848
  * Entity type: Currency
6317
6849
  */
6318
- BudgetCurrencyID?: string;
6319
- EndDate?: string;
6850
+ BudgetCurrencyID?: string | null;
6851
+ EndDate?: string | null;
6320
6852
  /**
6321
6853
  * Entity type: LoyaltyProgramGroup
6322
6854
  */
6323
6855
  ID: string;
6324
- Name: string;
6856
+ Name?: string | null;
6325
6857
  ReactivateProgramsWhenPossible?: boolean;
6326
- StartDate?: string;
6327
- Status: DataModelsLoyaltyProgramStatus;
6328
- TaxExemptionCode?: string;
6858
+ StartDate?: string | null;
6859
+ Status?: DataModelsLoyaltyProgramStatus;
6860
+ TaxExemptionCode?: string | null;
6329
6861
  }
6330
6862
  /**
6331
6863
  * Update the budget on the loyalty program group.
@@ -6346,6 +6878,7 @@ export interface UpdateLoyaltyProgramGroupBudget {
6346
6878
  * Update an existing LoyaltyProgramPaymentType
6347
6879
  */
6348
6880
  export interface UpdateLoyaltyProgramPaymentType {
6881
+ AllowPartialPayment?: boolean;
6349
6882
  BackendID?: string;
6350
6883
  Budget?: number;
6351
6884
  ExcludeFromProgramBudget?: boolean;
@@ -6355,11 +6888,12 @@ export interface UpdateLoyaltyProgramPaymentType {
6355
6888
  ID: string;
6356
6889
  MaximumAmountPerOrder?: number;
6357
6890
  MaximumPercentageOfUserBudgetPerOrder?: number;
6891
+ ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
6358
6892
  Required?: boolean;
6359
6893
  Sequence?: number;
6360
- TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
6894
+ TaxHandling?: DataModelsLoyaltyPaymentTaxHandlingType;
6361
6895
  UserBudget?: number;
6362
- UserBudgetDeduction: DataModelsUserBudgetDeduction;
6896
+ UserBudgetDeduction?: DataModelsUserBudgetDeduction;
6363
6897
  UserMaximumUsage?: number;
6364
6898
  }
6365
6899
  /**
@@ -6380,25 +6914,25 @@ export interface UpdateLoyaltyProgramProductLimitation {
6380
6914
  */
6381
6915
  export interface UpdatePointAwardingRule {
6382
6916
  ApplyRecursive?: boolean;
6383
- BackendID: string | null | undefined;
6917
+ BackendID?: string | null;
6384
6918
  Conditions?: LoyaltyUpdatePointAwardingRule_Condition[];
6385
- Description: string | null | undefined;
6919
+ Description?: string | null;
6386
6920
  Enabled?: boolean;
6387
- EndDate: string | null | undefined;
6921
+ EndDate?: string | null;
6388
6922
  /**
6389
6923
  * Entity type: PointAwardingRule
6390
6924
  */
6391
6925
  ID: string;
6392
- MarketingDescription: string | null | undefined;
6926
+ MarketingDescription?: string | null;
6393
6927
  Name?: string;
6394
6928
  /**
6395
6929
  * Entity type: OrganizationUnitSet
6396
6930
  */
6397
6931
  OrganizationUnitSetID?: string;
6398
- PointExpirationPolicyData: Record<string, TAnyValue> | null | undefined;
6399
- PointExpirationPolicyType: string | null | undefined;
6400
- PointPendingPolicyData: Record<string, TAnyValue> | null | undefined;
6401
- PointPendingPolicyType: string | null | undefined;
6932
+ PointExpirationPolicyData?: Record<string, TAnyValue> | null;
6933
+ PointExpirationPolicyType?: string | null;
6934
+ PointPendingPolicyData?: Record<string, TAnyValue> | null;
6935
+ PointPendingPolicyType?: string | null;
6402
6936
  PointsToAward?: number;
6403
6937
  StartDate?: string;
6404
6938
  }
@@ -6433,7 +6967,7 @@ export interface CreateMessageTemplate {
6433
6967
  * Entity type: Country
6434
6968
  */
6435
6969
  CountryID?: string;
6436
- Destination: DataModelsMessageTemplateDestinations;
6970
+ Destination?: DataModelsMessageTemplateDestinations;
6437
6971
  Footer?: string;
6438
6972
  Header?: string;
6439
6973
  Helpers?: string;
@@ -6450,7 +6984,7 @@ export interface CreateMessageTemplate {
6450
6984
  OrganizationUnitID?: string;
6451
6985
  PaperProperties?: DataModelsPaperProperties;
6452
6986
  Template: string;
6453
- Type: DataModelsMessageTemplateTypes;
6987
+ Type?: DataModelsMessageTemplateTypes;
6454
6988
  }
6455
6989
  export interface CreateMessageTemplateResponse {
6456
6990
  Error?: ServiceError;
@@ -6646,7 +7180,7 @@ export interface PreviewMessageTemplate {
6646
7180
  * Entity type: Country
6647
7181
  */
6648
7182
  CountryID?: string;
6649
- Destination: DataModelsMessageTemplateDestinations;
7183
+ Destination?: DataModelsMessageTemplateDestinations;
6650
7184
  Footer?: string;
6651
7185
  /**
6652
7186
  * A preview will be generated, even if device is known
@@ -6670,9 +7204,9 @@ export interface PreviewMessageTemplate {
6670
7204
  * Entity type: Station
6671
7205
  */
6672
7206
  StationID?: string;
6673
- TargetContentType: MessageTemplatesMessageTargetContentTypes;
7207
+ TargetContentType?: MessageTemplatesMessageTargetContentTypes;
6674
7208
  Template: string;
6675
- Type: DataModelsMessageTemplateTypes;
7209
+ Type?: DataModelsMessageTemplateTypes;
6676
7210
  }
6677
7211
  export interface PreviewMessageTemplateResponse {
6678
7212
  Error?: ServiceError;
@@ -6683,7 +7217,7 @@ export interface PreviewMessageTemplateResponse {
6683
7217
  }
6684
7218
  export interface SendSampleMailMessageTemplate {
6685
7219
  CountryID?: string;
6686
- Destination: DataModelsMessageTemplateDestinations;
7220
+ Destination?: DataModelsMessageTemplateDestinations;
6687
7221
  EmailAddress?: string;
6688
7222
  Helpers?: string;
6689
7223
  LanguageID?: string;
@@ -6692,7 +7226,7 @@ export interface SendSampleMailMessageTemplate {
6692
7226
  OrganizationUnitID?: string;
6693
7227
  SampleData?: Record<string, TAnyValue>;
6694
7228
  Template?: string;
6695
- Type: DataModelsMessageTemplateTypes;
7229
+ Type?: DataModelsMessageTemplateTypes;
6696
7230
  }
6697
7231
  /**
6698
7232
  * Update an existing MessageTemplate
@@ -6701,11 +7235,11 @@ export interface UpdateMessageTemplate {
6701
7235
  /**
6702
7236
  * Entity type: Country
6703
7237
  */
6704
- CountryID: string | null | undefined;
7238
+ CountryID?: string | null;
6705
7239
  Destination?: DataModelsMessageTemplateDestinations;
6706
- Footer: string | null | undefined;
6707
- Header: string | null | undefined;
6708
- Helpers: string | null | undefined;
7240
+ Footer?: string | null;
7241
+ Header?: string | null;
7242
+ Helpers?: string | null;
6709
7243
  /**
6710
7244
  * Entity type: MessageTemplate
6711
7245
  */
@@ -6714,14 +7248,14 @@ export interface UpdateMessageTemplate {
6714
7248
  /**
6715
7249
  * Entity type: Language
6716
7250
  */
6717
- LanguageID: string | null | undefined;
6718
- Layout: string | null | undefined;
7251
+ LanguageID?: string | null;
7252
+ Layout?: string | null;
6719
7253
  Name?: string;
6720
7254
  /**
6721
7255
  * Entity type: OrganizationUnit
6722
7256
  */
6723
- OrganizationUnitID: string | null | undefined;
6724
- PaperProperties: DataModelsPaperProperties | undefined;
7257
+ OrganizationUnitID?: string | null;
7258
+ PaperProperties?: DataModelsPaperProperties;
6725
7259
  Template?: string;
6726
7260
  }
6727
7261
  export interface OrdersCheckoutOptionCategoryDto {
@@ -6818,6 +7352,9 @@ export interface CreateOrderLedgerType {
6818
7352
  export interface CreateOrderLedgerTypeResponse {
6819
7353
  Description?: string;
6820
7354
  Error?: ServiceError;
7355
+ /**
7356
+ * Entity type: OrderLedgerType
7357
+ */
6821
7358
  ID: string;
6822
7359
  Metadata?: ResponseMessageMetadata;
6823
7360
  Name?: string;
@@ -6886,6 +7423,9 @@ export interface DeleteCheckoutOptionCategory {
6886
7423
  * Delete existing "OrderLedgerType"
6887
7424
  */
6888
7425
  export interface DeleteOrderLedgerType {
7426
+ /**
7427
+ * Entity type: OrderLedgerType
7428
+ */
6889
7429
  ID: string;
6890
7430
  }
6891
7431
  /**
@@ -6917,18 +7457,6 @@ export interface GetCheckoutOptionHandlersResponse {
6917
7457
  Metadata?: ResponseMessageMetadata;
6918
7458
  }
6919
7459
  /**
6920
- * Get the CheckoutOptions
6921
- */
6922
- export interface GetCheckoutOptions {
6923
- IncludeInactive?: boolean;
6924
- }
6925
- export interface GetCheckoutOptionsResponse {
6926
- Categories?: OrdersCheckoutOptionCategoryDto[];
6927
- Error?: ServiceError;
6928
- Metadata?: ResponseMessageMetadata;
6929
- Options?: OrdersCheckoutOptionDto[];
6930
- }
6931
- /**
6932
7460
  * Returns a single refund reason.
6933
7461
  */
6934
7462
  export interface GetRefundCorrectionReason {
@@ -6990,6 +7518,9 @@ export interface ListOrderLedgerTypesResponse {
6990
7518
  }
6991
7519
  export interface OrdersListOrderLedgerTypesResponse_ResponseModel {
6992
7520
  Description?: string;
7521
+ /**
7522
+ * Entity type: OrderLedgerType
7523
+ */
6993
7524
  ID: string;
6994
7525
  Name?: string;
6995
7526
  }
@@ -7092,7 +7623,7 @@ export interface DeleteReturnReason {
7092
7623
  * Get the reasons by type.
7093
7624
  */
7094
7625
  export interface GetReturnReasonsByType {
7095
- Type: DataModelsReturnReasonType;
7626
+ Type?: DataModelsReturnReasonType;
7096
7627
  }
7097
7628
  export interface GetReturnReasonsByTypeResponse {
7098
7629
  Error?: ServiceError;
@@ -7152,8 +7683,8 @@ export interface OrdersReturnReasonsListReturnReasonsResponse_Reason {
7152
7683
  * Update a return reason
7153
7684
  */
7154
7685
  export interface UpdateReturnReason {
7155
- BackendID: string | null | undefined;
7156
- Description: string | null | undefined;
7686
+ BackendID?: string | null;
7687
+ Description?: string | null;
7157
7688
  /**
7158
7689
  * Entity type: ReturnReason
7159
7690
  */
@@ -7176,9 +7707,9 @@ export interface UpdateCheckoutOption {
7176
7707
  /**
7177
7708
  * Entity type: CheckoutOptionCategory
7178
7709
  */
7179
- CategoryID: string | null | undefined;
7180
- Data: OrdersCheckoutOptionsICheckoutOptionConfigData | null | undefined;
7181
- Description: string | null | undefined;
7710
+ CategoryID?: string | null;
7711
+ Data?: OrdersCheckoutOptionsICheckoutOptionConfigData | null;
7712
+ Description?: string | null;
7182
7713
  Handler?: 'Certification' | 'CustomerReferences' | 'CustomFieldLine' | 'CustomField' | 'Delivery' | 'ElectronicInvoice' | 'FiscalID' | 'FiscalRemark' | 'GiftWrapping' | 'LotteryNumber' | 'OrderBackendIdentifier' | 'PartialShipment' | 'PickupPoint' | 'ProductSearchTemplate' | 'QuickBuy' | 'Remark' | 'RequestedDate' | 'SerialNumberValidation' | 'SoldBy' | 'TaxExempt' | 'TaxRegistrationNumber' | 'VerifyOrder' | 'SignOrder' | 'GlobalBlue';
7183
7714
  /**
7184
7715
  * Entity type: CheckoutOption
@@ -7189,18 +7720,18 @@ export interface UpdateCheckoutOption {
7189
7720
  /**
7190
7721
  * Entity type: OrganizationUnitSet
7191
7722
  */
7192
- OrganizationUnitSetID: string | null | undefined;
7723
+ OrganizationUnitSetID?: string | null;
7193
7724
  /**
7194
7725
  * Entity type: Script
7195
7726
  */
7196
- ScriptID: string | null | undefined;
7727
+ ScriptID?: string | null;
7197
7728
  Sequence?: number;
7198
7729
  }
7199
7730
  /**
7200
7731
  * Update an existing CheckoutOptionCategory
7201
7732
  */
7202
7733
  export interface UpdateCheckoutOptionCategory {
7203
- Description: string | null | undefined;
7734
+ Description?: string | null;
7204
7735
  /**
7205
7736
  * Entity type: CheckoutOptionCategory
7206
7737
  */
@@ -7224,19 +7755,25 @@ export interface UpdateCheckoutOptionSequences {
7224
7755
  */
7225
7756
  export interface UpdateOrderLedgerType {
7226
7757
  Description?: string;
7758
+ /**
7759
+ * Entity type: OrderLedgerType
7760
+ */
7227
7761
  ID: string;
7228
7762
  Name: string;
7229
7763
  }
7230
7764
  export interface UpdateOrderLedgerTypeResponse {
7231
7765
  Description?: string;
7232
7766
  Error?: ServiceError;
7767
+ /**
7768
+ * Entity type: OrderLedgerType
7769
+ */
7233
7770
  ID: string;
7234
7771
  Metadata?: ResponseMessageMetadata;
7235
7772
  Name?: string;
7236
7773
  }
7237
7774
  export interface UpdateRefundCorrectionReason {
7238
- BackendID: string | null | undefined;
7239
- Description: string | null | undefined;
7775
+ BackendID?: string | null;
7776
+ Description?: string | null;
7240
7777
  /**
7241
7778
  * Entity type: RefundCorrectionReason
7242
7779
  */
@@ -7252,8 +7789,8 @@ export interface UpdateRefundCorrectionReason {
7252
7789
  * Update an existing UnitPriceCorrectionReason
7253
7790
  */
7254
7791
  export interface UpdateUnitPriceCorrectionReason {
7255
- BackendID: string | null | undefined;
7256
- Description: string | null | undefined;
7792
+ BackendID?: string | null;
7793
+ Description?: string | null;
7257
7794
  /**
7258
7795
  * Entity type: UnitPriceCorrectionReason
7259
7796
  */
@@ -7283,7 +7820,7 @@ export interface CreateOrUpdateOrganizationUnitSubset {
7283
7820
  * Entity type: OrganizationUnitSet
7284
7821
  */
7285
7822
  SubsetID: string;
7286
- Type: DataModelsOrganizationUnitSetOperatorTypes;
7823
+ Type?: DataModelsOrganizationUnitSetOperatorTypes;
7287
7824
  }
7288
7825
  /**
7289
7826
  * Creates a new `OrganizationUnitSet`.
@@ -7315,14 +7852,22 @@ export interface CreateOrganizationUnitSet {
7315
7852
  * When specified, adds the sets contained in Subsets as a subset of the new set.
7316
7853
  */
7317
7854
  Subsets?: OrganizationUnitSetsCreateOrganizationUnitSet_OrganizationUnitSubSetDefinition[];
7318
- Type: DataModelsOrganizationUnitSetTypes;
7855
+ Type?: DataModelsOrganizationUnitSetTypes;
7319
7856
  }
7320
7857
  export interface OrganizationUnitSetsCreateOrganizationUnitSet_OrganizationUnitSubSetDefinition {
7321
7858
  /**
7322
7859
  * Entity type: OrganizationUnitSet
7323
7860
  */
7324
7861
  ID: string;
7325
- OperatorType: DataModelsOrganizationUnitSetOperatorTypes;
7862
+ OperatorType?: DataModelsOrganizationUnitSetOperatorTypes;
7863
+ }
7864
+ export interface CreateOrganizationUnitSetResponse {
7865
+ Error?: ServiceError;
7866
+ /**
7867
+ * Entity type: OrganizationUnitSet
7868
+ */
7869
+ ID: string;
7870
+ Metadata?: ResponseMessageMetadata;
7326
7871
  }
7327
7872
  /**
7328
7873
  * Creates a new OrganizationUnitSetScope.
@@ -7336,6 +7881,9 @@ export interface CreateOrganizationUnitSetScope {
7336
7881
  }
7337
7882
  export interface CreateOrganizationUnitSetScopeResponse {
7338
7883
  Error?: ServiceError;
7884
+ /**
7885
+ * Entity type: OrganizationUnitSetScope
7886
+ */
7339
7887
  ID: string;
7340
7888
  Metadata?: ResponseMessageMetadata;
7341
7889
  }
@@ -7356,6 +7904,9 @@ export interface DeleteOrganizationUnitSet {
7356
7904
  * It's not possible to delete a scope that is still in use by an OrganizationUnitSet.
7357
7905
  */
7358
7906
  export interface DeleteOrganizationUnitSetScope {
7907
+ /**
7908
+ * Entity type: OrganizationUnitSetScope
7909
+ */
7359
7910
  ID: string;
7360
7911
  }
7361
7912
  /**
@@ -7421,7 +7972,7 @@ export interface GetOrganizationUnitSetResponse {
7421
7972
  * Entity type: OrganizationUnit
7422
7973
  */
7423
7974
  OrganizationUnitID?: string;
7424
- Scope?: APIEnumDto;
7975
+ Scope?: EVAFrameworkAPIEnumDto;
7425
7976
  Type: DataModelsOrganizationUnitSetTypes;
7426
7977
  }
7427
7978
  /**
@@ -7436,6 +7987,9 @@ export interface GetOrganizationUnitSetScopesResponse {
7436
7987
  }
7437
7988
  export interface OrganizationUnitSetsGetOrganizationUnitSetScopesResponse_OrganizationUnitSetScope {
7438
7989
  Description?: string;
7990
+ /**
7991
+ * Entity type: OrganizationUnitSetScope
7992
+ */
7439
7993
  ID: string;
7440
7994
  Name?: string;
7441
7995
  OrganizationUnitUniqueInScope: boolean;
@@ -7469,7 +8023,7 @@ export interface OrganizationUnitSetsOrganizationUnitSetDetails {
7469
8023
  * Entity type: OrganizationUnit
7470
8024
  */
7471
8025
  OrganizationUnitID?: string;
7472
- Scope?: APIEnumDto;
8026
+ Scope?: EVAFrameworkAPIEnumDto;
7473
8027
  Subsets?: OrganizationUnitSetsOrganizationUnitSetDetails[];
7474
8028
  Type: DataModelsOrganizationUnitSetTypes;
7475
8029
  }
@@ -7486,7 +8040,7 @@ export interface OrganizationUnitSetsPreviewOrganizationUnitSet_PreviewOrganizat
7486
8040
  * Entity type: OrganizationUnitSubset
7487
8041
  */
7488
8042
  ID: string;
7489
- OperatorType: DataModelsOrganizationUnitSetOperatorTypes;
8043
+ OperatorType?: DataModelsOrganizationUnitSetOperatorTypes;
7490
8044
  SequenceNumber?: number;
7491
8045
  }
7492
8046
  export interface PreviewOrganizationUnitSetResponse {
@@ -7504,9 +8058,9 @@ export interface PreviewOrganizationUnitSetResponse {
7504
8058
  * it, pass the definition you got back from the `GetOrganizationUnitSet` service.
7505
8059
  */
7506
8060
  export interface UpdateOrganizationUnitSet {
7507
- BackendID: string | null | undefined;
7508
- Definition: DataModelsOrganizationUnitSetDefinition | undefined;
7509
- Description: string | null | undefined;
8061
+ BackendID?: string | null;
8062
+ Definition?: DataModelsOrganizationUnitSetDefinition;
8063
+ Description?: string | null;
7510
8064
  /**
7511
8065
  * Entity type: OrganizationUnitSet
7512
8066
  */
@@ -7515,7 +8069,7 @@ export interface UpdateOrganizationUnitSet {
7515
8069
  /**
7516
8070
  * Entity type: OrganizationUnitSetScope
7517
8071
  */
7518
- ScopeID: string | null | undefined;
8072
+ ScopeID?: string | null;
7519
8073
  }
7520
8074
  /**
7521
8075
  * Updates a OrganizationUnitSetScope.
@@ -7542,6 +8096,7 @@ export interface CreateCashHandler {
7542
8096
  * Entity type: Currency
7543
8097
  */
7544
8098
  CurrencyID: string;
8099
+ MaxAmountPerOrder?: number;
7545
8100
  Name: string;
7546
8101
  RoundingFactor: number;
7547
8102
  }
@@ -7669,6 +8224,7 @@ export interface GetCashHandlerByIDResponse {
7669
8224
  CurrencyID?: string;
7670
8225
  Error?: ServiceError;
7671
8226
  ID: string;
8227
+ MaxAmountPerOrder?: number;
7672
8228
  Metadata?: ResponseMessageMetadata;
7673
8229
  Name?: string;
7674
8230
  RoundingFactor: number;
@@ -7686,6 +8242,9 @@ export interface GetOpeningHoursTypesResponse {
7686
8242
  export interface OrganizationUnitsGetOpeningHoursTypesResponse_OpeningHoursTypeDto {
7687
8243
  BackendID?: string;
7688
8244
  Description?: string;
8245
+ /**
8246
+ * Entity type: Enum
8247
+ */
7689
8248
  ID: string;
7690
8249
  /**
7691
8250
  * Usually an internal & unchangable code - for display, use `Description`
@@ -7727,6 +8286,7 @@ export interface OrganizationUnitsListCashHandlersResponse_CashHandlerDto {
7727
8286
  * Entity type: CashHandler
7728
8287
  */
7729
8288
  ID: string;
8289
+ MaxAmountPerOrder?: number;
7730
8290
  Name?: string;
7731
8291
  RoundingFactor: number;
7732
8292
  }
@@ -7794,18 +8354,19 @@ export interface SetOrganizationUnitSupplierData {
7794
8354
  * Update an existing CashHandler
7795
8355
  */
7796
8356
  export interface UpdateCashHandler {
7797
- BankNotes: number[];
7798
- Coins: number[];
8357
+ BankNotes?: number[];
8358
+ Coins?: number[];
7799
8359
  /**
7800
8360
  * Entity type: Currency
7801
8361
  */
7802
- CurrencyID: string;
8362
+ CurrencyID?: string;
7803
8363
  /**
7804
8364
  * Entity type: CashHandler
7805
8365
  */
7806
8366
  ID: string;
7807
- Name: string;
7808
- RoundingFactor: number;
8367
+ MaxAmountPerOrder?: number | null;
8368
+ Name?: string;
8369
+ RoundingFactor?: number;
7809
8370
  }
7810
8371
  /**
7811
8372
  * Update an existing OpeningHoursType
@@ -7896,15 +8457,15 @@ export interface UpdateOrganizationUnitRegularOpeningHours {
7896
8457
  * When this OrganizationUnitSet doesn't have this PaymentType yet, it will be created. If it already exists the fields will be updated.
7897
8458
  */
7898
8459
  export interface CreateOrUpdateOrganizationUnitSetPaymentType {
7899
- AuthorizationExpirationInDays: number | null | undefined;
7900
- CaptureMoment: DataModelsPaymentTypeCaptureMoment | undefined;
8460
+ AuthorizationExpirationInDays?: number | null;
8461
+ CaptureMoment?: DataModelsPaymentTypeCaptureMoment;
7901
8462
  /**
7902
8463
  * Entity type: Product
7903
8464
  */
7904
- DigitalGiftCardProductID: string | null | undefined;
7905
- DisableForCarryOutOrders: boolean | null | undefined;
7906
- DisableForDeliveryOrders: boolean | null | undefined;
7907
- DisableForReserveOrders: boolean | null | undefined;
8465
+ DigitalGiftCardProductID?: string | null;
8466
+ DisableForCarryOutOrders?: boolean | null;
8467
+ DisableForDeliveryOrders?: boolean | null;
8468
+ DisableForReserveOrders?: boolean | null;
7908
8469
  /**
7909
8470
  * Entity type: OrganizationUnitSet
7910
8471
  */
@@ -7913,7 +8474,7 @@ export interface CreateOrUpdateOrganizationUnitSetPaymentType {
7913
8474
  * Entity type: PaymentType
7914
8475
  */
7915
8476
  PaymentTypeID: string;
7916
- RefundPriority: number | null | undefined;
8477
+ RefundPriority?: number | null;
7917
8478
  }
7918
8479
  /**
7919
8480
  * Create a new custom PaymentMethod.
@@ -7952,8 +8513,8 @@ export interface CreatePaymentType {
7952
8513
  AutoFinalizeOnOrderPaid?: boolean;
7953
8514
  BackendID?: string;
7954
8515
  BackendRelationID?: string;
7955
- CashJournalMethod: DataModelsPaymentCashJournalMethod;
7956
- Category: DataModelsPaymentTypeCategory;
8516
+ CashJournalMethod?: DataModelsPaymentCashJournalMethod;
8517
+ Category?: DataModelsPaymentTypeCategory;
7957
8518
  Code: string;
7958
8519
  IsActive?: boolean;
7959
8520
  /**
@@ -7967,7 +8528,7 @@ export interface CreatePaymentType {
7967
8528
  */
7968
8529
  PaymentMethodID: string;
7969
8530
  PrintOnDocuments?: boolean;
7970
- ReturnAction: DataModelsPaymentReturnActions;
8531
+ ReturnAction?: DataModelsPaymentReturnActions;
7971
8532
  Roles?: PaymentMethodsCreatePaymentType_PaymentTypeRole[];
7972
8533
  /**
7973
8534
  * Entity type: Script
@@ -8062,6 +8623,9 @@ export interface GetPaymentMethodsResponse {
8062
8623
  }
8063
8624
  export interface PaymentMethodsGetPaymentMethodsResponse_PaymentMethodDto {
8064
8625
  Code?: string;
8626
+ /**
8627
+ * Entity type: PaymentMethod
8628
+ */
8065
8629
  ID: string;
8066
8630
  Name?: string;
8067
8631
  }
@@ -8119,6 +8683,38 @@ export interface PaymentMethodsGetPaymentTypeByIDResponse_PaymentTypeRole {
8119
8683
  RoleID: string;
8120
8684
  }
8121
8685
  /**
8686
+ * Get CustomFields for the given payment type.
8687
+ */
8688
+ export interface GetPaymentTypeCustomFields {
8689
+ /**
8690
+ * Entity type: PaymentType
8691
+ */
8692
+ PaymentTypeID: string;
8693
+ }
8694
+ export interface GetPaymentTypeCustomFieldsResponse {
8695
+ CustomFields?: PaymentMethodsGetPaymentTypeCustomFieldsResponse_CustomFieldDto[];
8696
+ Error?: ServiceError;
8697
+ Metadata?: ResponseMessageMetadata;
8698
+ }
8699
+ export interface PaymentMethodsGetPaymentTypeCustomFieldsResponse_CustomFieldDto {
8700
+ BackendID?: string;
8701
+ DataType: DataModelsCustomFieldDataTypes;
8702
+ DisplayName?: string;
8703
+ EnumValues?: Record<string, string | null>;
8704
+ /**
8705
+ * Entity type: CustomField
8706
+ */
8707
+ ID: string;
8708
+ IsArray: boolean;
8709
+ Name: string;
8710
+ Order: number;
8711
+ /**
8712
+ * Entity type: CustomFieldType
8713
+ */
8714
+ TypeID: string;
8715
+ TypeName: string;
8716
+ }
8717
+ /**
8122
8718
  * Get's the ID/Name of all paymenttypes to use for filter inputs
8123
8719
  */
8124
8720
  export interface GetPaymentTypesForFilter {
@@ -8326,7 +8922,7 @@ export interface PaymentMethodsListPaymentTransactionsSettlementsResponse_Result
8326
8922
  MerchantReference?: string;
8327
8923
  PaymentReference?: string;
8328
8924
  Subtype?: string;
8329
- Type?: APIEnumDto;
8925
+ Type?: EVAFrameworkAPIEnumDto;
8330
8926
  }
8331
8927
  /**
8332
8928
  * List PaymentTypes. Returns a paged response.
@@ -8462,7 +9058,7 @@ export interface UpdatePaymentMethod {
8462
9058
  * Update the description of a PaymentTransactionLedgerType. Only custom made types can be updated.
8463
9059
  */
8464
9060
  export interface UpdatePaymentTransactionLedgerType {
8465
- Description: string | null | undefined;
9061
+ Description?: string | null;
8466
9062
  /**
8467
9063
  * Entity type: PaymentTransactionLedgerType
8468
9064
  */
@@ -8473,8 +9069,8 @@ export interface UpdatePaymentTransactionLedgerType {
8473
9069
  */
8474
9070
  export interface UpdatePaymentType {
8475
9071
  AutoFinalizeOnOrderPaid?: boolean;
8476
- BackendID: string | null | undefined;
8477
- BackendRelationID: string | null | undefined;
9072
+ BackendID?: string | null;
9073
+ BackendRelationID?: string | null;
8478
9074
  CashJournalMethod?: DataModelsPaymentCashJournalMethod;
8479
9075
  Category?: DataModelsPaymentTypeCategory;
8480
9076
  Code?: string;
@@ -8486,49 +9082,49 @@ export interface UpdatePaymentType {
8486
9082
  /**
8487
9083
  * Entity type: LedgerClass
8488
9084
  */
8489
- LedgerClassID: string | null | undefined;
9085
+ LedgerClassID?: string | null;
8490
9086
  Name?: string;
8491
- Options: PaymentMethodsUpdatePaymentType_PaymentTypeOptionsMaybe | undefined;
9087
+ Options?: PaymentMethodsUpdatePaymentType_PaymentTypeOptionsMaybe;
8492
9088
  /**
8493
9089
  * Entity type: PaymentMethod
8494
9090
  */
8495
9091
  PaymentMethodID?: string;
8496
9092
  PrintOnDocuments?: boolean;
8497
9093
  ReturnAction?: DataModelsPaymentReturnActions;
8498
- Roles: PaymentMethodsUpdatePaymentType_PaymentTypeRole[] | null | undefined;
9094
+ Roles?: PaymentMethodsUpdatePaymentType_PaymentTypeRole[] | null;
8499
9095
  /**
8500
9096
  * Entity type: Script
8501
9097
  */
8502
- ScriptID: string | null | undefined;
9098
+ ScriptID?: string | null;
8503
9099
  }
8504
9100
  export interface PaymentMethodsUpdatePaymentType_PaymentTypeOptionsMaybe {
8505
- BlockOverPayments: boolean | null | undefined;
8506
- CanBeCancelled: boolean | null | undefined;
8507
- CanBeRefunded: boolean | null | undefined;
9101
+ BlockOverPayments?: boolean | null;
9102
+ CanBeCancelled?: boolean | null;
9103
+ CanBeRefunded?: boolean | null;
8508
9104
  /**
8509
9105
  * Setting this to false results in refund only, will therefor only work with CanBeRefunded:true and CanRefundWithoutOriginalPaymentTransaction:true
8510
9106
  */
8511
- CanBeUsedForPayments: boolean | null | undefined;
8512
- CanRefundWithoutOriginalPaymentTransaction: boolean | null | undefined;
9107
+ CanBeUsedForPayments?: boolean | null;
9108
+ CanRefundWithoutOriginalPaymentTransaction?: boolean | null;
8513
9109
  /**
8514
9110
  * Entity type: GiftCardConfiguration
8515
9111
  */
8516
- GiftCardConfigurationID: string | null | undefined;
9112
+ GiftCardConfigurationID?: string | null;
8517
9113
  /**
8518
9114
  * Entity type: LoyaltyProgram
8519
9115
  */
8520
- LoyaltyProgramID: string | null | undefined;
8521
- OnlyAvailableInLocalMode: boolean | null | undefined;
8522
- Pending: boolean | null | undefined;
8523
- PinHandler: string | null | undefined;
8524
- RefundPending: boolean | null | undefined;
8525
- RequiredFunctionality: string | null | undefined;
8526
- RequiredFunctionalityScope: SecurityFunctionalityScope | undefined;
8527
- RequiredUserType: UserTypes | undefined;
8528
- RequiresAmount: boolean | null | undefined;
8529
- RequiresConfirmationForPayments: boolean | null | undefined;
8530
- RequiresConfirmationForRefunds: boolean | null | undefined;
8531
- RequiresInteractionForRefunds: boolean | null | undefined;
9116
+ LoyaltyProgramID?: string | null;
9117
+ OnlyAvailableInLocalMode?: boolean | null;
9118
+ Pending?: boolean | null;
9119
+ PinHandler?: string | null;
9120
+ RefundPending?: boolean | null;
9121
+ RequiredFunctionality?: string | null;
9122
+ RequiredFunctionalityScope?: SecurityFunctionalityScope;
9123
+ RequiredUserType?: UserTypes;
9124
+ RequiresAmount?: boolean | null;
9125
+ RequiresConfirmationForPayments?: boolean | null;
9126
+ RequiresConfirmationForRefunds?: boolean | null;
9127
+ RequiresInteractionForRefunds?: boolean | null;
8532
9128
  }
8533
9129
  export interface PaymentMethodsUpdatePaymentType_PaymentTypeRole {
8534
9130
  /**
@@ -8659,10 +9255,8 @@ export interface UploadPaymentSettlementFile {
8659
9255
  /**
8660
9256
  * Entity type: Blob
8661
9257
  */
8662
- BlobID?: string;
8663
- Data?: string;
9258
+ BlobID: string;
8664
9259
  Handler: string;
8665
- MimeType?: string;
8666
9260
  Name: string;
8667
9261
  /**
8668
9262
  * Entity type: OrganizationUnit
@@ -8811,15 +9405,15 @@ export interface RemovePersonalizedPromotionProducts {
8811
9405
  * Update an existing personalized promotion.
8812
9406
  */
8813
9407
  export interface UpdatePersonalizedPromotion {
8814
- BackendID: string | null | undefined;
8815
- Description: string | null | undefined;
9408
+ BackendID?: string | null;
9409
+ Description?: string | null;
8816
9410
  /**
8817
9411
  * Entity type: PersonalizedPromotion
8818
9412
  */
8819
9413
  ID: string;
8820
9414
  LockAfterFirstApply?: boolean;
8821
- MaximumDistinctProducts: number | null | undefined;
8822
- Name: string | null | undefined;
9415
+ MaximumDistinctProducts?: number | null;
9416
+ Name?: string | null;
8823
9417
  }
8824
9418
  /**
8825
9419
  * Create a new PriceList
@@ -8858,6 +9452,10 @@ export interface CreatePriceListAdjustment {
8858
9452
  PriceListID: string;
8859
9453
  PricingGroupID?: string;
8860
9454
  Sequence?: number;
9455
+ /**
9456
+ * If set to true, this will skip the recalculation of the price list after the adjustment is updated, defaults to false so it will always recalculate. Recalculation happens periodically thereafter.
9457
+ */
9458
+ SkipRecalculation?: boolean;
8861
9459
  Type: string;
8862
9460
  }
8863
9461
  export interface CreatePriceListAdjustmentResponse {
@@ -8916,6 +9514,9 @@ export interface CreatePriceListOrganizationUnit {
8916
9514
  }
8917
9515
  export interface CreatePriceListOrganizationUnitResponse {
8918
9516
  Error?: ServiceError;
9517
+ /**
9518
+ * Entity type: PriceListOrganizationUnit
9519
+ */
8919
9520
  ID: string;
8920
9521
  Metadata?: ResponseMessageMetadata;
8921
9522
  }
@@ -8930,7 +9531,7 @@ export interface CreatePriceListResponse {
8930
9531
  export interface CreatePriceListUsageType {
8931
9532
  Description?: string;
8932
9533
  Name: string;
8933
- RequiredUserType: UserTypes;
9534
+ RequiredUserType?: UserTypes;
8934
9535
  }
8935
9536
  export interface CreatePriceListUsageTypeResponse {
8936
9537
  Error?: ServiceError;
@@ -8954,6 +9555,10 @@ export interface DeletePriceListAdjustment {
8954
9555
  * Entity type: PriceListAdjustment
8955
9556
  */
8956
9557
  ID: string;
9558
+ /**
9559
+ * If set to true, this will skip the recalculation of the price list after the adjustment is updated, defaults to false so it will always recalculate. Recalculation happens periodically thereafter.
9560
+ */
9561
+ SkipRecalculation?: boolean;
8957
9562
  }
8958
9563
  /**
8959
9564
  * Delete a PriceListManualInputAdjustment
@@ -9093,6 +9698,7 @@ export interface GetPriceListManualInputAdjustmentByIDResponse {
9093
9698
  * Entity type: PriceListAdjustment
9094
9699
  */
9095
9700
  PriceListAdjustmentID: string;
9701
+ ProductBackendID?: string;
9096
9702
  ProductCustomID?: string;
9097
9703
  /**
9098
9704
  * Entity type: Product
@@ -9219,6 +9825,7 @@ export interface PricingListPriceListManualInputAdjustmentsResponse_PriceListMan
9219
9825
  * Entity type: PriceListManualInputAdjustment
9220
9826
  */
9221
9827
  ID: string;
9828
+ ProductBackendID?: string;
9222
9829
  ProductCustomID?: string;
9223
9830
  /**
9224
9831
  * Entity type: Product
@@ -9239,11 +9846,23 @@ export interface ListPriceListOrganizationUnitsResponse {
9239
9846
  Result?: PagedResult<PricingListPriceListOrganizationUnitsResponse_PriceListOrganizationUnitDto>;
9240
9847
  }
9241
9848
  export interface PricingListPriceListOrganizationUnitsResponse_PriceListOrganizationUnitDto {
9849
+ /**
9850
+ * Entity type: PriceListOrganizationUnit
9851
+ */
9242
9852
  ID: string;
9853
+ /**
9854
+ * Entity type: OrganizationUnit
9855
+ */
9243
9856
  OrganizationUnitID: string;
9244
9857
  OrganizationUnitName?: string;
9245
9858
  PriceList?: PricingListPriceListOrganizationUnitsResponse_PriceListOrganizationUnitDto_PriceListDto;
9859
+ /**
9860
+ * Entity type: PriceList
9861
+ */
9246
9862
  PriceListID: string;
9863
+ /**
9864
+ * Entity type: PriceListUsageType
9865
+ */
9247
9866
  PriceListUsageTypeID: string;
9248
9867
  PriceListUsageTypeName?: string;
9249
9868
  PricingGroupID?: string;
@@ -9391,8 +10010,8 @@ export interface PricingPriceListDto {
9391
10010
  * Update an existing PriceList
9392
10011
  */
9393
10012
  export interface UpdatePriceList {
9394
- BackendID: string | null | undefined;
9395
- BackendSystemID: string | null | undefined;
10013
+ BackendID?: string | null;
10014
+ BackendSystemID?: string | null;
9396
10015
  /**
9397
10016
  * Entity type: Currency
9398
10017
  */
@@ -9405,13 +10024,13 @@ export interface UpdatePriceList {
9405
10024
  IsActive?: boolean;
9406
10025
  IsFinalSalePriceList?: boolean;
9407
10026
  Name?: string;
9408
- TimeZone: string | null | undefined;
10027
+ TimeZone?: string | null;
9409
10028
  }
9410
10029
  /**
9411
10030
  * Update an existing PriceListAdjustment
9412
10031
  */
9413
10032
  export interface UpdatePriceListAdjustment {
9414
- BackendID: string | null | undefined;
10033
+ BackendID?: string | null;
9415
10034
  Data?: PricingIPriceListAdjustmentData;
9416
10035
  EffectiveDate: string;
9417
10036
  ExpireDate?: string;
@@ -9426,8 +10045,12 @@ export interface UpdatePriceListAdjustment {
9426
10045
  * Entity type: PriceListAdjustment
9427
10046
  */
9428
10047
  ParentAdjustmentID?: string;
9429
- PricingGroupID: string | null | undefined;
10048
+ PricingGroupID?: string | null;
9430
10049
  Sequence?: number;
10050
+ /**
10051
+ * If set to true, this will skip the recalculation of the price list after the adjustment is updated, defaults to false so it will always recalculate. Recalculation happens periodically thereafter.
10052
+ */
10053
+ SkipRecalculation?: boolean;
9431
10054
  Type: string;
9432
10055
  }
9433
10056
  /**
@@ -9462,7 +10085,7 @@ export interface UpdatePriceListOrganizationUnit {
9462
10085
  * Entity type: PriceListUsageType
9463
10086
  */
9464
10087
  PriceListUsageTypeID: string;
9465
- PricingGroupID: string | null | undefined;
10088
+ PricingGroupID?: string | null;
9466
10089
  /**
9467
10090
  * Entity type: OrganizationUnit
9468
10091
  */
@@ -9474,7 +10097,7 @@ export interface UpdatePriceListUsageType {
9474
10097
  * Entity type: PriceListUsageType
9475
10098
  */
9476
10099
  ID: string;
9477
- RequiredUserType: UserTypes;
10100
+ RequiredUserType?: UserTypes;
9478
10101
  }
9479
10102
  /**
9480
10103
  * Upload an excel file containing all ManualInputPriceListAdjustments for the given PriceListAdjustment. These will replace all exisiting adjustments.
@@ -9567,6 +10190,33 @@ export interface UpdatePrinterType {
9567
10190
  PaperWidth?: number;
9568
10191
  }
9569
10192
  /**
10193
+ * Returns the product count within the persisted product search template
10194
+ * When product id is given, it wil checks if a product is part of the persisted product search template result.
10195
+ * NOTE THAT after product search template creation/update if can take a few minutes for the result to be updated.
10196
+ */
10197
+ export interface CheckProductSearchTemplate {
10198
+ /**
10199
+ * Entity type: Product
10200
+ */
10201
+ ProductID?: string;
10202
+ /**
10203
+ * Entity type: ProductSearchTemplate
10204
+ */
10205
+ ProductSearchTemplateID: string;
10206
+ }
10207
+ export interface CheckProductSearchTemplateResponse {
10208
+ Error?: ServiceError;
10209
+ /**
10210
+ * Will return true/false is the given product is present. If no product is given it will return null
10211
+ */
10212
+ IsPresent?: boolean;
10213
+ Metadata?: ResponseMessageMetadata;
10214
+ /**
10215
+ * Total count of products withing the product search template result.
10216
+ */
10217
+ ResultCount: number;
10218
+ }
10219
+ /**
9570
10220
  * Creates a barcode for a product for a specific unit of measure.
9571
10221
  *
9572
10222
  * Optionally adds a record in the ProductUnitOfMeasure conversion table for the supplied Quantity.
@@ -9579,6 +10229,9 @@ export interface CreateProductBarcode {
9579
10229
  */
9580
10230
  ProductID: string;
9581
10231
  Quantity?: number;
10232
+ /**
10233
+ * Entity type: UnitOfMeasure
10234
+ */
9582
10235
  UnitOfMeasureID: string;
9583
10236
  }
9584
10237
  /**
@@ -9586,7 +10239,7 @@ export interface CreateProductBarcode {
9586
10239
  */
9587
10240
  export interface CreateProductRequirement {
9588
10241
  BackendID?: string;
9589
- DataType: DataModelsProductRequirementDataTypes;
10242
+ DataType?: DataModelsProductRequirementDataTypes;
9590
10243
  Handler?: string;
9591
10244
  Name: string;
9592
10245
  OrderType?: DataModelsOrderTypes;
@@ -9614,10 +10267,13 @@ export interface CreateProductSearchTemplate {
9614
10267
  IncludeLeafProducts?: boolean;
9615
10268
  MinimumRefreshInterval?: string;
9616
10269
  Name: string;
9617
- Type: DataModelsProductSearchTemplateTypes;
10270
+ Type?: DataModelsProductSearchTemplateTypes;
9618
10271
  }
9619
10272
  export interface CreateProductSearchTemplateResponse {
9620
10273
  Error?: ServiceError;
10274
+ /**
10275
+ * Entity type: ProductSearchTemplate
10276
+ */
9621
10277
  ID: string;
9622
10278
  Metadata?: ResponseMessageMetadata;
9623
10279
  }
@@ -9649,7 +10305,7 @@ export interface CreateSupplierProduct {
9649
10305
  Description?: string;
9650
10306
  PreferredMinimumOrderQuantity?: number;
9651
10307
  PrimitiveName: string;
9652
- Status: DataModelsProductStatus;
10308
+ Status?: DataModelsProductStatus;
9653
10309
  /**
9654
10310
  * Entity type: OrganizationUnit
9655
10311
  */
@@ -9661,6 +10317,9 @@ export interface CreateSupplierProduct {
9661
10317
  }
9662
10318
  export interface CreateSupplierProductResponse {
9663
10319
  Error?: ServiceError;
10320
+ /**
10321
+ * Entity type: Product
10322
+ */
9664
10323
  ID: string;
9665
10324
  Metadata?: ResponseMessageMetadata;
9666
10325
  }
@@ -9674,6 +10333,9 @@ export interface CreateUnitOfMeasure {
9674
10333
  }
9675
10334
  export interface CreateUnitOfMeasureResponse {
9676
10335
  Error?: ServiceError;
10336
+ /**
10337
+ * Entity type: UnitOfMeasure
10338
+ */
9677
10339
  ID: string;
9678
10340
  Metadata?: ResponseMessageMetadata;
9679
10341
  }
@@ -9895,7 +10557,7 @@ export interface GetSupplierProductByIDResponse {
9895
10557
  QuantityOnHand: number;
9896
10558
  RecommendedRecommendedRetailPrice?: number;
9897
10559
  Status: DataModelsProductStatus;
9898
- TaxCode?: APIEnumDto;
10560
+ TaxCode?: EVAFrameworkAPIEnumDto;
9899
10561
  }
9900
10562
  /**
9901
10563
  * Retrieves the suppliers (Organization Units) for the given Product.
@@ -9919,6 +10581,9 @@ export interface GetUnitOfMeasuresResponse {
9919
10581
  export interface ProductsGetUnitOfMeasuresResponse_UnitOfMeasureDto {
9920
10582
  BackendID?: string;
9921
10583
  Description?: string;
10584
+ /**
10585
+ * Entity type: Enum
10586
+ */
9922
10587
  ID: string;
9923
10588
  /**
9924
10589
  * Usually an internal & unchangable code - for display, use `Description`
@@ -9947,7 +10612,7 @@ export interface ProductsListProductBarcodesResponse_ProductBarcodeDto {
9947
10612
  ProductDisplayValue?: string;
9948
10613
  ProductID: string;
9949
10614
  Quantity: number;
9950
- UnitOfMeasure?: APIEnumDto;
10615
+ UnitOfMeasure?: EVAFrameworkAPIEnumDto;
9951
10616
  }
9952
10617
  /**
9953
10618
  * List existing Product Requirements
@@ -10022,7 +10687,7 @@ export interface ProductsListProductUnitOfMeasuresResponse_ProductUnitOfMeasureD
10022
10687
  ProductID: string;
10023
10688
  ProductName?: string;
10024
10689
  Quantity: number;
10025
- UnitOfMeasure?: APIEnumDto;
10690
+ UnitOfMeasure?: EVAFrameworkAPIEnumDto;
10026
10691
  UnitOfMeasureID: string;
10027
10692
  }
10028
10693
  /**
@@ -10050,7 +10715,7 @@ export interface ProductsListSupplierProductsResponse_SupplierProductDto {
10050
10715
  QuantityOnHand: number;
10051
10716
  RecommendedRecommendedRetailPrice?: number;
10052
10717
  Status: DataModelsProductStatus;
10053
- TaxCode?: APIEnumDto;
10718
+ TaxCode?: EVAFrameworkAPIEnumDto;
10054
10719
  }
10055
10720
  export interface ProductsProductRequirementDto {
10056
10721
  BackendID?: string;
@@ -10076,7 +10741,7 @@ export interface ProductsProductRequirementDto {
10076
10741
  */
10077
10742
  export interface UpdateProductRequirement {
10078
10743
  BackendID?: string;
10079
- DataType: DataModelsProductRequirementDataTypes;
10744
+ DataType?: DataModelsProductRequirementDataTypes;
10080
10745
  Handler?: string;
10081
10746
  /**
10082
10747
  * Entity type: ProductRequirement
@@ -10094,15 +10759,15 @@ export interface UpdateProductRequirement {
10094
10759
  * Update an existing ProductSearchTemplate
10095
10760
  */
10096
10761
  export interface UpdateProductSearchTemplate {
10097
- AggregationOptions: Record<string, SearchAggregationFilterModel> | null | undefined;
10098
- BackendID: string | null | undefined;
10762
+ AggregationOptions?: Record<string, SearchAggregationFilterModel> | null;
10763
+ BackendID?: string | null;
10099
10764
  Filters?: Record<string, SearchFilterModel>;
10100
10765
  /**
10101
10766
  * Entity type: ProductSearchTemplate
10102
10767
  */
10103
10768
  ID: string;
10104
10769
  IncludeLeafProducts?: boolean;
10105
- MinimumRefreshInterval: string | null | undefined;
10770
+ MinimumRefreshInterval?: string | null;
10106
10771
  Name?: string;
10107
10772
  Type?: DataModelsProductSearchTemplateTypes;
10108
10773
  }
@@ -10137,7 +10802,7 @@ export interface UpdateSupplierProduct {
10137
10802
  ID: string;
10138
10803
  PreferredMinimumOrderQuantity?: number;
10139
10804
  PrimitiveName: string;
10140
- Status: DataModelsProductStatus;
10805
+ Status?: DataModelsProductStatus;
10141
10806
  /**
10142
10807
  * Entity type: TaxCode
10143
10808
  */
@@ -10272,6 +10937,9 @@ export interface CreateRoleSet {
10272
10937
  }
10273
10938
  export interface CreateRoleSetResponse {
10274
10939
  Error?: ServiceError;
10940
+ /**
10941
+ * Entity type: RoleSet
10942
+ */
10275
10943
  ID: string;
10276
10944
  Metadata?: ResponseMessageMetadata;
10277
10945
  }
@@ -10302,8 +10970,8 @@ export interface DetachFunctionalitiesFromRole {
10302
10970
  }
10303
10971
  export interface RightsFunctionalityWithScope {
10304
10972
  Functionality: string;
10305
- RequiresElevation: boolean;
10306
- Scope: SecurityFunctionalityScope;
10973
+ RequiresElevation?: boolean;
10974
+ Scope?: SecurityFunctionalityScope;
10307
10975
  }
10308
10976
  export interface GetAvailableRoles {
10309
10977
  UserID: string;
@@ -10361,11 +11029,17 @@ export interface GetRoleResponse {
10361
11029
  Result?: RightsRoleWithFunctionalitiesDto;
10362
11030
  }
10363
11031
  export interface GetRoleSetByID {
11032
+ /**
11033
+ * Entity type: RoleSet
11034
+ */
10364
11035
  ID: string;
10365
11036
  }
10366
11037
  export interface GetRoleSetByIDResponse {
10367
11038
  BackendID?: string;
10368
11039
  Error?: ServiceError;
11040
+ /**
11041
+ * Entity type: RoleSet
11042
+ */
10369
11043
  ID: string;
10370
11044
  Metadata?: ResponseMessageMetadata;
10371
11045
  Name?: string;
@@ -10477,6 +11151,9 @@ export interface ListRoleSetsResponse {
10477
11151
  }
10478
11152
  export interface RightsListRoleSetsResponse_RoleSetDto {
10479
11153
  BackendID?: string;
11154
+ /**
11155
+ * Entity type: RoleSet
11156
+ */
10480
11157
  ID: string;
10481
11158
  Name?: string;
10482
11159
  }
@@ -10606,17 +11283,17 @@ export interface SetUserRoles {
10606
11283
  * Update a role.
10607
11284
  */
10608
11285
  export interface UpdateRole {
10609
- Code: string | null | undefined;
11286
+ Code?: string | null;
10610
11287
  /**
10611
11288
  * If this is set, any users that have not logged in after said days will get disabled
10612
11289
  */
10613
- DeactivateUserAfterInactiveDays: number | null | undefined;
11290
+ DeactivateUserAfterInactiveDays?: number | null;
10614
11291
  /**
10615
11292
  * Entity type: Role
10616
11293
  */
10617
11294
  ID: string;
10618
11295
  Name?: string;
10619
- UserType: UserTypes | undefined;
11296
+ UserType?: UserTypes;
10620
11297
  }
10621
11298
  /**
10622
11299
  * Update functionalities on a role.
@@ -10632,12 +11309,12 @@ export interface RightsUpdateRoleFunctionalities_FunctionalityToUpdate {
10632
11309
  /**
10633
11310
  * Scopes available only when elevated for this functionality. Should be set to `None (0)` for unscoped functionalities. To remove this functionality, set to `null`.
10634
11311
  */
10635
- ElevationScope: SecurityFunctionalityScope | undefined;
11312
+ ElevationScope?: SecurityFunctionalityScope;
10636
11313
  Functionality: string;
10637
11314
  /**
10638
11315
  * Scopes available for this functionality. Should be set to `None (0)` for unscoped functionalities. To remove this functionality, set to `null`.
10639
11316
  */
10640
- Scope: SecurityFunctionalityScope | undefined;
11317
+ Scope?: SecurityFunctionalityScope;
10641
11318
  }
10642
11319
  export interface UpdateRoleSet {
10643
11320
  BackendID?: string;
@@ -10706,6 +11383,9 @@ export interface AddPackageToCarrier {
10706
11383
  export interface ShippingCarrierDto {
10707
11384
  BackendID?: string;
10708
11385
  Code?: string;
11386
+ /**
11387
+ * Entity type: Carrier
11388
+ */
10709
11389
  ID: string;
10710
11390
  Name?: string;
10711
11391
  }
@@ -10719,6 +11399,9 @@ export interface CreateCarrier {
10719
11399
  }
10720
11400
  export interface CreateCarrierResponse {
10721
11401
  Error?: ServiceError;
11402
+ /**
11403
+ * Entity type: Carrier
11404
+ */
10722
11405
  ID: string;
10723
11406
  Metadata?: ResponseMessageMetadata;
10724
11407
  }
@@ -10771,6 +11454,9 @@ export interface CreatePackage {
10771
11454
  }
10772
11455
  export interface CreatePackageResponse {
10773
11456
  Error?: ServiceError;
11457
+ /**
11458
+ * Entity type: Package
11459
+ */
10774
11460
  ID: string;
10775
11461
  Metadata?: ResponseMessageMetadata;
10776
11462
  }
@@ -10798,7 +11484,6 @@ export interface CreateShippingCost {
10798
11484
  * Entity type: ShippingMethod
10799
11485
  */
10800
11486
  ShippingMethodID?: string;
10801
- UnitPriceInTax?: number;
10802
11487
  ZipCodes?: string[];
10803
11488
  }
10804
11489
  export interface CreateShippingCostResponse {
@@ -10815,7 +11500,7 @@ export interface CreateShippingMethod {
10815
11500
  */
10816
11501
  CarrierID: string;
10817
11502
  Code?: string;
10818
- DeliveryType: DataModelsShippingMethodDeliveryTypes;
11503
+ DeliveryType?: DataModelsShippingMethodDeliveryTypes;
10819
11504
  ExcludeProductsFromShippingMethod?: boolean;
10820
11505
  Handler?: string;
10821
11506
  InvoicingHandledByCarrier?: boolean;
@@ -10828,6 +11513,14 @@ export interface CreateShippingMethod {
10828
11513
  ShippingHandledByCarrier?: boolean;
10829
11514
  SupportsPickupAddress?: boolean;
10830
11515
  }
11516
+ export interface CreateShippingMethodResponse {
11517
+ Error?: ServiceError;
11518
+ /**
11519
+ * Entity type: ShippingMethod
11520
+ */
11521
+ ID: string;
11522
+ Metadata?: ResponseMessageMetadata;
11523
+ }
10831
11524
  /**
10832
11525
  * Creates a new ShippingMethodTransportationTime.
10833
11526
  */
@@ -10846,20 +11539,35 @@ export interface CreateShippingMethodTransportationTime {
10846
11539
  */
10847
11540
  ToCountryID?: string;
10848
11541
  }
11542
+ export interface CreateShippingMethodTransportationTimeResponse {
11543
+ Error?: ServiceError;
11544
+ /**
11545
+ * Entity type: ShippingMethodTransportationTime
11546
+ */
11547
+ ID: string;
11548
+ Metadata?: ResponseMessageMetadata;
11549
+ }
10849
11550
  /**
10850
11551
  * Creates a new ShippingRestriction.
10851
11552
  */
10852
11553
  export interface CreateShippingRestriction {
11554
+ /**
11555
+ * When set to `true`, the script will be leading for the entire order. Default is `true`
11556
+ */
11557
+ CheckScriptOnly?: boolean;
10853
11558
  /**
10854
11559
  * Entity type: Country
11560
+ * Required when there is no ScriptID set or CheckScriptOnly is 'false'
10855
11561
  */
10856
- CountryID: string;
11562
+ CountryID?: string;
10857
11563
  /**
10858
11564
  * Entity type: OrganizationUnit
11565
+ * Either an OrganizationUnitID or an OrganizationUnitSetID is required when there is no ScriptID set or CheckScriptOnly is 'false'
10859
11566
  */
10860
11567
  OrganizationUnitID?: string;
10861
11568
  /**
10862
11569
  * Entity type: OrganizationUnitSet
11570
+ * Either an OrganizationUnitID or an OrganizationUnitSetID is required when there is no ScriptID set or CheckScriptOnly is 'false'
10863
11571
  */
10864
11572
  OrganizationUnitSetID?: string;
10865
11573
  /**
@@ -10867,17 +11575,23 @@ export interface CreateShippingRestriction {
10867
11575
  */
10868
11576
  ProductPropertyTypeID?: string;
10869
11577
  ProductPropertyTypeValues?: string[];
11578
+ /**
11579
+ * Entity type: ProductSearchTemplate
11580
+ */
10870
11581
  ProductSearchTemplateID?: string;
10871
11582
  /**
10872
11583
  * Entity type: Script
10873
11584
  */
10874
11585
  ScriptID?: string;
10875
- Type: DataModelsShippingRestrictionType;
11586
+ Type?: DataModelsShippingRestrictionType;
10876
11587
  ZipCodeFrom?: string;
10877
11588
  ZipCodeTo?: string;
10878
11589
  }
10879
11590
  export interface CreateShippingRestrictionResponse {
10880
11591
  Error?: ServiceError;
11592
+ /**
11593
+ * Entity type: ShippingRestriction
11594
+ */
10881
11595
  ID: string;
10882
11596
  Metadata?: ResponseMessageMetadata;
10883
11597
  }
@@ -11025,7 +11739,6 @@ export interface GetShippingCostByIDResponse {
11025
11739
  OrganizationUnitName?: string;
11026
11740
  ShippingMethodID?: string;
11027
11741
  ShippingMethodName?: string;
11028
- UnitPriceInTax: number;
11029
11742
  ZipCodes?: string[];
11030
11743
  }
11031
11744
  /**
@@ -11049,6 +11762,9 @@ export interface GetShippingMethodByIDResponse {
11049
11762
  Error?: ServiceError;
11050
11763
  ExcludeProductsFromShippingMethod: boolean;
11051
11764
  Handler?: string;
11765
+ /**
11766
+ * Entity type: ShippingMethod
11767
+ */
11052
11768
  ID: string;
11053
11769
  InvoicingHandledByCarrier: boolean;
11054
11770
  Metadata?: ResponseMessageMetadata;
@@ -11070,19 +11786,32 @@ export interface GetShippingRestrictionByID {
11070
11786
  ID: string;
11071
11787
  }
11072
11788
  export interface GetShippingRestrictionByIDResponse {
11789
+ CheckScriptOnly: boolean;
11073
11790
  CountryID?: string;
11074
11791
  CountryName?: string;
11075
11792
  Error?: ServiceError;
11793
+ /**
11794
+ * Entity type: ShippingRestriction
11795
+ */
11076
11796
  ID: string;
11077
11797
  Metadata?: ResponseMessageMetadata;
11798
+ /**
11799
+ * Entity type: OrganizationUnit
11800
+ */
11078
11801
  OrganizationUnitID?: string;
11079
11802
  OrganizationUnitName?: string;
11080
11803
  OrganizationUnitSetDescription?: string;
11081
- OrganizationUnitSetID: string;
11804
+ /**
11805
+ * Entity type: OrganizationUnitSet
11806
+ */
11807
+ OrganizationUnitSetID?: string;
11082
11808
  OrganizationUnitSetName?: string;
11083
11809
  OrganizationUnitSetType?: DataModelsOrganizationUnitSetTypes;
11084
11810
  ProductPropertyTypeID?: string;
11085
11811
  ProductPropertyTypeValues?: string[];
11812
+ /**
11813
+ * Entity type: ProductSearchTemplate
11814
+ */
11086
11815
  ProductSearchTemplateID?: string;
11087
11816
  /**
11088
11817
  * Entity type: Script
@@ -11116,15 +11845,24 @@ export interface ListManagementShippingMethodsResponse {
11116
11845
  }
11117
11846
  export interface ShippingListManagementShippingMethodsResponse_Data {
11118
11847
  CarrierCode?: string;
11848
+ /**
11849
+ * Entity type: Carrier
11850
+ */
11119
11851
  CarrierID: string;
11120
11852
  CarrierName?: string;
11121
11853
  Code?: string;
11122
11854
  DeliveryType: DataModelsShippingMethodDeliveryTypes;
11123
11855
  Handler?: string;
11856
+ /**
11857
+ * Entity type: ShippingMethod
11858
+ */
11124
11859
  ID: string;
11125
11860
  InvoicingHandledByCarrier: boolean;
11126
11861
  Name?: string;
11127
11862
  PaymentHandledByCarrier: boolean;
11863
+ /**
11864
+ * Entity type: ProductSearchTemplate
11865
+ */
11128
11866
  ProductSearchTemplateID?: string;
11129
11867
  ProductSearchTemplateName?: string;
11130
11868
  ShippingHandledByCarrier: boolean;
@@ -11221,6 +11959,9 @@ export interface ShippingPackageDto {
11221
11959
  Code?: string;
11222
11960
  Description?: string;
11223
11961
  Height: number;
11962
+ /**
11963
+ * Entity type: Package
11964
+ */
11224
11965
  ID: string;
11225
11966
  IsDefault: boolean;
11226
11967
  Length: number;
@@ -11252,7 +11993,6 @@ export interface ShippingShippingCostDto {
11252
11993
  OrganizationUnitName?: string;
11253
11994
  ShippingMethodID?: string;
11254
11995
  ShippingMethodName?: string;
11255
- UnitPriceInTax: number;
11256
11996
  ZipCodes?: string[];
11257
11997
  }
11258
11998
  export interface ShippingShippingRestrictionDto {
@@ -11274,9 +12014,9 @@ export interface ShippingShippingRestrictionDto {
11274
12014
  /**
11275
12015
  * Entity type: OrganizationUnitSet
11276
12016
  */
11277
- OrganizationUnitSetID: string;
12017
+ OrganizationUnitSetID?: string;
11278
12018
  OrganizationUnitSetName?: string;
11279
- OrganizationUnitSetType: DataModelsOrganizationUnitSetTypes;
12019
+ OrganizationUnitSetType?: DataModelsOrganizationUnitSetTypes;
11280
12020
  /**
11281
12021
  * Entity type: ProductPropertyType
11282
12022
  */
@@ -11371,7 +12111,6 @@ export interface UpdateShippingCost {
11371
12111
  * Entity type: ShippingMethod
11372
12112
  */
11373
12113
  ShippingMethodID?: string;
11374
- UnitPriceInTax?: number;
11375
12114
  ZipCodes?: string[];
11376
12115
  }
11377
12116
  /**
@@ -11383,7 +12122,7 @@ export interface UpdateShippingMethod {
11383
12122
  */
11384
12123
  CarrierID: string;
11385
12124
  Code?: string;
11386
- DeliveryType: DataModelsShippingMethodDeliveryTypes;
12125
+ DeliveryType?: DataModelsShippingMethodDeliveryTypes;
11387
12126
  ExcludeProductsFromShippingMethod?: boolean;
11388
12127
  Handler?: string;
11389
12128
  /**
@@ -11428,10 +12167,14 @@ export interface UpdateShippingMethodTransportationTime {
11428
12167
  * Updates a ShippingRestriction.
11429
12168
  */
11430
12169
  export interface UpdateShippingRestriction {
12170
+ /**
12171
+ * When set to `true`, the script will be leading for the entire order.
12172
+ */
12173
+ CheckScriptOnly?: boolean;
11431
12174
  /**
11432
12175
  * Entity type: Country
11433
12176
  */
11434
- CountryID: string | null | undefined;
12177
+ CountryID?: string | null;
11435
12178
  /**
11436
12179
  * Entity type: ShippingRestriction
11437
12180
  */
@@ -11439,24 +12182,24 @@ export interface UpdateShippingRestriction {
11439
12182
  /**
11440
12183
  * Entity type: OrganizationUnit
11441
12184
  */
11442
- OrganizationUnitID: string | null | undefined;
12185
+ OrganizationUnitID?: string | null;
11443
12186
  /**
11444
12187
  * Entity type: OrganizationUnitSet
11445
12188
  */
11446
- OrganizationUnitSetID: string | null | undefined;
12189
+ OrganizationUnitSetID?: string | null;
11447
12190
  /**
11448
12191
  * Entity type: ProductPropertyType
11449
12192
  */
11450
- ProductPropertyTypeID: string | null | undefined;
11451
- ProductPropertyTypeValues: string[] | null | undefined;
11452
- ProductSearchTemplateID: string | null | undefined;
12193
+ ProductPropertyTypeID?: string | null;
12194
+ ProductPropertyTypeValues?: string[] | null;
12195
+ ProductSearchTemplateID?: string | null;
11453
12196
  /**
11454
12197
  * Entity type: Script
11455
12198
  */
11456
- ScriptID: string | null | undefined;
12199
+ ScriptID?: string | null;
11457
12200
  Type?: DataModelsShippingRestrictionType;
11458
- ZipCodeFrom: string | null | undefined;
11459
- ZipCodeTo: string | null | undefined;
12201
+ ZipCodeFrom?: string | null;
12202
+ ZipCodeTo?: string | null;
11460
12203
  }
11461
12204
  /**
11462
12205
  * Upload ShippingRestrictions. Expected format is an Excel file.
@@ -11498,6 +12241,9 @@ export interface CreateStockAllocationRule {
11498
12241
  * In case there is not enough stock, Priority is used to determine who gets preference. A higher Priority means a higher preference.
11499
12242
  */
11500
12243
  Priority?: number;
12244
+ /**
12245
+ * Entity type: Product
12246
+ */
11501
12247
  ProductID?: string;
11502
12248
  /**
11503
12249
  * Entity type: ProductSearchTemplate
@@ -11505,9 +12251,17 @@ export interface CreateStockAllocationRule {
11505
12251
  ProductSearchTemplateID?: string;
11506
12252
  RefillPeriodInDays?: number;
11507
12253
  StartDate?: string;
11508
- Type: DataModelsStockAllocationRuleTypes;
12254
+ Type?: DataModelsStockAllocationRuleTypes;
11509
12255
  Value?: number;
11510
- ValueType: DataModelsStockAllocationRuleValueTypes;
12256
+ ValueType?: DataModelsStockAllocationRuleValueTypes;
12257
+ }
12258
+ export interface CreateStockAllocationRuleResponse {
12259
+ Error?: ServiceError;
12260
+ /**
12261
+ * Entity type: StockAllocationRule
12262
+ */
12263
+ ID: string;
12264
+ Metadata?: ResponseMessageMetadata;
11511
12265
  }
11512
12266
  /**
11513
12267
  * Create a new StockLabel
@@ -11516,6 +12270,7 @@ export interface CreateStockAllocationRule {
11516
12270
  */
11517
12271
  export interface CreateStockLabel {
11518
12272
  Description?: string;
12273
+ DisplayName?: string;
11519
12274
  LedgerClassID?: string;
11520
12275
  Name: string;
11521
12276
  }
@@ -11531,6 +12286,9 @@ export interface CreateStockLabelResponse {
11531
12286
  * Deletes a StockAllocationRule.
11532
12287
  */
11533
12288
  export interface DeleteStockAllocationRule {
12289
+ /**
12290
+ * Entity type: StockAllocationRule
12291
+ */
11534
12292
  ID: string;
11535
12293
  }
11536
12294
  /**
@@ -11562,6 +12320,9 @@ export interface ListCumulativeStockResponse {
11562
12320
  }
11563
12321
  export interface StockListCumulativeStockResponse_Model {
11564
12322
  OrganizationUnitBackendID?: string;
12323
+ /**
12324
+ * Entity type: OrganizationUnit
12325
+ */
11565
12326
  OrganizationUnitID: string;
11566
12327
  OrganizationUnitName?: string;
11567
12328
  Product?: SearchIProductSearchItem;
@@ -11587,6 +12348,9 @@ export interface RefillStockAllocation {
11587
12348
  */
11588
12349
  export interface UpdateStockAllocationRule {
11589
12350
  EndDate?: string;
12351
+ /**
12352
+ * Entity type: StockAllocationRule
12353
+ */
11590
12354
  ID: string;
11591
12355
  /**
11592
12356
  * In case there is not enough stock, Priority is used to determine who gets preference. A higher Priority means a higher preference.
@@ -11601,12 +12365,13 @@ export interface UpdateStockAllocationRule {
11601
12365
  * Update the description or ledgerclass of StockLabel
11602
12366
  */
11603
12367
  export interface UpdateStockLabel {
11604
- Description?: string;
12368
+ Description?: string | null;
12369
+ DisplayName?: string | null;
11605
12370
  /**
11606
12371
  * Entity type: StockLabel
11607
12372
  */
11608
12373
  ID: string;
11609
- LedgerClassID?: string;
12374
+ LedgerClassID?: string | null;
11610
12375
  }
11611
12376
  /**
11612
12377
  * A service to upload an Excel containing StockAllocationRules that should be created or updated according to the values specified in the sheet.
@@ -11731,8 +12496,8 @@ export interface StockMutationsStockMutationReason {
11731
12496
  * Update a custom or internal stock mutation reason. The name cannot be modified for internal reasons.
11732
12497
  */
11733
12498
  export interface UpdateStockMutationReason {
11734
- BackendID: string | null | undefined;
11735
- Description: string | null | undefined;
12499
+ BackendID?: string | null;
12500
+ Description?: string | null;
11736
12501
  /**
11737
12502
  * Entity type: StockMutationReasons
11738
12503
  */
@@ -11881,11 +12646,12 @@ export interface CreateUserOriginResponse {
11881
12646
  * Creates a new UserRequirement and returns the ID of the new record.
11882
12647
  */
11883
12648
  export interface CreateUserRequirement {
12649
+ AccountType?: DataModelsUserAccountType;
11884
12650
  CustomValidators?: Record<string, TAnyValue | null>;
11885
12651
  Display?: boolean;
11886
12652
  Preferred?: boolean;
11887
12653
  Property: string;
11888
- RequiredFor: UsersUserRequirementsUserRequirementFor;
12654
+ RequiredFor?: UsersUserRequirementsUserRequirementFor;
11889
12655
  /**
11890
12656
  * Entity type: Script
11891
12657
  */
@@ -11902,7 +12668,7 @@ export interface CreateUserRequirement {
11902
12668
  * Entity type: UserRequirementSet
11903
12669
  */
11904
12670
  UserRequirementSetID?: string;
11905
- UserType: UserTypes;
12671
+ UserType?: UserTypes;
11906
12672
  }
11907
12673
  export interface CreateUserRequirementResponse {
11908
12674
  Error?: ServiceError;
@@ -12067,16 +12833,16 @@ export interface CreateEmployeeUserResponse {
12067
12833
  * Create or update employeedata for a user
12068
12834
  */
12069
12835
  export interface CreateOrUpdateEmployeeData {
12070
- EmployeeNumber: string | null | undefined;
12071
- Function: string | null | undefined;
12836
+ EmployeeNumber?: string | null;
12837
+ Function?: string | null;
12072
12838
  /**
12073
12839
  * Entity type: User
12074
12840
  */
12075
- ManagerID: string | null | undefined;
12841
+ ManagerID?: string | null;
12076
12842
  /**
12077
12843
  * Entity type: OrganizationUnit
12078
12844
  */
12079
- PrimaryOrganizationUnitID: string | null | undefined;
12845
+ PrimaryOrganizationUnitID?: string | null;
12080
12846
  /**
12081
12847
  * Entity type: User
12082
12848
  */
@@ -12272,6 +13038,9 @@ export interface GetUserOriginsResponse {
12272
13038
  export interface UsersGetUserOriginsResponse_UserOriginDto {
12273
13039
  BackendID?: string;
12274
13040
  Description?: string;
13041
+ /**
13042
+ * Entity type: Enum
13043
+ */
12275
13044
  ID: string;
12276
13045
  /**
12277
13046
  * Usually an internal & unchangable code - for display, use `Description`
@@ -12316,6 +13085,7 @@ export interface GetUserRequirement {
12316
13085
  ID: string;
12317
13086
  }
12318
13087
  export interface GetUserRequirementResponse {
13088
+ AccountType?: DataModelsUserAccountType;
12319
13089
  CustomValidators?: Record<string, TAnyValue | null>;
12320
13090
  Display: boolean;
12321
13091
  Error?: ServiceError;
@@ -12539,6 +13309,7 @@ export interface ListUserRequirementsResponse {
12539
13309
  Result?: PagedResult<UsersListUserRequirementsResponse_UserRequirementDto>;
12540
13310
  }
12541
13311
  export interface UsersListUserRequirementsResponse_UserRequirementDto {
13312
+ AccountType?: DataModelsUserAccountType;
12542
13313
  CustomValidators?: Record<string, TAnyValue | null>;
12543
13314
  Display: boolean;
12544
13315
  /**
@@ -12612,8 +13383,8 @@ export interface UpdateSubscription {
12612
13383
  /**
12613
13384
  * The (optional) BackendID of the subscription
12614
13385
  */
12615
- BackendID: string | null | undefined;
12616
- Description: string | null | undefined;
13386
+ BackendID?: string | null;
13387
+ Description?: string | null;
12617
13388
  /**
12618
13389
  * Entity type: Subscription
12619
13390
  */
@@ -12621,7 +13392,7 @@ export interface UpdateSubscription {
12621
13392
  /**
12622
13393
  * Entity type: Inquiry
12623
13394
  */
12624
- InquiryID: string | null | undefined;
13395
+ InquiryID?: string | null;
12625
13396
  /**
12626
13397
  * The name of the subscription
12627
13398
  */
@@ -12667,16 +13438,17 @@ export interface UpdateSubscriptionUserRequirements {
12667
13438
  Requirements: UsersUpdateSubscriptionUserRequirements_UserRequirementDto[];
12668
13439
  }
12669
13440
  export interface UsersUpdateSubscriptionUserRequirements_UserRequirementDto {
12670
- CustomValidators: Record<string, TAnyValue | null> | null | undefined;
13441
+ AccountType?: DataModelsUserAccountType;
13442
+ CustomValidators?: Record<string, TAnyValue | null> | null;
12671
13443
  Display?: boolean;
12672
13444
  /**
12673
13445
  * Entity type: UserRequirement
12674
13446
  */
12675
13447
  ID?: string;
12676
13448
  Preferred?: boolean;
12677
- Property: string | null | undefined;
13449
+ Property?: string | null;
12678
13450
  RequiredFor?: UsersUserRequirementsUserRequirementFor;
12679
- UserType: UserTypes | undefined;
13451
+ UserType?: UserTypes;
12680
13452
  }
12681
13453
  /**
12682
13454
  * Update an existing UserOrigin
@@ -12697,23 +13469,24 @@ export interface UpdateUserOrigin {
12697
13469
  * Updates an existing UserRequirement.
12698
13470
  */
12699
13471
  export interface UpdateUserRequirement {
12700
- CustomValidators: Record<string, TAnyValue | null> | null | undefined;
13472
+ AccountType?: DataModelsUserAccountType;
13473
+ CustomValidators?: Record<string, TAnyValue | null> | null;
12701
13474
  Display?: boolean;
12702
13475
  /**
12703
13476
  * Entity type: UserRequirement
12704
13477
  */
12705
13478
  ID: string;
12706
13479
  Preferred?: boolean;
12707
- Property: string | null | undefined;
13480
+ Property?: string | null;
12708
13481
  RequiredFor?: UsersUserRequirementsUserRequirementFor;
12709
13482
  /**
12710
13483
  * Entity type: Script
12711
13484
  */
12712
- ScriptID: string | null | undefined;
13485
+ ScriptID?: string | null;
12713
13486
  /**
12714
13487
  * Entity type: ShippingMethod
12715
13488
  */
12716
- ShippingMethodID: string | null | undefined;
13489
+ ShippingMethodID?: string | null;
12717
13490
  UserType?: UserTypes;
12718
13491
  }
12719
13492
  /**
@@ -12724,7 +13497,7 @@ export interface UpdateUserRequirementSet {
12724
13497
  * Entity type: UserRequirementSet
12725
13498
  */
12726
13499
  ID: string;
12727
- Name: string | null | undefined;
13500
+ Name?: string;
12728
13501
  /**
12729
13502
  * Entity type: OrganizationUnitSet
12730
13503
  */
@@ -12741,24 +13514,25 @@ export interface UpdateUserRequirementSetRequirements {
12741
13514
  Requirements?: UsersUpdateUserRequirementSetRequirements_UserRequirementDto[];
12742
13515
  }
12743
13516
  export interface UsersUpdateUserRequirementSetRequirements_UserRequirementDto {
12744
- CustomValidators: Record<string, TAnyValue | null> | null | undefined;
13517
+ AccountType?: DataModelsUserAccountType;
13518
+ CustomValidators?: Record<string, TAnyValue | null> | null;
12745
13519
  Display?: boolean;
12746
13520
  /**
12747
13521
  * Entity type: UserRequirement
12748
13522
  */
12749
13523
  ID?: string;
12750
13524
  Preferred?: boolean;
12751
- Property: string | null | undefined;
13525
+ Property?: string | null;
12752
13526
  RequiredFor?: UsersUserRequirementsUserRequirementFor;
12753
13527
  /**
12754
13528
  * Entity type: Script
12755
13529
  */
12756
- ScriptID: string | null | undefined;
13530
+ ScriptID?: string | null;
12757
13531
  /**
12758
13532
  * Entity type: ShippingMethod
12759
13533
  */
12760
- ShippingMethodID: string | null | undefined;
12761
- UserType: UserTypes | undefined;
13534
+ ShippingMethodID?: string | null;
13535
+ UserType?: UserTypes;
12762
13536
  }
12763
13537
  /**
12764
13538
  * Get the wishlist by ID.
@@ -12771,6 +13545,9 @@ export interface GetWishlist {
12771
13545
  }
12772
13546
  export interface GetWishlistResponse {
12773
13547
  CreatedOn: string;
13548
+ /**
13549
+ * Entity type: CustomField
13550
+ */
12774
13551
  CustomFieldValuesWithOptions?: Record<string, DataModelsCustomFieldValueWithOptions>;
12775
13552
  Description?: string;
12776
13553
  Error?: ServiceError;
@@ -12971,7 +13748,7 @@ export interface VisibilityGroupsListVisibilityGroupsResponse_VisibilityGroupDto
12971
13748
  */
12972
13749
  export interface UpdateVisibilityGroup {
12973
13750
  AllowCustomerStandardAccounts?: boolean;
12974
- Description: string | null | undefined;
13751
+ Description?: string | null;
12975
13752
  /**
12976
13753
  * Entity type: VisibilityGroup
12977
13754
  */
@@ -13006,7 +13783,7 @@ export interface EVACoreServicesAssortmentsAddProductsToAssortment_AssortmentPro
13006
13783
  * Entity type: Product
13007
13784
  */
13008
13785
  ProductID: string;
13009
- ProductStatus: DataModelsProductStatus;
13786
+ ProductStatus?: DataModelsProductStatus;
13010
13787
  ProductStatusesToIgnoreToChildProducts?: DataModelsProductStatus;
13011
13788
  StartDate?: string;
13012
13789
  }
@@ -13054,7 +13831,7 @@ export interface EVACoreServicesAssortmentsCreateAssortment_AssortmentProduct {
13054
13831
  * Entity type: Product
13055
13832
  */
13056
13833
  ProductID: string;
13057
- ProductStatus: DataModelsProductStatus;
13834
+ ProductStatus?: DataModelsProductStatus;
13058
13835
  StartDate?: string;
13059
13836
  }
13060
13837
  export interface CreateAssortmentResponse {
@@ -13191,6 +13968,9 @@ export interface EVACoreServicesAssortmentsGetAssortmentRootProductsResponse_Ass
13191
13968
  MixedProductStatuses: DataModelsProductStatus;
13192
13969
  ProductBackendID?: string;
13193
13970
  ProductDetails?: SearchIProductSearchItem;
13971
+ /**
13972
+ * Entity type: Product
13973
+ */
13194
13974
  ProductID: string;
13195
13975
  ProductStatus: DataModelsProductStatus;
13196
13976
  ProductType: DataModelsProductTypes;
@@ -13300,7 +14080,7 @@ export interface ExportGeneralLedgerSummaryToExcel {
13300
14080
  export interface CreateFraudItem {
13301
14081
  Data?: string;
13302
14082
  Object?: TAnyValue;
13303
- Type: DataModelsFraudDataType;
14083
+ Type?: DataModelsFraudDataType;
13304
14084
  }
13305
14085
  export interface CreateFraudItemResponse {
13306
14086
  Error?: ServiceError;
@@ -13413,7 +14193,10 @@ export interface ListRestockedProducts {
13413
14193
  export interface ListRestockedProductsResponse {
13414
14194
  Error?: ServiceError;
13415
14195
  Metadata?: ResponseMessageMetadata;
13416
- Results?: Record<string, number[] | null>;
14196
+ /**
14197
+ * Entity type: StockLabel
14198
+ */
14199
+ Results?: Record<string, string[] | null>;
13417
14200
  }
13418
14201
  /**
13419
14202
  * List the Stock per product/stocklabel for a subset of OrganizationUnits.
@@ -13475,29 +14258,38 @@ export interface EVACoreServicesStockListStockForOrganizationUnitsFilter {
13475
14258
  export interface ListStockForOrganizationUnitsResponse {
13476
14259
  Error?: ServiceError;
13477
14260
  Metadata?: ResponseMessageMetadata;
14261
+ /**
14262
+ * Entity type: Product
14263
+ */
13478
14264
  Products?: Record<string, EVACoreServicesStockListStockForOrganizationUnitsResponse_ProductDto>;
13479
14265
  Result?: PagedResult<EVACoreServicesStockListStockForOrganizationUnitsResponse_StockDto>;
13480
14266
  Url?: string;
13481
14267
  }
13482
14268
  export interface EVACoreServicesStockListStockForOrganizationUnitsResponse_ProductDto {
13483
- CurrencyID?: string;
13484
14269
  Product?: SearchIProductSearchItem;
13485
- TaxCodeID: string;
13486
- TaxRate: number;
13487
- UnitCost: number;
13488
- UnitPrice: number;
13489
- UnitPriceInTax: number;
13490
14270
  }
13491
14271
  export interface EVACoreServicesStockListStockForOrganizationUnitsResponse_StockDto {
13492
14272
  OrganizationUnitCurrencyID?: string;
14273
+ /**
14274
+ * Entity type: OrganizationUnit
14275
+ */
13493
14276
  OrganizationUnitID?: string;
13494
14277
  OrganizationUnitName?: string;
14278
+ /**
14279
+ * Entity type: Product
14280
+ */
13495
14281
  ProductID: string;
13496
14282
  QuantityAvailable: number;
13497
14283
  QuantityCommitted: number;
13498
14284
  QuantityOnHand: number;
14285
+ /**
14286
+ * Entity type: StockLabel
14287
+ */
13499
14288
  StockLabel: string;
13500
14289
  StockLabelName?: string;
14290
+ /**
14291
+ * Entity type: TaxCode
14292
+ */
13501
14293
  TaxCodeID: string;
13502
14294
  TaxRate: number;
13503
14295
  /**
@@ -13533,6 +14325,10 @@ export interface AddUserBoughtProductDetail {
13533
14325
  * Entity type: OrderLine
13534
14326
  */
13535
14327
  OrderLineID?: string;
14328
+ /**
14329
+ * Entity type: OrganizationUnit
14330
+ */
14331
+ OrganizationUnitID?: string;
13536
14332
  PurchaseDate?: string;
13537
14333
  PurchasedQuantity?: number;
13538
14334
  /**
@@ -13614,6 +14410,16 @@ export interface GetUserBoughtProduct {
13614
14410
  */
13615
14411
  IncludedProductProperties?: string[];
13616
14412
  }
14413
+ /**
14414
+ * Get a user bought product by a product's serial number.
14415
+ */
14416
+ export interface GetUserBoughtProductBySerialNumber {
14417
+ /**
14418
+ * Entity type: ProductPropertyType
14419
+ */
14420
+ IncludedProductProperties?: string[];
14421
+ SerialNumber: string;
14422
+ }
13617
14423
  export interface GetUserBoughtProductResponse {
13618
14424
  AdditionalWarrantyInfo?: string;
13619
14425
  Details?: EVACoreServicesUsersGetUserBoughtProductResponse_Detail[];
@@ -13653,6 +14459,10 @@ export interface EVACoreServicesUsersGetUserBoughtProductResponse_Detail {
13653
14459
  * Entity type: OrderLine
13654
14460
  */
13655
14461
  OrderLineID?: string;
14462
+ /**
14463
+ * Entity type: OrganizationUnit
14464
+ */
14465
+ OrganizationUnitID?: string;
13656
14466
  PurchaseDate?: string;
13657
14467
  PurchasedQuantity?: number;
13658
14468
  }
@@ -13698,7 +14508,7 @@ export interface EVACoreServicesUsersListUserBoughtProductsResponse_BoughtProduc
13698
14508
  WarrantyExpiryDate?: string;
13699
14509
  }
13700
14510
  /**
13701
- * Push bought products for users. Only accepts 1000 users per request
14511
+ * Push bought products for users. Only accepts 10000 users per request
13702
14512
  */
13703
14513
  export interface EVACoreServicesUsersPushBoughtProductsForUsers {
13704
14514
  BoughtProductsForUsers?: EVACoreServicesUsersPushBoughtProductsForUsers_PushedBoughtProductForUser[];
@@ -13712,16 +14522,34 @@ export interface EVACoreServicesUsersPushBoughtProductsForUsers_PushedBoughtProd
13712
14522
  }
13713
14523
  export interface PushBoughtProductsForUsersResponse {
13714
14524
  Error?: ServiceError;
13715
- FailedBoughtProductsForUsers?: Record<string, EVACoreServicesUsersPushBoughtProductsForUsersResponse_FailedUserBoughtProductsForUser[] | null>;
14525
+ FailedBoughtProductsForUsers?: EVACoreServicesUsersPushBoughtProductsForUsersResponse_FailedUserBoughtProductsForUser[];
13716
14526
  Metadata?: ResponseMessageMetadata;
14527
+ SuccessfulBoughtProductsForUsers?: EVACoreServicesUsersPushBoughtProductsForUsersResponse_SuccessfulUserBoughtProductsForUser[];
13717
14528
  }
13718
- export interface EVACoreServicesUsersPushBoughtProductsForUsersResponse_FailedUserBoughtProductsForUser {
14529
+ export interface EVACoreServicesUsersPushBoughtProductsForUsersResponse_BoughtProduct {
14530
+ ProductBackendID?: string;
13719
14531
  /**
13720
14532
  * Entity type: Product
13721
14533
  */
13722
14534
  ProductID: string;
13723
14535
  SerialNumber?: string;
13724
14536
  }
14537
+ export interface EVACoreServicesUsersPushBoughtProductsForUsersResponse_FailedUserBoughtProductsForUser {
14538
+ BoughtProducts?: EVACoreServicesUsersPushBoughtProductsForUsersResponse_BoughtProduct[];
14539
+ UserBackendID?: string;
14540
+ /**
14541
+ * Entity type: User
14542
+ */
14543
+ UserID: string;
14544
+ }
14545
+ export interface EVACoreServicesUsersPushBoughtProductsForUsersResponse_SuccessfulUserBoughtProductsForUser {
14546
+ BoughtProducts?: EVACoreServicesUsersPushBoughtProductsForUsersResponse_BoughtProduct[];
14547
+ UserBackendID?: string;
14548
+ /**
14549
+ * Entity type: User
14550
+ */
14551
+ UserID: string;
14552
+ }
13725
14553
  export interface PushBoughtProductsForUsers_Async {
13726
14554
  BoughtProductsForUsers?: EVACoreServicesUsersPushBoughtProductsForUsers_PushedBoughtProductForUser[];
13727
14555
  }
@@ -13738,7 +14566,6 @@ export interface PushBoughtProductsForUsers_AsyncResult {
13738
14566
  */
13739
14567
  export interface PushUserBoughtProduct {
13740
14568
  BoughtProducts?: EVACoreServicesUsersPushUserBoughtProduct_PushedBoughtProduct[];
13741
- RegistrationBackendSystemID?: string;
13742
14569
  /**
13743
14570
  * Entity type: User
13744
14571
  */
@@ -13766,6 +14593,11 @@ export interface EVACoreServicesUsersPushUserBoughtProduct_PushedBoughtProductDe
13766
14593
  * Entity type: OrderLine
13767
14594
  */
13768
14595
  OrderLineID?: string;
14596
+ /**
14597
+ * Entity type: OrganizationUnit
14598
+ * 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.
14599
+ */
14600
+ OrganizationUnitID?: string;
13769
14601
  PurchaseDate?: string;
13770
14602
  PurchasedQuantity?: number;
13771
14603
  }
@@ -13791,6 +14623,11 @@ export interface EVACoreServicesUsersPushedBoughtProduct_PushedBoughtProductDeta
13791
14623
  * Entity type: OrderLine
13792
14624
  */
13793
14625
  OrderLineID?: string;
14626
+ /**
14627
+ * Entity type: OrganizationUnit
14628
+ * 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.
14629
+ */
14630
+ OrganizationUnitID?: string;
13794
14631
  PurchaseDate?: string;
13795
14632
  PurchasedQuantity?: number;
13796
14633
  }
@@ -13809,6 +14646,11 @@ export interface RegisterUserBoughtProduct {
13809
14646
  */
13810
14647
  OrderLineID?: string;
13811
14648
  /**
14649
+ * Entity type: OrganizationUnit
14650
+ * 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.
14651
+ */
14652
+ OrganizationUnitID?: string;
14653
+ /**
13812
14654
  * Entity type: Product
13813
14655
  */
13814
14656
  ProductID: string;
@@ -13837,6 +14679,11 @@ export interface UpdateUserBoughtProductDetail {
13837
14679
  * Entity type: OrderLine
13838
14680
  */
13839
14681
  OrderLineID?: string;
14682
+ /**
14683
+ * Entity type: OrganizationUnit
14684
+ * 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.
14685
+ */
14686
+ OrganizationUnitID?: string;
13840
14687
  PurchaseDate?: string;
13841
14688
  PurchasedQuantity?: number;
13842
14689
  }