@springtree/eva-services-core-management 3.0.0-beta.0 → 3.0.0-beta.10

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, DataModelsLoyaltyProgramUsageTypes, 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, 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';
2
2
  export declare const enum Errors {
3
3
  /**
4
4
  * CashExpenseType {:string} already exists.
@@ -717,11 +717,6 @@ export interface GetCaseByIDResponse {
717
717
  */
718
718
  SummaryLastModifiedByID?: string;
719
719
  Title?: string;
720
- /**
721
- * Entity type: CaseTopic
722
- */
723
- TopicID?: string;
724
- TopicName?: string;
725
720
  }
726
721
  export interface CasesGetCaseByIDResponse_CaseRepair {
727
722
  CompletionTime?: string;
@@ -751,6 +746,7 @@ export interface CasesGetCaseByIDResponse_CaseTopicData {
751
746
  TopicName?: string;
752
747
  }
753
748
  export interface CasesGetCaseByIDResponse_CustomerInfo {
749
+ BackendID?: string;
754
750
  EmailAddress?: string;
755
751
  FirstName?: string;
756
752
  FullName?: string;
@@ -1072,13 +1068,21 @@ export interface CasesListCasesResponse_User {
1072
1068
  */
1073
1069
  export interface PushCase {
1074
1070
  AssignedOn?: string;
1071
+ /**
1072
+ * OU the case is assigned to. When set this will influence visibility.
1073
+ */
1074
+ AssignedOrganizationUnitBackendID?: string;
1075
1075
  Assignee?: CasesPushCase_PushCaseAssignee;
1076
1076
  BackendID: string;
1077
- BackendSystemID: string;
1077
+ CaseRelatedItems?: CasesPushCase_PushCaseRelatedItems;
1078
1078
  ClosingTime?: string;
1079
1079
  CustomFields?: Record<string, TAnyValue | null>;
1080
- Customer?: CasesPushCase_PushCaseCustomer;
1080
+ Customer: CasesPushCase_PushCaseCustomer | undefined;
1081
1081
  Description: string;
1082
+ /**
1083
+ * Setting this to true will try to suppress as many event exports as possible that might result from this call.
1084
+ */
1085
+ DisableEventExports?: boolean;
1082
1086
  Interactions?: CasesPushCase_PushCaseInteraction[];
1083
1087
  LastInteractionTime?: string;
1084
1088
  OriginatingOrganizationUnitBackendID?: string;
@@ -1089,6 +1093,10 @@ export interface PushCase {
1089
1093
  Summary?: string;
1090
1094
  Title: string;
1091
1095
  Topic: string;
1096
+ /**
1097
+ * Setting this to true will update the case information if it already exists instead of throwing an error.
1098
+ */
1099
+ Update?: boolean;
1092
1100
  }
1093
1101
  export interface CasesPushCase_PushCaseAddress {
1094
1102
  Address1?: string;
@@ -1122,6 +1130,10 @@ export interface CasesPushCase_PushCaseAssignee {
1122
1130
  * Entity type: User
1123
1131
  */
1124
1132
  ID?: string;
1133
+ /**
1134
+ * If specified as true, the assignee will be removed from the case.
1135
+ */
1136
+ Remove?: boolean;
1125
1137
  }
1126
1138
  export interface CasesPushCase_PushCaseCustomer {
1127
1139
  /**
@@ -1168,9 +1180,39 @@ export interface CasesPushCase_PushCaseCustomerCompany {
1168
1180
  VatNumber?: string;
1169
1181
  }
1170
1182
  export interface CasesPushCase_PushCaseInteraction {
1183
+ BackendID: string;
1184
+ /**
1185
+ * If specified as true, the interaction will be deleted.
1186
+ */
1187
+ Delete?: boolean;
1171
1188
  Text?: string;
1172
1189
  Type: DataModelsInteractionType;
1173
1190
  }
1191
+ export interface CasesPushCase_PushCaseRelatedItem {
1192
+ /**
1193
+ * If specified as true, the item will be deleted.
1194
+ */
1195
+ Delete?: boolean;
1196
+ IsWarranty?: boolean;
1197
+ /**
1198
+ * Entity type: OrderLine
1199
+ */
1200
+ OrderLineID?: string;
1201
+ /**
1202
+ * Entity type: Product
1203
+ */
1204
+ ProductID?: string;
1205
+ SerialNumber?: string;
1206
+ WarrantyAdditionalInformation?: string;
1207
+ WarrantyExpiration?: string;
1208
+ }
1209
+ export interface CasesPushCase_PushCaseRelatedItems {
1210
+ Items?: CasesPushCase_PushCaseRelatedItem[];
1211
+ /**
1212
+ * Entity type: Order
1213
+ */
1214
+ OrderID?: string;
1215
+ }
1174
1216
  export interface PushCaseResponse {
1175
1217
  Error?: ServiceError;
1176
1218
  /**
@@ -2008,7 +2050,16 @@ export interface UnsetSetting {
2008
2050
  /**
2009
2051
  * Entity type: OrganizationUnit
2010
2052
  */
2011
- OrganizationUnitID: string;
2053
+ OrganizationUnitID?: string;
2054
+ /**
2055
+ * Entity type: OrganizationUnitSet
2056
+ * Setting are not stored on sets, the set is evaluated when this service is called, and the unsetting is applied to all OrganizationUnits in the set.
2057
+ */
2058
+ OrganizationUnitSetID?: string;
2059
+ /**
2060
+ * When a Value is given, the setting will only be removed when the Value matches.
2061
+ */
2062
+ Value?: string;
2012
2063
  }
2013
2064
  export interface CreateCostPriceCalculation {
2014
2065
  BackendID?: string;
@@ -2520,6 +2571,19 @@ export interface UpdateCustomField {
2520
2571
  TypeKey: string | null | undefined;
2521
2572
  }
2522
2573
  /**
2574
+ * Add required custom fields to ManualDiscount
2575
+ */
2576
+ export interface AddRequiredCustomFieldsToManualDiscount {
2577
+ /**
2578
+ * Entity type: CustomField
2579
+ */
2580
+ CustomFieldIDs: string[];
2581
+ /**
2582
+ * Entity type: Discount
2583
+ */
2584
+ DiscountID: string;
2585
+ }
2586
+ /**
2523
2587
  * Add security roles to ManualDiscount
2524
2588
  */
2525
2589
  export interface AddRolesToManualDiscount {
@@ -2607,6 +2671,10 @@ export interface CreateDiscount {
2607
2671
  OrganizationUnitSetID: string;
2608
2672
  PromotionLabel?: string;
2609
2673
  /**
2674
+ * For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
2675
+ */
2676
+ RequiredCustomFields?: string[];
2677
+ /**
2610
2678
  * Entity type: OrganizationUnit
2611
2679
  */
2612
2680
  RestitutionOrganizationUnitID?: string;
@@ -2938,6 +3006,7 @@ export interface GetDiscountByIDResponse {
2938
3006
  * Entity type: DiscountCampaign
2939
3007
  */
2940
3008
  CampaignID?: string;
3009
+ CannotApplyToOwnOrder: boolean;
2941
3010
  CompliancyRule: DataModelsDiscountCompliancyRule;
2942
3011
  ConditionType: DataModelsDiscountConditionTypes;
2943
3012
  Conditions?: DiscountsGetDiscountByIDResponse_DiscountCondition[];
@@ -2992,12 +3061,17 @@ export interface GetDiscountByIDResponse {
2992
3061
  Metadata?: ResponseMessageMetadata;
2993
3062
  NeedsReason: boolean;
2994
3063
  /**
3064
+ * This could be the backend id of the OU if this is the system generated OU set of the OU
3065
+ */
3066
+ OrganizationUnitSetBackendID?: string;
3067
+ /**
2995
3068
  * Entity type: OrganizationUnitSet
2996
3069
  */
2997
3070
  OrganizationUnitSetID: string;
2998
3071
  OrganizationUnitSetName?: string;
2999
3072
  OrganizationUnitSetType?: DataModelsOrganizationUnitSetTypes;
3000
3073
  PromotionLabel?: string;
3074
+ RequiredCustomFields?: string[];
3001
3075
  /**
3002
3076
  * Entity type: OrganizationUnit
3003
3077
  */
@@ -3488,6 +3562,55 @@ export interface MoveDiscountLayer {
3488
3562
  ID: string;
3489
3563
  }
3490
3564
  /**
3565
+ * Push a DiscountCoupon
3566
+ */
3567
+ export interface PushDiscountCoupons {
3568
+ Coupons?: DiscountsPushDiscountCoupons_PushedCoupon[];
3569
+ /**
3570
+ * Entity type: Discount
3571
+ */
3572
+ DiscountID?: string;
3573
+ }
3574
+ export interface DiscountsPushDiscountCoupons_PushedCoupon {
3575
+ CouponCode?: string;
3576
+ IsActive?: boolean;
3577
+ MaximumUsage?: number;
3578
+ /**
3579
+ * Entity type: Order
3580
+ */
3581
+ OrderID?: string;
3582
+ /**
3583
+ * Entity type: User
3584
+ */
3585
+ UserID?: string;
3586
+ }
3587
+ export interface PushDiscountCouponsResponse {
3588
+ CreatedCoupons?: DiscountsPushDiscountCouponsResponse_CreatedCoupon[];
3589
+ Error?: ServiceError;
3590
+ Metadata?: ResponseMessageMetadata;
3591
+ }
3592
+ export interface DiscountsPushDiscountCouponsResponse_CreatedCoupon {
3593
+ /**
3594
+ * Entity type: DiscountCoupon
3595
+ */
3596
+ ID: string;
3597
+ IsDuplicateCoupon: boolean;
3598
+ }
3599
+ /**
3600
+ * Remove required custom fields from ManualDiscount
3601
+ */
3602
+ export interface RemoveRequiredCustomFieldsFromManualDiscount {
3603
+ /**
3604
+ * Entity type: CustomField
3605
+ */
3606
+ CustomFieldIDs?: string[];
3607
+ /**
3608
+ * Entity type: Discount
3609
+ */
3610
+ DiscountID: string;
3611
+ RemoveAllRequiredCustomFields?: boolean;
3612
+ }
3613
+ /**
3491
3614
  * Remove security roles from ManualDiscount
3492
3615
  */
3493
3616
  export interface RemoveRolesFromManualDiscount {
@@ -3572,6 +3695,15 @@ export interface DiscountsSearchDiscountsByQueryResponse_DiscountDto {
3572
3695
  UserUsageReloadStrategy?: string;
3573
3696
  }
3574
3697
  /**
3698
+ * Takes in all discount layers and sets their sequences. All layers except the system layer are required.
3699
+ */
3700
+ export interface SetDiscountLayerSequences {
3701
+ /**
3702
+ * Entity type: DiscountLayer
3703
+ */
3704
+ Layers: string[];
3705
+ }
3706
+ /**
3575
3707
  * Update an existing discount
3576
3708
  */
3577
3709
  export interface UpdateDiscount {
@@ -3638,6 +3770,10 @@ export interface UpdateDiscount {
3638
3770
  OrganizationUnitSetID: string;
3639
3771
  PromotionLabel?: string;
3640
3772
  /**
3773
+ * For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
3774
+ */
3775
+ RequiredCustomFields: string[] | null | undefined;
3776
+ /**
3641
3777
  * Entity type: OrganizationUnit
3642
3778
  */
3643
3779
  RestitutionOrganizationUnitID?: string;
@@ -3791,24 +3927,6 @@ export interface UploadCouponExcelResponse {
3791
3927
  IsProcessedAsync: boolean;
3792
3928
  Metadata?: ResponseMessageMetadata;
3793
3929
  }
3794
- export interface UploadCouponExcel_Async {
3795
- /**
3796
- * Entity type: Blob
3797
- */
3798
- BlobID?: string;
3799
- /**
3800
- * Entity type: Discount
3801
- */
3802
- DiscountID: string;
3803
- }
3804
- export interface UploadCouponExcel_AsyncResponse {
3805
- Error?: ServiceError;
3806
- JobID?: string;
3807
- Metadata?: ResponseMessageMetadata;
3808
- }
3809
- export interface UploadCouponExcel_AsyncResult {
3810
- JobID?: string;
3811
- }
3812
3930
  /**
3813
3931
  * Validates the given discount information
3814
3932
  */
@@ -3867,6 +3985,10 @@ export interface ValidateDiscount {
3867
3985
  */
3868
3986
  OrganizationUnitSetID: string;
3869
3987
  /**
3988
+ * For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
3989
+ */
3990
+ RequiredCustomFields?: string[];
3991
+ /**
3870
3992
  * Entity type: OrganizationUnit
3871
3993
  */
3872
3994
  RestitutionOrganizationUnitID?: string;
@@ -4423,6 +4545,10 @@ export interface GiftCardsListGiftCardConfigurationsResponse_GiftCardConfigurati
4423
4545
  * `ProductGiftCard`: an item that describes the giftcard properties of a product with type GiftCard
4424
4546
  */
4425
4547
  export interface ListProductGiftCards {
4548
+ /**
4549
+ * Entity type: ProductPropertyType
4550
+ */
4551
+ IncludedProductProperties?: string[];
4426
4552
  PageConfig?: PageConfig<GiftCardsListProductGiftCardsFilter>;
4427
4553
  }
4428
4554
  export interface ListProductGiftCardsResponse {
@@ -4445,6 +4571,7 @@ export interface GiftCardsListProductGiftCardsResponse_ProductGiftCardDto {
4445
4571
  */
4446
4572
  ID: string;
4447
4573
  IsDigital: boolean;
4574
+ Product?: SearchIProductSearchItem;
4448
4575
  /**
4449
4576
  * Entity type: Product
4450
4577
  */
@@ -4967,26 +5094,26 @@ export interface AddLoyaltyProgramPriceList {
4967
5094
  PriceListID: string;
4968
5095
  }
4969
5096
  /**
4970
- * Archive a point awarding rule
5097
+ * Add a custom field requirement to the loyalty program. NOTE THAT a custom field can only be set once as a requirement.
4971
5098
  */
4972
- export interface ArchivePointAwardingRule {
5099
+ export interface AddLoyaltyProgramRequiredCustomField {
4973
5100
  /**
4974
- * Entity type: PointAwardingRule
5101
+ * Entity type: CustomField
4975
5102
  */
4976
- ID: string;
5103
+ CustomFieldID: string;
5104
+ /**
5105
+ * Entity type: LoyaltyProgram
5106
+ */
5107
+ LoyaltyProgramID: string;
4977
5108
  }
4978
5109
  /**
4979
- * Attach a product limitation to a payment type.
5110
+ * Archive a point awarding rule
4980
5111
  */
4981
- export interface AttachLoyaltyProgramProductLimitationToPaymentType {
4982
- /**
4983
- * Entity type: LoyaltyProgramPaymentType
4984
- */
4985
- LoyaltyProgramPaymentTypeID: string;
5112
+ export interface ArchivePointAwardingRule {
4986
5113
  /**
4987
- * Entity type: LoyaltyProgramProductLimitation
5114
+ * Entity type: PointAwardingRule
4988
5115
  */
4989
- LoyaltyProgramProductLimitationID: string;
5116
+ ID: string;
4990
5117
  }
4991
5118
  /**
4992
5119
  * Attach a loyalty program to an order
@@ -5004,6 +5131,9 @@ export interface AttachLoyaltyProgramToOrder {
5004
5131
  * Entity type: User
5005
5132
  */
5006
5133
  UserID?: string;
5134
+ /**
5135
+ * When set, the UserID will also become required so we can verify the UserIdentifier.
5136
+ */
5007
5137
  UserIdentifier?: string;
5008
5138
  }
5009
5139
  /**
@@ -5077,7 +5207,6 @@ export interface CreateLoyaltyProgram {
5077
5207
  ResubscribeHandling?: DataModelsResubscribeHandlingType;
5078
5208
  StartDate?: string;
5079
5209
  Status: DataModelsLoyaltyProgramStatus;
5080
- UsageType?: DataModelsLoyaltyProgramUsageTypes;
5081
5210
  UserBudget?: number;
5082
5211
  /**
5083
5212
  * Attention!
@@ -5162,6 +5291,7 @@ export interface CreateLoyaltyProgramPaymentType {
5162
5291
  * Entity type: PaymentType
5163
5292
  */
5164
5293
  PaymentTypeID: string;
5294
+ ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
5165
5295
  Required?: boolean;
5166
5296
  Sequence?: number;
5167
5297
  TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
@@ -5205,6 +5335,10 @@ export interface CreateLoyaltyProgramResponse {
5205
5335
  */
5206
5336
  ID: string;
5207
5337
  Metadata?: ResponseMessageMetadata;
5338
+ /**
5339
+ * Entity type: Subscription
5340
+ */
5341
+ SubscriptionID: string;
5208
5342
  }
5209
5343
  /**
5210
5344
  * Create a point awarding rule.
@@ -5323,19 +5457,6 @@ export interface DetachLoyaltyProgramFromOrder {
5323
5457
  OrderID: string;
5324
5458
  }
5325
5459
  /**
5326
- * Detach a product limitation from a payment type.
5327
- */
5328
- export interface DetachLoyaltyProgramProductLimitationFromPaymentType {
5329
- /**
5330
- * Entity type: LoyaltyProgramPaymentType
5331
- */
5332
- LoyaltyProgramPaymentTypeID: string;
5333
- /**
5334
- * Entity type: LoyaltyProgramProductLimitation
5335
- */
5336
- LoyaltyProgramProductLimitationID: string;
5337
- }
5338
- /**
5339
5460
  * Disable a point awarding rule
5340
5461
  */
5341
5462
  export interface DisablePointAwardingRule {
@@ -5434,7 +5555,6 @@ export interface GetLoyaltyProgramGroupResponse {
5434
5555
  * Get the available loyalty program handlers
5435
5556
  */
5436
5557
  export interface GetLoyaltyProgramHandlers {
5437
- UsageType?: DataModelsLoyaltyProgramUsageTypes;
5438
5558
  }
5439
5559
  export interface GetLoyaltyProgramHandlersResponse {
5440
5560
  Error?: ServiceError;
@@ -5473,6 +5593,7 @@ export interface GetLoyaltyProgramPaymentTypeResponse {
5473
5593
  */
5474
5594
  PaymentTypeID: string;
5475
5595
  PaymentTypeName?: string;
5596
+ ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
5476
5597
  Required: boolean;
5477
5598
  Sequence: number;
5478
5599
  TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
@@ -5580,7 +5701,6 @@ export interface GetLoyaltyProgramResponse {
5580
5701
  * Entity type: LoyaltyProgram
5581
5702
  */
5582
5703
  SubscriptionID?: string;
5583
- UsageType?: DataModelsLoyaltyProgramUsageTypes;
5584
5704
  UsedBudget: number;
5585
5705
  UserBudget?: number;
5586
5706
  UserIdentifierPrefix?: string;
@@ -5589,6 +5709,34 @@ export interface GetLoyaltyProgramResponse {
5589
5709
  UserMaximumUsage?: number;
5590
5710
  }
5591
5711
  /**
5712
+ * Get the available loyalty program payment methods for the given order.
5713
+ */
5714
+ export interface GetOrderLoyaltyProgramPaymentTypes {
5715
+ /**
5716
+ * Entity type: Order
5717
+ */
5718
+ OrderID: string;
5719
+ }
5720
+ export interface GetOrderLoyaltyProgramPaymentTypesResponse {
5721
+ Error?: ServiceError;
5722
+ Metadata?: ResponseMessageMetadata;
5723
+ Options?: LoyaltyGetOrderLoyaltyProgramPaymentTypesResponse_Option[];
5724
+ }
5725
+ export interface LoyaltyGetOrderLoyaltyProgramPaymentTypesResponse_Option {
5726
+ BackendID?: string;
5727
+ /**
5728
+ * Entity type: LoyaltyProgramPaymentType
5729
+ */
5730
+ ID: string;
5731
+ /**
5732
+ * Entity type: PaymentType
5733
+ */
5734
+ PaymentTypeID: string;
5735
+ PaymentTypeName?: string;
5736
+ Required: boolean;
5737
+ Sequence: number;
5738
+ }
5739
+ /**
5592
5740
  * Get loyalty point rule.
5593
5741
  */
5594
5742
  export interface GetPointAwardingRule {
@@ -5805,10 +5953,50 @@ export interface LoyaltyListLoyaltyProgramProductLimitationsResponse_Item {
5805
5953
  */
5806
5954
  ID: string;
5807
5955
  Name?: string;
5956
+ /**
5957
+ * The quantity limit over the entire product limitation product set per order.
5958
+ */
5959
+ OverallQuantityLimitPerOrder?: number;
5960
+ /**
5961
+ * The quantity limit over the entire product limitation product set per user.
5962
+ */
5963
+ OverallQuantityLimitPerUser?: number;
5964
+ /**
5965
+ * The quantity limit per product within the product limitation product set per order.
5966
+ */
5808
5967
  QuantityLimitPerOrder?: number;
5968
+ /**
5969
+ * The quantity limit per product within the product limitation product set per user.
5970
+ */
5809
5971
  QuantityLimitPerUser?: number;
5810
5972
  }
5811
5973
  /**
5974
+ * List the loyalty program CustomFieldRequirements
5975
+ */
5976
+ export interface ListLoyaltyProgramRequiredCustomFields {
5977
+ InitialPageConfig?: PageTokenConfig<Record<string, string | null> | null>;
5978
+ /**
5979
+ * Entity type: LoyaltyProgram
5980
+ */
5981
+ LoyaltyProgramID: string;
5982
+ PageToken?: string;
5983
+ }
5984
+ export interface ListLoyaltyProgramRequiredCustomFieldsResponse {
5985
+ Error?: ServiceError;
5986
+ Metadata?: ResponseMessageMetadata;
5987
+ NextPageToken?: string;
5988
+ PreviousPageToken?: string;
5989
+ Results?: LoyaltyListLoyaltyProgramRequiredCustomFieldsResponse_CustomField[];
5990
+ }
5991
+ export interface LoyaltyListLoyaltyProgramRequiredCustomFieldsResponse_CustomField {
5992
+ BackendID?: string;
5993
+ /**
5994
+ * Entity type: CustomField
5995
+ */
5996
+ ID: string;
5997
+ Name?: string;
5998
+ }
5999
+ /**
5812
6000
  * List the LoyaltyPrograms
5813
6001
  */
5814
6002
  export interface ListLoyaltyPrograms {
@@ -5839,7 +6027,6 @@ export interface LoyaltyListLoyaltyProgramsResponse_LoyaltyProgramDto {
5839
6027
  Options: DataModelsLoyaltyProgramOptions;
5840
6028
  StartDate?: string;
5841
6029
  Status: DataModelsLoyaltyProgramStatus;
5842
- UsageType: DataModelsLoyaltyProgramUsageTypes;
5843
6030
  }
5844
6031
  /**
5845
6032
  * List loyalty point rules. Returns a paged response.
@@ -5866,37 +6053,311 @@ export interface LoyaltyListPointAwardingRulesResponse_Rule {
5866
6053
  /**
5867
6054
  * Entity type: LoyaltyProgram
5868
6055
  */
5869
- LoyaltyProgramID: string;
5870
- LoyaltyProgramName?: string;
5871
- Name?: string;
6056
+ LoyaltyProgramID: string;
6057
+ LoyaltyProgramName?: string;
6058
+ Name?: string;
6059
+ /**
6060
+ * Entity type: OrganizationUnitSet
6061
+ */
6062
+ OrganizationUnitSetID: string;
6063
+ OrganizationUnitSetName?: string;
6064
+ StartDate: string;
6065
+ }
6066
+ export interface LoyaltyLoyaltyProgramProductLimitationData {
6067
+ Filters?: Record<string, SearchFilterModel>;
6068
+ /**
6069
+ * The quantity limit over the entire product limitation product set per order.
6070
+ */
6071
+ OverallQuantityLimitPerOrder?: number;
6072
+ /**
6073
+ * The quantity limit over the entire product limitation product set per user.
6074
+ */
6075
+ OverallQuantityLimitPerUser?: number;
6076
+ /**
6077
+ * Entity type: Product
6078
+ */
6079
+ ProductIDs?: string[];
6080
+ /**
6081
+ * Entity type: ProductSearchTemplate
6082
+ */
6083
+ ProductSearchID?: string;
6084
+ /**
6085
+ * The quantity limit per product within the product limitation product set per order.
6086
+ */
6087
+ QuantityLimitPerOrder?: number;
6088
+ /**
6089
+ * The quantity limit per product within the product limitation product set per user.
6090
+ */
6091
+ QuantityLimitPerUser?: number;
6092
+ }
6093
+ /**
6094
+ * Push a LoyaltyProgram.
6095
+ * If it doesn't exist it will be created, otherwise is will be updated.
6096
+ * Sub entities will also be created or updated, but will not be removed.
6097
+ */
6098
+ export interface LoyaltyPushLoyaltyProgram {
6099
+ /**
6100
+ * Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
6101
+ */
6102
+ AllowUnsubscribeBy: DataModelsAllowUnsubscribeByType;
6103
+ /**
6104
+ * When true, the loyalty program will not automatically be applied to the order when a customer is attached and all conditions are met.
6105
+ * When false, the loyalty program will automatically be applied if all conditions are met.
6106
+ */
6107
+ ApplyManuallyOnly?: boolean;
6108
+ /**
6109
+ * When true, if a non anonymous customer is attached to the order they will be automatically subscribed on finishing the order.
6110
+ * When false, the customer will not be subscribed.
6111
+ *
6112
+ * This is ignore when`RequiresSubscribedCustomer` or `RequiresSubscriptionValidation` is set to true.
6113
+ */
6114
+ AutoSubscribeCustomer?: boolean;
6115
+ Budget?: number;
6116
+ /**
6117
+ * Entity type: Currency
6118
+ */
6119
+ BudgetCurrencyID?: string;
6120
+ Conditions?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramCondition[];
6121
+ Data?: TAnyValue;
6122
+ DeactivateWhenBudgetIsReached?: boolean;
6123
+ Description?: string;
6124
+ EndDate?: string;
6125
+ Handler: string;
6126
+ /**
6127
+ * Entity type: LoyaltyProgram
6128
+ */
6129
+ ID: string;
6130
+ LoyaltyPointUsageOptions: DataModelsLoyaltyPointUsageOptions;
6131
+ /**
6132
+ * Entity type: LoyaltyProgramGroup
6133
+ */
6134
+ LoyaltyProgramGroupID?: string;
6135
+ Name: string;
6136
+ Options: DataModelsLoyaltyProgramOptions;
6137
+ OrganizationUnitSets?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramOrganizationUnitSet[];
6138
+ PaymentTypes?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType[];
6139
+ PointAwardingRules?: LoyaltyPushLoyaltyProgram_PushPointAwardingRule[];
6140
+ PointExpirationPolicyData?: Record<string, TAnyValue>;
6141
+ PointExpirationPolicyType?: string;
6142
+ PointPendingPolicyData?: Record<string, TAnyValue>;
6143
+ PointPendingPolicyType?: string;
6144
+ /**
6145
+ * Entity type: PriceList
6146
+ */
6147
+ PriceLists?: string[];
6148
+ ProductLimitations?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation[];
6149
+ ReactivateProgramWhenPossible?: boolean;
6150
+ ReloadPolicy?: string;
6151
+ /**
6152
+ * When true, the loyalty program will only be applied when a customer is attached to the order.
6153
+ *
6154
+ * When false, the loyalty program can be attached to the order even if there is no customer attached.
6155
+ */
6156
+ RequireCustomer?: boolean;
6157
+ /**
6158
+ * When set to true, subscribing the user will require a UserIdentifier to be given.
6159
+ * Attention!
6160
+ * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6161
+ * 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.
6162
+ */
6163
+ RequireManualUserIdentifier?: boolean;
6164
+ RequiredCustomFields?: string[];
6165
+ /**
6166
+ * 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.
6167
+ * Also, this will make the `RequireCustomer` automatically true and `AutoSubscribeCustomer` false.
6168
+ *
6169
+ * 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.
6170
+ */
6171
+ RequiresSubscribedCustomer?: boolean;
6172
+ /**
6173
+ * When true, the order will require that the attached customer on the order will be validated by providing the UserIdentifier in the `AttachBenefitProgramToOrder` service.
6174
+ * Also, this will make the `RequireCustomer` and `RequiresSubscribedCustomer` automatically true and `AutoSubscribeCustomer` false.
6175
+ *
6176
+ * When false, this validation isn't required.
6177
+ */
6178
+ RequiresSubscriptionValidation?: boolean;
6179
+ /**
6180
+ * Handling when a user is unsubscribed and re-subscribes.
6181
+ */
6182
+ ResubscribeHandling: DataModelsResubscribeHandlingType;
6183
+ StartDate?: string;
6184
+ Status: DataModelsLoyaltyProgramStatus;
6185
+ UserBudget?: number;
6186
+ /**
6187
+ * Attention!
6188
+ * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6189
+ * 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.
6190
+ */
6191
+ UserIdentifierPrefix?: string;
6192
+ /**
6193
+ * Attention!
6194
+ * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6195
+ * 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.
6196
+ */
6197
+ UserIdentifierStartNumber?: string;
6198
+ /**
6199
+ * Attention!
6200
+ * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
6201
+ * 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.
6202
+ */
6203
+ UserIdentifierSuffix?: string;
6204
+ UserMaximumUsage?: number;
6205
+ }
6206
+ export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramCondition {
6207
+ Data: Record<string, TAnyValue>;
6208
+ /**
6209
+ * Entity type: LoyaltyProgramCondition
6210
+ */
6211
+ ID: string;
6212
+ Type: string;
6213
+ }
6214
+ export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramOrganizationUnitSet {
6215
+ ConfirmationRequired?: boolean;
6216
+ Enabled?: boolean;
6217
+ Hidden?: boolean;
6218
+ OrganizationUnitSetID?: string;
6219
+ }
6220
+ export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType {
6221
+ Budget?: number;
6222
+ ExcludeFromProgramBudget?: boolean;
6223
+ /**
6224
+ * Entity type: LoyaltyProgramPaymentType
6225
+ */
6226
+ ID: string;
6227
+ MaximumAmountPerOrder?: number;
6228
+ MaximumPercentageOfUserBudgetPerOrder?: number;
6229
+ /**
6230
+ * Entity type: PaymentType
6231
+ */
6232
+ PaymentTypeID: string;
6233
+ ProductLimitation?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType_ProductLimitationData;
6234
+ Required?: boolean;
6235
+ Sequence?: number;
6236
+ TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
6237
+ UserBudget?: number;
6238
+ UserBudgetDeduction: DataModelsUserBudgetDeduction;
6239
+ UserMaximumUsage?: number;
6240
+ }
6241
+ export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType_ProductLimitationData {
6242
+ Filters?: Record<string, SearchFilterModel>;
6243
+ /**
6244
+ * The quantity limit over the entire product limitation product set per order.
6245
+ */
6246
+ OverallQuantityLimitPerOrder?: number;
6247
+ /**
6248
+ * The quantity limit over the entire product limitation product set per user.
6249
+ */
6250
+ OverallQuantityLimitPerUser?: number;
6251
+ /**
6252
+ * Entity type: Product
6253
+ */
6254
+ ProductIDs?: string[];
6255
+ /**
6256
+ * Entity type: ProductSearchTemplate
6257
+ */
6258
+ ProductSearchID?: string;
6259
+ /**
6260
+ * The quantity limit per product within the product limitation product set per order.
6261
+ */
6262
+ QuantityLimitPerOrder?: number;
6263
+ /**
6264
+ * The quantity limit per product within the product limitation product set per user.
6265
+ */
6266
+ QuantityLimitPerUser?: number;
6267
+ }
6268
+ export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation {
6269
+ ApplyToPriceList?: boolean;
6270
+ Filters?: Record<string, SearchFilterModel>;
6271
+ ID: string;
6272
+ Name: string;
6273
+ OverallQuantityLimitPerOrder?: number;
6274
+ OverallQuantityLimitPerUser?: number;
6275
+ /**
6276
+ * Entity type: Product
6277
+ */
6278
+ ProductIDs?: string[];
6279
+ /**
6280
+ * Entity type: ProductSearchTemplate
6281
+ */
6282
+ ProductSearchID?: string;
6283
+ QuantityLimitPerOrder?: number;
6284
+ QuantityLimitPerUser?: number;
6285
+ }
6286
+ export interface LoyaltyPushLoyaltyProgram_PushPointAwardingRule {
6287
+ ApplyRecursive?: boolean;
6288
+ Conditions?: LoyaltyPushLoyaltyProgram_PushPointAwardingRuleCondition[];
6289
+ Description?: string;
6290
+ Enabled?: boolean;
6291
+ EndDate?: string;
6292
+ ID: string;
6293
+ MarketingDescription?: string;
6294
+ Name: string;
6295
+ /**
6296
+ * Entity type: OrganizationUnitSet
6297
+ */
6298
+ OrganizationUnitSetID: string;
6299
+ PointExpirationPolicyData?: TAnyValue;
6300
+ PointExpirationPolicyType?: string;
6301
+ PointPendingPolicyData?: TAnyValue;
6302
+ PointPendingPolicyType?: string;
6303
+ PointsToAward?: number;
6304
+ StartDate: string;
6305
+ }
6306
+ export interface LoyaltyPushLoyaltyProgram_PushPointAwardingRuleCondition {
6307
+ Data?: LoyaltyRulesIPointAwardingConditionData;
6308
+ ID: string;
6309
+ Type: 'ORDERAMOUNT' | 'PRODUCT' | 'USERCUSTOMFIELD';
6310
+ }
6311
+ export interface PushLoyaltyProgramGroupResponse {
6312
+ Error?: ServiceError;
6313
+ /**
6314
+ * Entity type: LoyaltyProgram
6315
+ */
6316
+ ID: string;
6317
+ Metadata?: ResponseMessageMetadata;
6318
+ }
6319
+ export interface PushLoyaltyProgramGroup_Async {
6320
+ Budget?: number;
6321
+ /**
6322
+ * Entity type: Currency
6323
+ */
6324
+ BudgetCurrencyID?: string;
6325
+ DeactivateWhenBudgetIsReached?: boolean;
6326
+ EndDate?: string;
5872
6327
  /**
5873
- * Entity type: OrganizationUnitSet
6328
+ * Entity type: LoyaltyProgramGroup
5874
6329
  */
5875
- OrganizationUnitSetID: string;
5876
- OrganizationUnitSetName?: string;
5877
- StartDate: string;
6330
+ ID: string;
6331
+ Name: string;
6332
+ StartDate?: string;
6333
+ Status: DataModelsLoyaltyProgramStatus;
6334
+ TaxExemptionCode?: string;
5878
6335
  }
5879
- export interface LoyaltyLoyaltyProgramProductLimitationData {
5880
- Filters?: Record<string, SearchFilterModel>;
6336
+ export interface PushLoyaltyProgramGroup_AsyncResponse {
6337
+ Error?: ServiceError;
6338
+ JobID?: string;
6339
+ Metadata?: ResponseMessageMetadata;
6340
+ }
6341
+ export interface PushLoyaltyProgramGroup_AsyncResult {
6342
+ JobID?: string;
6343
+ }
6344
+ export interface PushLoyaltyProgramResponse {
6345
+ Error?: ServiceError;
5881
6346
  /**
5882
- * Entity type: Product
6347
+ * Entity type: LoyaltyProgram
5883
6348
  */
5884
- ProductIDs?: string[];
6349
+ ID: string;
6350
+ Metadata?: ResponseMessageMetadata;
5885
6351
  /**
5886
- * Entity type: ProductSearchTemplate
6352
+ * Entity type: Subscription
5887
6353
  */
5888
- ProductSearchID?: string;
5889
- QuantityLimitPerOrder?: number;
5890
- QuantityLimitPerUser?: number;
6354
+ SubscriptionID: string;
5891
6355
  }
5892
- /**
5893
- * Push a LoyaltyProgram.
5894
- */
5895
- export interface PushLoyaltyProgram {
6356
+ export interface PushLoyaltyProgram_Async {
5896
6357
  /**
5897
6358
  * Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
5898
6359
  */
5899
- AllowUnsubscribeBy?: DataModelsAllowUnsubscribeByType;
6360
+ AllowUnsubscribeBy: DataModelsAllowUnsubscribeByType;
5900
6361
  /**
5901
6362
  * When true, the loyalty program will not automatically be applied to the order when a customer is attached and all conditions are met.
5902
6363
  * When false, the loyalty program will automatically be applied if all conditions are met.
@@ -5924,7 +6385,7 @@ export interface PushLoyaltyProgram {
5924
6385
  * Entity type: LoyaltyProgram
5925
6386
  */
5926
6387
  ID: string;
5927
- LoyaltyPointUsageOptions?: DataModelsLoyaltyPointUsageOptions;
6388
+ LoyaltyPointUsageOptions: DataModelsLoyaltyPointUsageOptions;
5928
6389
  /**
5929
6390
  * Entity type: LoyaltyProgramGroup
5930
6391
  */
@@ -5934,12 +6395,12 @@ export interface PushLoyaltyProgram {
5934
6395
  OrganizationUnitSets?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramOrganizationUnitSet[];
5935
6396
  PaymentTypes?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType[];
5936
6397
  PointAwardingRules?: LoyaltyPushLoyaltyProgram_PushPointAwardingRule[];
5937
- PointExpirationPolicyData?: TAnyValue;
6398
+ PointExpirationPolicyData?: Record<string, TAnyValue>;
5938
6399
  PointExpirationPolicyType?: string;
5939
- PointPendingPolicyData?: TAnyValue;
6400
+ PointPendingPolicyData?: Record<string, TAnyValue>;
5940
6401
  PointPendingPolicyType?: string;
5941
6402
  /**
5942
- * Entity type: LoyaltyProgramCondition
6403
+ * Entity type: PriceList
5943
6404
  */
5944
6405
  PriceLists?: string[];
5945
6406
  ProductLimitations?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation[];
@@ -5958,6 +6419,7 @@ export interface PushLoyaltyProgram {
5958
6419
  * 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.
5959
6420
  */
5960
6421
  RequireManualUserIdentifier?: boolean;
6422
+ RequiredCustomFields?: string[];
5961
6423
  /**
5962
6424
  * 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.
5963
6425
  * Also, this will make the `RequireCustomer` automatically true and `AutoSubscribeCustomer` false.
@@ -5975,7 +6437,7 @@ export interface PushLoyaltyProgram {
5975
6437
  /**
5976
6438
  * Handling when a user is unsubscribed and re-subscribes.
5977
6439
  */
5978
- ResubscribeHandling?: DataModelsResubscribeHandlingType;
6440
+ ResubscribeHandling: DataModelsResubscribeHandlingType;
5979
6441
  StartDate?: string;
5980
6442
  Status: DataModelsLoyaltyProgramStatus;
5981
6443
  UserBudget?: number;
@@ -5999,89 +6461,14 @@ export interface PushLoyaltyProgram {
5999
6461
  UserIdentifierSuffix?: string;
6000
6462
  UserMaximumUsage?: number;
6001
6463
  }
6002
- export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramCondition {
6003
- Data: TAnyValue;
6004
- /**
6005
- * Entity type: LoyaltyProgramCondition
6006
- */
6007
- ID: string;
6008
- Type: string;
6009
- }
6010
- export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramOrganizationUnitSet {
6011
- ConfirmationRequired?: boolean;
6012
- Enabled?: boolean;
6013
- Hidden?: boolean;
6014
- OrganizationUnitSetID?: string;
6015
- }
6016
- export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType {
6017
- Budget?: number;
6018
- ExcludeFromProgramBudget?: boolean;
6019
- /**
6020
- * Entity type: LoyaltyProgramPaymentType
6021
- */
6022
- ID: string;
6023
- MaximumAmountPerOrder?: number;
6024
- MaximumPercentageOfUserBudgetPerOrder?: number;
6025
- /**
6026
- * Entity type: PaymentType
6027
- */
6028
- PaymentTypeID: string;
6029
- ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
6030
- Required?: boolean;
6031
- Sequence?: number;
6032
- TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
6033
- UserBudget?: number;
6034
- UserBudgetDeduction: DataModelsUserBudgetDeduction;
6035
- UserMaximumUsage?: number;
6036
- }
6037
- export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation {
6038
- Filters?: Record<string, SearchFilterModel>;
6039
- ID: string;
6040
- Name: string;
6041
- /**
6042
- * Entity type: Product
6043
- */
6044
- ProductIDs?: string[];
6045
- /**
6046
- * Entity type: ProductSearchTemplate
6047
- */
6048
- ProductSearchID?: string;
6049
- QuantityLimitPerOrder?: number;
6050
- QuantityLimitPerUser?: number;
6051
- }
6052
- export interface LoyaltyPushLoyaltyProgram_PushPointAwardingRule {
6053
- ApplyRecursive?: boolean;
6054
- Conditions?: LoyaltyPushLoyaltyProgram_PushPointAwardingRuleCondition[];
6055
- Description?: string;
6056
- Enabled?: boolean;
6057
- EndDate?: string;
6058
- ID: string;
6059
- MarketingDescription?: string;
6060
- Name: string;
6061
- /**
6062
- * Entity type: OrganizationUnitSet
6063
- */
6064
- OrganizationUnitSetID: string;
6065
- PointExpirationPolicyData?: TAnyValue;
6066
- PointExpirationPolicyType?: string;
6067
- PointPendingPolicyData?: TAnyValue;
6068
- PointPendingPolicyType?: string;
6069
- PointsToAward?: number;
6070
- StartDate: string;
6071
- }
6072
- export interface LoyaltyPushLoyaltyProgram_PushPointAwardingRuleCondition {
6073
- Data?: LoyaltyRulesIPointAwardingConditionData;
6074
- ID?: string;
6075
- Type: 'ORDERAMOUNT' | 'PRODUCT' | 'USERCUSTOMFIELD';
6076
- }
6077
- export interface PushLoyaltyProgramResponse {
6464
+ export interface PushLoyaltyProgram_AsyncResponse {
6078
6465
  Error?: ServiceError;
6079
- /**
6080
- * Entity type: LoyaltyProgram
6081
- */
6082
- ID: string;
6466
+ JobID?: string;
6083
6467
  Metadata?: ResponseMessageMetadata;
6084
6468
  }
6469
+ export interface PushLoyaltyProgram_AsyncResult {
6470
+ JobID?: string;
6471
+ }
6085
6472
  /**
6086
6473
  * Rebalance loyalty points of a user
6087
6474
  */
@@ -6125,6 +6512,33 @@ export interface RemoveLoyaltyProgramPriceList {
6125
6512
  PriceListID: string;
6126
6513
  }
6127
6514
  /**
6515
+ * Removes a custom field requirement from a loyalty program.
6516
+ */
6517
+ export interface RemoveLoyaltyProgramRequiredCustomField {
6518
+ /**
6519
+ * Entity type: CustomField
6520
+ */
6521
+ CustomFieldID: string;
6522
+ /**
6523
+ * Entity type: LoyaltyProgram
6524
+ */
6525
+ LoyaltyProgramID: string;
6526
+ }
6527
+ /**
6528
+ * Set the optional loyalty program payment types for the order.
6529
+ */
6530
+ export interface SetOrderLoyaltyProgramPaymentTypes {
6531
+ /**
6532
+ * Entity type: Order
6533
+ */
6534
+ OrderID: string;
6535
+ /**
6536
+ * Entity type: LoyaltyProgramPaymentType
6537
+ * When left empty no optional payment types will be available. Required payment types cannot be unselected.
6538
+ */
6539
+ SelectedLoyaltyProgramPaymentTypes: string[];
6540
+ }
6541
+ /**
6128
6542
  * Update an existing LoyaltyProgram
6129
6543
  */
6130
6544
  export interface UpdateLoyaltyProgram {
@@ -6198,7 +6612,6 @@ export interface UpdateLoyaltyProgram {
6198
6612
  ResubscribeHandling: DataModelsResubscribeHandlingType | undefined;
6199
6613
  StartDate: string | null | undefined;
6200
6614
  Status?: DataModelsLoyaltyProgramStatus;
6201
- UsageType?: DataModelsLoyaltyProgramUsageTypes;
6202
6615
  UserBudget: number | null | undefined;
6203
6616
  /**
6204
6617
  * Attention!
@@ -6300,6 +6713,7 @@ export interface UpdateLoyaltyProgramPaymentType {
6300
6713
  ID: string;
6301
6714
  MaximumAmountPerOrder?: number;
6302
6715
  MaximumPercentageOfUserBudgetPerOrder?: number;
6716
+ ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
6303
6717
  Required?: boolean;
6304
6718
  Sequence?: number;
6305
6719
  TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
@@ -6862,18 +7276,6 @@ export interface GetCheckoutOptionHandlersResponse {
6862
7276
  Metadata?: ResponseMessageMetadata;
6863
7277
  }
6864
7278
  /**
6865
- * Get the CheckoutOptions
6866
- */
6867
- export interface GetCheckoutOptions {
6868
- IncludeInactive?: boolean;
6869
- }
6870
- export interface GetCheckoutOptionsResponse {
6871
- Categories?: OrdersCheckoutOptionCategoryDto[];
6872
- Error?: ServiceError;
6873
- Metadata?: ResponseMessageMetadata;
6874
- Options?: OrdersCheckoutOptionDto[];
6875
- }
6876
- /**
6877
7279
  * Returns a single refund reason.
6878
7280
  */
6879
7281
  export interface GetRefundCorrectionReason {
@@ -7487,6 +7889,7 @@ export interface CreateCashHandler {
7487
7889
  * Entity type: Currency
7488
7890
  */
7489
7891
  CurrencyID: string;
7892
+ MaxAmountPerOrder?: number;
7490
7893
  Name: string;
7491
7894
  RoundingFactor: number;
7492
7895
  }
@@ -7614,6 +8017,7 @@ export interface GetCashHandlerByIDResponse {
7614
8017
  CurrencyID?: string;
7615
8018
  Error?: ServiceError;
7616
8019
  ID: string;
8020
+ MaxAmountPerOrder?: number;
7617
8021
  Metadata?: ResponseMessageMetadata;
7618
8022
  Name?: string;
7619
8023
  RoundingFactor: number;
@@ -7672,6 +8076,7 @@ export interface OrganizationUnitsListCashHandlersResponse_CashHandlerDto {
7672
8076
  * Entity type: CashHandler
7673
8077
  */
7674
8078
  ID: string;
8079
+ MaxAmountPerOrder?: number;
7675
8080
  Name?: string;
7676
8081
  RoundingFactor: number;
7677
8082
  }
@@ -7739,18 +8144,19 @@ export interface SetOrganizationUnitSupplierData {
7739
8144
  * Update an existing CashHandler
7740
8145
  */
7741
8146
  export interface UpdateCashHandler {
7742
- BankNotes: number[];
7743
- Coins: number[];
8147
+ BankNotes?: number[];
8148
+ Coins?: number[];
7744
8149
  /**
7745
8150
  * Entity type: Currency
7746
8151
  */
7747
- CurrencyID: string;
8152
+ CurrencyID?: string;
7748
8153
  /**
7749
8154
  * Entity type: CashHandler
7750
8155
  */
7751
8156
  ID: string;
7752
- Name: string;
7753
- RoundingFactor: number;
8157
+ MaxAmountPerOrder: number | null | undefined;
8158
+ Name?: string;
8159
+ RoundingFactor?: number;
7754
8160
  }
7755
8161
  /**
7756
8162
  * Update an existing OpeningHoursType
@@ -8803,6 +9209,10 @@ export interface CreatePriceListAdjustment {
8803
9209
  PriceListID: string;
8804
9210
  PricingGroupID?: string;
8805
9211
  Sequence?: number;
9212
+ /**
9213
+ * 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.
9214
+ */
9215
+ SkipRecalculation?: boolean;
8806
9216
  Type: string;
8807
9217
  }
8808
9218
  export interface CreatePriceListAdjustmentResponse {
@@ -8899,6 +9309,10 @@ export interface DeletePriceListAdjustment {
8899
9309
  * Entity type: PriceListAdjustment
8900
9310
  */
8901
9311
  ID: string;
9312
+ /**
9313
+ * 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.
9314
+ */
9315
+ SkipRecalculation?: boolean;
8902
9316
  }
8903
9317
  /**
8904
9318
  * Delete a PriceListManualInputAdjustment
@@ -9373,6 +9787,10 @@ export interface UpdatePriceListAdjustment {
9373
9787
  ParentAdjustmentID?: string;
9374
9788
  PricingGroupID: string | null | undefined;
9375
9789
  Sequence?: number;
9790
+ /**
9791
+ * 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.
9792
+ */
9793
+ SkipRecalculation?: boolean;
9376
9794
  Type: string;
9377
9795
  }
9378
9796
  /**
@@ -10743,7 +11161,6 @@ export interface CreateShippingCost {
10743
11161
  * Entity type: ShippingMethod
10744
11162
  */
10745
11163
  ShippingMethodID?: string;
10746
- UnitPriceInTax?: number;
10747
11164
  ZipCodes?: string[];
10748
11165
  }
10749
11166
  export interface CreateShippingCostResponse {
@@ -10795,16 +11212,23 @@ export interface CreateShippingMethodTransportationTime {
10795
11212
  * Creates a new ShippingRestriction.
10796
11213
  */
10797
11214
  export interface CreateShippingRestriction {
11215
+ /**
11216
+ * When set to `true`, the script will be leading for the entire order. Default is `true`
11217
+ */
11218
+ CheckScriptOnly?: boolean;
10798
11219
  /**
10799
11220
  * Entity type: Country
11221
+ * Required when there is no ScriptID set or CheckScriptOnly is 'false'
10800
11222
  */
10801
- CountryID: string;
11223
+ CountryID?: string;
10802
11224
  /**
10803
11225
  * Entity type: OrganizationUnit
11226
+ * Either an OrganizationUnitID or an OrganizationUnitSetID is required when there is no ScriptID set or CheckScriptOnly is 'false'
10804
11227
  */
10805
11228
  OrganizationUnitID?: string;
10806
11229
  /**
10807
11230
  * Entity type: OrganizationUnitSet
11231
+ * Either an OrganizationUnitID or an OrganizationUnitSetID is required when there is no ScriptID set or CheckScriptOnly is 'false'
10808
11232
  */
10809
11233
  OrganizationUnitSetID?: string;
10810
11234
  /**
@@ -10970,7 +11394,6 @@ export interface GetShippingCostByIDResponse {
10970
11394
  OrganizationUnitName?: string;
10971
11395
  ShippingMethodID?: string;
10972
11396
  ShippingMethodName?: string;
10973
- UnitPriceInTax: number;
10974
11397
  ZipCodes?: string[];
10975
11398
  }
10976
11399
  /**
@@ -11015,6 +11438,7 @@ export interface GetShippingRestrictionByID {
11015
11438
  ID: string;
11016
11439
  }
11017
11440
  export interface GetShippingRestrictionByIDResponse {
11441
+ CheckScriptOnly: boolean;
11018
11442
  CountryID?: string;
11019
11443
  CountryName?: string;
11020
11444
  Error?: ServiceError;
@@ -11023,7 +11447,7 @@ export interface GetShippingRestrictionByIDResponse {
11023
11447
  OrganizationUnitID?: string;
11024
11448
  OrganizationUnitName?: string;
11025
11449
  OrganizationUnitSetDescription?: string;
11026
- OrganizationUnitSetID: string;
11450
+ OrganizationUnitSetID?: string;
11027
11451
  OrganizationUnitSetName?: string;
11028
11452
  OrganizationUnitSetType?: DataModelsOrganizationUnitSetTypes;
11029
11453
  ProductPropertyTypeID?: string;
@@ -11197,7 +11621,6 @@ export interface ShippingShippingCostDto {
11197
11621
  OrganizationUnitName?: string;
11198
11622
  ShippingMethodID?: string;
11199
11623
  ShippingMethodName?: string;
11200
- UnitPriceInTax: number;
11201
11624
  ZipCodes?: string[];
11202
11625
  }
11203
11626
  export interface ShippingShippingRestrictionDto {
@@ -11219,9 +11642,9 @@ export interface ShippingShippingRestrictionDto {
11219
11642
  /**
11220
11643
  * Entity type: OrganizationUnitSet
11221
11644
  */
11222
- OrganizationUnitSetID: string;
11645
+ OrganizationUnitSetID?: string;
11223
11646
  OrganizationUnitSetName?: string;
11224
- OrganizationUnitSetType: DataModelsOrganizationUnitSetTypes;
11647
+ OrganizationUnitSetType?: DataModelsOrganizationUnitSetTypes;
11225
11648
  /**
11226
11649
  * Entity type: ProductPropertyType
11227
11650
  */
@@ -11316,7 +11739,6 @@ export interface UpdateShippingCost {
11316
11739
  * Entity type: ShippingMethod
11317
11740
  */
11318
11741
  ShippingMethodID?: string;
11319
- UnitPriceInTax?: number;
11320
11742
  ZipCodes?: string[];
11321
11743
  }
11322
11744
  /**
@@ -11373,6 +11795,10 @@ export interface UpdateShippingMethodTransportationTime {
11373
11795
  * Updates a ShippingRestriction.
11374
11796
  */
11375
11797
  export interface UpdateShippingRestriction {
11798
+ /**
11799
+ * When set to `true`, the script will be leading for the entire order.
11800
+ */
11801
+ CheckScriptOnly?: boolean;
11376
11802
  /**
11377
11803
  * Entity type: Country
11378
11804
  */
@@ -11461,6 +11887,7 @@ export interface CreateStockAllocationRule {
11461
11887
  */
11462
11888
  export interface CreateStockLabel {
11463
11889
  Description?: string;
11890
+ DisplayName?: string;
11464
11891
  LedgerClassID?: string;
11465
11892
  Name: string;
11466
11893
  }
@@ -11546,12 +11973,13 @@ export interface UpdateStockAllocationRule {
11546
11973
  * Update the description or ledgerclass of StockLabel
11547
11974
  */
11548
11975
  export interface UpdateStockLabel {
11549
- Description?: string;
11976
+ Description: string | null | undefined;
11977
+ DisplayName: string | null | undefined;
11550
11978
  /**
11551
11979
  * Entity type: StockLabel
11552
11980
  */
11553
11981
  ID: string;
11554
- LedgerClassID?: string;
11982
+ LedgerClassID: string | null | undefined;
11555
11983
  }
11556
11984
  /**
11557
11985
  * A service to upload an Excel containing StockAllocationRules that should be created or updated according to the values specified in the sheet.
@@ -11826,6 +12254,7 @@ export interface CreateUserOriginResponse {
11826
12254
  * Creates a new UserRequirement and returns the ID of the new record.
11827
12255
  */
11828
12256
  export interface CreateUserRequirement {
12257
+ AccountType?: DataModelsUserAccountType;
11829
12258
  CustomValidators?: Record<string, TAnyValue | null>;
11830
12259
  Display?: boolean;
11831
12260
  Preferred?: boolean;
@@ -12261,6 +12690,7 @@ export interface GetUserRequirement {
12261
12690
  ID: string;
12262
12691
  }
12263
12692
  export interface GetUserRequirementResponse {
12693
+ AccountType?: DataModelsUserAccountType;
12264
12694
  CustomValidators?: Record<string, TAnyValue | null>;
12265
12695
  Display: boolean;
12266
12696
  Error?: ServiceError;
@@ -12484,6 +12914,7 @@ export interface ListUserRequirementsResponse {
12484
12914
  Result?: PagedResult<UsersListUserRequirementsResponse_UserRequirementDto>;
12485
12915
  }
12486
12916
  export interface UsersListUserRequirementsResponse_UserRequirementDto {
12917
+ AccountType?: DataModelsUserAccountType;
12487
12918
  CustomValidators?: Record<string, TAnyValue | null>;
12488
12919
  Display: boolean;
12489
12920
  /**
@@ -12612,6 +13043,7 @@ export interface UpdateSubscriptionUserRequirements {
12612
13043
  Requirements: UsersUpdateSubscriptionUserRequirements_UserRequirementDto[];
12613
13044
  }
12614
13045
  export interface UsersUpdateSubscriptionUserRequirements_UserRequirementDto {
13046
+ AccountType: DataModelsUserAccountType | undefined;
12615
13047
  CustomValidators: Record<string, TAnyValue | null> | null | undefined;
12616
13048
  Display?: boolean;
12617
13049
  /**
@@ -12642,6 +13074,7 @@ export interface UpdateUserOrigin {
12642
13074
  * Updates an existing UserRequirement.
12643
13075
  */
12644
13076
  export interface UpdateUserRequirement {
13077
+ AccountType: DataModelsUserAccountType | undefined;
12645
13078
  CustomValidators: Record<string, TAnyValue | null> | null | undefined;
12646
13079
  Display?: boolean;
12647
13080
  /**
@@ -12686,6 +13119,7 @@ export interface UpdateUserRequirementSetRequirements {
12686
13119
  Requirements?: UsersUpdateUserRequirementSetRequirements_UserRequirementDto[];
12687
13120
  }
12688
13121
  export interface UsersUpdateUserRequirementSetRequirements_UserRequirementDto {
13122
+ AccountType: DataModelsUserAccountType | undefined;
12689
13123
  CustomValidators: Record<string, TAnyValue | null> | null | undefined;
12690
13124
  Display?: boolean;
12691
13125
  /**
@@ -13643,6 +14077,60 @@ export interface EVACoreServicesUsersListUserBoughtProductsResponse_BoughtProduc
13643
14077
  WarrantyExpiryDate?: string;
13644
14078
  }
13645
14079
  /**
14080
+ * Push bought products for users. Only accepts 10000 users per request
14081
+ */
14082
+ export interface EVACoreServicesUsersPushBoughtProductsForUsers {
14083
+ BoughtProductsForUsers?: EVACoreServicesUsersPushBoughtProductsForUsers_PushedBoughtProductForUser[];
14084
+ }
14085
+ export interface EVACoreServicesUsersPushBoughtProductsForUsers_PushedBoughtProductForUser {
14086
+ BoughtProducts?: EVACoreServicesUsersPushedBoughtProduct[];
14087
+ /**
14088
+ * Entity type: User
14089
+ */
14090
+ UserID: string;
14091
+ }
14092
+ export interface PushBoughtProductsForUsersResponse {
14093
+ Error?: ServiceError;
14094
+ FailedBoughtProductsForUsers?: EVACoreServicesUsersPushBoughtProductsForUsersResponse_FailedUserBoughtProductsForUser[];
14095
+ Metadata?: ResponseMessageMetadata;
14096
+ SuccessfulBoughtProductsForUsers?: EVACoreServicesUsersPushBoughtProductsForUsersResponse_SuccessfulUserBoughtProductsForUser[];
14097
+ }
14098
+ export interface EVACoreServicesUsersPushBoughtProductsForUsersResponse_BoughtProduct {
14099
+ ProductBackendID?: string;
14100
+ /**
14101
+ * Entity type: Product
14102
+ */
14103
+ ProductID: string;
14104
+ SerialNumber?: string;
14105
+ }
14106
+ export interface EVACoreServicesUsersPushBoughtProductsForUsersResponse_FailedUserBoughtProductsForUser {
14107
+ BoughtProducts?: EVACoreServicesUsersPushBoughtProductsForUsersResponse_BoughtProduct[];
14108
+ UserBackendID?: string;
14109
+ /**
14110
+ * Entity type: User
14111
+ */
14112
+ UserID: string;
14113
+ }
14114
+ export interface EVACoreServicesUsersPushBoughtProductsForUsersResponse_SuccessfulUserBoughtProductsForUser {
14115
+ BoughtProducts?: EVACoreServicesUsersPushBoughtProductsForUsersResponse_BoughtProduct[];
14116
+ UserBackendID?: string;
14117
+ /**
14118
+ * Entity type: User
14119
+ */
14120
+ UserID: string;
14121
+ }
14122
+ export interface PushBoughtProductsForUsers_Async {
14123
+ BoughtProductsForUsers?: EVACoreServicesUsersPushBoughtProductsForUsers_PushedBoughtProductForUser[];
14124
+ }
14125
+ export interface PushBoughtProductsForUsers_AsyncResponse {
14126
+ Error?: ServiceError;
14127
+ JobID?: string;
14128
+ Metadata?: ResponseMessageMetadata;
14129
+ }
14130
+ export interface PushBoughtProductsForUsers_AsyncResult {
14131
+ JobID?: string;
14132
+ }
14133
+ /**
13646
14134
  * Push user bought product.
13647
14135
  */
13648
14136
  export interface PushUserBoughtProduct {
@@ -13678,6 +14166,31 @@ export interface EVACoreServicesUsersPushUserBoughtProduct_PushedBoughtProductDe
13678
14166
  PurchaseDate?: string;
13679
14167
  PurchasedQuantity?: number;
13680
14168
  }
14169
+ export interface EVACoreServicesUsersPushedBoughtProduct {
14170
+ AdditionalWarrantyInfo?: string;
14171
+ Archive?: boolean;
14172
+ Details?: EVACoreServicesUsersPushedBoughtProduct_PushedBoughtProductDetail[];
14173
+ IsUnderWarranty?: boolean;
14174
+ /**
14175
+ * Entity type: Product
14176
+ */
14177
+ ProductID: string;
14178
+ SerialNumber?: string;
14179
+ WarrantyExpiryDate?: string;
14180
+ }
14181
+ export interface EVACoreServicesUsersPushedBoughtProduct_PushedBoughtProductDetail {
14182
+ BackendID?: string;
14183
+ /**
14184
+ * Entity type: Order
14185
+ */
14186
+ OrderID?: string;
14187
+ /**
14188
+ * Entity type: OrderLine
14189
+ */
14190
+ OrderLineID?: string;
14191
+ PurchaseDate?: string;
14192
+ PurchasedQuantity?: number;
14193
+ }
13681
14194
  /**
13682
14195
  * Register user bought product.
13683
14196
  */