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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- import { DataModelsBookingFlags, DataModelsAccountType, ServiceError, ResponseMessageMetadata, FinanceListAccountsFilter, PageConfig, FinanceListAccountsItem, PagedResult, AuditingModelsAuditingSettingType, DataModelsCustomFieldKeyValue, DataModelsCasePriority, DataModelsInteractionType, DataModelsCaseStatusAction, DataModelsCustomFieldValueWithOptions, DataModelsSerialNumberRegistrationStatus, DataModelsRepairStatus, APIEnumDto, SearchIProductSearchItem, InteractionsListCaseInteractionsFilter, PageTokenConfig, CasesListCaseStatusesFilter, CasesListCaseTopicsFilter, CasesListCasesFilter, TAnyValue, DataModelsUserAccountType, AddressesAddressDataDto, AddressesAddressDto, DataModelsCompanyType, CompaniesListCompaniesFilter, CompaniesListCompaniesItem, ConfigurationSettingRemovalReason, ConfigurationSettingModel, ConfigurationAppSettingsAppSettingAutocompleteInfo, SortDirection, ConfigurationSettingValueEntityTypes, ConfigurationSettingSensitivityTypes, ConfigurationAppSettingsListAppSettingsHistoryFilter, ConfigurationAppSettingsListAppSettingsFilter, ConfigurationSettingsListSettingsHistoryFilter, SecurityFunctionalityScope, InternationalizationCultureFilter, InternationalizationOrganizationUnitCountryFilter, InternationalizationOrganizationUnitLanguageFilter, DataModelsCustomFieldDataTypes, UserTypes, DataModelsCustomFieldMetadata, DataModelsCustomFieldOptions, DataModelsCustomFieldValueOperator, CustomFieldsListCustomFieldOptionsFilter, DataModelsCustomFieldValue, CustomFieldsListCustomFieldsFilter, DiscountsIDiscountActionData, DataModelsDiscountAppliesTo, DataModelsDiscountCompliancyRule, DataModelsDiscountConditionTypes, DaysOfWeek, DataModelsDiscountOrderTypes, DataModelsFinancialDespersionType, DataModelsDiscountTriggers, IConditionData, DataModelsDiscountDeactivationReasons, DataModelsOrganizationUnitSetTypes, DiscountsSearchDiscountsByQueryFilter, DiscountsListDiscountCouponsFilter, DataModelsListDiscountCampaignsFilter, DiscountsListDiscountLayerFilter, DataModelsListDiscountTemplatesFilter, CustomFieldsCustomFieldValidationErrorData, DataModelsEntityFieldValidatorUserTypes, DataModelsEntityFieldValidatorEntityTypes, EntityFieldValidatorsValidatorsEntityFieldValidatorBase, DataModelsEntityFieldValidatorType, EntityFieldValidatorsListEntityFieldValidatorsFilter, SearchFilterModel, StockMutationsListProductCostPriceLedgerFilter, StockMutationsListProductCostPriceLedgerItem, StockMutationsListStockMutationUnitCostSourceLedgerFilter, StockMutationsListStockMutationUnitCostSourceLedgerItem, DataModelsCashExpenseAmountTypes, FinanceCashListCashCorrectionReasonsFilter, FinanceCashListCashExpenseTypesFilter, ExchangeRatesListExchangeRatesFilter, GiftCardsConfigurationGiftCardConfigurationUsageTypes, GiftCardsConfigurationProductGiftCardCommunicationOptions, GiftCardsListGiftCardConfigurationsFilter, GiftCardsListProductGiftCardsFilter, DataModelsClientApplicationType, DevicesIDeviceTypeData, NotificationsListClientApplicationsFilter, InquiriesListInquiriesFilter, DataModelsAllowUnsubscribeByType, DataModelsLoyaltyPointUsageOptions, DataModelsLoyaltyProgramOptions, DataModelsResubscribeHandlingType, DataModelsLoyaltyProgramStatus, DataModelsLoyaltyPaymentTaxHandlingType, DataModelsUserBudgetDeduction, LoyaltyRulesIPointAwardingConditionData, DataModelsLoyaltyProgramGroupDeactivationReasons, DataModelsLoyaltyProgramDeactivationReasons, LoyaltyListLoyaltyProgramGroupFilter, LoyaltyListLoyaltyProgramsFilter, LoyaltyListPointAwardingRuleFilter, DataModelsMessageTemplateDestinations, DataModelsPaperProperties, DataModelsMessageTemplateTypes, MessageTemplatesMessageTemplateFilter, MessageTemplatesMessageTargetContentTypes, OrdersCheckoutOptionsICheckoutOptionConfigData, OrdersCheckoutOptionsListCheckoutOptionCategoriesFilter, OrdersCheckoutOptionsListCheckoutOptionsFilter, OrdersReturnsListRefundCorrectionReasonsFilter, OrdersCorrectionsListUnitPriceCorrectionReasonsFilter, DataModelsReturnReasonType, DataModelsOrganizationUnitSetOperatorTypes, DataModelsOrganizationUnitSetDefinition, OrganizationUnitsListOrganizationUnitSetsFilter, OrganizationUnitsListOrganizationUnitSetsItem, OrganizationUnitsDtoOpeningHoursDataDto, FinanceCashListCashHandlersFilter, OrganizationUnitsListOldOpeningHoursFilter, OrganizationUnitsDtoOpeningHoursDto, OrganizationUnitsOrganizationUnitCurrencyFilter, OrganizationUnitsDtoDayOpeningHours, DataModelsPaymentTypeCaptureMoment, DataModelsPaymentCashJournalMethod, DataModelsPaymentTypeCategory, DataModelsPaymentTypeOptions, DataModelsPaymentReturnActions, PaymentsListOrganizationUnitSetPaymentTypesFilter, PaymentsListPaymentMethodsFilter, PaymentsListPaymentTransactionCapturesFilter, DataModelsPaymentTransactionCaptureStatuses, PaymentsListPaymentTransactionsFilter, DataModelsPaymentStatuses, PaymentsListPaymentTypesFilter, PaymentsSettlementsListSettlementFilesFilter, DataModelsPaymentTransactionSettlementFileStatus, PaymentsSettlementsListSettlementsFilter, PersonalizedPromotionsListPersonalizedPromotionsFilter, PricingIPriceListAdjustmentData, DataModelsPriceListAdjustmentSystemType, PricingListPriceListAdjustmentsFilter, PricingListManualInputAdjustmentsFilter, PricingListPriceListOrganizationUnitsFilter, PricingListPriceListsFilter, PricingListPriceListsForOrganizationUnitFilter, PricingListProductPriceLedgerFilter, PricingRoundingData, DataModelsProductRequirementDataTypes, DataModelsOrderTypes, DataModelsProductRequirementOptions, SearchAggregationFilterModel, DataModelsProductSearchTemplateTypes, DataModelsProductStatus, ProductsListProductBarcodesFilter, DataModelsProductBarcodeOrigin, ProductsListProductRequirementsFilter, SearchListProductSearchTemplateResultsFilter, SearchListProductSearchTemplateResultItem, SearchProductSearchTemplateFilters, ProductsListProductUnitOfMeasuresFilter, ProductsListSupplierProductsFilter, UsersListRolesFilter, OrganizationUnitsListUserOrganizationUnitRolesFilter, DataModelsShippingMethodDeliveryTypes, DataModelsShippingRestrictionType, ShippingListCarriersFilter, ShippingListShippingMethodsFilter, ShippingListOrganizationUnitShippingMethodsFilter, ShippingListShippingCostsFilter, ShippingListTransportationTimesFilter, ShippingShippingMethodTransportationTimeItem, ShippingListShippingRestrictionsFilter, DataModelsStockAllocationRuleTypes, DataModelsStockAllocationRuleValueTypes, SuppliersListStockAllocationRulesFilter, StockMutationsListCumulativeStockFilter, SuppliersListStockAllocationRulesItem, StockMutationsListStockMutationReasonsModelFilters, StockMutationsStockMutationFilters, ScrollablePageConfig, StockMutationsSearchStockMutationResult, ScrollablePagedResult, PricingListTaxRateModelFilters, UsersUserRequirementsUserRequirementFor, UsersUserRequirementsUserRequirementProperties, UsersUserRequirementsUserRequirementForSubscriptionResponse, UsersUserRequirementsUserRequirementResponse, UsersSubscriptionsListSubscriptionUsersFilter, DataModelsSubscriptionStatus, DataModelsSubscriptionType, UsersUserRequirementsListUserRequirementSetsFilter, UsersUserRequirementsListUserRequirementsFilter, WishlistsListWishlistsFilter, VisibilityGroupsListVisibilityGroupConfigurationsFilter, VisibilityGroupsListVisibilityGroupsFilter, DataModelsProductTypes, ProductsListAssortmentProductsFilter, FinanceListGeneralLedgersFilter, DataModelsFraudDataType, AddressesListFraudItemsFilter, UserBoughtProductsListUserBoughtProductsFilter, SearchIProductSearchItemPrimaryImage } from '@springtree/eva-services-core';
1
+ import { DataModelsBookingFlags, DataModelsAccountType, ServiceError, ResponseMessageMetadata, FinanceListAccountsFilter, PageConfig, FinanceListAccountsItem, PagedResult, AuditingModelsAuditingSettingType, DataModelsCustomFieldKeyValue, DataModelsCasePriority, DataModelsInteractionType, DataModelsCaseStatusAction, DataModelsCustomFieldValueWithOptions, DataModelsSerialNumberRegistrationStatus, DataModelsRepairStatus, EVAFrameworkAPIEnumDto, SearchIProductSearchItem, InteractionsListCaseInteractionsFilter, PageTokenConfig, CasesListCaseStatusesFilter, CasesListCaseTopicsFilter, CasesListCasesFilter, TAnyValue, DataModelsUserAccountType, AddressesAddressDataDto, AddressesAddressDto, DataModelsCompanyType, CompaniesListCompaniesFilter, CompaniesListCompaniesItem, ConfigurationSettingRemovalReason, ConfigurationSettingModel, ConfigurationAppSettingsAppSettingAutocompleteInfo, SortDirection, ConfigurationSettingValueEntityTypes, ConfigurationSettingSensitivityTypes, ConfigurationAppSettingsListAppSettingsHistoryFilter, ConfigurationAppSettingsListAppSettingsFilter, ConfigurationSettingsListSettingsHistoryFilter, SecurityFunctionalityScope, InternationalizationCultureFilter, InternationalizationOrganizationUnitCountryFilter, InternationalizationOrganizationUnitLanguageFilter, DataModelsCustomFieldDataTypes, UserTypes, DataModelsCustomFieldMetadata, DataModelsCustomFieldOptions, DataModelsCustomFieldValueOperator, CustomFieldsListCustomFieldOptionsFilter, DataModelsCustomFieldValue, CustomFieldsListCustomFieldsFilter, DiscountsIDiscountActionData, DataModelsDiscountAppliesTo, DataModelsDiscountCompliancyRule, DataModelsDiscountConditionTypes, DaysOfWeek, DataModelsDiscountOrderTypes, DataModelsFinancialDespersionType, DataModelsDiscountTriggers, IConditionData, DataModelsDiscountDeactivationReasons, DataModelsOrganizationUnitSetTypes, DiscountsSearchDiscountsByQueryFilter, DiscountsListDiscountCouponsFilter, DataModelsListDiscountCampaignsFilter, DiscountsListDiscountLayerFilter, DataModelsListDiscountTemplatesFilter, CustomFieldsCustomFieldValidationErrorData, DataModelsEntityFieldValidatorUserTypes, DataModelsEntityFieldValidatorEntityTypes, EntityFieldValidatorsValidatorsEntityFieldValidatorBase, DataModelsEntityFieldValidatorType, EntityFieldValidatorsListEntityFieldValidatorsFilter, SearchFilterModel, StockMutationsListProductCostPriceLedgerFilter, StockMutationsListProductCostPriceLedgerItem, StockMutationsListStockMutationUnitCostSourceLedgerFilter, StockMutationsListStockMutationUnitCostSourceLedgerItem, DataModelsCashExpenseAmountTypes, FinanceCashListCashCorrectionReasonsFilter, FinanceCashListCashExpenseTypesFilter, ExchangeRatesListExchangeRatesFilter, GiftCardsConfigurationGiftCardConfigurationUsageTypes, GiftCardsConfigurationProductGiftCardCommunicationOptions, GiftCardsListGiftCardConfigurationsFilter, GiftCardsListProductGiftCardsFilter, DataModelsClientApplicationType, DevicesIDeviceTypeData, NotificationsListClientApplicationsFilter, InquiriesListInquiriesFilter, DataModelsAllowUnsubscribeByType, DataModelsLoyaltyPointUsageOptions, DataModelsLoyaltyProgramOptions, DataModelsResubscribeHandlingType, DataModelsLoyaltyProgramStatus, DataModelsLoyaltyPaymentTaxHandlingType, DataModelsUserBudgetDeduction, LoyaltyRulesIPointAwardingConditionData, DataModelsLoyaltyProgramGroupDeactivationReasons, DataModelsLoyaltyProgramDeactivationReasons, 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,16 @@ export interface PushCase {
1078
1106
  AssignedOrganizationUnitBackendID?: string;
1079
1107
  Assignee?: CasesPushCase_PushCaseAssignee;
1080
1108
  BackendID: string;
1081
- BackendSystemID?: string;
1082
1109
  CaseRelatedItems?: CasesPushCase_PushCaseRelatedItems;
1110
+ /**
1111
+ * The topic that this case is a part of. If a BackendID is provided and a CaseTopic exists with that ID, that CaseTopic is used, no matter what Name or ParentBackendID are passed and if they match.
1112
+ * If no CaseTopic exists with the given BackendID, but one does exist with the given Name and ParentBackendID, that CaseTopic is used instead, disregarding what BackendID was passed in the request.
1113
+ * If none of these conditions are met, a new CaseTopic is created.
1114
+ */
1115
+ CaseTopic?: CasesPushCase_PushCaseTopic;
1083
1116
  ClosingTime?: string;
1084
1117
  CustomFields?: Record<string, TAnyValue | null>;
1085
- Customer: CasesPushCase_PushCaseCustomer | undefined;
1118
+ Customer?: CasesPushCase_PushCaseCustomer;
1086
1119
  Description: string;
1087
1120
  /**
1088
1121
  * Setting this to true will try to suppress as many event exports as possible that might result from this call.
@@ -1091,13 +1124,13 @@ export interface PushCase {
1091
1124
  Interactions?: CasesPushCase_PushCaseInteraction[];
1092
1125
  LastInteractionTime?: string;
1093
1126
  OriginatingOrganizationUnitBackendID?: string;
1094
- Priority: DataModelsCasePriority;
1127
+ Priority?: DataModelsCasePriority;
1095
1128
  ReportingTime?: string;
1096
1129
  Solution?: string;
1097
1130
  Status: string;
1098
1131
  Summary?: string;
1099
1132
  Title: string;
1100
- Topic: string;
1133
+ Topic?: string;
1101
1134
  /**
1102
1135
  * Setting this to true will update the case information if it already exists instead of throwing an error.
1103
1136
  */
@@ -1191,7 +1224,7 @@ export interface CasesPushCase_PushCaseInteraction {
1191
1224
  */
1192
1225
  Delete?: boolean;
1193
1226
  Text?: string;
1194
- Type: DataModelsInteractionType;
1227
+ Type?: DataModelsInteractionType;
1195
1228
  }
1196
1229
  export interface CasesPushCase_PushCaseRelatedItem {
1197
1230
  /**
@@ -1218,6 +1251,17 @@ export interface CasesPushCase_PushCaseRelatedItems {
1218
1251
  */
1219
1252
  OrderID?: string;
1220
1253
  }
1254
+ export interface CasesPushCase_PushCaseTopic {
1255
+ BackendID: string;
1256
+ /**
1257
+ * Required if pushing and creating a previously non-existent CaseTopic
1258
+ */
1259
+ Name?: string;
1260
+ /**
1261
+ * Provide a ParentID, or nothing if the CaseTopic should be root-level.
1262
+ */
1263
+ ParentBackendID?: string;
1264
+ }
1221
1265
  export interface PushCaseResponse {
1222
1266
  Error?: ServiceError;
1223
1267
  /**
@@ -1298,18 +1342,18 @@ export interface UpdateCase {
1298
1342
  * Entity type: OrganizationUnit
1299
1343
  * OU the case is assigned to. When set this will influence visibility.
1300
1344
  */
1301
- AssignedOrganizationUnitID: string | null | undefined;
1302
- BackendID: string | null | undefined;
1345
+ AssignedOrganizationUnitID?: string | null;
1346
+ BackendID?: string | null;
1303
1347
  /**
1304
1348
  * Optional additional custom fields
1305
1349
  */
1306
- CustomFields: DataModelsCustomFieldKeyValue[] | null | undefined;
1350
+ CustomFields?: DataModelsCustomFieldKeyValue[] | null;
1307
1351
  /**
1308
1352
  * Entity type: User
1309
1353
  */
1310
- CustomerID: string | null | undefined;
1354
+ CustomerID?: string | null;
1311
1355
  Description?: string;
1312
- ExternalOrderIdentifier: string | null | undefined;
1356
+ ExternalOrderIdentifier?: string | null;
1313
1357
  /**
1314
1358
  * Entity type: Case
1315
1359
  */
@@ -1318,7 +1362,7 @@ export interface UpdateCase {
1318
1362
  * Entity type: OrganizationUnit
1319
1363
  * Can only be set once. Can be updated when not set on create.
1320
1364
  */
1321
- OriginatingOrganizationUnitID: string | null | undefined;
1365
+ OriginatingOrganizationUnitID?: string | null;
1322
1366
  Title?: string;
1323
1367
  /**
1324
1368
  * Entity type: CaseTopic
@@ -1329,7 +1373,7 @@ export interface UpdateCase {
1329
1373
  * Update a case interaction
1330
1374
  */
1331
1375
  export interface UpdateCaseInteraction {
1332
- BackendID: string | null | undefined;
1376
+ BackendID?: string | null;
1333
1377
  /**
1334
1378
  * Entity type: Interaction
1335
1379
  */
@@ -1343,7 +1387,7 @@ export interface UpdateCaseState {
1343
1387
  /**
1344
1388
  * Entity type: User
1345
1389
  */
1346
- AssigneeID: string | null | undefined;
1390
+ AssigneeID?: string | null;
1347
1391
  /**
1348
1392
  * Entity type: Case
1349
1393
  */
@@ -1352,7 +1396,7 @@ export interface UpdateCaseState {
1352
1396
  /**
1353
1397
  * The solution for the case
1354
1398
  */
1355
- Solution: string | null | undefined;
1399
+ Solution?: string | null;
1356
1400
  /**
1357
1401
  * Entity type: CaseStatus
1358
1402
  */
@@ -1368,9 +1412,9 @@ export interface UpdateCaseStateResponse {
1368
1412
  */
1369
1413
  export interface UpdateCaseStatus {
1370
1414
  Action?: DataModelsCaseStatusAction;
1371
- BackendID: string | null | undefined;
1372
- Color: string | null | undefined;
1373
- Description: string | null | undefined;
1415
+ BackendID?: string | null;
1416
+ Color?: string | null;
1417
+ Description?: string | null;
1374
1418
  /**
1375
1419
  * Entity type: CaseStatus
1376
1420
  */
@@ -1380,7 +1424,7 @@ export interface UpdateCaseStatus {
1380
1424
  /**
1381
1425
  * Entity type: Script
1382
1426
  */
1383
- ScriptID: string | null | undefined;
1427
+ ScriptID?: string | null;
1384
1428
  }
1385
1429
  /**
1386
1430
  * Update an existing case summary.
@@ -1399,8 +1443,8 @@ export interface UpdateCaseSummary {
1399
1443
  * Update a case topic
1400
1444
  */
1401
1445
  export interface UpdateCaseTopic {
1402
- BackendID: string | null | undefined;
1403
- Description: string | null | undefined;
1446
+ BackendID?: string | null;
1447
+ Description?: string | null;
1404
1448
  /**
1405
1449
  * Entity type: CaseTopic
1406
1450
  */
@@ -1441,6 +1485,14 @@ export interface CreateCompany {
1441
1485
  VisitorsAddress?: AddressesAddressDataDto;
1442
1486
  WasteDisposalNumber?: string;
1443
1487
  }
1488
+ export interface CreateCompanyResponse {
1489
+ Error?: ServiceError;
1490
+ /**
1491
+ * Entity type: Company
1492
+ */
1493
+ ID: string;
1494
+ Metadata?: ResponseMessageMetadata;
1495
+ }
1444
1496
  /**
1445
1497
  * Deletes a Company. If a Company is still in use by Users or OrganizationUnits this service will return an error.
1446
1498
  */
@@ -1515,34 +1567,34 @@ export interface ListCompaniesResponse {
1515
1567
  * Updates a Company. Fields not provided in the request are ignored.
1516
1568
  */
1517
1569
  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;
1570
+ AccountHolderName?: string | null;
1571
+ BIC?: string | null;
1572
+ BackendID?: string | null;
1573
+ ContactEmailAddress?: string | null;
1574
+ ContactPhoneNumber?: string | null;
1575
+ EntityType?: string | null;
1576
+ EstablishedDate?: string | null;
1577
+ FiscalID?: string | null;
1578
+ IBAN?: string | null;
1527
1579
  /**
1528
1580
  * Entity type: Company
1529
1581
  */
1530
1582
  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;
1583
+ IndustryCode?: string | null;
1584
+ InvoiceAddress?: AddressesAddressDataDto;
1585
+ InvoiceEmailAddress?: string | null;
1586
+ LogoID?: string | null;
1587
+ Name?: string | null;
1588
+ RegistrationCity?: string | null;
1589
+ RegistrationCountryID?: string | null;
1590
+ RegistrationCountrySubdivisionID?: string | null;
1591
+ RegistrationNumber?: string | null;
1592
+ SocialCapital?: number | null;
1593
+ TaxOfficeNumber?: string | null;
1542
1594
  Type?: DataModelsCompanyType;
1543
- VatNumber: string | null | undefined;
1544
- VisitorsAddress: AddressesAddressDataDto | undefined;
1545
- WasteDisposalNumber: string | null | undefined;
1595
+ VatNumber?: string | null;
1596
+ VisitorsAddress?: AddressesAddressDataDto;
1597
+ WasteDisposalNumber?: string | null;
1546
1598
  }
1547
1599
  export interface ValidateCompany {
1548
1600
  AccountHolderName?: string;
@@ -1677,7 +1729,7 @@ export interface GetAppSettingsForOrganizationUnit {
1677
1729
  * Entity type: OrganizationUnit
1678
1730
  */
1679
1731
  OrganizationUnitID: string;
1680
- SortDirection: SortDirection;
1732
+ SortDirection?: SortDirection;
1681
1733
  SortProperty?: string;
1682
1734
  }
1683
1735
  export interface GetAppSettingsForOrganizationUnitResponse {
@@ -1886,7 +1938,7 @@ export interface ListSettings {
1886
1938
  */
1887
1939
  OrganizationUnitID: string;
1888
1940
  ShowDeprecationsOnly?: boolean;
1889
- SortDirection: SortDirection;
1941
+ SortDirection?: SortDirection;
1890
1942
  SortProperty?: string;
1891
1943
  TypedFilter?: ConfigurationListSettingsTypedFilters;
1892
1944
  }
@@ -1898,13 +1950,16 @@ export interface ListSettingsPerOrganizationUnit {
1898
1950
  FunctionalityCategory?: string;
1899
1951
  Key?: string;
1900
1952
  ShowDeprecationsOnly?: boolean;
1901
- SortDirection: SortDirection;
1953
+ SortDirection?: SortDirection;
1902
1954
  SortProperty?: string;
1903
1955
  TypedFilter?: ConfigurationListSettingsTypedFilters;
1904
1956
  }
1905
1957
  export interface ListSettingsPerOrganizationUnitResponse {
1906
1958
  Error?: ServiceError;
1907
1959
  Metadata?: ResponseMessageMetadata;
1960
+ /**
1961
+ * Entity type: OrganizationUnit
1962
+ */
1908
1963
  Result?: Record<string, Record<string, ConfigurationSettingDto> | null>;
1909
1964
  }
1910
1965
  export interface ListSettingsResponse {
@@ -2119,13 +2174,13 @@ export interface CostPriceCalculationsGetCostPriceCalculationsResponse_Item {
2119
2174
  Name: string;
2120
2175
  }
2121
2176
  export interface UpdateCostPriceCalculation {
2122
- BackendID: string | null | undefined;
2177
+ BackendID?: string | null;
2123
2178
  Factor?: number;
2124
2179
  /**
2125
2180
  * Entity type: CostPriceCalculation
2126
2181
  */
2127
2182
  ID: string;
2128
- Name: string | null | undefined;
2183
+ Name?: string | null;
2129
2184
  }
2130
2185
  /**
2131
2186
  * Create a new Culture
@@ -2310,7 +2365,7 @@ export interface CulturesListOrganizationUnitLanguagesResponse_OrganizationUnitL
2310
2365
  */
2311
2366
  export interface CreateCustomField {
2312
2367
  BackendID?: string;
2313
- DataType: DataModelsCustomFieldDataTypes;
2368
+ DataType?: DataModelsCustomFieldDataTypes;
2314
2369
  DisplayName?: string;
2315
2370
  EnumValues?: Record<string, string | null>;
2316
2371
  InputHint?: string;
@@ -2386,7 +2441,7 @@ export interface GetCustomFieldMetadataResponse {
2386
2441
  export interface GetCustomFieldTypes {
2387
2442
  }
2388
2443
  export interface GetCustomFieldTypesResponse {
2389
- CustomFieldTypes?: APIEnumDto[];
2444
+ CustomFieldTypes?: EVAFrameworkAPIEnumDto[];
2390
2445
  Error?: ServiceError;
2391
2446
  Metadata?: ResponseMessageMetadata;
2392
2447
  }
@@ -2404,6 +2459,9 @@ export interface GetCustomFields {
2404
2459
  TypeID: string;
2405
2460
  }
2406
2461
  export interface GetCustomFieldsResponse {
2462
+ /**
2463
+ * Entity type: CustomField
2464
+ */
2407
2465
  CustomFieldOptions?: Record<string, DataModelsCustomFieldOptions>;
2408
2466
  Error?: ServiceError;
2409
2467
  Metadata?: ResponseMessageMetadata;
@@ -2522,23 +2580,23 @@ export interface CustomFieldsListCustomFieldsResponse_CustomFieldDto {
2522
2580
  * Set options for custom fields
2523
2581
  */
2524
2582
  export interface SetCustomFieldOptions {
2525
- CustomFieldDefaultValue: DataModelsCustomFieldValue | undefined;
2583
+ CustomFieldDefaultValue?: DataModelsCustomFieldValue;
2526
2584
  /**
2527
2585
  * Entity type: CustomField
2528
2586
  */
2529
2587
  CustomFieldID: string;
2530
- EditableByUserTypes: UserTypes | undefined;
2588
+ EditableByUserTypes?: UserTypes;
2531
2589
  /**
2532
2590
  * Entity type: Script
2533
2591
  */
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;
2592
+ EligibilityScriptID?: string | null;
2593
+ IsRequired?: boolean | null;
2594
+ MaximumDate?: string | null;
2595
+ MaximumLength?: number | null;
2596
+ MaximumValue?: number | null;
2597
+ MinimumDate?: string | null;
2598
+ MinimumLength?: number | null;
2599
+ MinimumValue?: number | null;
2542
2600
  /**
2543
2601
  * Entity type: OrganizationUnitSet
2544
2602
  */
@@ -2546,8 +2604,8 @@ export interface SetCustomFieldOptions {
2546
2604
  /**
2547
2605
  * Entity type: Script
2548
2606
  */
2549
- SecurityScriptID: string | null | undefined;
2550
- VisibleByUserTypes: UserTypes | undefined;
2607
+ SecurityScriptID?: string | null;
2608
+ VisibleByUserTypes?: UserTypes;
2551
2609
  }
2552
2610
  export interface UnsetCustomFieldOptions {
2553
2611
  /**
@@ -2563,17 +2621,30 @@ export interface UnsetCustomFieldOptions {
2563
2621
  * Update an existing custom CustomField.
2564
2622
  */
2565
2623
  export interface UpdateCustomField {
2566
- BackendID: string | null | undefined;
2567
- DisplayName: string | null | undefined;
2568
- EnumValues: Record<string, string | null> | null | undefined;
2624
+ BackendID?: string | null;
2625
+ DisplayName?: string | null;
2626
+ EnumValues?: Record<string, string | null> | null;
2569
2627
  /**
2570
2628
  * Entity type: CustomField
2571
2629
  */
2572
2630
  ID: string;
2573
- InputHint: string | null | undefined;
2574
- Name: string | null | undefined;
2631
+ InputHint?: string | null;
2632
+ Name?: string | null;
2575
2633
  Order?: number;
2576
- TypeKey: string | null | undefined;
2634
+ TypeKey?: string | null;
2635
+ }
2636
+ /**
2637
+ * Add required custom fields to ManualDiscount
2638
+ */
2639
+ export interface AddRequiredCustomFieldsToManualDiscount {
2640
+ /**
2641
+ * Entity type: CustomField
2642
+ */
2643
+ CustomFieldIDs: string[];
2644
+ /**
2645
+ * Entity type: Discount
2646
+ */
2647
+ DiscountID: string;
2577
2648
  }
2578
2649
  /**
2579
2650
  * Add security roles to ManualDiscount
@@ -2611,8 +2682,8 @@ export interface CreateDiscount {
2611
2682
  */
2612
2683
  CampaignID?: string;
2613
2684
  CannotApplyToOwnOrder?: boolean;
2614
- CompliancyRule: DataModelsDiscountCompliancyRule;
2615
- ConditionType: DataModelsDiscountConditionTypes;
2685
+ CompliancyRule?: DataModelsDiscountCompliancyRule;
2686
+ ConditionType?: DataModelsDiscountConditionTypes;
2616
2687
  Conditions?: DiscountsCreateDiscount_DiscountConditionDto[];
2617
2688
  CouponHandler?: string;
2618
2689
  CouponsGeneratedByOtherDiscount?: boolean;
@@ -2631,10 +2702,10 @@ export interface CreateDiscount {
2631
2702
  DaysApplicable?: DaysOfWeek;
2632
2703
  DeactivateWhenBudgetReached?: boolean;
2633
2704
  Description: string;
2634
- DiscountOrderType: DataModelsDiscountOrderTypes;
2705
+ DiscountOrderType?: DataModelsDiscountOrderTypes;
2635
2706
  Enable?: boolean;
2636
2707
  EndDate?: string;
2637
- FinancialDispersion: DataModelsFinancialDespersionType;
2708
+ FinancialDispersion?: DataModelsFinancialDespersionType;
2638
2709
  /**
2639
2710
  * Entity type: Blob
2640
2711
  */
@@ -2663,6 +2734,11 @@ export interface CreateDiscount {
2663
2734
  OrganizationUnitSetID: string;
2664
2735
  PromotionLabel?: string;
2665
2736
  /**
2737
+ * Entity type: CustomField
2738
+ * For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
2739
+ */
2740
+ RequiredCustomFields?: string[];
2741
+ /**
2666
2742
  * Entity type: OrganizationUnit
2667
2743
  */
2668
2744
  RestitutionOrganizationUnitID?: string;
@@ -2671,7 +2747,7 @@ export interface CreateDiscount {
2671
2747
  */
2672
2748
  RoleIDs?: string[];
2673
2749
  StartDate?: string;
2674
- Trigger: DataModelsDiscountTriggers;
2750
+ Trigger?: DataModelsDiscountTriggers;
2675
2751
  UserUsageLimit?: number;
2676
2752
  UserUsageReloadStrategy?: string;
2677
2753
  }
@@ -2695,6 +2771,14 @@ export interface CreateDiscountCampaign {
2695
2771
  Name: string;
2696
2772
  StartDate?: string;
2697
2773
  }
2774
+ export interface CreateDiscountCampaignResponse {
2775
+ Error?: ServiceError;
2776
+ /**
2777
+ * Entity type: DiscountCampaign
2778
+ */
2779
+ ID: string;
2780
+ Metadata?: ResponseMessageMetadata;
2781
+ }
2698
2782
  /**
2699
2783
  * Create a DiscountCoupon
2700
2784
  */
@@ -2720,12 +2804,12 @@ export interface CreateDiscountCouponResponse {
2720
2804
  * Create a discount from the given template with the overwrites with the values given in the request.
2721
2805
  */
2722
2806
  export interface CreateDiscountFromTemplate {
2723
- BackendID: string | null | undefined;
2807
+ BackendID?: string | null;
2724
2808
  /**
2725
2809
  * Entity type: DiscountCampaign
2726
2810
  */
2727
- CampaignID: string | null | undefined;
2728
- CompliancyRule: DataModelsDiscountCompliancyRule;
2811
+ CampaignID?: string | null;
2812
+ CompliancyRule?: DataModelsDiscountCompliancyRule;
2729
2813
  CreateAsActive?: boolean;
2730
2814
  /**
2731
2815
  * Entity type: Currency
@@ -2733,12 +2817,12 @@ export interface CreateDiscountFromTemplate {
2733
2817
  CurrencyID: string;
2734
2818
  Description: string;
2735
2819
  EndDate?: string;
2736
- FinancialDispersion: DataModelsFinancialDespersionType;
2820
+ FinancialDispersion?: DataModelsFinancialDespersionType;
2737
2821
  /**
2738
2822
  * Entity type: DiscountTemplate
2739
2823
  */
2740
2824
  ID: string;
2741
- ImageBlobID: string | null | undefined;
2825
+ ImageBlobID?: string | null;
2742
2826
  IsExclusive?: boolean;
2743
2827
  /**
2744
2828
  * Entity type: DiscountLayer
@@ -2747,16 +2831,16 @@ export interface CreateDiscountFromTemplate {
2747
2831
  /**
2748
2832
  * Entity type: LedgerClass
2749
2833
  */
2750
- LedgerClassID: string | null | undefined;
2834
+ LedgerClassID?: string | null;
2751
2835
  LoyaltyPointWithdrawal?: number;
2752
2836
  /**
2753
2837
  * Entity type: LoyaltyProgram
2754
2838
  */
2755
2839
  LoyaltyProgramID?: string;
2756
2840
  MarketingDescription?: string;
2757
- MaximumUsage: number | null | undefined;
2758
- MaximumUsagePerOrder: number | null | undefined;
2759
- MaximumUsagePerUser: number | null | undefined;
2841
+ MaximumUsage?: number | null;
2842
+ MaximumUsagePerOrder?: number | null;
2843
+ MaximumUsagePerUser?: number | null;
2760
2844
  NeedsReason?: boolean;
2761
2845
  /**
2762
2846
  * Entity type: OrganizationUnitSet
@@ -2768,8 +2852,8 @@ export interface CreateDiscountFromTemplate {
2768
2852
  */
2769
2853
  RestitutionOrganizationUnitID?: string;
2770
2854
  StartDate?: string;
2771
- UserUsageLimit: number | null | undefined;
2772
- UserUsageReloadStrategy: string | null | undefined;
2855
+ UserUsageLimit?: number | null;
2856
+ UserUsageReloadStrategy?: string | null;
2773
2857
  }
2774
2858
  /**
2775
2859
  * Create a new DiscountLayer
@@ -2802,18 +2886,18 @@ export interface CreateDiscountResponse {
2802
2886
  export interface CreateDiscountTemplate {
2803
2887
  ActionData: DiscountsIDiscountActionData;
2804
2888
  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;
2889
+ AppliesTo?: DataModelsDiscountAppliesTo;
2806
2890
  BackendID?: string;
2807
2891
  /**
2808
2892
  * Entity type: DiscountCampaign
2809
2893
  */
2810
2894
  CampaignID?: string;
2811
- ConditionType: DataModelsDiscountConditionTypes;
2895
+ ConditionType?: DataModelsDiscountConditionTypes;
2812
2896
  Conditions?: DiscountsCreateDiscountTemplate_Condition[];
2813
2897
  CouponHandler?: string;
2814
2898
  CouponsGeneratedByOtherDiscount?: boolean;
2815
2899
  Description: string;
2816
- DiscountOrderType: DataModelsDiscountOrderTypes;
2900
+ DiscountOrderType?: DataModelsDiscountOrderTypes;
2817
2901
  ImageBlobID?: string;
2818
2902
  IsActive?: boolean;
2819
2903
  IsExclusive?: boolean;
@@ -2829,7 +2913,7 @@ export interface CreateDiscountTemplate {
2829
2913
  * Entity type: OrganizationUnit
2830
2914
  */
2831
2915
  RestitutionOrganizationUnitID?: string;
2832
- Trigger: DataModelsDiscountTriggers;
2916
+ Trigger?: DataModelsDiscountTriggers;
2833
2917
  UserUsageLimit?: number;
2834
2918
  UserUsageReloadStrategy?: string;
2835
2919
  }
@@ -2837,6 +2921,14 @@ export interface DiscountsCreateDiscountTemplate_Condition {
2837
2921
  Data: IConditionData;
2838
2922
  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
2923
  }
2924
+ export interface CreateDiscountTemplateResponse {
2925
+ Error?: ServiceError;
2926
+ /**
2927
+ * Entity type: DiscountTemplate
2928
+ */
2929
+ ID: string;
2930
+ Metadata?: ResponseMessageMetadata;
2931
+ }
2840
2932
  /**
2841
2933
  * Delete a DiscountCampaign
2842
2934
  */
@@ -2949,6 +3041,24 @@ export interface GenerateDiscountCoupons {
2949
3041
  Quantity?: number;
2950
3042
  Suffix?: string;
2951
3043
  }
3044
+ export interface GenerateDiscountCoupons_Async {
3045
+ /**
3046
+ * Entity type: Discount
3047
+ */
3048
+ DiscountID: string;
3049
+ MaximumUsage?: number;
3050
+ Prefix?: string;
3051
+ Quantity?: number;
3052
+ Suffix?: string;
3053
+ }
3054
+ export interface GenerateDiscountCoupons_AsyncResponse {
3055
+ Error?: ServiceError;
3056
+ JobID?: string;
3057
+ Metadata?: ResponseMessageMetadata;
3058
+ }
3059
+ export interface GenerateDiscountCoupons_AsyncResult {
3060
+ JobID?: string;
3061
+ }
2952
3062
  /**
2953
3063
  * 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
3064
  */
@@ -2964,6 +3074,9 @@ export interface GetCouponByTokenResponse {
2964
3074
  DiscountID: string;
2965
3075
  DiscountMarketingDescription?: string;
2966
3076
  Error?: ServiceError;
3077
+ /**
3078
+ * Entity type: OrderLine
3079
+ */
2967
3080
  FromCancelledLines?: Record<string, number>;
2968
3081
  Metadata?: ResponseMessageMetadata;
2969
3082
  /**
@@ -2994,6 +3107,7 @@ export interface GetDiscountByIDResponse {
2994
3107
  * Entity type: DiscountCampaign
2995
3108
  */
2996
3109
  CampaignID?: string;
3110
+ CannotApplyToOwnOrder: boolean;
2997
3111
  CompliancyRule: DataModelsDiscountCompliancyRule;
2998
3112
  ConditionType: DataModelsDiscountConditionTypes;
2999
3113
  Conditions?: DiscountsGetDiscountByIDResponse_DiscountCondition[];
@@ -3005,6 +3119,9 @@ export interface GetDiscountByIDResponse {
3005
3119
  * Entity type: Currency
3006
3120
  */
3007
3121
  CurrencyID?: string;
3122
+ /**
3123
+ * Entity type: CustomField
3124
+ */
3008
3125
  CustomFieldValuesWithOptions?: Record<string, DataModelsCustomFieldValueWithOptions>;
3009
3126
  /**
3010
3127
  * Entity type: CustomField
@@ -3059,6 +3176,10 @@ export interface GetDiscountByIDResponse {
3059
3176
  OrganizationUnitSetType?: DataModelsOrganizationUnitSetTypes;
3060
3177
  PromotionLabel?: string;
3061
3178
  /**
3179
+ * Entity type: CustomField
3180
+ */
3181
+ RequiredCustomFields?: string[];
3182
+ /**
3062
3183
  * Entity type: OrganizationUnit
3063
3184
  */
3064
3185
  RestitutionOrganizationUnitID?: string;
@@ -3075,6 +3196,9 @@ export interface GetDiscountByIDResponse {
3075
3196
  }
3076
3197
  export interface DiscountsGetDiscountByIDResponse_DiscountCondition {
3077
3198
  Data?: IConditionData;
3199
+ /**
3200
+ * Entity type: DiscountCondition
3201
+ */
3078
3202
  ID: string;
3079
3203
  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
3204
  UseAsActionCondition: boolean;
@@ -3454,6 +3578,9 @@ export interface ListDiscountLayersResponse {
3454
3578
  }
3455
3579
  export interface DiscountsListDiscountLayersResponse_DiscountLayerDto {
3456
3580
  Description?: string;
3581
+ /**
3582
+ * Entity type: DiscountLayer
3583
+ */
3457
3584
  ID: string;
3458
3585
  IsExclusive: boolean;
3459
3586
  /**
@@ -3548,6 +3675,55 @@ export interface MoveDiscountLayer {
3548
3675
  ID: string;
3549
3676
  }
3550
3677
  /**
3678
+ * Push a DiscountCoupon
3679
+ */
3680
+ export interface PushDiscountCoupons {
3681
+ Coupons?: DiscountsPushDiscountCoupons_PushedCoupon[];
3682
+ /**
3683
+ * Entity type: Discount
3684
+ */
3685
+ DiscountID?: string;
3686
+ }
3687
+ export interface DiscountsPushDiscountCoupons_PushedCoupon {
3688
+ CouponCode?: string;
3689
+ IsActive?: boolean;
3690
+ MaximumUsage?: number;
3691
+ /**
3692
+ * Entity type: Order
3693
+ */
3694
+ OrderID?: string;
3695
+ /**
3696
+ * Entity type: User
3697
+ */
3698
+ UserID?: string;
3699
+ }
3700
+ export interface PushDiscountCouponsResponse {
3701
+ CreatedCoupons?: DiscountsPushDiscountCouponsResponse_CreatedCoupon[];
3702
+ Error?: ServiceError;
3703
+ Metadata?: ResponseMessageMetadata;
3704
+ }
3705
+ export interface DiscountsPushDiscountCouponsResponse_CreatedCoupon {
3706
+ /**
3707
+ * Entity type: DiscountCoupon
3708
+ */
3709
+ ID: string;
3710
+ IsDuplicateCoupon: boolean;
3711
+ }
3712
+ /**
3713
+ * Remove required custom fields from ManualDiscount
3714
+ */
3715
+ export interface RemoveRequiredCustomFieldsFromManualDiscount {
3716
+ /**
3717
+ * Entity type: CustomField
3718
+ */
3719
+ CustomFieldIDs?: string[];
3720
+ /**
3721
+ * Entity type: Discount
3722
+ */
3723
+ DiscountID: string;
3724
+ RemoveAllRequiredCustomFields?: boolean;
3725
+ }
3726
+ /**
3551
3727
  * Remove security roles from ManualDiscount
3552
3728
  */
3553
3729
  export interface RemoveRolesFromManualDiscount {
@@ -3632,6 +3808,15 @@ export interface DiscountsSearchDiscountsByQueryResponse_DiscountDto {
3632
3808
  UserUsageReloadStrategy?: string;
3633
3809
  }
3634
3810
  /**
3811
+ * Takes in all discount layers and sets their sequences. All layers except the system layer are required.
3812
+ */
3813
+ export interface SetDiscountLayerSequences {
3814
+ /**
3815
+ * Entity type: DiscountLayer
3816
+ */
3817
+ Layers: string[];
3818
+ }
3819
+ /**
3635
3820
  * Update an existing discount
3636
3821
  */
3637
3822
  export interface UpdateDiscount {
@@ -3645,10 +3830,10 @@ export interface UpdateDiscount {
3645
3830
  */
3646
3831
  CampaignID?: string;
3647
3832
  CannotApplyToOwnOrder?: boolean;
3648
- CompliancyRule: DataModelsDiscountCompliancyRule;
3649
- ConditionType: DataModelsDiscountConditionTypes;
3833
+ CompliancyRule?: DataModelsDiscountCompliancyRule;
3834
+ ConditionType?: DataModelsDiscountConditionTypes;
3650
3835
  Conditions?: DiscountsUpdateDiscount_DiscountConditionDto[];
3651
- CouponHandler: string | null | undefined;
3836
+ CouponHandler?: string | null;
3652
3837
  CouponsGeneratedByOtherDiscount?: boolean;
3653
3838
  /**
3654
3839
  * Entity type: Currency
@@ -3657,7 +3842,7 @@ export interface UpdateDiscount {
3657
3842
  /**
3658
3843
  * Optional additional custom fields
3659
3844
  */
3660
- CustomFields: DataModelsCustomFieldKeyValue[] | null | undefined;
3845
+ CustomFields?: DataModelsCustomFieldKeyValue[] | null;
3661
3846
  /**
3662
3847
  * Entity type: CustomField
3663
3848
  */
@@ -3665,10 +3850,10 @@ export interface UpdateDiscount {
3665
3850
  DaysApplicable?: DaysOfWeek;
3666
3851
  DeactivateWhenBudgetReached?: boolean;
3667
3852
  Description: string;
3668
- DiscountOrderType: DataModelsDiscountOrderTypes;
3853
+ DiscountOrderType?: DataModelsDiscountOrderTypes;
3669
3854
  Enable?: boolean;
3670
3855
  EndDate?: string;
3671
- FinancialDispersion: DataModelsFinancialDespersionType;
3856
+ FinancialDispersion?: DataModelsFinancialDespersionType;
3672
3857
  /**
3673
3858
  * Entity type: Discount
3674
3859
  */
@@ -3698,12 +3883,20 @@ export interface UpdateDiscount {
3698
3883
  OrganizationUnitSetID: string;
3699
3884
  PromotionLabel?: string;
3700
3885
  /**
3886
+ * Entity type: CustomField
3887
+ * For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
3888
+ */
3889
+ RequiredCustomFields?: string[] | null;
3890
+ /**
3701
3891
  * Entity type: OrganizationUnit
3702
3892
  */
3703
3893
  RestitutionOrganizationUnitID?: string;
3894
+ /**
3895
+ * Entity type: Role
3896
+ */
3704
3897
  RoleIDs?: string[];
3705
3898
  StartDate?: string;
3706
- Trigger: DataModelsDiscountTriggers;
3899
+ Trigger?: DataModelsDiscountTriggers;
3707
3900
  UserUsageLimit?: number;
3708
3901
  UserUsageReloadStrategy?: string;
3709
3902
  }
@@ -3719,21 +3912,21 @@ export interface DiscountsUpdateDiscount_DiscountConditionDto {
3719
3912
  * Update an existing DiscountCampaign
3720
3913
  */
3721
3914
  export interface UpdateDiscountCampaign {
3722
- BackendID: string | null | undefined;
3723
- BackendSystemID: string | null | undefined;
3915
+ BackendID?: string | null;
3916
+ BackendSystemID?: string | null;
3724
3917
  /**
3725
3918
  * Entity type: Currency
3726
3919
  */
3727
- CurrencyID: string | null | undefined;
3728
- Description: string | null | undefined;
3729
- EndDate: string | null | undefined;
3920
+ CurrencyID?: string | null;
3921
+ Description?: string | null;
3922
+ EndDate?: string | null;
3730
3923
  /**
3731
3924
  * Entity type: DiscountCampaign
3732
3925
  */
3733
3926
  ID: string;
3734
3927
  KeepDiscountsWithinCampaignTimespan?: boolean;
3735
- Name: string | null | undefined;
3736
- StartDate: string | null | undefined;
3928
+ Name?: string | null;
3929
+ StartDate?: string | null;
3737
3930
  }
3738
3931
  /**
3739
3932
  * Update the budget on the discount campaign.
@@ -3745,7 +3938,7 @@ export interface UpdateDiscountCampaignBudget {
3745
3938
  /**
3746
3939
  * Entity type: Currency
3747
3940
  */
3748
- CurrencyID: string | null | undefined;
3941
+ CurrencyID?: string | null;
3749
3942
  DeactivateDiscountsWhenBudgetIsReached?: boolean;
3750
3943
  /**
3751
3944
  * Entity type: DiscountCampaign
@@ -3757,7 +3950,7 @@ export interface UpdateDiscountCampaignBudget {
3757
3950
  * Update an existing DiscountCoupon
3758
3951
  */
3759
3952
  export interface UpdateDiscountCoupon {
3760
- CouponCode: string;
3953
+ CouponCode?: string;
3761
3954
  /**
3762
3955
  * Entity type: DiscountCoupon
3763
3956
  */
@@ -3789,18 +3982,18 @@ export interface UpdateDiscountLayer {
3789
3982
  export interface UpdateDiscountTemplate {
3790
3983
  ActionData: DiscountsIDiscountActionData;
3791
3984
  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;
3985
+ AppliesTo?: DataModelsDiscountAppliesTo;
3793
3986
  BackendID?: string;
3794
3987
  /**
3795
3988
  * Entity type: DiscountCampaign
3796
3989
  */
3797
3990
  CampaignID?: string;
3798
- ConditionType: DataModelsDiscountConditionTypes;
3991
+ ConditionType?: DataModelsDiscountConditionTypes;
3799
3992
  Conditions?: DiscountsUpdateDiscountTemplate_Condition[];
3800
3993
  CouponHandler?: string;
3801
3994
  CouponsGeneratedByOtherDiscount?: boolean;
3802
3995
  Description: string;
3803
- DiscountOrderType: DataModelsDiscountOrderTypes;
3996
+ DiscountOrderType?: DataModelsDiscountOrderTypes;
3804
3997
  /**
3805
3998
  * Entity type: DiscountTemplate
3806
3999
  */
@@ -3820,7 +4013,7 @@ export interface UpdateDiscountTemplate {
3820
4013
  * Entity type: OrganizationUnit
3821
4014
  */
3822
4015
  RestitutionOrganizationUnitID?: string;
3823
- Trigger: DataModelsDiscountTriggers;
4016
+ Trigger?: DataModelsDiscountTriggers;
3824
4017
  UserUsageLimit?: number;
3825
4018
  UserUsageReloadStrategy?: string;
3826
4019
  }
@@ -3877,8 +4070,8 @@ export interface ValidateDiscount {
3877
4070
  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
4071
  AppliesTo?: DataModelsDiscountAppliesTo;
3879
4072
  BackendID?: string;
3880
- CompliancyRule: DataModelsDiscountCompliancyRule;
3881
- ConditionType: DataModelsDiscountConditionTypes;
4073
+ CompliancyRule?: DataModelsDiscountCompliancyRule;
4074
+ ConditionType?: DataModelsDiscountConditionTypes;
3882
4075
  Conditions?: DiscountsValidateDiscount_DiscountConditionDto[];
3883
4076
  CouponHandler?: string;
3884
4077
  CouponsGeneratedByOtherDiscount?: boolean;
@@ -3896,9 +4089,9 @@ export interface ValidateDiscount {
3896
4089
  CustomUserUsageLimitFieldID?: string;
3897
4090
  DaysApplicable?: DaysOfWeek;
3898
4091
  Description?: string;
3899
- DiscountOrderType: DataModelsDiscountOrderTypes;
4092
+ DiscountOrderType?: DataModelsDiscountOrderTypes;
3900
4093
  EndDate?: string;
3901
- FinancialDispersion: DataModelsFinancialDespersionType;
4094
+ FinancialDispersion?: DataModelsFinancialDespersionType;
3902
4095
  /**
3903
4096
  * Entity type: Discount
3904
4097
  */
@@ -3927,11 +4120,16 @@ export interface ValidateDiscount {
3927
4120
  */
3928
4121
  OrganizationUnitSetID: string;
3929
4122
  /**
4123
+ * Entity type: CustomField
4124
+ * For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
4125
+ */
4126
+ RequiredCustomFields?: string[];
4127
+ /**
3930
4128
  * Entity type: OrganizationUnit
3931
4129
  */
3932
4130
  RestitutionOrganizationUnitID?: string;
3933
4131
  StartDate: string;
3934
- Trigger: DataModelsDiscountTriggers;
4132
+ Trigger?: DataModelsDiscountTriggers;
3935
4133
  }
3936
4134
  export interface DiscountsValidateDiscount_DiscountConditionDto {
3937
4135
  Data?: IConditionData;
@@ -3940,6 +4138,9 @@ export interface DiscountsValidateDiscount_DiscountConditionDto {
3940
4138
  }
3941
4139
  export interface ValidateDiscountResponse {
3942
4140
  ActionMessages?: string[];
4141
+ /**
4142
+ * Entity type: DiscountCondition
4143
+ */
3943
4144
  ConditionMessages?: Record<string, string[] | null>;
3944
4145
  CustomFieldMessages?: DiscountsValidateDiscountResponse_CustomFieldMessage;
3945
4146
  Error?: ServiceError;
@@ -3957,14 +4158,14 @@ export interface DiscountsValidateDiscountResponse_CustomFieldMessage {
3957
4158
  export interface ValidateDiscountTemplate {
3958
4159
  ActionData: DiscountsIDiscountActionData;
3959
4160
  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;
4161
+ AppliesTo?: DataModelsDiscountAppliesTo;
3961
4162
  BackendID?: string;
3962
- ConditionType: DataModelsDiscountConditionTypes;
4163
+ ConditionType?: DataModelsDiscountConditionTypes;
3963
4164
  Conditions?: DiscountsValidateDiscountTemplate_Condition[];
3964
4165
  CouponHandler?: string;
3965
4166
  CouponsGeneratedByOtherDiscount?: boolean;
3966
4167
  Description: string;
3967
- DiscountOrderType: DataModelsDiscountOrderTypes;
4168
+ DiscountOrderType?: DataModelsDiscountOrderTypes;
3968
4169
  IsExclusive?: boolean;
3969
4170
  /**
3970
4171
  * Entity type: LedgerClass
@@ -3978,7 +4179,7 @@ export interface ValidateDiscountTemplate {
3978
4179
  * Entity type: OrganizationUnit
3979
4180
  */
3980
4181
  RestitutionOrganizationUnitID?: string;
3981
- Trigger: DataModelsDiscountTriggers;
4182
+ Trigger?: DataModelsDiscountTriggers;
3982
4183
  UserUsageLimit?: number;
3983
4184
  UserUsageReloadStrategy?: string;
3984
4185
  }
@@ -4015,17 +4216,20 @@ export interface VerifyDiscount {
4015
4216
  * Create a new entity field validator
4016
4217
  */
4017
4218
  export interface CreateEntityFieldValidator {
4018
- ApplyFor: DataModelsEntityFieldValidatorUserTypes;
4019
- Entity: DataModelsEntityFieldValidatorEntityTypes;
4219
+ ApplyFor?: DataModelsEntityFieldValidatorUserTypes;
4220
+ Entity?: DataModelsEntityFieldValidatorEntityTypes;
4020
4221
  EntityFieldName: string;
4021
4222
  /**
4022
4223
  * This must be of object that inherits the class EntityFieldValidatorBase. For example StringEntityFieldValidator or DefaultEntityFieldValidator
4023
4224
  */
4024
4225
  ValidatorData: EntityFieldValidatorsValidatorsEntityFieldValidatorBase;
4025
- ValidatorType: DataModelsEntityFieldValidatorType;
4226
+ ValidatorType?: DataModelsEntityFieldValidatorType;
4026
4227
  }
4027
4228
  export interface CreateEntityFieldValidatorResponse {
4028
4229
  Error?: ServiceError;
4230
+ /**
4231
+ * Entity type: EntityFieldValidator
4232
+ */
4029
4233
  ID: string;
4030
4234
  Metadata?: ResponseMessageMetadata;
4031
4235
  }
@@ -4090,6 +4294,9 @@ export interface EntityFieldValidatorsListEntityFieldValidatorsResponse_ListEnti
4090
4294
  ApplyFor: DataModelsEntityFieldValidatorUserTypes;
4091
4295
  Entity: DataModelsEntityFieldValidatorEntityTypes;
4092
4296
  EntityFieldName?: string;
4297
+ /**
4298
+ * Entity type: EntityFieldValidator
4299
+ */
4093
4300
  ID: string;
4094
4301
  ValidatorData?: EntityFieldValidatorsValidatorsEntityFieldValidatorBase;
4095
4302
  ValidatorType: DataModelsEntityFieldValidatorType;
@@ -4103,7 +4310,7 @@ export interface UpdateEntityFieldValidator {
4103
4310
  * Entity type: EntityFieldValidator
4104
4311
  */
4105
4312
  ID: string;
4106
- ValidatorData: EntityFieldValidatorsValidatorsEntityFieldValidatorBase | null | undefined;
4313
+ ValidatorData?: EntityFieldValidatorsValidatorsEntityFieldValidatorBase | null;
4107
4314
  }
4108
4315
  /**
4109
4316
  * -
@@ -4186,7 +4393,7 @@ export interface FinanceCashExpenseTypeOrganizationUnitSet {
4186
4393
  * An example of this might be tips left by a customer.
4187
4394
  */
4188
4395
  export interface CreateCashExpenseType {
4189
- AmountType: DataModelsCashExpenseAmountTypes;
4396
+ AmountType?: DataModelsCashExpenseAmountTypes;
4190
4397
  BackendID?: string;
4191
4398
  Description?: string;
4192
4399
  LedgerClassID?: string;
@@ -4329,7 +4536,7 @@ export interface FinanceListExchangeRatesResponse_ExchangeRateDto {
4329
4536
  * Updates a cash expense type. All properties except for its Name can be updated.
4330
4537
  */
4331
4538
  export interface UpdateCashExpenseType {
4332
- AmountType: DataModelsCashExpenseAmountTypes;
4539
+ AmountType?: DataModelsCashExpenseAmountTypes;
4333
4540
  BackendID?: string;
4334
4541
  Description?: string;
4335
4542
  /**
@@ -4361,7 +4568,7 @@ export interface CreateGiftCardConfiguration {
4361
4568
  Data?: TAnyValue;
4362
4569
  Handler: string;
4363
4570
  Name: string;
4364
- UsageType: GiftCardsConfigurationGiftCardConfigurationUsageTypes;
4571
+ UsageType?: GiftCardsConfigurationGiftCardConfigurationUsageTypes;
4365
4572
  }
4366
4573
  export interface CreateGiftCardConfigurationResponse {
4367
4574
  Error?: ServiceError;
@@ -4483,6 +4690,10 @@ export interface GiftCardsListGiftCardConfigurationsResponse_GiftCardConfigurati
4483
4690
  * `ProductGiftCard`: an item that describes the giftcard properties of a product with type GiftCard
4484
4691
  */
4485
4692
  export interface ListProductGiftCards {
4693
+ /**
4694
+ * Entity type: ProductPropertyType
4695
+ */
4696
+ IncludedProductProperties?: string[];
4486
4697
  PageConfig?: PageConfig<GiftCardsListProductGiftCardsFilter>;
4487
4698
  }
4488
4699
  export interface ListProductGiftCardsResponse {
@@ -4505,6 +4716,7 @@ export interface GiftCardsListProductGiftCardsResponse_ProductGiftCardDto {
4505
4716
  */
4506
4717
  ID: string;
4507
4718
  IsDigital: boolean;
4719
+ Product?: SearchIProductSearchItem;
4508
4720
  /**
4509
4721
  * Entity type: Product
4510
4722
  */
@@ -4521,8 +4733,8 @@ export interface UpdateGiftCardConfiguration {
4521
4733
  /**
4522
4734
  * 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
4735
  */
4524
- CardType: string | null | undefined;
4525
- Data: TAnyValue | null | undefined;
4736
+ CardType?: string | null;
4737
+ Data?: TAnyValue | null;
4526
4738
  Handler?: string;
4527
4739
  /**
4528
4740
  * Entity type: GiftCardConfiguration
@@ -4538,11 +4750,11 @@ export interface UpdateProductGiftCard {
4538
4750
  /**
4539
4751
  * Communication options for digital giftcards
4540
4752
  */
4541
- CommunicationOptions: GiftCardsConfigurationProductGiftCardCommunicationOptions | undefined;
4753
+ CommunicationOptions?: GiftCardsConfigurationProductGiftCardCommunicationOptions;
4542
4754
  /**
4543
4755
  * Entity type: GiftCardConfiguration
4544
4756
  */
4545
- GiftCardConfigurationID: string | null | undefined;
4757
+ GiftCardConfigurationID?: string | null;
4546
4758
  /**
4547
4759
  * Entity type: ProductGiftCard
4548
4760
  */
@@ -4563,7 +4775,7 @@ export interface CreateClientApplication {
4563
4775
  BackendID: string;
4564
4776
  Name: string;
4565
4777
  NotificationConfiguration?: string;
4566
- Type: DataModelsClientApplicationType;
4778
+ Type?: DataModelsClientApplicationType;
4567
4779
  }
4568
4780
  export interface CreateClientApplicationResponse {
4569
4781
  Error?: ServiceError;
@@ -4594,7 +4806,18 @@ export interface CreateDevice {
4594
4806
  * Entity type: Station
4595
4807
  */
4596
4808
  StationID?: string;
4597
- TypeID: string;
4809
+ /**
4810
+ * Entity type: DeviceType
4811
+ */
4812
+ TypeID?: number;
4813
+ }
4814
+ export interface CreateDeviceResponse {
4815
+ Error?: ServiceError;
4816
+ /**
4817
+ * Entity type: Device
4818
+ */
4819
+ ID: string;
4820
+ Metadata?: ResponseMessageMetadata;
4598
4821
  }
4599
4822
  /**
4600
4823
  * Creates a new OpenCashDrawerReason. Name and Description can both be localized through the LocalizeOpenCashDrawerReason service later.
@@ -4634,6 +4857,14 @@ export interface CreateStation {
4634
4857
  */
4635
4858
  OrganizationUnitID: string;
4636
4859
  }
4860
+ export interface CreateStationResponse {
4861
+ Error?: ServiceError;
4862
+ /**
4863
+ * Entity type: Station
4864
+ */
4865
+ ID: string;
4866
+ Metadata?: ResponseMessageMetadata;
4867
+ }
4637
4868
  /**
4638
4869
  * Delete a ClientApplication
4639
4870
  */
@@ -4816,17 +5047,17 @@ export interface UpdateClientApplication {
4816
5047
  */
4817
5048
  ID: string;
4818
5049
  Name?: string;
4819
- NotificationConfiguration: string | null | undefined;
5050
+ NotificationConfiguration?: string | null;
4820
5051
  Type?: DataModelsClientApplicationType;
4821
5052
  }
4822
5053
  /**
4823
5054
  * Updates a device
4824
5055
  */
4825
5056
  export interface UpdateDevice {
4826
- Address: string | null | undefined;
4827
- AssemblyName: string | null | undefined;
4828
- BackendID: string | null | undefined;
4829
- Data: DevicesIDeviceTypeData | null | undefined;
5057
+ Address?: string | null;
5058
+ AssemblyName?: string | null;
5059
+ BackendID?: string | null;
5060
+ Data?: DevicesIDeviceTypeData | null;
4830
5061
  /**
4831
5062
  * Entity type: Device
4832
5063
  */
@@ -4835,16 +5066,19 @@ export interface UpdateDevice {
4835
5066
  /**
4836
5067
  * Entity type: OrganizationUnit
4837
5068
  */
4838
- OrganizationUnitID: string | null | undefined;
5069
+ OrganizationUnitID?: string | null;
4839
5070
  /**
4840
5071
  * Entity type: PrinterType
4841
5072
  */
4842
- PrinterTypeID: string | null | undefined;
5073
+ PrinterTypeID?: string | null;
4843
5074
  /**
4844
5075
  * Entity type: Station
4845
5076
  */
4846
- StationID: string | null | undefined;
4847
- TypeID?: string;
5077
+ StationID?: string | null;
5078
+ /**
5079
+ * Entity type: DeviceType
5080
+ */
5081
+ TypeID?: number;
4848
5082
  }
4849
5083
  /**
4850
5084
  * Updates an existing OpenCashDrawerReason with a new Name and Description.
@@ -4858,24 +5092,14 @@ export interface UpdateOpenCashDrawerReason {
4858
5092
  Name: string;
4859
5093
  }
4860
5094
  /**
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
5095
  * Updates a station.
4872
5096
  */
4873
5097
  export interface UpdateStation {
4874
- BackendID: string | null | undefined;
5098
+ BackendID?: string | null;
4875
5099
  /**
4876
5100
  * Optional additional custom fields
4877
5101
  */
4878
- CustomFields: DataModelsCustomFieldKeyValue[] | null | undefined;
5102
+ CustomFields?: DataModelsCustomFieldKeyValue[] | null;
4879
5103
  /**
4880
5104
  * Entity type: Station
4881
5105
  */
@@ -4891,6 +5115,9 @@ export interface CreateInquiry {
4891
5115
  Name: string;
4892
5116
  OneTimeUseOnly?: boolean;
4893
5117
  PromptUser?: boolean;
5118
+ /**
5119
+ * Entity type: Script
5120
+ */
4894
5121
  ScriptID?: string;
4895
5122
  }
4896
5123
  export interface InquiriesCreateInquiry_ItemData {
@@ -4980,7 +5207,7 @@ export interface ListInquiriesResponse {
4980
5207
  * Update an inquiry
4981
5208
  */
4982
5209
  export interface UpdateInquiry {
4983
- Description: string | null | undefined;
5210
+ Description?: string | null;
4984
5211
  /**
4985
5212
  * Entity type: Inquiry
4986
5213
  */
@@ -4988,13 +5215,16 @@ export interface UpdateInquiry {
4988
5215
  Name?: string;
4989
5216
  OneTimeUseOnly?: boolean;
4990
5217
  PromptUser?: boolean;
4991
- ScriptID: string | null | undefined;
5218
+ /**
5219
+ * Entity type: Script
5220
+ */
5221
+ ScriptID?: string | null;
4992
5222
  }
4993
5223
  /**
4994
5224
  * Updates an inquiry item
4995
5225
  */
4996
5226
  export interface UpdateInquiryItem {
4997
- Description: string | null | undefined;
5227
+ Description?: string | null;
4998
5228
  /**
4999
5229
  * Entity type: InquiryItem
5000
5230
  */
@@ -5027,26 +5257,26 @@ export interface AddLoyaltyProgramPriceList {
5027
5257
  PriceListID: string;
5028
5258
  }
5029
5259
  /**
5030
- * Archive a point awarding rule
5260
+ * Add a custom field requirement to the loyalty program. NOTE THAT a custom field can only be set once as a requirement.
5031
5261
  */
5032
- export interface ArchivePointAwardingRule {
5262
+ export interface AddLoyaltyProgramRequiredCustomField {
5033
5263
  /**
5034
- * Entity type: PointAwardingRule
5264
+ * Entity type: CustomField
5035
5265
  */
5036
- ID: string;
5266
+ CustomFieldID: string;
5267
+ /**
5268
+ * Entity type: LoyaltyProgram
5269
+ */
5270
+ LoyaltyProgramID: string;
5037
5271
  }
5038
5272
  /**
5039
- * Attach a product limitation to a payment type.
5273
+ * Archive a point awarding rule
5040
5274
  */
5041
- export interface AttachLoyaltyProgramProductLimitationToPaymentType {
5042
- /**
5043
- * Entity type: LoyaltyProgramPaymentType
5044
- */
5045
- LoyaltyProgramPaymentTypeID: string;
5275
+ export interface ArchivePointAwardingRule {
5046
5276
  /**
5047
- * Entity type: LoyaltyProgramProductLimitation
5277
+ * Entity type: PointAwardingRule
5048
5278
  */
5049
- LoyaltyProgramProductLimitationID: string;
5279
+ ID: string;
5050
5280
  }
5051
5281
  /**
5052
5282
  * Attach a loyalty program to an order
@@ -5064,6 +5294,9 @@ export interface AttachLoyaltyProgramToOrder {
5064
5294
  * Entity type: User
5065
5295
  */
5066
5296
  UserID?: string;
5297
+ /**
5298
+ * When set, the UserID will also become required so we can verify the UserIdentifier.
5299
+ */
5067
5300
  UserIdentifier?: string;
5068
5301
  }
5069
5302
  /**
@@ -5074,10 +5307,6 @@ export interface CreateLoyaltyProgram {
5074
5307
  * Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
5075
5308
  */
5076
5309
  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
5310
  ApplyManuallyOnly?: boolean;
5082
5311
  /**
5083
5312
  * When true, if a non anonymous customer is attached to the order they will be automatically subscribed on finishing the order.
@@ -5096,9 +5325,12 @@ export interface CreateLoyaltyProgram {
5096
5325
  EndDate?: string;
5097
5326
  Handler: string;
5098
5327
  LoyaltyPointUsageOptions?: DataModelsLoyaltyPointUsageOptions;
5328
+ /**
5329
+ * Entity type: LoyaltyProgramGroup
5330
+ */
5099
5331
  LoyaltyProgramGroupID?: string;
5100
5332
  Name: string;
5101
- Options: DataModelsLoyaltyProgramOptions;
5333
+ Options?: DataModelsLoyaltyProgramOptions;
5102
5334
  PointExpirationPolicyData?: Record<string, TAnyValue>;
5103
5335
  PointExpirationPolicyType?: string;
5104
5336
  PointPendingPolicyData?: Record<string, TAnyValue>;
@@ -5136,7 +5368,7 @@ export interface CreateLoyaltyProgram {
5136
5368
  */
5137
5369
  ResubscribeHandling?: DataModelsResubscribeHandlingType;
5138
5370
  StartDate?: string;
5139
- Status: DataModelsLoyaltyProgramStatus;
5371
+ Status?: DataModelsLoyaltyProgramStatus;
5140
5372
  UserBudget?: number;
5141
5373
  /**
5142
5374
  * Attention!
@@ -5193,7 +5425,7 @@ export interface CreateLoyaltyProgramGroup {
5193
5425
  EndDate?: string;
5194
5426
  Name: string;
5195
5427
  StartDate?: string;
5196
- Status: DataModelsLoyaltyProgramStatus;
5428
+ Status?: DataModelsLoyaltyProgramStatus;
5197
5429
  TaxExemptionCode?: string;
5198
5430
  }
5199
5431
  export interface CreateLoyaltyProgramGroupResponse {
@@ -5208,6 +5440,7 @@ export interface CreateLoyaltyProgramGroupResponse {
5208
5440
  * Create a new LoyaltyProgramPaymentType
5209
5441
  */
5210
5442
  export interface CreateLoyaltyProgramPaymentType {
5443
+ AllowPartialPayment?: boolean;
5211
5444
  BackendID?: string;
5212
5445
  Budget?: number;
5213
5446
  ExcludeFromProgramBudget?: boolean;
@@ -5221,11 +5454,12 @@ export interface CreateLoyaltyProgramPaymentType {
5221
5454
  * Entity type: PaymentType
5222
5455
  */
5223
5456
  PaymentTypeID: string;
5457
+ ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
5224
5458
  Required?: boolean;
5225
5459
  Sequence?: number;
5226
- TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
5460
+ TaxHandling?: DataModelsLoyaltyPaymentTaxHandlingType;
5227
5461
  UserBudget?: number;
5228
- UserBudgetDeduction: DataModelsUserBudgetDeduction;
5462
+ UserBudgetDeduction?: DataModelsUserBudgetDeduction;
5229
5463
  UserMaximumUsage?: number;
5230
5464
  }
5231
5465
  export interface CreateLoyaltyProgramPaymentTypeResponse {
@@ -5264,6 +5498,10 @@ export interface CreateLoyaltyProgramResponse {
5264
5498
  */
5265
5499
  ID: string;
5266
5500
  Metadata?: ResponseMessageMetadata;
5501
+ /**
5502
+ * Entity type: Subscription
5503
+ */
5504
+ SubscriptionID: string;
5267
5505
  }
5268
5506
  /**
5269
5507
  * Create a point awarding rule.
@@ -5382,19 +5620,6 @@ export interface DetachLoyaltyProgramFromOrder {
5382
5620
  OrderID: string;
5383
5621
  }
5384
5622
  /**
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
5623
  * Disable a point awarding rule
5399
5624
  */
5400
5625
  export interface DisablePointAwardingRule {
@@ -5509,6 +5734,7 @@ export interface GetLoyaltyProgramPaymentType {
5509
5734
  ID: string;
5510
5735
  }
5511
5736
  export interface GetLoyaltyProgramPaymentTypeResponse {
5737
+ AllowPartialPayment: boolean;
5512
5738
  BackendID?: string;
5513
5739
  Budget?: number;
5514
5740
  BudgetRemaining?: number;
@@ -5531,6 +5757,7 @@ export interface GetLoyaltyProgramPaymentTypeResponse {
5531
5757
  */
5532
5758
  PaymentTypeID: string;
5533
5759
  PaymentTypeName?: string;
5760
+ ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
5534
5761
  Required: boolean;
5535
5762
  Sequence: number;
5536
5763
  TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
@@ -5567,8 +5794,7 @@ export interface GetLoyaltyProgramProductLimitationResponse {
5567
5794
  export interface GetLoyaltyProgramResponse {
5568
5795
  AllowUnsubscribeBy?: DataModelsAllowUnsubscribeByType;
5569
5796
  /**
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.
5797
+ * This property has been deprecated. A loyaltyprogram should always be manually applied.
5572
5798
  */
5573
5799
  ApplyManuallyOnly: boolean;
5574
5800
  /**
@@ -5646,6 +5872,78 @@ export interface GetLoyaltyProgramResponse {
5646
5872
  UserMaximumUsage?: number;
5647
5873
  }
5648
5874
  /**
5875
+ * Get the loyalty program user usage
5876
+ */
5877
+ export interface GetLoyaltyProgramUserUsage {
5878
+ /**
5879
+ * Entity type: ProductPropertyType
5880
+ */
5881
+ IncludedProductProperties?: string[];
5882
+ /**
5883
+ * Entity type: LoyaltyProgram
5884
+ */
5885
+ LoyaltyProgramID: string;
5886
+ /**
5887
+ * Entity type: User
5888
+ */
5889
+ UserID?: string;
5890
+ }
5891
+ export interface GetLoyaltyProgramUserUsageResponse {
5892
+ Error?: ServiceError;
5893
+ Metadata?: ResponseMessageMetadata;
5894
+ PaymentUsages?: LoyaltyGetLoyaltyProgramUserUsageResponse_PaymentUsage[];
5895
+ ProductUsages?: LoyaltyGetLoyaltyProgramUserUsageResponse_ProductUsage[];
5896
+ }
5897
+ export interface LoyaltyGetLoyaltyProgramUserUsageResponse_PaymentUsage {
5898
+ AmountUsage: number;
5899
+ /**
5900
+ * Entity type: LoyaltyProgramPaymentType
5901
+ */
5902
+ LoyaltyProgramPaymentTypeID: string;
5903
+ ProductUsage?: LoyaltyGetLoyaltyProgramUserUsageResponse_ProductUsage[];
5904
+ }
5905
+ export interface LoyaltyGetLoyaltyProgramUserUsageResponse_ProductUsage {
5906
+ ConsumedQuantity: number;
5907
+ PrimaryImage?: SearchIProductSearchItemPrimaryImage;
5908
+ /**
5909
+ * Entity type: Product
5910
+ */
5911
+ ProductBackendID?: string;
5912
+ /**
5913
+ * Entity type: Product
5914
+ */
5915
+ ProductID: string;
5916
+ ProductName?: string;
5917
+ }
5918
+ /**
5919
+ * Get the available loyalty program payment methods for the given order.
5920
+ */
5921
+ export interface GetOrderLoyaltyProgramPaymentTypes {
5922
+ /**
5923
+ * Entity type: Order
5924
+ */
5925
+ OrderID: string;
5926
+ }
5927
+ export interface GetOrderLoyaltyProgramPaymentTypesResponse {
5928
+ Error?: ServiceError;
5929
+ Metadata?: ResponseMessageMetadata;
5930
+ Options?: LoyaltyGetOrderLoyaltyProgramPaymentTypesResponse_Option[];
5931
+ }
5932
+ export interface LoyaltyGetOrderLoyaltyProgramPaymentTypesResponse_Option {
5933
+ BackendID?: string;
5934
+ /**
5935
+ * Entity type: LoyaltyProgramPaymentType
5936
+ */
5937
+ ID: string;
5938
+ /**
5939
+ * Entity type: PaymentType
5940
+ */
5941
+ PaymentTypeID: string;
5942
+ PaymentTypeName?: string;
5943
+ Required: boolean;
5944
+ Sequence: number;
5945
+ }
5946
+ /**
5649
5947
  * Get loyalty point rule.
5650
5948
  */
5651
5949
  export interface GetPointAwardingRule {
@@ -5792,6 +6090,7 @@ export interface ListLoyaltyProgramPaymentTypesResponse {
5792
6090
  Results?: LoyaltyListLoyaltyProgramPaymentTypesResponse_Item[];
5793
6091
  }
5794
6092
  export interface LoyaltyListLoyaltyProgramPaymentTypesResponse_Item {
6093
+ AllowPartialPayment: boolean;
5795
6094
  BackendID?: string;
5796
6095
  Budget?: number;
5797
6096
  ExcludeFromProgramBudget: boolean;
@@ -5862,10 +6161,50 @@ export interface LoyaltyListLoyaltyProgramProductLimitationsResponse_Item {
5862
6161
  */
5863
6162
  ID: string;
5864
6163
  Name?: string;
6164
+ /**
6165
+ * The quantity limit over the entire product limitation product set per order.
6166
+ */
6167
+ OverallQuantityLimitPerOrder?: number;
6168
+ /**
6169
+ * The quantity limit over the entire product limitation product set per user.
6170
+ */
6171
+ OverallQuantityLimitPerUser?: number;
6172
+ /**
6173
+ * The quantity limit per product within the product limitation product set per order.
6174
+ */
5865
6175
  QuantityLimitPerOrder?: number;
6176
+ /**
6177
+ * The quantity limit per product within the product limitation product set per user.
6178
+ */
5866
6179
  QuantityLimitPerUser?: number;
5867
6180
  }
5868
6181
  /**
6182
+ * List the loyalty program CustomFieldRequirements
6183
+ */
6184
+ export interface ListLoyaltyProgramRequiredCustomFields {
6185
+ InitialPageConfig?: PageTokenConfig<Record<string, string | null> | null>;
6186
+ /**
6187
+ * Entity type: LoyaltyProgram
6188
+ */
6189
+ LoyaltyProgramID: string;
6190
+ PageToken?: string;
6191
+ }
6192
+ export interface ListLoyaltyProgramRequiredCustomFieldsResponse {
6193
+ Error?: ServiceError;
6194
+ Metadata?: ResponseMessageMetadata;
6195
+ NextPageToken?: string;
6196
+ PreviousPageToken?: string;
6197
+ Results?: LoyaltyListLoyaltyProgramRequiredCustomFieldsResponse_CustomField[];
6198
+ }
6199
+ export interface LoyaltyListLoyaltyProgramRequiredCustomFieldsResponse_CustomField {
6200
+ BackendID?: string;
6201
+ /**
6202
+ * Entity type: CustomField
6203
+ */
6204
+ ID: string;
6205
+ Name?: string;
6206
+ }
6207
+ /**
5869
6208
  * List the LoyaltyPrograms
5870
6209
  */
5871
6210
  export interface ListLoyaltyPrograms {
@@ -5935,6 +6274,14 @@ export interface LoyaltyListPointAwardingRulesResponse_Rule {
5935
6274
  export interface LoyaltyLoyaltyProgramProductLimitationData {
5936
6275
  Filters?: Record<string, SearchFilterModel>;
5937
6276
  /**
6277
+ * The quantity limit over the entire product limitation product set per order.
6278
+ */
6279
+ OverallQuantityLimitPerOrder?: number;
6280
+ /**
6281
+ * The quantity limit over the entire product limitation product set per user.
6282
+ */
6283
+ OverallQuantityLimitPerUser?: number;
6284
+ /**
5938
6285
  * Entity type: Product
5939
6286
  */
5940
6287
  ProductIDs?: string[];
@@ -5942,21 +6289,25 @@ export interface LoyaltyLoyaltyProgramProductLimitationData {
5942
6289
  * Entity type: ProductSearchTemplate
5943
6290
  */
5944
6291
  ProductSearchID?: string;
6292
+ /**
6293
+ * The quantity limit per product within the product limitation product set per order.
6294
+ */
5945
6295
  QuantityLimitPerOrder?: number;
6296
+ /**
6297
+ * The quantity limit per product within the product limitation product set per user.
6298
+ */
5946
6299
  QuantityLimitPerUser?: number;
5947
6300
  }
5948
6301
  /**
5949
6302
  * Push a LoyaltyProgram.
6303
+ * If it doesn't exist it will be created, otherwise is will be updated.
6304
+ * Sub entities will also be created or updated, but will not be removed.
5950
6305
  */
5951
- export interface PushLoyaltyProgram {
6306
+ export interface LoyaltyPushLoyaltyProgram {
5952
6307
  /**
5953
6308
  * Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
5954
6309
  */
5955
6310
  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
6311
  ApplyManuallyOnly?: boolean;
5961
6312
  /**
5962
6313
  * When true, if a non anonymous customer is attached to the order they will be automatically subscribed on finishing the order.
@@ -5965,17 +6316,17 @@ export interface PushLoyaltyProgram {
5965
6316
  * This is ignore when`RequiresSubscribedCustomer` or `RequiresSubscriptionValidation` is set to true.
5966
6317
  */
5967
6318
  AutoSubscribeCustomer?: boolean;
5968
- Budget?: number;
6319
+ Budget?: number | null;
5969
6320
  /**
5970
6321
  * Entity type: Currency
5971
6322
  */
5972
- BudgetCurrencyID?: string;
6323
+ BudgetCurrencyID?: string | null;
5973
6324
  Conditions?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramCondition[];
5974
- Data?: TAnyValue;
6325
+ Data?: TAnyValue | null;
5975
6326
  DeactivateWhenBudgetIsReached?: boolean;
5976
- Description?: string;
5977
- EndDate?: string;
5978
- Handler: string;
6327
+ Description?: string | null;
6328
+ EndDate?: string | null;
6329
+ Handler?: string;
5979
6330
  /**
5980
6331
  * Entity type: LoyaltyProgram
5981
6332
  */
@@ -5984,23 +6335,23 @@ export interface PushLoyaltyProgram {
5984
6335
  /**
5985
6336
  * Entity type: LoyaltyProgramGroup
5986
6337
  */
5987
- LoyaltyProgramGroupID?: string;
5988
- Name: string;
5989
- Options: DataModelsLoyaltyProgramOptions;
6338
+ LoyaltyProgramGroupID?: string | null;
6339
+ Name?: string;
6340
+ Options?: DataModelsLoyaltyProgramOptions;
5990
6341
  OrganizationUnitSets?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramOrganizationUnitSet[];
5991
6342
  PaymentTypes?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType[];
5992
6343
  PointAwardingRules?: LoyaltyPushLoyaltyProgram_PushPointAwardingRule[];
5993
- PointExpirationPolicyData?: TAnyValue;
5994
- PointExpirationPolicyType?: string;
5995
- PointPendingPolicyData?: TAnyValue;
5996
- PointPendingPolicyType?: string;
6344
+ PointExpirationPolicyData?: Record<string, TAnyValue> | null;
6345
+ PointExpirationPolicyType?: string | null;
6346
+ PointPendingPolicyData?: Record<string, TAnyValue> | null;
6347
+ PointPendingPolicyType?: string | null;
5997
6348
  /**
5998
- * Entity type: LoyaltyProgramCondition
6349
+ * Entity type: PriceList
5999
6350
  */
6000
6351
  PriceLists?: string[];
6001
6352
  ProductLimitations?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation[];
6002
6353
  ReactivateProgramWhenPossible?: boolean;
6003
- ReloadPolicy?: string;
6354
+ ReloadPolicy?: string | null;
6004
6355
  /**
6005
6356
  * When true, the loyalty program will only be applied when a customer is attached to the order.
6006
6357
  *
@@ -6013,7 +6364,8 @@ export interface PushLoyaltyProgram {
6013
6364
  * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6014
6365
  * 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
6366
  */
6016
- RequireManualUserIdentifier?: boolean;
6367
+ RequireManualUserIdentifier?: boolean | null;
6368
+ RequiredCustomFields?: string[];
6017
6369
  /**
6018
6370
  * 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
6371
  * Also, this will make the `RequireCustomer` automatically true and `AutoSubscribeCustomer` false.
@@ -6032,31 +6384,31 @@ export interface PushLoyaltyProgram {
6032
6384
  * Handling when a user is unsubscribed and re-subscribes.
6033
6385
  */
6034
6386
  ResubscribeHandling?: DataModelsResubscribeHandlingType;
6035
- StartDate?: string;
6036
- Status: DataModelsLoyaltyProgramStatus;
6037
- UserBudget?: number;
6387
+ StartDate?: string | null;
6388
+ Status?: DataModelsLoyaltyProgramStatus;
6389
+ UserBudget?: number | null;
6038
6390
  /**
6039
6391
  * Attention!
6040
6392
  * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6041
6393
  * 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
6394
  */
6043
- UserIdentifierPrefix?: string;
6395
+ UserIdentifierPrefix?: string | null;
6044
6396
  /**
6045
6397
  * Attention!
6046
6398
  * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6047
6399
  * 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
6400
  */
6049
- UserIdentifierStartNumber?: string;
6401
+ UserIdentifierStartNumber?: string | null;
6050
6402
  /**
6051
6403
  * Attention!
6052
6404
  * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6053
6405
  * 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
6406
  */
6055
- UserIdentifierSuffix?: string;
6056
- UserMaximumUsage?: number;
6407
+ UserIdentifierSuffix?: string | null;
6408
+ UserMaximumUsage?: number | null;
6057
6409
  }
6058
6410
  export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramCondition {
6059
- Data: TAnyValue;
6411
+ Data: Record<string, TAnyValue>;
6060
6412
  /**
6061
6413
  * Entity type: LoyaltyProgramCondition
6062
6414
  */
@@ -6070,6 +6422,7 @@ export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramOrganizationUnitSet
6070
6422
  OrganizationUnitSetID?: string;
6071
6423
  }
6072
6424
  export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType {
6425
+ AllowPartialPayment?: boolean;
6073
6426
  Budget?: number;
6074
6427
  ExcludeFromProgramBudget?: boolean;
6075
6428
  /**
@@ -6082,62 +6435,241 @@ export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType {
6082
6435
  * Entity type: PaymentType
6083
6436
  */
6084
6437
  PaymentTypeID: string;
6085
- ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
6438
+ ProductLimitation?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType_ProductLimitationData;
6086
6439
  Required?: boolean;
6087
6440
  Sequence?: number;
6088
- TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
6441
+ TaxHandling?: DataModelsLoyaltyPaymentTaxHandlingType;
6089
6442
  UserBudget?: number;
6090
- UserBudgetDeduction: DataModelsUserBudgetDeduction;
6443
+ UserBudgetDeduction?: DataModelsUserBudgetDeduction;
6091
6444
  UserMaximumUsage?: number;
6092
6445
  }
6446
+ export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType_ProductLimitationData {
6447
+ Filters?: Record<string, SearchFilterModel>;
6448
+ /**
6449
+ * The quantity limit over the entire product limitation product set per order.
6450
+ */
6451
+ OverallQuantityLimitPerOrder?: number;
6452
+ /**
6453
+ * The quantity limit over the entire product limitation product set per user.
6454
+ */
6455
+ OverallQuantityLimitPerUser?: number;
6456
+ /**
6457
+ * Entity type: Product
6458
+ */
6459
+ ProductIDs?: string[];
6460
+ /**
6461
+ * Entity type: ProductSearchTemplate
6462
+ */
6463
+ ProductSearchID?: string;
6464
+ /**
6465
+ * The quantity limit per product within the product limitation product set per order.
6466
+ */
6467
+ QuantityLimitPerOrder?: number;
6468
+ /**
6469
+ * The quantity limit per product within the product limitation product set per user.
6470
+ */
6471
+ QuantityLimitPerUser?: number;
6472
+ }
6093
6473
  export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation {
6474
+ ApplyToPriceList?: boolean;
6094
6475
  Filters?: Record<string, SearchFilterModel>;
6095
6476
  ID: string;
6096
6477
  Name: string;
6478
+ OverallQuantityLimitPerOrder?: number;
6479
+ OverallQuantityLimitPerUser?: number;
6480
+ /**
6481
+ * Entity type: Product
6482
+ */
6483
+ ProductIDs?: string[];
6484
+ /**
6485
+ * Entity type: ProductSearchTemplate
6486
+ */
6487
+ ProductSearchID?: string;
6488
+ QuantityLimitPerOrder?: number;
6489
+ QuantityLimitPerUser?: number;
6490
+ }
6491
+ export interface LoyaltyPushLoyaltyProgram_PushPointAwardingRule {
6492
+ ApplyRecursive?: boolean;
6493
+ Conditions?: LoyaltyPushLoyaltyProgram_PushPointAwardingRuleCondition[];
6494
+ Description?: string;
6495
+ Enabled?: boolean;
6496
+ EndDate?: string;
6497
+ ID: string;
6498
+ MarketingDescription?: string;
6499
+ Name: string;
6500
+ /**
6501
+ * Entity type: OrganizationUnitSet
6502
+ */
6503
+ OrganizationUnitSetID: string;
6504
+ PointExpirationPolicyData?: TAnyValue;
6505
+ PointExpirationPolicyType?: string;
6506
+ PointPendingPolicyData?: TAnyValue;
6507
+ PointPendingPolicyType?: string;
6508
+ PointsToAward?: number;
6509
+ StartDate: string;
6510
+ }
6511
+ export interface LoyaltyPushLoyaltyProgram_PushPointAwardingRuleCondition {
6512
+ Data?: LoyaltyRulesIPointAwardingConditionData;
6513
+ ID: string;
6514
+ Type: 'ORDERAMOUNT' | 'PRODUCT' | 'USERCUSTOMFIELD';
6515
+ }
6516
+ export interface PushLoyaltyProgramGroupResponse {
6517
+ Error?: ServiceError;
6518
+ /**
6519
+ * Entity type: LoyaltyProgram
6520
+ */
6521
+ ID: string;
6522
+ Metadata?: ResponseMessageMetadata;
6523
+ }
6524
+ export interface PushLoyaltyProgramGroup_Async {
6525
+ Budget?: number;
6526
+ /**
6527
+ * Entity type: Currency
6528
+ */
6529
+ BudgetCurrencyID?: string;
6530
+ DeactivateWhenBudgetIsReached?: boolean;
6531
+ EndDate?: string;
6532
+ /**
6533
+ * Entity type: LoyaltyProgramGroup
6534
+ */
6535
+ ID: string;
6536
+ Name: string;
6537
+ StartDate?: string;
6538
+ Status?: DataModelsLoyaltyProgramStatus;
6539
+ TaxExemptionCode?: string;
6540
+ }
6541
+ export interface PushLoyaltyProgramGroup_AsyncResponse {
6542
+ Error?: ServiceError;
6543
+ JobID?: string;
6544
+ Metadata?: ResponseMessageMetadata;
6545
+ }
6546
+ export interface PushLoyaltyProgramGroup_AsyncResult {
6547
+ JobID?: string;
6548
+ }
6549
+ export interface PushLoyaltyProgramResponse {
6550
+ Error?: ServiceError;
6551
+ /**
6552
+ * Entity type: LoyaltyProgram
6553
+ */
6554
+ ID: string;
6555
+ Metadata?: ResponseMessageMetadata;
6556
+ /**
6557
+ * Entity type: Subscription
6558
+ */
6559
+ SubscriptionID: string;
6560
+ }
6561
+ export interface PushLoyaltyProgram_Async {
6562
+ /**
6563
+ * Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
6564
+ */
6565
+ AllowUnsubscribeBy?: DataModelsAllowUnsubscribeByType;
6566
+ ApplyManuallyOnly?: boolean;
6567
+ /**
6568
+ * When true, if a non anonymous customer is attached to the order they will be automatically subscribed on finishing the order.
6569
+ * When false, the customer will not be subscribed.
6570
+ *
6571
+ * This is ignore when`RequiresSubscribedCustomer` or `RequiresSubscriptionValidation` is set to true.
6572
+ */
6573
+ AutoSubscribeCustomer?: boolean;
6574
+ Budget?: number | null;
6575
+ /**
6576
+ * Entity type: Currency
6577
+ */
6578
+ BudgetCurrencyID?: string | null;
6579
+ Conditions?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramCondition[];
6580
+ Data?: TAnyValue | null;
6581
+ DeactivateWhenBudgetIsReached?: boolean;
6582
+ Description?: string | null;
6583
+ EndDate?: string | null;
6584
+ Handler?: string;
6585
+ /**
6586
+ * Entity type: LoyaltyProgram
6587
+ */
6588
+ ID: string;
6589
+ LoyaltyPointUsageOptions?: DataModelsLoyaltyPointUsageOptions;
6590
+ /**
6591
+ * Entity type: LoyaltyProgramGroup
6592
+ */
6593
+ LoyaltyProgramGroupID?: string | null;
6594
+ Name?: string;
6595
+ Options?: DataModelsLoyaltyProgramOptions;
6596
+ OrganizationUnitSets?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramOrganizationUnitSet[];
6597
+ PaymentTypes?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType[];
6598
+ PointAwardingRules?: LoyaltyPushLoyaltyProgram_PushPointAwardingRule[];
6599
+ PointExpirationPolicyData?: Record<string, TAnyValue> | null;
6600
+ PointExpirationPolicyType?: string | null;
6601
+ PointPendingPolicyData?: Record<string, TAnyValue> | null;
6602
+ PointPendingPolicyType?: string | null;
6603
+ /**
6604
+ * Entity type: PriceList
6605
+ */
6606
+ PriceLists?: string[];
6607
+ ProductLimitations?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation[];
6608
+ ReactivateProgramWhenPossible?: boolean;
6609
+ ReloadPolicy?: string | null;
6610
+ /**
6611
+ * When true, the loyalty program will only be applied when a customer is attached to the order.
6612
+ *
6613
+ * When false, the loyalty program can be attached to the order even if there is no customer attached.
6614
+ */
6615
+ RequireCustomer?: boolean;
6616
+ /**
6617
+ * When set to true, subscribing the user will require a UserIdentifier to be given.
6618
+ * Attention!
6619
+ * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6620
+ * 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.
6621
+ */
6622
+ RequireManualUserIdentifier?: boolean | null;
6623
+ RequiredCustomFields?: string[];
6624
+ /**
6625
+ * 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.
6626
+ * Also, this will make the `RequireCustomer` automatically true and `AutoSubscribeCustomer` false.
6627
+ *
6628
+ * 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.
6629
+ */
6630
+ RequiresSubscribedCustomer?: boolean;
6631
+ /**
6632
+ * When true, the order will require that the attached customer on the order will be validated by providing the UserIdentifier in the `AttachBenefitProgramToOrder` service.
6633
+ * Also, this will make the `RequireCustomer` and `RequiresSubscribedCustomer` automatically true and `AutoSubscribeCustomer` false.
6634
+ *
6635
+ * When false, this validation isn't required.
6636
+ */
6637
+ RequiresSubscriptionValidation?: boolean;
6638
+ /**
6639
+ * Handling when a user is unsubscribed and re-subscribes.
6640
+ */
6641
+ ResubscribeHandling?: DataModelsResubscribeHandlingType;
6642
+ StartDate?: string | null;
6643
+ Status?: DataModelsLoyaltyProgramStatus;
6644
+ UserBudget?: number | null;
6097
6645
  /**
6098
- * Entity type: Product
6646
+ * Attention!
6647
+ * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6648
+ * 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.
6099
6649
  */
6100
- ProductIDs?: string[];
6650
+ UserIdentifierPrefix?: string | null;
6101
6651
  /**
6102
- * Entity type: ProductSearchTemplate
6652
+ * Attention!
6653
+ * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6654
+ * 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.
6103
6655
  */
6104
- ProductSearchID?: string;
6105
- QuantityLimitPerOrder?: number;
6106
- QuantityLimitPerUser?: number;
6107
- }
6108
- export interface LoyaltyPushLoyaltyProgram_PushPointAwardingRule {
6109
- ApplyRecursive?: boolean;
6110
- Conditions?: LoyaltyPushLoyaltyProgram_PushPointAwardingRuleCondition[];
6111
- Description?: string;
6112
- Enabled?: boolean;
6113
- EndDate?: string;
6114
- ID: string;
6115
- MarketingDescription?: string;
6116
- Name: string;
6656
+ UserIdentifierStartNumber?: string | null;
6117
6657
  /**
6118
- * Entity type: OrganizationUnitSet
6658
+ * Attention!
6659
+ * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6660
+ * 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.
6119
6661
  */
6120
- OrganizationUnitSetID: string;
6121
- PointExpirationPolicyData?: TAnyValue;
6122
- PointExpirationPolicyType?: string;
6123
- PointPendingPolicyData?: TAnyValue;
6124
- PointPendingPolicyType?: string;
6125
- PointsToAward?: number;
6126
- StartDate: string;
6127
- }
6128
- export interface LoyaltyPushLoyaltyProgram_PushPointAwardingRuleCondition {
6129
- Data?: LoyaltyRulesIPointAwardingConditionData;
6130
- ID?: string;
6131
- Type: 'ORDERAMOUNT' | 'PRODUCT' | 'USERCUSTOMFIELD';
6662
+ UserIdentifierSuffix?: string | null;
6663
+ UserMaximumUsage?: number | null;
6132
6664
  }
6133
- export interface PushLoyaltyProgramResponse {
6665
+ export interface PushLoyaltyProgram_AsyncResponse {
6134
6666
  Error?: ServiceError;
6135
- /**
6136
- * Entity type: LoyaltyProgram
6137
- */
6138
- ID: string;
6667
+ JobID?: string;
6139
6668
  Metadata?: ResponseMessageMetadata;
6140
6669
  }
6670
+ export interface PushLoyaltyProgram_AsyncResult {
6671
+ JobID?: string;
6672
+ }
6141
6673
  /**
6142
6674
  * Rebalance loyalty points of a user
6143
6675
  */
@@ -6181,16 +6713,42 @@ export interface RemoveLoyaltyProgramPriceList {
6181
6713
  PriceListID: string;
6182
6714
  }
6183
6715
  /**
6716
+ * Removes a custom field requirement from a loyalty program.
6717
+ */
6718
+ export interface RemoveLoyaltyProgramRequiredCustomField {
6719
+ /**
6720
+ * Entity type: CustomField
6721
+ */
6722
+ CustomFieldID: string;
6723
+ /**
6724
+ * Entity type: LoyaltyProgram
6725
+ */
6726
+ LoyaltyProgramID: string;
6727
+ }
6728
+ /**
6729
+ * Set the optional loyalty program payment types for the order.
6730
+ */
6731
+ export interface SetOrderLoyaltyProgramPaymentTypes {
6732
+ /**
6733
+ * Entity type: Order
6734
+ */
6735
+ OrderID: string;
6736
+ /**
6737
+ * Entity type: LoyaltyProgramPaymentType
6738
+ * When left empty no optional payment types will be available. Required payment types cannot be unselected.
6739
+ */
6740
+ SelectedLoyaltyProgramPaymentTypes: string[];
6741
+ }
6742
+ /**
6184
6743
  * Update an existing LoyaltyProgram
6185
6744
  */
6186
6745
  export interface UpdateLoyaltyProgram {
6187
6746
  /**
6188
6747
  * Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
6189
6748
  */
6190
- AllowUnsubscribeBy: DataModelsAllowUnsubscribeByType | undefined;
6749
+ AllowUnsubscribeBy?: DataModelsAllowUnsubscribeByType;
6191
6750
  /**
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.
6751
+ * This property has been deprecated. A loyaltyprogram should always be manually applied.
6194
6752
  */
6195
6753
  ApplyManuallyOnly?: boolean;
6196
6754
  /**
@@ -6200,27 +6758,30 @@ export interface UpdateLoyaltyProgram {
6200
6758
  * This is ignore when`RequiresSubscribedCustomer` or `RequiresSubscriptionValidation` is set to true.
6201
6759
  */
6202
6760
  AutoSubscribeCustomer?: boolean;
6203
- BackendID: string | null | undefined;
6761
+ BackendID?: string | null;
6204
6762
  /**
6205
6763
  * Entity type: Currency
6206
6764
  */
6207
- BudgetCurrencyID: string | null | undefined;
6208
- Data: TAnyValue | null | undefined;
6209
- Description: string | null | undefined;
6210
- EndDate: string | null | undefined;
6765
+ BudgetCurrencyID?: string | null;
6766
+ Data?: TAnyValue | null;
6767
+ Description?: string | null;
6768
+ EndDate?: string | null;
6211
6769
  /**
6212
6770
  * Entity type: LoyaltyProgram
6213
6771
  */
6214
6772
  ID: string;
6215
6773
  LoyaltyPointUsageOptions?: DataModelsLoyaltyPointUsageOptions;
6216
- LoyaltyProgramGroupID: string | null | undefined;
6774
+ /**
6775
+ * Entity type: LoyaltyProgramGroup
6776
+ */
6777
+ LoyaltyProgramGroupID?: string | null;
6217
6778
  Name?: string;
6218
6779
  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;
6780
+ PointExpirationPolicyData?: Record<string, TAnyValue> | null;
6781
+ PointExpirationPolicyType?: string | null;
6782
+ PointPendingPolicyData?: Record<string, TAnyValue> | null;
6783
+ PointPendingPolicyType?: string | null;
6784
+ ReloadPolicy?: string | null;
6224
6785
  /**
6225
6786
  * When true, the loyalty program will only be applied when a customer is attached to the order.
6226
6787
  *
@@ -6233,7 +6794,7 @@ export interface UpdateLoyaltyProgram {
6233
6794
  * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6234
6795
  * This value cannot be changed after it is set in either the create or update.
6235
6796
  */
6236
- RequireManualUserIdentifier: boolean | null | undefined;
6797
+ RequireManualUserIdentifier?: boolean | null;
6237
6798
  /**
6238
6799
  * 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
6800
  * Also, this will make the `RequireCustomer` automatically true and `AutoSubscribeCustomer` false.
@@ -6251,29 +6812,29 @@ export interface UpdateLoyaltyProgram {
6251
6812
  /**
6252
6813
  * Handling when a user is unsubscribed and re-subscribes.
6253
6814
  */
6254
- ResubscribeHandling: DataModelsResubscribeHandlingType | undefined;
6255
- StartDate: string | null | undefined;
6815
+ ResubscribeHandling?: DataModelsResubscribeHandlingType;
6816
+ StartDate?: string | null;
6256
6817
  Status?: DataModelsLoyaltyProgramStatus;
6257
- UserBudget: number | null | undefined;
6818
+ UserBudget?: number | null;
6258
6819
  /**
6259
6820
  * Attention!
6260
6821
  * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6261
6822
  * This value cannot be changed after it is set in either the create or update.
6262
6823
  */
6263
- UserIdentifierPrefix: string | null | undefined;
6824
+ UserIdentifierPrefix?: string | null;
6264
6825
  /**
6265
6826
  * Attention!
6266
6827
  * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6267
6828
  * This value cannot be changed after it is set in either the create or update.
6268
6829
  */
6269
- UserIdentifierStartNumber: string | null | undefined;
6830
+ UserIdentifierStartNumber?: string | null;
6270
6831
  /**
6271
6832
  * Attention!
6272
6833
  * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6273
6834
  * This value cannot be changed after it is set in either the create or update.
6274
6835
  */
6275
- UserIdentifierSuffix: string | null | undefined;
6276
- UserMaximumUsage: number | null | undefined;
6836
+ UserIdentifierSuffix?: string | null;
6837
+ UserMaximumUsage?: number | null;
6277
6838
  }
6278
6839
  /**
6279
6840
  * Update the budget on the loyalty program group.
@@ -6311,21 +6872,21 @@ export interface UpdateLoyaltyProgramCondition {
6311
6872
  * 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
6873
  */
6313
6874
  export interface UpdateLoyaltyProgramGroup {
6314
- BackendID?: string;
6875
+ BackendID?: string | null;
6315
6876
  /**
6316
6877
  * Entity type: Currency
6317
6878
  */
6318
- BudgetCurrencyID?: string;
6319
- EndDate?: string;
6879
+ BudgetCurrencyID?: string | null;
6880
+ EndDate?: string | null;
6320
6881
  /**
6321
6882
  * Entity type: LoyaltyProgramGroup
6322
6883
  */
6323
6884
  ID: string;
6324
- Name: string;
6885
+ Name?: string | null;
6325
6886
  ReactivateProgramsWhenPossible?: boolean;
6326
- StartDate?: string;
6327
- Status: DataModelsLoyaltyProgramStatus;
6328
- TaxExemptionCode?: string;
6887
+ StartDate?: string | null;
6888
+ Status?: DataModelsLoyaltyProgramStatus;
6889
+ TaxExemptionCode?: string | null;
6329
6890
  }
6330
6891
  /**
6331
6892
  * Update the budget on the loyalty program group.
@@ -6346,6 +6907,7 @@ export interface UpdateLoyaltyProgramGroupBudget {
6346
6907
  * Update an existing LoyaltyProgramPaymentType
6347
6908
  */
6348
6909
  export interface UpdateLoyaltyProgramPaymentType {
6910
+ AllowPartialPayment?: boolean;
6349
6911
  BackendID?: string;
6350
6912
  Budget?: number;
6351
6913
  ExcludeFromProgramBudget?: boolean;
@@ -6355,11 +6917,12 @@ export interface UpdateLoyaltyProgramPaymentType {
6355
6917
  ID: string;
6356
6918
  MaximumAmountPerOrder?: number;
6357
6919
  MaximumPercentageOfUserBudgetPerOrder?: number;
6920
+ ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
6358
6921
  Required?: boolean;
6359
6922
  Sequence?: number;
6360
- TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
6923
+ TaxHandling?: DataModelsLoyaltyPaymentTaxHandlingType;
6361
6924
  UserBudget?: number;
6362
- UserBudgetDeduction: DataModelsUserBudgetDeduction;
6925
+ UserBudgetDeduction?: DataModelsUserBudgetDeduction;
6363
6926
  UserMaximumUsage?: number;
6364
6927
  }
6365
6928
  /**
@@ -6380,25 +6943,25 @@ export interface UpdateLoyaltyProgramProductLimitation {
6380
6943
  */
6381
6944
  export interface UpdatePointAwardingRule {
6382
6945
  ApplyRecursive?: boolean;
6383
- BackendID: string | null | undefined;
6946
+ BackendID?: string | null;
6384
6947
  Conditions?: LoyaltyUpdatePointAwardingRule_Condition[];
6385
- Description: string | null | undefined;
6948
+ Description?: string | null;
6386
6949
  Enabled?: boolean;
6387
- EndDate: string | null | undefined;
6950
+ EndDate?: string | null;
6388
6951
  /**
6389
6952
  * Entity type: PointAwardingRule
6390
6953
  */
6391
6954
  ID: string;
6392
- MarketingDescription: string | null | undefined;
6955
+ MarketingDescription?: string | null;
6393
6956
  Name?: string;
6394
6957
  /**
6395
6958
  * Entity type: OrganizationUnitSet
6396
6959
  */
6397
6960
  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;
6961
+ PointExpirationPolicyData?: Record<string, TAnyValue> | null;
6962
+ PointExpirationPolicyType?: string | null;
6963
+ PointPendingPolicyData?: Record<string, TAnyValue> | null;
6964
+ PointPendingPolicyType?: string | null;
6402
6965
  PointsToAward?: number;
6403
6966
  StartDate?: string;
6404
6967
  }
@@ -6433,7 +6996,7 @@ export interface CreateMessageTemplate {
6433
6996
  * Entity type: Country
6434
6997
  */
6435
6998
  CountryID?: string;
6436
- Destination: DataModelsMessageTemplateDestinations;
6999
+ Destination?: DataModelsMessageTemplateDestinations;
6437
7000
  Footer?: string;
6438
7001
  Header?: string;
6439
7002
  Helpers?: string;
@@ -6450,7 +7013,7 @@ export interface CreateMessageTemplate {
6450
7013
  OrganizationUnitID?: string;
6451
7014
  PaperProperties?: DataModelsPaperProperties;
6452
7015
  Template: string;
6453
- Type: DataModelsMessageTemplateTypes;
7016
+ Type?: DataModelsMessageTemplateTypes;
6454
7017
  }
6455
7018
  export interface CreateMessageTemplateResponse {
6456
7019
  Error?: ServiceError;
@@ -6646,7 +7209,7 @@ export interface PreviewMessageTemplate {
6646
7209
  * Entity type: Country
6647
7210
  */
6648
7211
  CountryID?: string;
6649
- Destination: DataModelsMessageTemplateDestinations;
7212
+ Destination?: DataModelsMessageTemplateDestinations;
6650
7213
  Footer?: string;
6651
7214
  /**
6652
7215
  * A preview will be generated, even if device is known
@@ -6670,9 +7233,9 @@ export interface PreviewMessageTemplate {
6670
7233
  * Entity type: Station
6671
7234
  */
6672
7235
  StationID?: string;
6673
- TargetContentType: MessageTemplatesMessageTargetContentTypes;
7236
+ TargetContentType?: MessageTemplatesMessageTargetContentTypes;
6674
7237
  Template: string;
6675
- Type: DataModelsMessageTemplateTypes;
7238
+ Type?: DataModelsMessageTemplateTypes;
6676
7239
  }
6677
7240
  export interface PreviewMessageTemplateResponse {
6678
7241
  Error?: ServiceError;
@@ -6682,17 +7245,26 @@ export interface PreviewMessageTemplateResponse {
6682
7245
  Url?: string;
6683
7246
  }
6684
7247
  export interface SendSampleMailMessageTemplate {
7248
+ /**
7249
+ * Entity type: Country
7250
+ */
6685
7251
  CountryID?: string;
6686
- Destination: DataModelsMessageTemplateDestinations;
7252
+ Destination?: DataModelsMessageTemplateDestinations;
6687
7253
  EmailAddress?: string;
6688
7254
  Helpers?: string;
7255
+ /**
7256
+ * Entity type: Language
7257
+ */
6689
7258
  LanguageID?: string;
6690
7259
  Layout?: string;
6691
7260
  Name?: string;
7261
+ /**
7262
+ * Entity type: OrganizationUnit
7263
+ */
6692
7264
  OrganizationUnitID?: string;
6693
7265
  SampleData?: Record<string, TAnyValue>;
6694
7266
  Template?: string;
6695
- Type: DataModelsMessageTemplateTypes;
7267
+ Type?: DataModelsMessageTemplateTypes;
6696
7268
  }
6697
7269
  /**
6698
7270
  * Update an existing MessageTemplate
@@ -6701,11 +7273,11 @@ export interface UpdateMessageTemplate {
6701
7273
  /**
6702
7274
  * Entity type: Country
6703
7275
  */
6704
- CountryID: string | null | undefined;
7276
+ CountryID?: string | null;
6705
7277
  Destination?: DataModelsMessageTemplateDestinations;
6706
- Footer: string | null | undefined;
6707
- Header: string | null | undefined;
6708
- Helpers: string | null | undefined;
7278
+ Footer?: string | null;
7279
+ Header?: string | null;
7280
+ Helpers?: string | null;
6709
7281
  /**
6710
7282
  * Entity type: MessageTemplate
6711
7283
  */
@@ -6714,14 +7286,14 @@ export interface UpdateMessageTemplate {
6714
7286
  /**
6715
7287
  * Entity type: Language
6716
7288
  */
6717
- LanguageID: string | null | undefined;
6718
- Layout: string | null | undefined;
7289
+ LanguageID?: string | null;
7290
+ Layout?: string | null;
6719
7291
  Name?: string;
6720
7292
  /**
6721
7293
  * Entity type: OrganizationUnit
6722
7294
  */
6723
- OrganizationUnitID: string | null | undefined;
6724
- PaperProperties: DataModelsPaperProperties | undefined;
7295
+ OrganizationUnitID?: string | null;
7296
+ PaperProperties?: DataModelsPaperProperties;
6725
7297
  Template?: string;
6726
7298
  }
6727
7299
  export interface OrdersCheckoutOptionCategoryDto {
@@ -6742,7 +7314,7 @@ export interface OrdersCheckoutOptionDto {
6742
7314
  CategoryName: string;
6743
7315
  ConfigData?: Record<string, TAnyValue>;
6744
7316
  Description?: string;
6745
- 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';
7317
+ Handler: 'Certification' | 'CustomerReferences' | 'CustomFieldLine' | 'CustomField' | 'Delivery' | 'ElectronicInvoice' | 'FiscalID' | 'FiscalRemark' | 'GiftWrapping' | 'LotteryNumber' | 'OrderBackendIdentifier' | 'PartialShipment' | 'PickupPoint' | 'ProductSearchTemplate' | 'QuickBuy' | 'Remark' | 'RequestedDate' | 'SoldBy' | 'TaxExempt' | 'TaxRegistrationNumber' | 'VerifyOrder' | 'SignOrder' | 'GlobalBlue';
6746
7318
  /**
6747
7319
  * Entity type: CheckoutOption
6748
7320
  */
@@ -6771,7 +7343,7 @@ export interface CreateCheckoutOption {
6771
7343
  CategoryID?: string;
6772
7344
  Data?: OrdersCheckoutOptionsICheckoutOptionConfigData;
6773
7345
  Description?: string;
6774
- 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';
7346
+ Handler: 'Certification' | 'CustomerReferences' | 'CustomFieldLine' | 'CustomField' | 'Delivery' | 'ElectronicInvoice' | 'FiscalID' | 'FiscalRemark' | 'GiftWrapping' | 'LotteryNumber' | 'OrderBackendIdentifier' | 'PartialShipment' | 'PickupPoint' | 'ProductSearchTemplate' | 'QuickBuy' | 'Remark' | 'RequestedDate' | 'SoldBy' | 'TaxExempt' | 'TaxRegistrationNumber' | 'VerifyOrder' | 'SignOrder' | 'GlobalBlue';
6775
7347
  IsActive?: boolean;
6776
7348
  Name: string;
6777
7349
  /**
@@ -6818,6 +7390,9 @@ export interface CreateOrderLedgerType {
6818
7390
  export interface CreateOrderLedgerTypeResponse {
6819
7391
  Description?: string;
6820
7392
  Error?: ServiceError;
7393
+ /**
7394
+ * Entity type: OrderLedgerType
7395
+ */
6821
7396
  ID: string;
6822
7397
  Metadata?: ResponseMessageMetadata;
6823
7398
  Name?: string;
@@ -6886,6 +7461,9 @@ export interface DeleteCheckoutOptionCategory {
6886
7461
  * Delete existing "OrderLedgerType"
6887
7462
  */
6888
7463
  export interface DeleteOrderLedgerType {
7464
+ /**
7465
+ * Entity type: OrderLedgerType
7466
+ */
6889
7467
  ID: string;
6890
7468
  }
6891
7469
  /**
@@ -6917,18 +7495,6 @@ export interface GetCheckoutOptionHandlersResponse {
6917
7495
  Metadata?: ResponseMessageMetadata;
6918
7496
  }
6919
7497
  /**
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
7498
  * Returns a single refund reason.
6933
7499
  */
6934
7500
  export interface GetRefundCorrectionReason {
@@ -6990,6 +7556,9 @@ export interface ListOrderLedgerTypesResponse {
6990
7556
  }
6991
7557
  export interface OrdersListOrderLedgerTypesResponse_ResponseModel {
6992
7558
  Description?: string;
7559
+ /**
7560
+ * Entity type: OrderLedgerType
7561
+ */
6993
7562
  ID: string;
6994
7563
  Name?: string;
6995
7564
  }
@@ -7092,7 +7661,7 @@ export interface DeleteReturnReason {
7092
7661
  * Get the reasons by type.
7093
7662
  */
7094
7663
  export interface GetReturnReasonsByType {
7095
- Type: DataModelsReturnReasonType;
7664
+ Type?: DataModelsReturnReasonType;
7096
7665
  }
7097
7666
  export interface GetReturnReasonsByTypeResponse {
7098
7667
  Error?: ServiceError;
@@ -7152,8 +7721,8 @@ export interface OrdersReturnReasonsListReturnReasonsResponse_Reason {
7152
7721
  * Update a return reason
7153
7722
  */
7154
7723
  export interface UpdateReturnReason {
7155
- BackendID: string | null | undefined;
7156
- Description: string | null | undefined;
7724
+ BackendID?: string | null;
7725
+ Description?: string | null;
7157
7726
  /**
7158
7727
  * Entity type: ReturnReason
7159
7728
  */
@@ -7176,10 +7745,10 @@ export interface UpdateCheckoutOption {
7176
7745
  /**
7177
7746
  * Entity type: CheckoutOptionCategory
7178
7747
  */
7179
- CategoryID: string | null | undefined;
7180
- Data: OrdersCheckoutOptionsICheckoutOptionConfigData | null | undefined;
7181
- Description: string | null | undefined;
7182
- 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';
7748
+ CategoryID?: string | null;
7749
+ Data?: OrdersCheckoutOptionsICheckoutOptionConfigData | null;
7750
+ Description?: string | null;
7751
+ Handler?: 'Certification' | 'CustomerReferences' | 'CustomFieldLine' | 'CustomField' | 'Delivery' | 'ElectronicInvoice' | 'FiscalID' | 'FiscalRemark' | 'GiftWrapping' | 'LotteryNumber' | 'OrderBackendIdentifier' | 'PartialShipment' | 'PickupPoint' | 'ProductSearchTemplate' | 'QuickBuy' | 'Remark' | 'RequestedDate' | 'SoldBy' | 'TaxExempt' | 'TaxRegistrationNumber' | 'VerifyOrder' | 'SignOrder' | 'GlobalBlue';
7183
7752
  /**
7184
7753
  * Entity type: CheckoutOption
7185
7754
  */
@@ -7189,18 +7758,18 @@ export interface UpdateCheckoutOption {
7189
7758
  /**
7190
7759
  * Entity type: OrganizationUnitSet
7191
7760
  */
7192
- OrganizationUnitSetID: string | null | undefined;
7761
+ OrganizationUnitSetID?: string | null;
7193
7762
  /**
7194
7763
  * Entity type: Script
7195
7764
  */
7196
- ScriptID: string | null | undefined;
7765
+ ScriptID?: string | null;
7197
7766
  Sequence?: number;
7198
7767
  }
7199
7768
  /**
7200
7769
  * Update an existing CheckoutOptionCategory
7201
7770
  */
7202
7771
  export interface UpdateCheckoutOptionCategory {
7203
- Description: string | null | undefined;
7772
+ Description?: string | null;
7204
7773
  /**
7205
7774
  * Entity type: CheckoutOptionCategory
7206
7775
  */
@@ -7224,19 +7793,25 @@ export interface UpdateCheckoutOptionSequences {
7224
7793
  */
7225
7794
  export interface UpdateOrderLedgerType {
7226
7795
  Description?: string;
7796
+ /**
7797
+ * Entity type: OrderLedgerType
7798
+ */
7227
7799
  ID: string;
7228
7800
  Name: string;
7229
7801
  }
7230
7802
  export interface UpdateOrderLedgerTypeResponse {
7231
7803
  Description?: string;
7232
7804
  Error?: ServiceError;
7805
+ /**
7806
+ * Entity type: OrderLedgerType
7807
+ */
7233
7808
  ID: string;
7234
7809
  Metadata?: ResponseMessageMetadata;
7235
7810
  Name?: string;
7236
7811
  }
7237
7812
  export interface UpdateRefundCorrectionReason {
7238
- BackendID: string | null | undefined;
7239
- Description: string | null | undefined;
7813
+ BackendID?: string | null;
7814
+ Description?: string | null;
7240
7815
  /**
7241
7816
  * Entity type: RefundCorrectionReason
7242
7817
  */
@@ -7252,8 +7827,8 @@ export interface UpdateRefundCorrectionReason {
7252
7827
  * Update an existing UnitPriceCorrectionReason
7253
7828
  */
7254
7829
  export interface UpdateUnitPriceCorrectionReason {
7255
- BackendID: string | null | undefined;
7256
- Description: string | null | undefined;
7830
+ BackendID?: string | null;
7831
+ Description?: string | null;
7257
7832
  /**
7258
7833
  * Entity type: UnitPriceCorrectionReason
7259
7834
  */
@@ -7283,7 +7858,7 @@ export interface CreateOrUpdateOrganizationUnitSubset {
7283
7858
  * Entity type: OrganizationUnitSet
7284
7859
  */
7285
7860
  SubsetID: string;
7286
- Type: DataModelsOrganizationUnitSetOperatorTypes;
7861
+ Type?: DataModelsOrganizationUnitSetOperatorTypes;
7287
7862
  }
7288
7863
  /**
7289
7864
  * Creates a new `OrganizationUnitSet`.
@@ -7315,14 +7890,22 @@ export interface CreateOrganizationUnitSet {
7315
7890
  * When specified, adds the sets contained in Subsets as a subset of the new set.
7316
7891
  */
7317
7892
  Subsets?: OrganizationUnitSetsCreateOrganizationUnitSet_OrganizationUnitSubSetDefinition[];
7318
- Type: DataModelsOrganizationUnitSetTypes;
7893
+ Type?: DataModelsOrganizationUnitSetTypes;
7319
7894
  }
7320
7895
  export interface OrganizationUnitSetsCreateOrganizationUnitSet_OrganizationUnitSubSetDefinition {
7321
7896
  /**
7322
7897
  * Entity type: OrganizationUnitSet
7323
7898
  */
7324
7899
  ID: string;
7325
- OperatorType: DataModelsOrganizationUnitSetOperatorTypes;
7900
+ OperatorType?: DataModelsOrganizationUnitSetOperatorTypes;
7901
+ }
7902
+ export interface CreateOrganizationUnitSetResponse {
7903
+ Error?: ServiceError;
7904
+ /**
7905
+ * Entity type: OrganizationUnitSet
7906
+ */
7907
+ ID: string;
7908
+ Metadata?: ResponseMessageMetadata;
7326
7909
  }
7327
7910
  /**
7328
7911
  * Creates a new OrganizationUnitSetScope.
@@ -7336,6 +7919,9 @@ export interface CreateOrganizationUnitSetScope {
7336
7919
  }
7337
7920
  export interface CreateOrganizationUnitSetScopeResponse {
7338
7921
  Error?: ServiceError;
7922
+ /**
7923
+ * Entity type: OrganizationUnitSetScope
7924
+ */
7339
7925
  ID: string;
7340
7926
  Metadata?: ResponseMessageMetadata;
7341
7927
  }
@@ -7356,6 +7942,9 @@ export interface DeleteOrganizationUnitSet {
7356
7942
  * It's not possible to delete a scope that is still in use by an OrganizationUnitSet.
7357
7943
  */
7358
7944
  export interface DeleteOrganizationUnitSetScope {
7945
+ /**
7946
+ * Entity type: OrganizationUnitSetScope
7947
+ */
7359
7948
  ID: string;
7360
7949
  }
7361
7950
  /**
@@ -7421,7 +8010,7 @@ export interface GetOrganizationUnitSetResponse {
7421
8010
  * Entity type: OrganizationUnit
7422
8011
  */
7423
8012
  OrganizationUnitID?: string;
7424
- Scope?: APIEnumDto;
8013
+ Scope?: EVAFrameworkAPIEnumDto;
7425
8014
  Type: DataModelsOrganizationUnitSetTypes;
7426
8015
  }
7427
8016
  /**
@@ -7436,6 +8025,9 @@ export interface GetOrganizationUnitSetScopesResponse {
7436
8025
  }
7437
8026
  export interface OrganizationUnitSetsGetOrganizationUnitSetScopesResponse_OrganizationUnitSetScope {
7438
8027
  Description?: string;
8028
+ /**
8029
+ * Entity type: OrganizationUnitSetScope
8030
+ */
7439
8031
  ID: string;
7440
8032
  Name?: string;
7441
8033
  OrganizationUnitUniqueInScope: boolean;
@@ -7469,7 +8061,7 @@ export interface OrganizationUnitSetsOrganizationUnitSetDetails {
7469
8061
  * Entity type: OrganizationUnit
7470
8062
  */
7471
8063
  OrganizationUnitID?: string;
7472
- Scope?: APIEnumDto;
8064
+ Scope?: EVAFrameworkAPIEnumDto;
7473
8065
  Subsets?: OrganizationUnitSetsOrganizationUnitSetDetails[];
7474
8066
  Type: DataModelsOrganizationUnitSetTypes;
7475
8067
  }
@@ -7486,7 +8078,7 @@ export interface OrganizationUnitSetsPreviewOrganizationUnitSet_PreviewOrganizat
7486
8078
  * Entity type: OrganizationUnitSubset
7487
8079
  */
7488
8080
  ID: string;
7489
- OperatorType: DataModelsOrganizationUnitSetOperatorTypes;
8081
+ OperatorType?: DataModelsOrganizationUnitSetOperatorTypes;
7490
8082
  SequenceNumber?: number;
7491
8083
  }
7492
8084
  export interface PreviewOrganizationUnitSetResponse {
@@ -7504,9 +8096,9 @@ export interface PreviewOrganizationUnitSetResponse {
7504
8096
  * it, pass the definition you got back from the `GetOrganizationUnitSet` service.
7505
8097
  */
7506
8098
  export interface UpdateOrganizationUnitSet {
7507
- BackendID: string | null | undefined;
7508
- Definition: DataModelsOrganizationUnitSetDefinition | undefined;
7509
- Description: string | null | undefined;
8099
+ BackendID?: string | null;
8100
+ Definition?: DataModelsOrganizationUnitSetDefinition;
8101
+ Description?: string | null;
7510
8102
  /**
7511
8103
  * Entity type: OrganizationUnitSet
7512
8104
  */
@@ -7515,7 +8107,7 @@ export interface UpdateOrganizationUnitSet {
7515
8107
  /**
7516
8108
  * Entity type: OrganizationUnitSetScope
7517
8109
  */
7518
- ScopeID: string | null | undefined;
8110
+ ScopeID?: string | null;
7519
8111
  }
7520
8112
  /**
7521
8113
  * Updates a OrganizationUnitSetScope.
@@ -7542,6 +8134,7 @@ export interface CreateCashHandler {
7542
8134
  * Entity type: Currency
7543
8135
  */
7544
8136
  CurrencyID: string;
8137
+ MaxAmountPerOrder?: number;
7545
8138
  Name: string;
7546
8139
  RoundingFactor: number;
7547
8140
  }
@@ -7643,6 +8236,9 @@ export interface DeleteOrganizationUnitCurrency {
7643
8236
  ID: string;
7644
8237
  }
7645
8238
  export interface DeleteOrganizationUnitGroup {
8239
+ /**
8240
+ * Entity type: OrganizationUnitGroup
8241
+ */
7646
8242
  ID: string;
7647
8243
  }
7648
8244
  /**
@@ -7669,6 +8265,7 @@ export interface GetCashHandlerByIDResponse {
7669
8265
  CurrencyID?: string;
7670
8266
  Error?: ServiceError;
7671
8267
  ID: string;
8268
+ MaxAmountPerOrder?: number;
7672
8269
  Metadata?: ResponseMessageMetadata;
7673
8270
  Name?: string;
7674
8271
  RoundingFactor: number;
@@ -7686,6 +8283,9 @@ export interface GetOpeningHoursTypesResponse {
7686
8283
  export interface OrganizationUnitsGetOpeningHoursTypesResponse_OpeningHoursTypeDto {
7687
8284
  BackendID?: string;
7688
8285
  Description?: string;
8286
+ /**
8287
+ * Entity type: Enum
8288
+ */
7689
8289
  ID: string;
7690
8290
  /**
7691
8291
  * Usually an internal & unchangable code - for display, use `Description`
@@ -7727,6 +8327,7 @@ export interface OrganizationUnitsListCashHandlersResponse_CashHandlerDto {
7727
8327
  * Entity type: CashHandler
7728
8328
  */
7729
8329
  ID: string;
8330
+ MaxAmountPerOrder?: number;
7730
8331
  Name?: string;
7731
8332
  RoundingFactor: number;
7732
8333
  }
@@ -7794,18 +8395,19 @@ export interface SetOrganizationUnitSupplierData {
7794
8395
  * Update an existing CashHandler
7795
8396
  */
7796
8397
  export interface UpdateCashHandler {
7797
- BankNotes: number[];
7798
- Coins: number[];
8398
+ BankNotes?: number[];
8399
+ Coins?: number[];
7799
8400
  /**
7800
8401
  * Entity type: Currency
7801
8402
  */
7802
- CurrencyID: string;
8403
+ CurrencyID?: string;
7803
8404
  /**
7804
8405
  * Entity type: CashHandler
7805
8406
  */
7806
8407
  ID: string;
7807
- Name: string;
7808
- RoundingFactor: number;
8408
+ MaxAmountPerOrder?: number | null;
8409
+ Name?: string;
8410
+ RoundingFactor?: number;
7809
8411
  }
7810
8412
  /**
7811
8413
  * Update an existing OpeningHoursType
@@ -7896,15 +8498,15 @@ export interface UpdateOrganizationUnitRegularOpeningHours {
7896
8498
  * When this OrganizationUnitSet doesn't have this PaymentType yet, it will be created. If it already exists the fields will be updated.
7897
8499
  */
7898
8500
  export interface CreateOrUpdateOrganizationUnitSetPaymentType {
7899
- AuthorizationExpirationInDays: number | null | undefined;
7900
- CaptureMoment: DataModelsPaymentTypeCaptureMoment | undefined;
8501
+ AuthorizationExpirationInDays?: number | null;
8502
+ CaptureMoment?: DataModelsPaymentTypeCaptureMoment;
7901
8503
  /**
7902
8504
  * Entity type: Product
7903
8505
  */
7904
- DigitalGiftCardProductID: string | null | undefined;
7905
- DisableForCarryOutOrders: boolean | null | undefined;
7906
- DisableForDeliveryOrders: boolean | null | undefined;
7907
- DisableForReserveOrders: boolean | null | undefined;
8506
+ DigitalGiftCardProductID?: string | null;
8507
+ DisableForCarryOutOrders?: boolean | null;
8508
+ DisableForDeliveryOrders?: boolean | null;
8509
+ DisableForReserveOrders?: boolean | null;
7908
8510
  /**
7909
8511
  * Entity type: OrganizationUnitSet
7910
8512
  */
@@ -7913,7 +8515,7 @@ export interface CreateOrUpdateOrganizationUnitSetPaymentType {
7913
8515
  * Entity type: PaymentType
7914
8516
  */
7915
8517
  PaymentTypeID: string;
7916
- RefundPriority: number | null | undefined;
8518
+ RefundPriority?: number | null;
7917
8519
  }
7918
8520
  /**
7919
8521
  * Create a new custom PaymentMethod.
@@ -7949,11 +8551,12 @@ export interface CreatePaymentTransactionLedgerTypeResponse {
7949
8551
  * Create a new PaymentType.
7950
8552
  */
7951
8553
  export interface CreatePaymentType {
8554
+ AllowMultiCurrency?: boolean;
7952
8555
  AutoFinalizeOnOrderPaid?: boolean;
7953
8556
  BackendID?: string;
7954
8557
  BackendRelationID?: string;
7955
- CashJournalMethod: DataModelsPaymentCashJournalMethod;
7956
- Category: DataModelsPaymentTypeCategory;
8558
+ CashJournalMethod?: DataModelsPaymentCashJournalMethod;
8559
+ Category?: DataModelsPaymentTypeCategory;
7957
8560
  Code: string;
7958
8561
  IsActive?: boolean;
7959
8562
  /**
@@ -7967,7 +8570,7 @@ export interface CreatePaymentType {
7967
8570
  */
7968
8571
  PaymentMethodID: string;
7969
8572
  PrintOnDocuments?: boolean;
7970
- ReturnAction: DataModelsPaymentReturnActions;
8573
+ ReturnAction?: DataModelsPaymentReturnActions;
7971
8574
  Roles?: PaymentMethodsCreatePaymentType_PaymentTypeRole[];
7972
8575
  /**
7973
8576
  * Entity type: Script
@@ -8062,6 +8665,9 @@ export interface GetPaymentMethodsResponse {
8062
8665
  }
8063
8666
  export interface PaymentMethodsGetPaymentMethodsResponse_PaymentMethodDto {
8064
8667
  Code?: string;
8668
+ /**
8669
+ * Entity type: PaymentMethod
8670
+ */
8065
8671
  ID: string;
8066
8672
  Name?: string;
8067
8673
  }
@@ -8075,6 +8681,7 @@ export interface GetPaymentTypeByID {
8075
8681
  ID: string;
8076
8682
  }
8077
8683
  export interface GetPaymentTypeByIDResponse {
8684
+ AllowMultiCurrency: boolean;
8078
8685
  AutoFinalizeOnOrderPaid: boolean;
8079
8686
  BackendID?: string;
8080
8687
  BackendRelationID?: string;
@@ -8119,6 +8726,38 @@ export interface PaymentMethodsGetPaymentTypeByIDResponse_PaymentTypeRole {
8119
8726
  RoleID: string;
8120
8727
  }
8121
8728
  /**
8729
+ * Get CustomFields for the given payment type.
8730
+ */
8731
+ export interface GetPaymentTypeCustomFields {
8732
+ /**
8733
+ * Entity type: PaymentType
8734
+ */
8735
+ PaymentTypeID: string;
8736
+ }
8737
+ export interface GetPaymentTypeCustomFieldsResponse {
8738
+ CustomFields?: PaymentMethodsGetPaymentTypeCustomFieldsResponse_CustomFieldDto[];
8739
+ Error?: ServiceError;
8740
+ Metadata?: ResponseMessageMetadata;
8741
+ }
8742
+ export interface PaymentMethodsGetPaymentTypeCustomFieldsResponse_CustomFieldDto {
8743
+ BackendID?: string;
8744
+ DataType: DataModelsCustomFieldDataTypes;
8745
+ DisplayName?: string;
8746
+ EnumValues?: Record<string, string | null>;
8747
+ /**
8748
+ * Entity type: CustomField
8749
+ */
8750
+ ID: string;
8751
+ IsArray: boolean;
8752
+ Name: string;
8753
+ Order: number;
8754
+ /**
8755
+ * Entity type: CustomFieldType
8756
+ */
8757
+ TypeID: string;
8758
+ TypeName: string;
8759
+ }
8760
+ /**
8122
8761
  * Get's the ID/Name of all paymenttypes to use for filter inputs
8123
8762
  */
8124
8763
  export interface GetPaymentTypesForFilter {
@@ -8232,6 +8871,9 @@ export interface ListPaymentTransactionSettlements {
8232
8871
  MerchantReference?: string;
8233
8872
  PaymentReference?: string;
8234
8873
  SubType?: string;
8874
+ /**
8875
+ * Entity type: PaymentTransactionSettlementType
8876
+ */
8235
8877
  TypeID?: string;
8236
8878
  }
8237
8879
  /**
@@ -8326,7 +8968,7 @@ export interface PaymentMethodsListPaymentTransactionsSettlementsResponse_Result
8326
8968
  MerchantReference?: string;
8327
8969
  PaymentReference?: string;
8328
8970
  Subtype?: string;
8329
- Type?: APIEnumDto;
8971
+ Type?: EVAFrameworkAPIEnumDto;
8330
8972
  }
8331
8973
  /**
8332
8974
  * List PaymentTypes. Returns a paged response.
@@ -8462,7 +9104,7 @@ export interface UpdatePaymentMethod {
8462
9104
  * Update the description of a PaymentTransactionLedgerType. Only custom made types can be updated.
8463
9105
  */
8464
9106
  export interface UpdatePaymentTransactionLedgerType {
8465
- Description: string | null | undefined;
9107
+ Description?: string | null;
8466
9108
  /**
8467
9109
  * Entity type: PaymentTransactionLedgerType
8468
9110
  */
@@ -8472,9 +9114,10 @@ export interface UpdatePaymentTransactionLedgerType {
8472
9114
  * Update an existing PaymentType.
8473
9115
  */
8474
9116
  export interface UpdatePaymentType {
9117
+ AllowMultiCurrency?: boolean;
8475
9118
  AutoFinalizeOnOrderPaid?: boolean;
8476
- BackendID: string | null | undefined;
8477
- BackendRelationID: string | null | undefined;
9119
+ BackendID?: string | null;
9120
+ BackendRelationID?: string | null;
8478
9121
  CashJournalMethod?: DataModelsPaymentCashJournalMethod;
8479
9122
  Category?: DataModelsPaymentTypeCategory;
8480
9123
  Code?: string;
@@ -8486,49 +9129,49 @@ export interface UpdatePaymentType {
8486
9129
  /**
8487
9130
  * Entity type: LedgerClass
8488
9131
  */
8489
- LedgerClassID: string | null | undefined;
9132
+ LedgerClassID?: string | null;
8490
9133
  Name?: string;
8491
- Options: PaymentMethodsUpdatePaymentType_PaymentTypeOptionsMaybe | undefined;
9134
+ Options?: PaymentMethodsUpdatePaymentType_PaymentTypeOptionsMaybe;
8492
9135
  /**
8493
9136
  * Entity type: PaymentMethod
8494
9137
  */
8495
9138
  PaymentMethodID?: string;
8496
9139
  PrintOnDocuments?: boolean;
8497
9140
  ReturnAction?: DataModelsPaymentReturnActions;
8498
- Roles: PaymentMethodsUpdatePaymentType_PaymentTypeRole[] | null | undefined;
9141
+ Roles?: PaymentMethodsUpdatePaymentType_PaymentTypeRole[] | null;
8499
9142
  /**
8500
9143
  * Entity type: Script
8501
9144
  */
8502
- ScriptID: string | null | undefined;
9145
+ ScriptID?: string | null;
8503
9146
  }
8504
9147
  export interface PaymentMethodsUpdatePaymentType_PaymentTypeOptionsMaybe {
8505
- BlockOverPayments: boolean | null | undefined;
8506
- CanBeCancelled: boolean | null | undefined;
8507
- CanBeRefunded: boolean | null | undefined;
9148
+ BlockOverPayments?: boolean | null;
9149
+ CanBeCancelled?: boolean | null;
9150
+ CanBeRefunded?: boolean | null;
8508
9151
  /**
8509
9152
  * Setting this to false results in refund only, will therefor only work with CanBeRefunded:true and CanRefundWithoutOriginalPaymentTransaction:true
8510
9153
  */
8511
- CanBeUsedForPayments: boolean | null | undefined;
8512
- CanRefundWithoutOriginalPaymentTransaction: boolean | null | undefined;
9154
+ CanBeUsedForPayments?: boolean | null;
9155
+ CanRefundWithoutOriginalPaymentTransaction?: boolean | null;
8513
9156
  /**
8514
9157
  * Entity type: GiftCardConfiguration
8515
9158
  */
8516
- GiftCardConfigurationID: string | null | undefined;
9159
+ GiftCardConfigurationID?: string | null;
8517
9160
  /**
8518
9161
  * Entity type: LoyaltyProgram
8519
9162
  */
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;
9163
+ LoyaltyProgramID?: string | null;
9164
+ OnlyAvailableInLocalMode?: boolean | null;
9165
+ Pending?: boolean | null;
9166
+ PinHandler?: string | null;
9167
+ RefundPending?: boolean | null;
9168
+ RequiredFunctionality?: string | null;
9169
+ RequiredFunctionalityScope?: SecurityFunctionalityScope;
9170
+ RequiredUserType?: UserTypes;
9171
+ RequiresAmount?: boolean | null;
9172
+ RequiresConfirmationForPayments?: boolean | null;
9173
+ RequiresConfirmationForRefunds?: boolean | null;
9174
+ RequiresInteractionForRefunds?: boolean | null;
8532
9175
  }
8533
9176
  export interface PaymentMethodsUpdatePaymentType_PaymentTypeRole {
8534
9177
  /**
@@ -8659,10 +9302,8 @@ export interface UploadPaymentSettlementFile {
8659
9302
  /**
8660
9303
  * Entity type: Blob
8661
9304
  */
8662
- BlobID?: string;
8663
- Data?: string;
9305
+ BlobID: string;
8664
9306
  Handler: string;
8665
- MimeType?: string;
8666
9307
  Name: string;
8667
9308
  /**
8668
9309
  * Entity type: OrganizationUnit
@@ -8811,15 +9452,15 @@ export interface RemovePersonalizedPromotionProducts {
8811
9452
  * Update an existing personalized promotion.
8812
9453
  */
8813
9454
  export interface UpdatePersonalizedPromotion {
8814
- BackendID: string | null | undefined;
8815
- Description: string | null | undefined;
9455
+ BackendID?: string | null;
9456
+ Description?: string | null;
8816
9457
  /**
8817
9458
  * Entity type: PersonalizedPromotion
8818
9459
  */
8819
9460
  ID: string;
8820
9461
  LockAfterFirstApply?: boolean;
8821
- MaximumDistinctProducts: number | null | undefined;
8822
- Name: string | null | undefined;
9462
+ MaximumDistinctProducts?: number | null;
9463
+ Name?: string | null;
8823
9464
  }
8824
9465
  /**
8825
9466
  * Create a new PriceList
@@ -8858,6 +9499,10 @@ export interface CreatePriceListAdjustment {
8858
9499
  PriceListID: string;
8859
9500
  PricingGroupID?: string;
8860
9501
  Sequence?: number;
9502
+ /**
9503
+ * 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.
9504
+ */
9505
+ SkipRecalculation?: boolean;
8861
9506
  Type: string;
8862
9507
  }
8863
9508
  export interface CreatePriceListAdjustmentResponse {
@@ -8916,6 +9561,9 @@ export interface CreatePriceListOrganizationUnit {
8916
9561
  }
8917
9562
  export interface CreatePriceListOrganizationUnitResponse {
8918
9563
  Error?: ServiceError;
9564
+ /**
9565
+ * Entity type: PriceListOrganizationUnit
9566
+ */
8919
9567
  ID: string;
8920
9568
  Metadata?: ResponseMessageMetadata;
8921
9569
  }
@@ -8930,7 +9578,7 @@ export interface CreatePriceListResponse {
8930
9578
  export interface CreatePriceListUsageType {
8931
9579
  Description?: string;
8932
9580
  Name: string;
8933
- RequiredUserType: UserTypes;
9581
+ RequiredUserType?: UserTypes;
8934
9582
  }
8935
9583
  export interface CreatePriceListUsageTypeResponse {
8936
9584
  Error?: ServiceError;
@@ -8954,6 +9602,10 @@ export interface DeletePriceListAdjustment {
8954
9602
  * Entity type: PriceListAdjustment
8955
9603
  */
8956
9604
  ID: string;
9605
+ /**
9606
+ * 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.
9607
+ */
9608
+ SkipRecalculation?: boolean;
8957
9609
  }
8958
9610
  /**
8959
9611
  * Delete a PriceListManualInputAdjustment
@@ -9093,6 +9745,7 @@ export interface GetPriceListManualInputAdjustmentByIDResponse {
9093
9745
  * Entity type: PriceListAdjustment
9094
9746
  */
9095
9747
  PriceListAdjustmentID: string;
9748
+ ProductBackendID?: string;
9096
9749
  ProductCustomID?: string;
9097
9750
  /**
9098
9751
  * Entity type: Product
@@ -9219,6 +9872,7 @@ export interface PricingListPriceListManualInputAdjustmentsResponse_PriceListMan
9219
9872
  * Entity type: PriceListManualInputAdjustment
9220
9873
  */
9221
9874
  ID: string;
9875
+ ProductBackendID?: string;
9222
9876
  ProductCustomID?: string;
9223
9877
  /**
9224
9878
  * Entity type: Product
@@ -9239,11 +9893,23 @@ export interface ListPriceListOrganizationUnitsResponse {
9239
9893
  Result?: PagedResult<PricingListPriceListOrganizationUnitsResponse_PriceListOrganizationUnitDto>;
9240
9894
  }
9241
9895
  export interface PricingListPriceListOrganizationUnitsResponse_PriceListOrganizationUnitDto {
9896
+ /**
9897
+ * Entity type: PriceListOrganizationUnit
9898
+ */
9242
9899
  ID: string;
9900
+ /**
9901
+ * Entity type: OrganizationUnit
9902
+ */
9243
9903
  OrganizationUnitID: string;
9244
9904
  OrganizationUnitName?: string;
9245
9905
  PriceList?: PricingListPriceListOrganizationUnitsResponse_PriceListOrganizationUnitDto_PriceListDto;
9906
+ /**
9907
+ * Entity type: PriceList
9908
+ */
9246
9909
  PriceListID: string;
9910
+ /**
9911
+ * Entity type: PriceListUsageType
9912
+ */
9247
9913
  PriceListUsageTypeID: string;
9248
9914
  PriceListUsageTypeName?: string;
9249
9915
  PricingGroupID?: string;
@@ -9391,8 +10057,8 @@ export interface PricingPriceListDto {
9391
10057
  * Update an existing PriceList
9392
10058
  */
9393
10059
  export interface UpdatePriceList {
9394
- BackendID: string | null | undefined;
9395
- BackendSystemID: string | null | undefined;
10060
+ BackendID?: string | null;
10061
+ BackendSystemID?: string | null;
9396
10062
  /**
9397
10063
  * Entity type: Currency
9398
10064
  */
@@ -9405,13 +10071,13 @@ export interface UpdatePriceList {
9405
10071
  IsActive?: boolean;
9406
10072
  IsFinalSalePriceList?: boolean;
9407
10073
  Name?: string;
9408
- TimeZone: string | null | undefined;
10074
+ TimeZone?: string | null;
9409
10075
  }
9410
10076
  /**
9411
10077
  * Update an existing PriceListAdjustment
9412
10078
  */
9413
10079
  export interface UpdatePriceListAdjustment {
9414
- BackendID: string | null | undefined;
10080
+ BackendID?: string | null;
9415
10081
  Data?: PricingIPriceListAdjustmentData;
9416
10082
  EffectiveDate: string;
9417
10083
  ExpireDate?: string;
@@ -9426,8 +10092,12 @@ export interface UpdatePriceListAdjustment {
9426
10092
  * Entity type: PriceListAdjustment
9427
10093
  */
9428
10094
  ParentAdjustmentID?: string;
9429
- PricingGroupID: string | null | undefined;
10095
+ PricingGroupID?: string | null;
9430
10096
  Sequence?: number;
10097
+ /**
10098
+ * 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.
10099
+ */
10100
+ SkipRecalculation?: boolean;
9431
10101
  Type: string;
9432
10102
  }
9433
10103
  /**
@@ -9462,7 +10132,7 @@ export interface UpdatePriceListOrganizationUnit {
9462
10132
  * Entity type: PriceListUsageType
9463
10133
  */
9464
10134
  PriceListUsageTypeID: string;
9465
- PricingGroupID: string | null | undefined;
10135
+ PricingGroupID?: string | null;
9466
10136
  /**
9467
10137
  * Entity type: OrganizationUnit
9468
10138
  */
@@ -9474,7 +10144,7 @@ export interface UpdatePriceListUsageType {
9474
10144
  * Entity type: PriceListUsageType
9475
10145
  */
9476
10146
  ID: string;
9477
- RequiredUserType: UserTypes;
10147
+ RequiredUserType?: UserTypes;
9478
10148
  }
9479
10149
  /**
9480
10150
  * Upload an excel file containing all ManualInputPriceListAdjustments for the given PriceListAdjustment. These will replace all exisiting adjustments.
@@ -9567,6 +10237,33 @@ export interface UpdatePrinterType {
9567
10237
  PaperWidth?: number;
9568
10238
  }
9569
10239
  /**
10240
+ * Returns the product count within the persisted product search template
10241
+ * When product id is given, it wil checks if a product is part of the persisted product search template result.
10242
+ * NOTE THAT after product search template creation/update if can take a few minutes for the result to be updated.
10243
+ */
10244
+ export interface CheckProductSearchTemplate {
10245
+ /**
10246
+ * Entity type: Product
10247
+ */
10248
+ ProductID?: string;
10249
+ /**
10250
+ * Entity type: ProductSearchTemplate
10251
+ */
10252
+ ProductSearchTemplateID: string;
10253
+ }
10254
+ export interface CheckProductSearchTemplateResponse {
10255
+ Error?: ServiceError;
10256
+ /**
10257
+ * Will return true/false is the given product is present. If no product is given it will return null
10258
+ */
10259
+ IsPresent?: boolean;
10260
+ Metadata?: ResponseMessageMetadata;
10261
+ /**
10262
+ * Total count of products withing the product search template result.
10263
+ */
10264
+ ResultCount: number;
10265
+ }
10266
+ /**
9570
10267
  * Creates a barcode for a product for a specific unit of measure.
9571
10268
  *
9572
10269
  * Optionally adds a record in the ProductUnitOfMeasure conversion table for the supplied Quantity.
@@ -9579,6 +10276,9 @@ export interface CreateProductBarcode {
9579
10276
  */
9580
10277
  ProductID: string;
9581
10278
  Quantity?: number;
10279
+ /**
10280
+ * Entity type: UnitOfMeasure
10281
+ */
9582
10282
  UnitOfMeasureID: string;
9583
10283
  }
9584
10284
  /**
@@ -9586,7 +10286,7 @@ export interface CreateProductBarcode {
9586
10286
  */
9587
10287
  export interface CreateProductRequirement {
9588
10288
  BackendID?: string;
9589
- DataType: DataModelsProductRequirementDataTypes;
10289
+ DataType?: DataModelsProductRequirementDataTypes;
9590
10290
  Handler?: string;
9591
10291
  Name: string;
9592
10292
  OrderType?: DataModelsOrderTypes;
@@ -9614,10 +10314,13 @@ export interface CreateProductSearchTemplate {
9614
10314
  IncludeLeafProducts?: boolean;
9615
10315
  MinimumRefreshInterval?: string;
9616
10316
  Name: string;
9617
- Type: DataModelsProductSearchTemplateTypes;
10317
+ Type?: DataModelsProductSearchTemplateTypes;
9618
10318
  }
9619
10319
  export interface CreateProductSearchTemplateResponse {
9620
10320
  Error?: ServiceError;
10321
+ /**
10322
+ * Entity type: ProductSearchTemplate
10323
+ */
9621
10324
  ID: string;
9622
10325
  Metadata?: ResponseMessageMetadata;
9623
10326
  }
@@ -9649,7 +10352,7 @@ export interface CreateSupplierProduct {
9649
10352
  Description?: string;
9650
10353
  PreferredMinimumOrderQuantity?: number;
9651
10354
  PrimitiveName: string;
9652
- Status: DataModelsProductStatus;
10355
+ Status?: DataModelsProductStatus;
9653
10356
  /**
9654
10357
  * Entity type: OrganizationUnit
9655
10358
  */
@@ -9661,6 +10364,9 @@ export interface CreateSupplierProduct {
9661
10364
  }
9662
10365
  export interface CreateSupplierProductResponse {
9663
10366
  Error?: ServiceError;
10367
+ /**
10368
+ * Entity type: Product
10369
+ */
9664
10370
  ID: string;
9665
10371
  Metadata?: ResponseMessageMetadata;
9666
10372
  }
@@ -9674,6 +10380,9 @@ export interface CreateUnitOfMeasure {
9674
10380
  }
9675
10381
  export interface CreateUnitOfMeasureResponse {
9676
10382
  Error?: ServiceError;
10383
+ /**
10384
+ * Entity type: UnitOfMeasure
10385
+ */
9677
10386
  ID: string;
9678
10387
  Metadata?: ResponseMessageMetadata;
9679
10388
  }
@@ -9895,7 +10604,7 @@ export interface GetSupplierProductByIDResponse {
9895
10604
  QuantityOnHand: number;
9896
10605
  RecommendedRecommendedRetailPrice?: number;
9897
10606
  Status: DataModelsProductStatus;
9898
- TaxCode?: APIEnumDto;
10607
+ TaxCode?: EVAFrameworkAPIEnumDto;
9899
10608
  }
9900
10609
  /**
9901
10610
  * Retrieves the suppliers (Organization Units) for the given Product.
@@ -9919,6 +10628,9 @@ export interface GetUnitOfMeasuresResponse {
9919
10628
  export interface ProductsGetUnitOfMeasuresResponse_UnitOfMeasureDto {
9920
10629
  BackendID?: string;
9921
10630
  Description?: string;
10631
+ /**
10632
+ * Entity type: Enum
10633
+ */
9922
10634
  ID: string;
9923
10635
  /**
9924
10636
  * Usually an internal & unchangable code - for display, use `Description`
@@ -9947,7 +10659,7 @@ export interface ProductsListProductBarcodesResponse_ProductBarcodeDto {
9947
10659
  ProductDisplayValue?: string;
9948
10660
  ProductID: string;
9949
10661
  Quantity: number;
9950
- UnitOfMeasure?: APIEnumDto;
10662
+ UnitOfMeasure?: EVAFrameworkAPIEnumDto;
9951
10663
  }
9952
10664
  /**
9953
10665
  * List existing Product Requirements
@@ -10022,7 +10734,7 @@ export interface ProductsListProductUnitOfMeasuresResponse_ProductUnitOfMeasureD
10022
10734
  ProductID: string;
10023
10735
  ProductName?: string;
10024
10736
  Quantity: number;
10025
- UnitOfMeasure?: APIEnumDto;
10737
+ UnitOfMeasure?: EVAFrameworkAPIEnumDto;
10026
10738
  UnitOfMeasureID: string;
10027
10739
  }
10028
10740
  /**
@@ -10050,7 +10762,7 @@ export interface ProductsListSupplierProductsResponse_SupplierProductDto {
10050
10762
  QuantityOnHand: number;
10051
10763
  RecommendedRecommendedRetailPrice?: number;
10052
10764
  Status: DataModelsProductStatus;
10053
- TaxCode?: APIEnumDto;
10765
+ TaxCode?: EVAFrameworkAPIEnumDto;
10054
10766
  }
10055
10767
  export interface ProductsProductRequirementDto {
10056
10768
  BackendID?: string;
@@ -10076,7 +10788,7 @@ export interface ProductsProductRequirementDto {
10076
10788
  */
10077
10789
  export interface UpdateProductRequirement {
10078
10790
  BackendID?: string;
10079
- DataType: DataModelsProductRequirementDataTypes;
10791
+ DataType?: DataModelsProductRequirementDataTypes;
10080
10792
  Handler?: string;
10081
10793
  /**
10082
10794
  * Entity type: ProductRequirement
@@ -10094,15 +10806,15 @@ export interface UpdateProductRequirement {
10094
10806
  * Update an existing ProductSearchTemplate
10095
10807
  */
10096
10808
  export interface UpdateProductSearchTemplate {
10097
- AggregationOptions: Record<string, SearchAggregationFilterModel> | null | undefined;
10098
- BackendID: string | null | undefined;
10809
+ AggregationOptions?: Record<string, SearchAggregationFilterModel> | null;
10810
+ BackendID?: string | null;
10099
10811
  Filters?: Record<string, SearchFilterModel>;
10100
10812
  /**
10101
10813
  * Entity type: ProductSearchTemplate
10102
10814
  */
10103
10815
  ID: string;
10104
10816
  IncludeLeafProducts?: boolean;
10105
- MinimumRefreshInterval: string | null | undefined;
10817
+ MinimumRefreshInterval?: string | null;
10106
10818
  Name?: string;
10107
10819
  Type?: DataModelsProductSearchTemplateTypes;
10108
10820
  }
@@ -10137,7 +10849,7 @@ export interface UpdateSupplierProduct {
10137
10849
  ID: string;
10138
10850
  PreferredMinimumOrderQuantity?: number;
10139
10851
  PrimitiveName: string;
10140
- Status: DataModelsProductStatus;
10852
+ Status?: DataModelsProductStatus;
10141
10853
  /**
10142
10854
  * Entity type: TaxCode
10143
10855
  */
@@ -10272,6 +10984,9 @@ export interface CreateRoleSet {
10272
10984
  }
10273
10985
  export interface CreateRoleSetResponse {
10274
10986
  Error?: ServiceError;
10987
+ /**
10988
+ * Entity type: RoleSet
10989
+ */
10275
10990
  ID: string;
10276
10991
  Metadata?: ResponseMessageMetadata;
10277
10992
  }
@@ -10302,10 +11017,13 @@ export interface DetachFunctionalitiesFromRole {
10302
11017
  }
10303
11018
  export interface RightsFunctionalityWithScope {
10304
11019
  Functionality: string;
10305
- RequiresElevation: boolean;
10306
- Scope: SecurityFunctionalityScope;
11020
+ RequiresElevation?: boolean;
11021
+ Scope?: SecurityFunctionalityScope;
10307
11022
  }
10308
11023
  export interface GetAvailableRoles {
11024
+ /**
11025
+ * Entity type: User
11026
+ */
10309
11027
  UserID: string;
10310
11028
  }
10311
11029
  export interface GetAvailableRolesResponse {
@@ -10361,11 +11079,17 @@ export interface GetRoleResponse {
10361
11079
  Result?: RightsRoleWithFunctionalitiesDto;
10362
11080
  }
10363
11081
  export interface GetRoleSetByID {
11082
+ /**
11083
+ * Entity type: RoleSet
11084
+ */
10364
11085
  ID: string;
10365
11086
  }
10366
11087
  export interface GetRoleSetByIDResponse {
10367
11088
  BackendID?: string;
10368
11089
  Error?: ServiceError;
11090
+ /**
11091
+ * Entity type: RoleSet
11092
+ */
10369
11093
  ID: string;
10370
11094
  Metadata?: ResponseMessageMetadata;
10371
11095
  Name?: string;
@@ -10477,6 +11201,9 @@ export interface ListRoleSetsResponse {
10477
11201
  }
10478
11202
  export interface RightsListRoleSetsResponse_RoleSetDto {
10479
11203
  BackendID?: string;
11204
+ /**
11205
+ * Entity type: RoleSet
11206
+ */
10480
11207
  ID: string;
10481
11208
  Name?: string;
10482
11209
  }
@@ -10606,17 +11333,17 @@ export interface SetUserRoles {
10606
11333
  * Update a role.
10607
11334
  */
10608
11335
  export interface UpdateRole {
10609
- Code: string | null | undefined;
11336
+ Code?: string | null;
10610
11337
  /**
10611
11338
  * If this is set, any users that have not logged in after said days will get disabled
10612
11339
  */
10613
- DeactivateUserAfterInactiveDays: number | null | undefined;
11340
+ DeactivateUserAfterInactiveDays?: number | null;
10614
11341
  /**
10615
11342
  * Entity type: Role
10616
11343
  */
10617
11344
  ID: string;
10618
11345
  Name?: string;
10619
- UserType: UserTypes | undefined;
11346
+ UserType?: UserTypes;
10620
11347
  }
10621
11348
  /**
10622
11349
  * Update functionalities on a role.
@@ -10632,12 +11359,12 @@ export interface RightsUpdateRoleFunctionalities_FunctionalityToUpdate {
10632
11359
  /**
10633
11360
  * 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
11361
  */
10635
- ElevationScope: SecurityFunctionalityScope | undefined;
11362
+ ElevationScope?: SecurityFunctionalityScope;
10636
11363
  Functionality: string;
10637
11364
  /**
10638
11365
  * Scopes available for this functionality. Should be set to `None (0)` for unscoped functionalities. To remove this functionality, set to `null`.
10639
11366
  */
10640
- Scope: SecurityFunctionalityScope | undefined;
11367
+ Scope?: SecurityFunctionalityScope;
10641
11368
  }
10642
11369
  export interface UpdateRoleSet {
10643
11370
  BackendID?: string;
@@ -10706,6 +11433,9 @@ export interface AddPackageToCarrier {
10706
11433
  export interface ShippingCarrierDto {
10707
11434
  BackendID?: string;
10708
11435
  Code?: string;
11436
+ /**
11437
+ * Entity type: Carrier
11438
+ */
10709
11439
  ID: string;
10710
11440
  Name?: string;
10711
11441
  }
@@ -10719,6 +11449,9 @@ export interface CreateCarrier {
10719
11449
  }
10720
11450
  export interface CreateCarrierResponse {
10721
11451
  Error?: ServiceError;
11452
+ /**
11453
+ * Entity type: Carrier
11454
+ */
10722
11455
  ID: string;
10723
11456
  Metadata?: ResponseMessageMetadata;
10724
11457
  }
@@ -10771,6 +11504,9 @@ export interface CreatePackage {
10771
11504
  }
10772
11505
  export interface CreatePackageResponse {
10773
11506
  Error?: ServiceError;
11507
+ /**
11508
+ * Entity type: Package
11509
+ */
10774
11510
  ID: string;
10775
11511
  Metadata?: ResponseMessageMetadata;
10776
11512
  }
@@ -10798,11 +11534,13 @@ export interface CreateShippingCost {
10798
11534
  * Entity type: ShippingMethod
10799
11535
  */
10800
11536
  ShippingMethodID?: string;
10801
- UnitPriceInTax?: number;
10802
11537
  ZipCodes?: string[];
10803
11538
  }
10804
11539
  export interface CreateShippingCostResponse {
10805
11540
  Error?: ServiceError;
11541
+ /**
11542
+ * Entity type: ShippingCost
11543
+ */
10806
11544
  ID: string;
10807
11545
  Metadata?: ResponseMessageMetadata;
10808
11546
  }
@@ -10815,7 +11553,7 @@ export interface CreateShippingMethod {
10815
11553
  */
10816
11554
  CarrierID: string;
10817
11555
  Code?: string;
10818
- DeliveryType: DataModelsShippingMethodDeliveryTypes;
11556
+ DeliveryType?: DataModelsShippingMethodDeliveryTypes;
10819
11557
  ExcludeProductsFromShippingMethod?: boolean;
10820
11558
  Handler?: string;
10821
11559
  InvoicingHandledByCarrier?: boolean;
@@ -10828,6 +11566,14 @@ export interface CreateShippingMethod {
10828
11566
  ShippingHandledByCarrier?: boolean;
10829
11567
  SupportsPickupAddress?: boolean;
10830
11568
  }
11569
+ export interface CreateShippingMethodResponse {
11570
+ Error?: ServiceError;
11571
+ /**
11572
+ * Entity type: ShippingMethod
11573
+ */
11574
+ ID: string;
11575
+ Metadata?: ResponseMessageMetadata;
11576
+ }
10831
11577
  /**
10832
11578
  * Creates a new ShippingMethodTransportationTime.
10833
11579
  */
@@ -10846,20 +11592,35 @@ export interface CreateShippingMethodTransportationTime {
10846
11592
  */
10847
11593
  ToCountryID?: string;
10848
11594
  }
11595
+ export interface CreateShippingMethodTransportationTimeResponse {
11596
+ Error?: ServiceError;
11597
+ /**
11598
+ * Entity type: ShippingMethodTransportationTime
11599
+ */
11600
+ ID: string;
11601
+ Metadata?: ResponseMessageMetadata;
11602
+ }
10849
11603
  /**
10850
11604
  * Creates a new ShippingRestriction.
10851
11605
  */
10852
11606
  export interface CreateShippingRestriction {
11607
+ /**
11608
+ * When set to `true`, the script will be leading for the entire order. Default is `true`
11609
+ */
11610
+ CheckScriptOnly?: boolean;
10853
11611
  /**
10854
11612
  * Entity type: Country
11613
+ * Required when there is no ScriptID set or CheckScriptOnly is 'false'
10855
11614
  */
10856
- CountryID: string;
11615
+ CountryID?: string;
10857
11616
  /**
10858
11617
  * Entity type: OrganizationUnit
11618
+ * Either an OrganizationUnitID or an OrganizationUnitSetID is required when there is no ScriptID set or CheckScriptOnly is 'false'
10859
11619
  */
10860
11620
  OrganizationUnitID?: string;
10861
11621
  /**
10862
11622
  * Entity type: OrganizationUnitSet
11623
+ * Either an OrganizationUnitID or an OrganizationUnitSetID is required when there is no ScriptID set or CheckScriptOnly is 'false'
10863
11624
  */
10864
11625
  OrganizationUnitSetID?: string;
10865
11626
  /**
@@ -10867,17 +11628,23 @@ export interface CreateShippingRestriction {
10867
11628
  */
10868
11629
  ProductPropertyTypeID?: string;
10869
11630
  ProductPropertyTypeValues?: string[];
11631
+ /**
11632
+ * Entity type: ProductSearchTemplate
11633
+ */
10870
11634
  ProductSearchTemplateID?: string;
10871
11635
  /**
10872
11636
  * Entity type: Script
10873
11637
  */
10874
11638
  ScriptID?: string;
10875
- Type: DataModelsShippingRestrictionType;
11639
+ Type?: DataModelsShippingRestrictionType;
10876
11640
  ZipCodeFrom?: string;
10877
11641
  ZipCodeTo?: string;
10878
11642
  }
10879
11643
  export interface CreateShippingRestrictionResponse {
10880
11644
  Error?: ServiceError;
11645
+ /**
11646
+ * Entity type: ShippingRestriction
11647
+ */
10881
11648
  ID: string;
10882
11649
  Metadata?: ResponseMessageMetadata;
10883
11650
  }
@@ -10903,6 +11670,9 @@ export interface DeletePackage {
10903
11670
  * Delete a `ShippingCost`
10904
11671
  */
10905
11672
  export interface DeleteShippingCost {
11673
+ /**
11674
+ * Entity type: ShippingCost
11675
+ */
10906
11676
  ID: string;
10907
11677
  }
10908
11678
  /**
@@ -11014,18 +11784,32 @@ export interface GetShippingCostByID {
11014
11784
  export interface GetShippingCostByIDResponse {
11015
11785
  Amount: number;
11016
11786
  BackendID?: string;
11787
+ /**
11788
+ * Entity type: Country
11789
+ */
11017
11790
  CountryID?: string;
11791
+ /**
11792
+ * Entity type: Currency
11793
+ */
11018
11794
  CurrencyID?: string;
11019
11795
  Error?: ServiceError;
11796
+ /**
11797
+ * Entity type: ShippingCost
11798
+ */
11020
11799
  ID: string;
11021
11800
  MaximumOrderAmount?: number;
11022
11801
  Metadata?: ResponseMessageMetadata;
11023
11802
  MinimumOrderAmount?: number;
11803
+ /**
11804
+ * Entity type: OrganizationUnit
11805
+ */
11024
11806
  OrganizationUnitID?: string;
11025
11807
  OrganizationUnitName?: string;
11808
+ /**
11809
+ * Entity type: ShippingMethod
11810
+ */
11026
11811
  ShippingMethodID?: string;
11027
11812
  ShippingMethodName?: string;
11028
- UnitPriceInTax: number;
11029
11813
  ZipCodes?: string[];
11030
11814
  }
11031
11815
  /**
@@ -11049,6 +11833,9 @@ export interface GetShippingMethodByIDResponse {
11049
11833
  Error?: ServiceError;
11050
11834
  ExcludeProductsFromShippingMethod: boolean;
11051
11835
  Handler?: string;
11836
+ /**
11837
+ * Entity type: ShippingMethod
11838
+ */
11052
11839
  ID: string;
11053
11840
  InvoicingHandledByCarrier: boolean;
11054
11841
  Metadata?: ResponseMessageMetadata;
@@ -11070,19 +11857,32 @@ export interface GetShippingRestrictionByID {
11070
11857
  ID: string;
11071
11858
  }
11072
11859
  export interface GetShippingRestrictionByIDResponse {
11860
+ CheckScriptOnly: boolean;
11073
11861
  CountryID?: string;
11074
11862
  CountryName?: string;
11075
11863
  Error?: ServiceError;
11864
+ /**
11865
+ * Entity type: ShippingRestriction
11866
+ */
11076
11867
  ID: string;
11077
11868
  Metadata?: ResponseMessageMetadata;
11869
+ /**
11870
+ * Entity type: OrganizationUnit
11871
+ */
11078
11872
  OrganizationUnitID?: string;
11079
11873
  OrganizationUnitName?: string;
11080
11874
  OrganizationUnitSetDescription?: string;
11081
- OrganizationUnitSetID: string;
11875
+ /**
11876
+ * Entity type: OrganizationUnitSet
11877
+ */
11878
+ OrganizationUnitSetID?: string;
11082
11879
  OrganizationUnitSetName?: string;
11083
11880
  OrganizationUnitSetType?: DataModelsOrganizationUnitSetTypes;
11084
11881
  ProductPropertyTypeID?: string;
11085
11882
  ProductPropertyTypeValues?: string[];
11883
+ /**
11884
+ * Entity type: ProductSearchTemplate
11885
+ */
11086
11886
  ProductSearchTemplateID?: string;
11087
11887
  /**
11088
11888
  * Entity type: Script
@@ -11116,15 +11916,24 @@ export interface ListManagementShippingMethodsResponse {
11116
11916
  }
11117
11917
  export interface ShippingListManagementShippingMethodsResponse_Data {
11118
11918
  CarrierCode?: string;
11919
+ /**
11920
+ * Entity type: Carrier
11921
+ */
11119
11922
  CarrierID: string;
11120
11923
  CarrierName?: string;
11121
11924
  Code?: string;
11122
11925
  DeliveryType: DataModelsShippingMethodDeliveryTypes;
11123
11926
  Handler?: string;
11927
+ /**
11928
+ * Entity type: ShippingMethod
11929
+ */
11124
11930
  ID: string;
11125
11931
  InvoicingHandledByCarrier: boolean;
11126
11932
  Name?: string;
11127
11933
  PaymentHandledByCarrier: boolean;
11934
+ /**
11935
+ * Entity type: ProductSearchTemplate
11936
+ */
11128
11937
  ProductSearchTemplateID?: string;
11129
11938
  ProductSearchTemplateName?: string;
11130
11939
  ShippingHandledByCarrier: boolean;
@@ -11221,6 +12030,9 @@ export interface ShippingPackageDto {
11221
12030
  Code?: string;
11222
12031
  Description?: string;
11223
12032
  Height: number;
12033
+ /**
12034
+ * Entity type: Package
12035
+ */
11224
12036
  ID: string;
11225
12037
  IsDefault: boolean;
11226
12038
  Length: number;
@@ -11243,16 +12055,30 @@ export interface RemovePackageFromCarrier {
11243
12055
  export interface ShippingShippingCostDto {
11244
12056
  Amount: number;
11245
12057
  BackendID?: string;
12058
+ /**
12059
+ * Entity type: Country
12060
+ */
11246
12061
  CountryID?: string;
12062
+ /**
12063
+ * Entity type: Currency
12064
+ */
11247
12065
  CurrencyID?: string;
12066
+ /**
12067
+ * Entity type: ShippingCost
12068
+ */
11248
12069
  ID: string;
11249
12070
  MaximumOrderAmount?: number;
11250
12071
  MinimumOrderAmount?: number;
12072
+ /**
12073
+ * Entity type: OrganizationUnit
12074
+ */
11251
12075
  OrganizationUnitID?: string;
11252
12076
  OrganizationUnitName?: string;
12077
+ /**
12078
+ * Entity type: ShippingMethod
12079
+ */
11253
12080
  ShippingMethodID?: string;
11254
12081
  ShippingMethodName?: string;
11255
- UnitPriceInTax: number;
11256
12082
  ZipCodes?: string[];
11257
12083
  }
11258
12084
  export interface ShippingShippingRestrictionDto {
@@ -11274,9 +12100,9 @@ export interface ShippingShippingRestrictionDto {
11274
12100
  /**
11275
12101
  * Entity type: OrganizationUnitSet
11276
12102
  */
11277
- OrganizationUnitSetID: string;
12103
+ OrganizationUnitSetID?: string;
11278
12104
  OrganizationUnitSetName?: string;
11279
- OrganizationUnitSetType: DataModelsOrganizationUnitSetTypes;
12105
+ OrganizationUnitSetType?: DataModelsOrganizationUnitSetTypes;
11280
12106
  /**
11281
12107
  * Entity type: ProductPropertyType
11282
12108
  */
@@ -11360,6 +12186,9 @@ export interface UpdateShippingCost {
11360
12186
  * Entity type: Currency
11361
12187
  */
11362
12188
  CurrencyID: string;
12189
+ /**
12190
+ * Entity type: ShippingCost
12191
+ */
11363
12192
  ID: string;
11364
12193
  MaximumOrderAmount?: number;
11365
12194
  MinimumOrderAmount?: number;
@@ -11371,7 +12200,6 @@ export interface UpdateShippingCost {
11371
12200
  * Entity type: ShippingMethod
11372
12201
  */
11373
12202
  ShippingMethodID?: string;
11374
- UnitPriceInTax?: number;
11375
12203
  ZipCodes?: string[];
11376
12204
  }
11377
12205
  /**
@@ -11383,7 +12211,7 @@ export interface UpdateShippingMethod {
11383
12211
  */
11384
12212
  CarrierID: string;
11385
12213
  Code?: string;
11386
- DeliveryType: DataModelsShippingMethodDeliveryTypes;
12214
+ DeliveryType?: DataModelsShippingMethodDeliveryTypes;
11387
12215
  ExcludeProductsFromShippingMethod?: boolean;
11388
12216
  Handler?: string;
11389
12217
  /**
@@ -11428,10 +12256,14 @@ export interface UpdateShippingMethodTransportationTime {
11428
12256
  * Updates a ShippingRestriction.
11429
12257
  */
11430
12258
  export interface UpdateShippingRestriction {
12259
+ /**
12260
+ * When set to `true`, the script will be leading for the entire order.
12261
+ */
12262
+ CheckScriptOnly?: boolean;
11431
12263
  /**
11432
12264
  * Entity type: Country
11433
12265
  */
11434
- CountryID: string | null | undefined;
12266
+ CountryID?: string | null;
11435
12267
  /**
11436
12268
  * Entity type: ShippingRestriction
11437
12269
  */
@@ -11439,24 +12271,27 @@ export interface UpdateShippingRestriction {
11439
12271
  /**
11440
12272
  * Entity type: OrganizationUnit
11441
12273
  */
11442
- OrganizationUnitID: string | null | undefined;
12274
+ OrganizationUnitID?: string | null;
11443
12275
  /**
11444
12276
  * Entity type: OrganizationUnitSet
11445
12277
  */
11446
- OrganizationUnitSetID: string | null | undefined;
12278
+ OrganizationUnitSetID?: string | null;
11447
12279
  /**
11448
12280
  * Entity type: ProductPropertyType
11449
12281
  */
11450
- ProductPropertyTypeID: string | null | undefined;
11451
- ProductPropertyTypeValues: string[] | null | undefined;
11452
- ProductSearchTemplateID: string | null | undefined;
12282
+ ProductPropertyTypeID?: string | null;
12283
+ ProductPropertyTypeValues?: string[] | null;
12284
+ /**
12285
+ * Entity type: ProductSearchTemplate
12286
+ */
12287
+ ProductSearchTemplateID?: string | null;
11453
12288
  /**
11454
12289
  * Entity type: Script
11455
12290
  */
11456
- ScriptID: string | null | undefined;
12291
+ ScriptID?: string | null;
11457
12292
  Type?: DataModelsShippingRestrictionType;
11458
- ZipCodeFrom: string | null | undefined;
11459
- ZipCodeTo: string | null | undefined;
12293
+ ZipCodeFrom?: string | null;
12294
+ ZipCodeTo?: string | null;
11460
12295
  }
11461
12296
  /**
11462
12297
  * Upload ShippingRestrictions. Expected format is an Excel file.
@@ -11498,6 +12333,9 @@ export interface CreateStockAllocationRule {
11498
12333
  * In case there is not enough stock, Priority is used to determine who gets preference. A higher Priority means a higher preference.
11499
12334
  */
11500
12335
  Priority?: number;
12336
+ /**
12337
+ * Entity type: Product
12338
+ */
11501
12339
  ProductID?: string;
11502
12340
  /**
11503
12341
  * Entity type: ProductSearchTemplate
@@ -11505,9 +12343,17 @@ export interface CreateStockAllocationRule {
11505
12343
  ProductSearchTemplateID?: string;
11506
12344
  RefillPeriodInDays?: number;
11507
12345
  StartDate?: string;
11508
- Type: DataModelsStockAllocationRuleTypes;
12346
+ Type?: DataModelsStockAllocationRuleTypes;
11509
12347
  Value?: number;
11510
- ValueType: DataModelsStockAllocationRuleValueTypes;
12348
+ ValueType?: DataModelsStockAllocationRuleValueTypes;
12349
+ }
12350
+ export interface CreateStockAllocationRuleResponse {
12351
+ Error?: ServiceError;
12352
+ /**
12353
+ * Entity type: StockAllocationRule
12354
+ */
12355
+ ID: string;
12356
+ Metadata?: ResponseMessageMetadata;
11511
12357
  }
11512
12358
  /**
11513
12359
  * Create a new StockLabel
@@ -11516,6 +12362,7 @@ export interface CreateStockAllocationRule {
11516
12362
  */
11517
12363
  export interface CreateStockLabel {
11518
12364
  Description?: string;
12365
+ DisplayName?: string;
11519
12366
  LedgerClassID?: string;
11520
12367
  Name: string;
11521
12368
  }
@@ -11531,6 +12378,9 @@ export interface CreateStockLabelResponse {
11531
12378
  * Deletes a StockAllocationRule.
11532
12379
  */
11533
12380
  export interface DeleteStockAllocationRule {
12381
+ /**
12382
+ * Entity type: StockAllocationRule
12383
+ */
11534
12384
  ID: string;
11535
12385
  }
11536
12386
  /**
@@ -11562,6 +12412,9 @@ export interface ListCumulativeStockResponse {
11562
12412
  }
11563
12413
  export interface StockListCumulativeStockResponse_Model {
11564
12414
  OrganizationUnitBackendID?: string;
12415
+ /**
12416
+ * Entity type: OrganizationUnit
12417
+ */
11565
12418
  OrganizationUnitID: string;
11566
12419
  OrganizationUnitName?: string;
11567
12420
  Product?: SearchIProductSearchItem;
@@ -11579,6 +12432,9 @@ export interface ListStockAllocationRulesResponse {
11579
12432
  * Reallocates the stock for a StockLocationRule with `Type` = `Limitation`.
11580
12433
  */
11581
12434
  export interface RefillStockAllocation {
12435
+ /**
12436
+ * Entity type: StockAllocationRule
12437
+ */
11582
12438
  ID: string;
11583
12439
  ValueOverride?: number;
11584
12440
  }
@@ -11587,6 +12443,9 @@ export interface RefillStockAllocation {
11587
12443
  */
11588
12444
  export interface UpdateStockAllocationRule {
11589
12445
  EndDate?: string;
12446
+ /**
12447
+ * Entity type: StockAllocationRule
12448
+ */
11590
12449
  ID: string;
11591
12450
  /**
11592
12451
  * In case there is not enough stock, Priority is used to determine who gets preference. A higher Priority means a higher preference.
@@ -11601,12 +12460,13 @@ export interface UpdateStockAllocationRule {
11601
12460
  * Update the description or ledgerclass of StockLabel
11602
12461
  */
11603
12462
  export interface UpdateStockLabel {
11604
- Description?: string;
12463
+ Description?: string | null;
12464
+ DisplayName?: string | null;
11605
12465
  /**
11606
12466
  * Entity type: StockLabel
11607
12467
  */
11608
12468
  ID: string;
11609
- LedgerClassID?: string;
12469
+ LedgerClassID?: string | null;
11610
12470
  }
11611
12471
  /**
11612
12472
  * A service to upload an Excel containing StockAllocationRules that should be created or updated according to the values specified in the sheet.
@@ -11731,8 +12591,8 @@ export interface StockMutationsStockMutationReason {
11731
12591
  * Update a custom or internal stock mutation reason. The name cannot be modified for internal reasons.
11732
12592
  */
11733
12593
  export interface UpdateStockMutationReason {
11734
- BackendID: string | null | undefined;
11735
- Description: string | null | undefined;
12594
+ BackendID?: string | null;
12595
+ Description?: string | null;
11736
12596
  /**
11737
12597
  * Entity type: StockMutationReasons
11738
12598
  */
@@ -11881,11 +12741,12 @@ export interface CreateUserOriginResponse {
11881
12741
  * Creates a new UserRequirement and returns the ID of the new record.
11882
12742
  */
11883
12743
  export interface CreateUserRequirement {
12744
+ AccountType?: DataModelsUserAccountType;
11884
12745
  CustomValidators?: Record<string, TAnyValue | null>;
11885
12746
  Display?: boolean;
11886
12747
  Preferred?: boolean;
11887
12748
  Property: string;
11888
- RequiredFor: UsersUserRequirementsUserRequirementFor;
12749
+ RequiredFor?: UsersUserRequirementsUserRequirementFor;
11889
12750
  /**
11890
12751
  * Entity type: Script
11891
12752
  */
@@ -11902,7 +12763,7 @@ export interface CreateUserRequirement {
11902
12763
  * Entity type: UserRequirementSet
11903
12764
  */
11904
12765
  UserRequirementSetID?: string;
11905
- UserType: UserTypes;
12766
+ UserType?: UserTypes;
11906
12767
  }
11907
12768
  export interface CreateUserRequirementResponse {
11908
12769
  Error?: ServiceError;
@@ -12067,16 +12928,16 @@ export interface CreateEmployeeUserResponse {
12067
12928
  * Create or update employeedata for a user
12068
12929
  */
12069
12930
  export interface CreateOrUpdateEmployeeData {
12070
- EmployeeNumber: string | null | undefined;
12071
- Function: string | null | undefined;
12931
+ EmployeeNumber?: string | null;
12932
+ Function?: string | null;
12072
12933
  /**
12073
12934
  * Entity type: User
12074
12935
  */
12075
- ManagerID: string | null | undefined;
12936
+ ManagerID?: string | null;
12076
12937
  /**
12077
12938
  * Entity type: OrganizationUnit
12078
12939
  */
12079
- PrimaryOrganizationUnitID: string | null | undefined;
12940
+ PrimaryOrganizationUnitID?: string | null;
12080
12941
  /**
12081
12942
  * Entity type: User
12082
12943
  */
@@ -12272,6 +13133,9 @@ export interface GetUserOriginsResponse {
12272
13133
  export interface UsersGetUserOriginsResponse_UserOriginDto {
12273
13134
  BackendID?: string;
12274
13135
  Description?: string;
13136
+ /**
13137
+ * Entity type: Enum
13138
+ */
12275
13139
  ID: string;
12276
13140
  /**
12277
13141
  * Usually an internal & unchangable code - for display, use `Description`
@@ -12316,6 +13180,7 @@ export interface GetUserRequirement {
12316
13180
  ID: string;
12317
13181
  }
12318
13182
  export interface GetUserRequirementResponse {
13183
+ AccountType?: DataModelsUserAccountType;
12319
13184
  CustomValidators?: Record<string, TAnyValue | null>;
12320
13185
  Display: boolean;
12321
13186
  Error?: ServiceError;
@@ -12539,6 +13404,7 @@ export interface ListUserRequirementsResponse {
12539
13404
  Result?: PagedResult<UsersListUserRequirementsResponse_UserRequirementDto>;
12540
13405
  }
12541
13406
  export interface UsersListUserRequirementsResponse_UserRequirementDto {
13407
+ AccountType?: DataModelsUserAccountType;
12542
13408
  CustomValidators?: Record<string, TAnyValue | null>;
12543
13409
  Display: boolean;
12544
13410
  /**
@@ -12612,8 +13478,8 @@ export interface UpdateSubscription {
12612
13478
  /**
12613
13479
  * The (optional) BackendID of the subscription
12614
13480
  */
12615
- BackendID: string | null | undefined;
12616
- Description: string | null | undefined;
13481
+ BackendID?: string | null;
13482
+ Description?: string | null;
12617
13483
  /**
12618
13484
  * Entity type: Subscription
12619
13485
  */
@@ -12621,7 +13487,7 @@ export interface UpdateSubscription {
12621
13487
  /**
12622
13488
  * Entity type: Inquiry
12623
13489
  */
12624
- InquiryID: string | null | undefined;
13490
+ InquiryID?: string | null;
12625
13491
  /**
12626
13492
  * The name of the subscription
12627
13493
  */
@@ -12667,16 +13533,17 @@ export interface UpdateSubscriptionUserRequirements {
12667
13533
  Requirements: UsersUpdateSubscriptionUserRequirements_UserRequirementDto[];
12668
13534
  }
12669
13535
  export interface UsersUpdateSubscriptionUserRequirements_UserRequirementDto {
12670
- CustomValidators: Record<string, TAnyValue | null> | null | undefined;
13536
+ AccountType?: DataModelsUserAccountType;
13537
+ CustomValidators?: Record<string, TAnyValue | null> | null;
12671
13538
  Display?: boolean;
12672
13539
  /**
12673
13540
  * Entity type: UserRequirement
12674
13541
  */
12675
13542
  ID?: string;
12676
13543
  Preferred?: boolean;
12677
- Property: string | null | undefined;
13544
+ Property?: string | null;
12678
13545
  RequiredFor?: UsersUserRequirementsUserRequirementFor;
12679
- UserType: UserTypes | undefined;
13546
+ UserType?: UserTypes;
12680
13547
  }
12681
13548
  /**
12682
13549
  * Update an existing UserOrigin
@@ -12697,23 +13564,24 @@ export interface UpdateUserOrigin {
12697
13564
  * Updates an existing UserRequirement.
12698
13565
  */
12699
13566
  export interface UpdateUserRequirement {
12700
- CustomValidators: Record<string, TAnyValue | null> | null | undefined;
13567
+ AccountType?: DataModelsUserAccountType;
13568
+ CustomValidators?: Record<string, TAnyValue | null> | null;
12701
13569
  Display?: boolean;
12702
13570
  /**
12703
13571
  * Entity type: UserRequirement
12704
13572
  */
12705
13573
  ID: string;
12706
13574
  Preferred?: boolean;
12707
- Property: string | null | undefined;
13575
+ Property?: string | null;
12708
13576
  RequiredFor?: UsersUserRequirementsUserRequirementFor;
12709
13577
  /**
12710
13578
  * Entity type: Script
12711
13579
  */
12712
- ScriptID: string | null | undefined;
13580
+ ScriptID?: string | null;
12713
13581
  /**
12714
13582
  * Entity type: ShippingMethod
12715
13583
  */
12716
- ShippingMethodID: string | null | undefined;
13584
+ ShippingMethodID?: string | null;
12717
13585
  UserType?: UserTypes;
12718
13586
  }
12719
13587
  /**
@@ -12724,7 +13592,7 @@ export interface UpdateUserRequirementSet {
12724
13592
  * Entity type: UserRequirementSet
12725
13593
  */
12726
13594
  ID: string;
12727
- Name: string | null | undefined;
13595
+ Name?: string;
12728
13596
  /**
12729
13597
  * Entity type: OrganizationUnitSet
12730
13598
  */
@@ -12741,24 +13609,25 @@ export interface UpdateUserRequirementSetRequirements {
12741
13609
  Requirements?: UsersUpdateUserRequirementSetRequirements_UserRequirementDto[];
12742
13610
  }
12743
13611
  export interface UsersUpdateUserRequirementSetRequirements_UserRequirementDto {
12744
- CustomValidators: Record<string, TAnyValue | null> | null | undefined;
13612
+ AccountType?: DataModelsUserAccountType;
13613
+ CustomValidators?: Record<string, TAnyValue | null> | null;
12745
13614
  Display?: boolean;
12746
13615
  /**
12747
13616
  * Entity type: UserRequirement
12748
13617
  */
12749
13618
  ID?: string;
12750
13619
  Preferred?: boolean;
12751
- Property: string | null | undefined;
13620
+ Property?: string | null;
12752
13621
  RequiredFor?: UsersUserRequirementsUserRequirementFor;
12753
13622
  /**
12754
13623
  * Entity type: Script
12755
13624
  */
12756
- ScriptID: string | null | undefined;
13625
+ ScriptID?: string | null;
12757
13626
  /**
12758
13627
  * Entity type: ShippingMethod
12759
13628
  */
12760
- ShippingMethodID: string | null | undefined;
12761
- UserType: UserTypes | undefined;
13629
+ ShippingMethodID?: string | null;
13630
+ UserType?: UserTypes;
12762
13631
  }
12763
13632
  /**
12764
13633
  * Get the wishlist by ID.
@@ -12771,6 +13640,9 @@ export interface GetWishlist {
12771
13640
  }
12772
13641
  export interface GetWishlistResponse {
12773
13642
  CreatedOn: string;
13643
+ /**
13644
+ * Entity type: CustomField
13645
+ */
12774
13646
  CustomFieldValuesWithOptions?: Record<string, DataModelsCustomFieldValueWithOptions>;
12775
13647
  Description?: string;
12776
13648
  Error?: ServiceError;
@@ -12971,7 +13843,7 @@ export interface VisibilityGroupsListVisibilityGroupsResponse_VisibilityGroupDto
12971
13843
  */
12972
13844
  export interface UpdateVisibilityGroup {
12973
13845
  AllowCustomerStandardAccounts?: boolean;
12974
- Description: string | null | undefined;
13846
+ Description?: string | null;
12975
13847
  /**
12976
13848
  * Entity type: VisibilityGroup
12977
13849
  */
@@ -13006,7 +13878,7 @@ export interface EVACoreServicesAssortmentsAddProductsToAssortment_AssortmentPro
13006
13878
  * Entity type: Product
13007
13879
  */
13008
13880
  ProductID: string;
13009
- ProductStatus: DataModelsProductStatus;
13881
+ ProductStatus?: DataModelsProductStatus;
13010
13882
  ProductStatusesToIgnoreToChildProducts?: DataModelsProductStatus;
13011
13883
  StartDate?: string;
13012
13884
  }
@@ -13054,7 +13926,7 @@ export interface EVACoreServicesAssortmentsCreateAssortment_AssortmentProduct {
13054
13926
  * Entity type: Product
13055
13927
  */
13056
13928
  ProductID: string;
13057
- ProductStatus: DataModelsProductStatus;
13929
+ ProductStatus?: DataModelsProductStatus;
13058
13930
  StartDate?: string;
13059
13931
  }
13060
13932
  export interface CreateAssortmentResponse {
@@ -13191,6 +14063,9 @@ export interface EVACoreServicesAssortmentsGetAssortmentRootProductsResponse_Ass
13191
14063
  MixedProductStatuses: DataModelsProductStatus;
13192
14064
  ProductBackendID?: string;
13193
14065
  ProductDetails?: SearchIProductSearchItem;
14066
+ /**
14067
+ * Entity type: Product
14068
+ */
13194
14069
  ProductID: string;
13195
14070
  ProductStatus: DataModelsProductStatus;
13196
14071
  ProductType: DataModelsProductTypes;
@@ -13300,7 +14175,7 @@ export interface ExportGeneralLedgerSummaryToExcel {
13300
14175
  export interface CreateFraudItem {
13301
14176
  Data?: string;
13302
14177
  Object?: TAnyValue;
13303
- Type: DataModelsFraudDataType;
14178
+ Type?: DataModelsFraudDataType;
13304
14179
  }
13305
14180
  export interface CreateFraudItemResponse {
13306
14181
  Error?: ServiceError;
@@ -13413,7 +14288,10 @@ export interface ListRestockedProducts {
13413
14288
  export interface ListRestockedProductsResponse {
13414
14289
  Error?: ServiceError;
13415
14290
  Metadata?: ResponseMessageMetadata;
13416
- Results?: Record<string, number[] | null>;
14291
+ /**
14292
+ * Entity type: StockLabel
14293
+ */
14294
+ Results?: Record<string, string[] | null>;
13417
14295
  }
13418
14296
  /**
13419
14297
  * List the Stock per product/stocklabel for a subset of OrganizationUnits.
@@ -13475,29 +14353,38 @@ export interface EVACoreServicesStockListStockForOrganizationUnitsFilter {
13475
14353
  export interface ListStockForOrganizationUnitsResponse {
13476
14354
  Error?: ServiceError;
13477
14355
  Metadata?: ResponseMessageMetadata;
14356
+ /**
14357
+ * Entity type: Product
14358
+ */
13478
14359
  Products?: Record<string, EVACoreServicesStockListStockForOrganizationUnitsResponse_ProductDto>;
13479
14360
  Result?: PagedResult<EVACoreServicesStockListStockForOrganizationUnitsResponse_StockDto>;
13480
14361
  Url?: string;
13481
14362
  }
13482
14363
  export interface EVACoreServicesStockListStockForOrganizationUnitsResponse_ProductDto {
13483
- CurrencyID?: string;
13484
14364
  Product?: SearchIProductSearchItem;
13485
- TaxCodeID: string;
13486
- TaxRate: number;
13487
- UnitCost: number;
13488
- UnitPrice: number;
13489
- UnitPriceInTax: number;
13490
14365
  }
13491
14366
  export interface EVACoreServicesStockListStockForOrganizationUnitsResponse_StockDto {
13492
14367
  OrganizationUnitCurrencyID?: string;
14368
+ /**
14369
+ * Entity type: OrganizationUnit
14370
+ */
13493
14371
  OrganizationUnitID?: string;
13494
14372
  OrganizationUnitName?: string;
14373
+ /**
14374
+ * Entity type: Product
14375
+ */
13495
14376
  ProductID: string;
13496
14377
  QuantityAvailable: number;
13497
14378
  QuantityCommitted: number;
13498
14379
  QuantityOnHand: number;
14380
+ /**
14381
+ * Entity type: StockLabel
14382
+ */
13499
14383
  StockLabel: string;
13500
14384
  StockLabelName?: string;
14385
+ /**
14386
+ * Entity type: TaxCode
14387
+ */
13501
14388
  TaxCodeID: string;
13502
14389
  TaxRate: number;
13503
14390
  /**
@@ -13533,6 +14420,10 @@ export interface AddUserBoughtProductDetail {
13533
14420
  * Entity type: OrderLine
13534
14421
  */
13535
14422
  OrderLineID?: string;
14423
+ /**
14424
+ * Entity type: OrganizationUnit
14425
+ */
14426
+ OrganizationUnitID?: string;
13536
14427
  PurchaseDate?: string;
13537
14428
  PurchasedQuantity?: number;
13538
14429
  /**
@@ -13614,6 +14505,16 @@ export interface GetUserBoughtProduct {
13614
14505
  */
13615
14506
  IncludedProductProperties?: string[];
13616
14507
  }
14508
+ /**
14509
+ * Get a user bought product by a product's serial number.
14510
+ */
14511
+ export interface GetUserBoughtProductBySerialNumber {
14512
+ /**
14513
+ * Entity type: ProductPropertyType
14514
+ */
14515
+ IncludedProductProperties?: string[];
14516
+ SerialNumber: string;
14517
+ }
13617
14518
  export interface GetUserBoughtProductResponse {
13618
14519
  AdditionalWarrantyInfo?: string;
13619
14520
  Details?: EVACoreServicesUsersGetUserBoughtProductResponse_Detail[];
@@ -13653,6 +14554,10 @@ export interface EVACoreServicesUsersGetUserBoughtProductResponse_Detail {
13653
14554
  * Entity type: OrderLine
13654
14555
  */
13655
14556
  OrderLineID?: string;
14557
+ /**
14558
+ * Entity type: OrganizationUnit
14559
+ */
14560
+ OrganizationUnitID?: string;
13656
14561
  PurchaseDate?: string;
13657
14562
  PurchasedQuantity?: number;
13658
14563
  }
@@ -13698,7 +14603,7 @@ export interface EVACoreServicesUsersListUserBoughtProductsResponse_BoughtProduc
13698
14603
  WarrantyExpiryDate?: string;
13699
14604
  }
13700
14605
  /**
13701
- * Push bought products for users. Only accepts 1000 users per request
14606
+ * Push bought products for users. Only accepts 10000 users per request
13702
14607
  */
13703
14608
  export interface EVACoreServicesUsersPushBoughtProductsForUsers {
13704
14609
  BoughtProductsForUsers?: EVACoreServicesUsersPushBoughtProductsForUsers_PushedBoughtProductForUser[];
@@ -13712,16 +14617,34 @@ export interface EVACoreServicesUsersPushBoughtProductsForUsers_PushedBoughtProd
13712
14617
  }
13713
14618
  export interface PushBoughtProductsForUsersResponse {
13714
14619
  Error?: ServiceError;
13715
- FailedBoughtProductsForUsers?: Record<string, EVACoreServicesUsersPushBoughtProductsForUsersResponse_FailedUserBoughtProductsForUser[] | null>;
14620
+ FailedBoughtProductsForUsers?: EVACoreServicesUsersPushBoughtProductsForUsersResponse_FailedUserBoughtProductsForUser[];
13716
14621
  Metadata?: ResponseMessageMetadata;
14622
+ SuccessfulBoughtProductsForUsers?: EVACoreServicesUsersPushBoughtProductsForUsersResponse_SuccessfulUserBoughtProductsForUser[];
13717
14623
  }
13718
- export interface EVACoreServicesUsersPushBoughtProductsForUsersResponse_FailedUserBoughtProductsForUser {
14624
+ export interface EVACoreServicesUsersPushBoughtProductsForUsersResponse_BoughtProduct {
14625
+ ProductBackendID?: string;
13719
14626
  /**
13720
14627
  * Entity type: Product
13721
14628
  */
13722
14629
  ProductID: string;
13723
14630
  SerialNumber?: string;
13724
14631
  }
14632
+ export interface EVACoreServicesUsersPushBoughtProductsForUsersResponse_FailedUserBoughtProductsForUser {
14633
+ BoughtProducts?: EVACoreServicesUsersPushBoughtProductsForUsersResponse_BoughtProduct[];
14634
+ UserBackendID?: string;
14635
+ /**
14636
+ * Entity type: User
14637
+ */
14638
+ UserID: string;
14639
+ }
14640
+ export interface EVACoreServicesUsersPushBoughtProductsForUsersResponse_SuccessfulUserBoughtProductsForUser {
14641
+ BoughtProducts?: EVACoreServicesUsersPushBoughtProductsForUsersResponse_BoughtProduct[];
14642
+ UserBackendID?: string;
14643
+ /**
14644
+ * Entity type: User
14645
+ */
14646
+ UserID: string;
14647
+ }
13725
14648
  export interface PushBoughtProductsForUsers_Async {
13726
14649
  BoughtProductsForUsers?: EVACoreServicesUsersPushBoughtProductsForUsers_PushedBoughtProductForUser[];
13727
14650
  }
@@ -13738,7 +14661,6 @@ export interface PushBoughtProductsForUsers_AsyncResult {
13738
14661
  */
13739
14662
  export interface PushUserBoughtProduct {
13740
14663
  BoughtProducts?: EVACoreServicesUsersPushUserBoughtProduct_PushedBoughtProduct[];
13741
- RegistrationBackendSystemID?: string;
13742
14664
  /**
13743
14665
  * Entity type: User
13744
14666
  */
@@ -13766,6 +14688,11 @@ export interface EVACoreServicesUsersPushUserBoughtProduct_PushedBoughtProductDe
13766
14688
  * Entity type: OrderLine
13767
14689
  */
13768
14690
  OrderLineID?: string;
14691
+ /**
14692
+ * Entity type: OrganizationUnit
14693
+ * 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.
14694
+ */
14695
+ OrganizationUnitID?: string;
13769
14696
  PurchaseDate?: string;
13770
14697
  PurchasedQuantity?: number;
13771
14698
  }
@@ -13791,6 +14718,11 @@ export interface EVACoreServicesUsersPushedBoughtProduct_PushedBoughtProductDeta
13791
14718
  * Entity type: OrderLine
13792
14719
  */
13793
14720
  OrderLineID?: string;
14721
+ /**
14722
+ * Entity type: OrganizationUnit
14723
+ * 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.
14724
+ */
14725
+ OrganizationUnitID?: string;
13794
14726
  PurchaseDate?: string;
13795
14727
  PurchasedQuantity?: number;
13796
14728
  }
@@ -13809,6 +14741,11 @@ export interface RegisterUserBoughtProduct {
13809
14741
  */
13810
14742
  OrderLineID?: string;
13811
14743
  /**
14744
+ * Entity type: OrganizationUnit
14745
+ * 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.
14746
+ */
14747
+ OrganizationUnitID?: string;
14748
+ /**
13812
14749
  * Entity type: Product
13813
14750
  */
13814
14751
  ProductID: string;
@@ -13837,6 +14774,11 @@ export interface UpdateUserBoughtProductDetail {
13837
14774
  * Entity type: OrderLine
13838
14775
  */
13839
14776
  OrderLineID?: string;
14777
+ /**
14778
+ * Entity type: OrganizationUnit
14779
+ * 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.
14780
+ */
14781
+ OrganizationUnitID?: string;
13840
14782
  PurchaseDate?: string;
13841
14783
  PurchasedQuantity?: number;
13842
14784
  }