@springtree/eva-services-core-management 2.2.2 → 2.3.1

package/lib/EVA.Core.Management.Services.d.ts

@@ -13,6 +13,19 @@ export declare namespace CoreManagement {
         request?: EVA.Core.Management.AddBlobToCaseInteraction;
         response?: EVA.Core.EmptyResponseMessage;
     }
+    /**
+     * Add a price list to a loyalty program. NOTE THAT you can only add one pricelist per currency to a loyalty program.
+     *
+     * @export
+     * @class AddLoyaltyProgramPriceList
+     * @implements {EvaService}
+     */
+    class AddLoyaltyProgramPriceList implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.AddLoyaltyProgramPriceList;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
     /**
      * Add a package to a carrier
      *
@@ -185,6 +198,32 @@ But if the list is a mixed product list, all updates will be applied according t
         request?: EVA.Core.Management.AttachFunctionalitiesToRole;
         response?: EVA.Core.EmptyResponseMessage;
     }
+    /**
+     * Attach a product limitation to a payment type.
+     *
+     * @export
+     * @class AttachLoyaltyProgramProductLimitationToPaymentType
+     * @implements {EvaService}
+     */
+    class AttachLoyaltyProgramProductLimitationToPaymentType implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.AttachLoyaltyProgramProductLimitationToPaymentType;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
+    /**
+     * Attach a loyalty program to an order
+     *
+     * @export
+     * @class AttachLoyaltyProgramToOrder
+     * @implements {EvaService}
+     */
+    class AttachLoyaltyProgramToOrder implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.AttachLoyaltyProgramToOrder;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
     /**
      * Resets the Financial Periods for given OU and all children to which the auditing provider applies. **Use with care!**
      *
@@ -700,6 +739,58 @@ This PIN will only be valid for a limited amount of time, and only for the provi
         request?: EVA.Core.Management.CreateLoyaltyProgram;
         response?: EVA.Core.Management.CreateLoyaltyProgramResponse;
     }
+    /**
+     * Create a new LoyaltyProgramCondition
+     *
+     * @export
+     * @class CreateLoyaltyProgramCondition
+     * @implements {EvaService}
+     */
+    class CreateLoyaltyProgramCondition implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.CreateLoyaltyProgramCondition;
+        response?: EVA.Core.Management.CreateLoyaltyProgramConditionResponse;
+    }
+    /**
+     * Create a new LoyaltyProgramGroup
+     *
+     * @export
+     * @class CreateLoyaltyProgramGroup
+     * @implements {EvaService}
+     */
+    class CreateLoyaltyProgramGroup implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.CreateLoyaltyProgramGroup;
+        response?: EVA.Core.Management.CreateLoyaltyProgramGroupResponse;
+    }
+    /**
+     * Create a new LoyaltyProgramPaymentType
+     *
+     * @export
+     * @class CreateLoyaltyProgramPaymentType
+     * @implements {EvaService}
+     */
+    class CreateLoyaltyProgramPaymentType implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.CreateLoyaltyProgramPaymentType;
+        response?: EVA.Core.Management.CreateLoyaltyProgramPaymentTypeResponse;
+    }
+    /**
+     * Create a loyalty program product limitation.
+     *
+     * @export
+     * @class CreateLoyaltyProgramProductLimitation
+     * @implements {EvaService}
+     */
+    class CreateLoyaltyProgramProductLimitation implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.CreateLoyaltyProgramProductLimitation;
+        response?: EVA.Core.Management.CreateLoyaltyProgramProductLimitationResponse;
+    }
     /**
      * Create a new MessageTemplate
      *
@@ -1164,32 +1255,6 @@ Optionally adds a record in the ProductUnitOfMeasure conversion table for the su
         request?: EVA.Core.Management.CreateRefundCorrectionReason;
         response?: EVA.Core.Management.CreateRefundCorrectionReasonResponse;
     }
-    /**
-     * Create a repair
-     *
-     * @export
-     * @class CreateRepair
-     * @implements {EvaService}
-     */
-    class CreateRepair implements IEvaServiceDefinition {
-        name: string;
-        path: string;
-        request?: EVA.Core.Management.CreateRepair;
-        response?: EVA.Core.Management.CreateRepairResponse;
-    }
-    /**
-     * Creates a new interaction associated with a specific repair
-     *
-     * @export
-     * @class CreateRepairInteraction
-     * @implements {EvaService}
-     */
-    class CreateRepairInteraction implements IEvaServiceDefinition {
-        name: string;
-        path: string;
-        request?: EVA.Core.Management.CreateRepairInteraction;
-        response?: EVA.Core.Management.CreateRepairInteractionResponse;
-    }
     /**
      * Create a return reason
      *
@@ -1530,7 +1595,7 @@ Name is required
         response?: EVA.Core.EmptyResponseMessage;
     }
     /**
-     * Delete a case topic
+     * Delete a case topic. NOTE THAT sub topics will also be deleted.
      *
      * @export
      * @class DeleteCaseTopic
@@ -1802,6 +1867,58 @@ Name is required
         request?: EVA.Core.Management.DeleteLoyaltyProgram;
         response?: EVA.Core.EmptyResponseMessage;
     }
+    /**
+     * Delete a LoyaltyProgramCondition
+     *
+     * @export
+     * @class DeleteLoyaltyProgramCondition
+     * @implements {EvaService}
+     */
+    class DeleteLoyaltyProgramCondition implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.DeleteLoyaltyProgramCondition;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
+    /**
+     * Delete the LoyaltyProgramGroup
+     *
+     * @export
+     * @class DeleteLoyaltyProgramGroup
+     * @implements {EvaService}
+     */
+    class DeleteLoyaltyProgramGroup implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.DeleteLoyaltyProgramGroup;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
+    /**
+     * Delete a LoyaltyProgramPaymentType
+     *
+     * @export
+     * @class DeleteLoyaltyProgramPaymentType
+     * @implements {EvaService}
+     */
+    class DeleteLoyaltyProgramPaymentType implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.DeleteLoyaltyProgramPaymentType;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
+    /**
+     * Delete a loyalty program product limitation.
+     *
+     * @export
+     * @class DeleteLoyaltyProgramProductLimitation
+     * @implements {EvaService}
+     */
+    class DeleteLoyaltyProgramProductLimitation implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.DeleteLoyaltyProgramProductLimitation;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
     /**
      * Delete a MessageTemplate
      *
@@ -2501,6 +2618,32 @@ File in state processing or processed can't be deleted due to generated financia
         request?: EVA.Core.Management.DetachFunctionalitiesFromRole;
         response?: EVA.Core.EmptyResponseMessage;
     }
+    /**
+     * Detach a loyalty program from an order
+     *
+     * @export
+     * @class DetachLoyaltyProgramFromOrder
+     * @implements {EvaService}
+     */
+    class DetachLoyaltyProgramFromOrder implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.DetachLoyaltyProgramFromOrder;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
+    /**
+     * Detach a product limitation from a payment type.
+     *
+     * @export
+     * @class DetachLoyaltyProgramProductLimitationFromPaymentType
+     * @implements {EvaService}
+     */
+    class DetachLoyaltyProgramProductLimitationFromPaymentType implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.DetachLoyaltyProgramProductLimitationFromPaymentType;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
     /**
      * Disable discounts
      *
@@ -2996,19 +3139,6 @@ A duplicated discount will not be Active and Verified.
         request?: EVA.Core.Management.ExportUserSubscriptions;
         response?: EVA.Core.ResourceResponseMessage;
     }
-    /**
-     * TODO: Needs documentation
-     *
-     * @export
-     * @class FinishRepair
-     * @implements {EvaService}
-     */
-    class FinishRepair implements IEvaServiceDefinition {
-        name: string;
-        path: string;
-        request?: EVA.Core.Management.FinishRepair;
-        response?: EVA.Core.EmptyResponseMessage;
-    }
     /**
      * Generate a batch DiscountCoupons, they will be emailed to the current user
      *
@@ -3757,6 +3887,32 @@ At this moment the supported DeviceTypes are:
         request?: EVA.Core.Management.GetLoyaltyProgram;
         response?: EVA.Core.Management.GetLoyaltyProgramResponse;
     }
+    /**
+     * Get a LoyaltyProgramCondition
+     *
+     * @export
+     * @class GetLoyaltyProgramCondition
+     * @implements {EvaService}
+     */
+    class GetLoyaltyProgramCondition implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.GetLoyaltyProgramCondition;
+        response?: EVA.Core.Management.GetLoyaltyProgramConditionResponse;
+    }
+    /**
+     * Get a LoyaltyProgramGroup
+     *
+     * @export
+     * @class GetLoyaltyProgramGroup
+     * @implements {EvaService}
+     */
+    class GetLoyaltyProgramGroup implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.GetLoyaltyProgramGroup;
+        response?: EVA.Core.Management.GetLoyaltyProgramGroupResponse;
+    }
     /**
      * Get the available loyalty program handlers
      *
@@ -3770,6 +3926,32 @@ At this moment the supported DeviceTypes are:
         request?: EVA.Core.Management.GetLoyaltyProgramHandlers;
         response?: EVA.Core.Management.GetLoyaltyProgramHandlersResponse;
     }
+    /**
+     * Get a LoyaltyProgramPaymentType
+     *
+     * @export
+     * @class GetLoyaltyProgramPaymentType
+     * @implements {EvaService}
+     */
+    class GetLoyaltyProgramPaymentType implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.GetLoyaltyProgramPaymentType;
+        response?: EVA.Core.Management.GetLoyaltyProgramPaymentTypeResponse;
+    }
+    /**
+     * Get a loyalty program product limitations"
+     *
+     * @export
+     * @class GetLoyaltyProgramProductLimitation
+     * @implements {EvaService}
+     */
+    class GetLoyaltyProgramProductLimitation implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.GetLoyaltyProgramProductLimitation;
+        response?: EVA.Core.Management.GetLoyaltyProgramProductLimitationResponse;
+    }
     /**
      * Get a MessageTemplate
      *
@@ -4152,19 +4334,6 @@ These handlers are custom build to fetch values for ProductRequirements from ext
         request?: EVA.Core.Management.GetRefundCorrectionReason;
         response?: EVA.Core.Management.GetRefundCorrectionReasonResponse;
     }
-    /**
-     * TODO: Needs documentation
-     *
-     * @export
-     * @class GetRepair
-     * @implements {EvaService}
-     */
-    class GetRepair implements IEvaServiceDefinition {
-        name: string;
-        path: string;
-        request?: EVA.Core.Management.GetRepair;
-        response?: EVA.Core.Management.GetRepairResponse;
-    }
     /**
      * Get the reasons by type.
      *
@@ -5062,6 +5231,84 @@ or to get a specific product in an assortment by filtering on both.
         request?: EVA.Core.Management.ListInquiries;
         response?: EVA.Core.Management.ListInquiriesResponse;
     }
+    /**
+     * Lists all payment types under the Loyalty payment method that aren't already connected to a loyalty program.
+     *
+     * @export
+     * @class ListLoyaltyPaymentMethodTypes
+     * @implements {EvaService}
+     */
+    class ListLoyaltyPaymentMethodTypes implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.ListLoyaltyPaymentMethodTypes;
+        response?: EVA.Core.Management.ListLoyaltyPaymentMethodTypesResponse;
+    }
+    /**
+     * List the LoyaltyProgramCondition
+     *
+     * @export
+     * @class ListLoyaltyProgramConditions
+     * @implements {EvaService}
+     */
+    class ListLoyaltyProgramConditions implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.ListLoyaltyProgramConditions;
+        response?: EVA.Core.Management.ListLoyaltyProgramConditionsResponse;
+    }
+    /**
+     * List the LoyaltyProgramGroups
+     *
+     * @export
+     * @class ListLoyaltyProgramGroups
+     * @implements {EvaService}
+     */
+    class ListLoyaltyProgramGroups implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.ListLoyaltyProgramGroups;
+        response?: EVA.Core.Management.ListLoyaltyProgramGroupsResponse;
+    }
+    /**
+     * List the LoyaltyProgramPaymentType
+     *
+     * @export
+     * @class ListLoyaltyProgramPaymentTypes
+     * @implements {EvaService}
+     */
+    class ListLoyaltyProgramPaymentTypes implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.ListLoyaltyProgramPaymentTypes;
+        response?: EVA.Core.Management.ListLoyaltyProgramPaymentTypesResponse;
+    }
+    /**
+     * List the loyalty program pricelists
+     *
+     * @export
+     * @class ListLoyaltyProgramPriceLists
+     * @implements {EvaService}
+     */
+    class ListLoyaltyProgramPriceLists implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.ListLoyaltyProgramPriceLists;
+        response?: EVA.Core.Management.ListLoyaltyProgramPriceListsResponse;
+    }
+    /**
+     * List the loyalty program product limitations
+     *
+     * @export
+     * @class ListLoyaltyProgramProductLimitations
+     * @implements {EvaService}
+     */
+    class ListLoyaltyProgramProductLimitations implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.ListLoyaltyProgramProductLimitations;
+        response?: EVA.Core.Management.ListLoyaltyProgramProductLimitationsResponse;
+    }
     /**
      * List the LoyaltyPrograms
      *
@@ -5578,32 +5825,6 @@ It is required to supply some OrganizationUnitIDs or some ProductIDs in the Page
         request?: EVA.Core.Management.ListRefundCorrectionReasons;
         response?: EVA.Core.Management.ListRefundCorrectionReasonsResponse;
     }
-    /**
-     * List the repair interactions
-     *
-     * @export
-     * @class ListRepairInteractions
-     * @implements {EvaService}
-     */
-    class ListRepairInteractions implements IEvaServiceDefinition {
-        name: string;
-        path: string;
-        request?: EVA.Core.Management.ListRepairInteractions;
-        response?: EVA.Core.Management.ListRepairInteractionsResponse;
-    }
-    /**
-     * List Repairs, optionally filtered.
-     *
-     * @export
-     * @class ListRepairs
-     * @implements {EvaService}
-     */
-    class ListRepairs implements IEvaServiceDefinition {
-        name: string;
-        path: string;
-        request?: EVA.Core.Management.ListRepairs;
-        response?: EVA.Core.Management.ListRepairsResponse;
-    }
     /**
      * TODO: Needs documentation
      *
@@ -6113,6 +6334,19 @@ Also the MessageTemplate `QRCodePrintingTemplate` can be configured in Stencil.
         request?: EVA.Core.Management.PushCase;
         response?: EVA.Core.Management.PushCaseResponse;
     }
+    /**
+     * Push a LoyaltyProgram.
+     *
+     * @export
+     * @class PushLoyaltyProgram
+     * @implements {EvaService}
+     */
+    class PushLoyaltyProgram implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.PushLoyaltyProgram;
+        response?: EVA.Core.Management.PushLoyaltyProgramResponse;
+    }
     /**
      * Push user bought product.
      *
@@ -6126,6 +6360,19 @@ Also the MessageTemplate `QRCodePrintingTemplate` can be configured in Stencil.
         request?: EVA.Core.Management.PushUserBoughtProduct;
         response?: EVA.Core.EmptyResponseMessage;
     }
+    /**
+     * Set products for personalized promotion for the given user. Overwrites existing products and product selection. Will unset products and selection when no products are provided.
+     *
+     * @export
+     * @class PushUserPersonalizedPromotionProducts
+     * @implements {EvaService}
+     */
+    class PushUserPersonalizedPromotionProducts implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.PushUserPersonalizedPromotionProducts;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
     /**
      * The service enables endpoints to push user subscriptions based on the user backend id and subscription backend id.
 Multiple subscriptions can be pushed at once.
@@ -6209,6 +6456,19 @@ NOTE THAT Balance can only be provided for loyalty subscriptions that have a EVA
         request?: EVA.Core.Management.RemoveCaseRelatedItems;
         response?: EVA.Core.EmptyResponseMessage;
     }
+    /**
+     * Removes a price list from a loyalty program.
+     *
+     * @export
+     * @class RemoveLoyaltyProgramPriceList
+     * @implements {EvaService}
+     */
+    class RemoveLoyaltyProgramPriceList implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.RemoveLoyaltyProgramPriceList;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
     /**
      * Remove a package from a carrier
      *
@@ -6288,7 +6548,7 @@ NOTE THAT Balance can only be provided for loyalty subscriptions that have a EVA
         response?: EVA.Core.Management.SearchStockMutationsResponse;
     }
     /**
-     * Set selected products for personalized promotion for the logged in user or the given user. Ovewrites existing selection.
+     * Set selected products for personalized promotion for the logged in user or the given user. Overwrites existing selection.
      *
      * @export
      * @class SelectUserPersonalizedPromotionProducts
@@ -6941,6 +7201,97 @@ When the budget is cleared or raised above the current `TotalDiscountGiven`, or
         request?: EVA.Core.Management.UpdateLoyaltyProgram;
         response?: EVA.Core.EmptyResponseMessage;
     }
+    /**
+     * Update the budget on the loyalty program group.
+ATTENTION! When the currency is changed, the used budget registration will be reset to 0!
+When the budget is lowered below the current used budget and the `DeactivateWhenBudgetIsReached` is set to true, all related programs will be deactivated.
+When the budget is cleared or raised above the current used budget, or `DeactivateWhenBudgetIsReached` is set to false, and the `ReactivateProgramsWhenPossible` is set to true, all programs that were deactivate by the group budget will be reactivated when possible.
+     *
+     * @export
+     * @class UpdateLoyaltyProgramBudget
+     * @implements {EvaService}
+     */
+    class UpdateLoyaltyProgramBudget implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.UpdateLoyaltyProgramBudget;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
+    /**
+     * Update an existing LoyaltyProgramCondition
+     *
+     * @export
+     * @class UpdateLoyaltyProgramCondition
+     * @implements {EvaService}
+     */
+    class UpdateLoyaltyProgramCondition implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.UpdateLoyaltyProgramCondition;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
+    /**
+     * Update an existing LoyaltyProgramGroup
+
+ATTENTION!
+When the currency is changed, the budget usages will be reset to 0!
+
+ATTENTION!
+When a change to Status, StartDate, EndDate or Currency leads to the group being deactivated, all related loyalty programs will also be deactivated.
+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.
+     *
+     * @export
+     * @class UpdateLoyaltyProgramGroup
+     * @implements {EvaService}
+     */
+    class UpdateLoyaltyProgramGroup implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.UpdateLoyaltyProgramGroup;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
+    /**
+     * Update the budget on the loyalty program group.
+ATTENTION!
+When the budget is lowered below the current used budget and the `DeactivateWhenBudgetIsReached` is set to true, all related programs will be deactivated.
+When the budget is cleared or raised above the current used budget, or `DeactivateWhenBudgetIsReached` is set to false, and the `ReactivateProgramsWhenPossible` is set to true, all programs that were deactivate by the group budget will be reactivated when possible.
+     *
+     * @export
+     * @class UpdateLoyaltyProgramGroupBudget
+     * @implements {EvaService}
+     */
+    class UpdateLoyaltyProgramGroupBudget implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.UpdateLoyaltyProgramGroupBudget;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
+    /**
+     * Update an existing LoyaltyProgramPaymentType
+     *
+     * @export
+     * @class UpdateLoyaltyProgramPaymentType
+     * @implements {EvaService}
+     */
+    class UpdateLoyaltyProgramPaymentType implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.UpdateLoyaltyProgramPaymentType;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
+    /**
+     * Update a loyalty program product limitation.
+     *
+     * @export
+     * @class UpdateLoyaltyProgramProductLimitation
+     * @implements {EvaService}
+     */
+    class UpdateLoyaltyProgramProductLimitation implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.UpdateLoyaltyProgramProductLimitation;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
     /**
      * Update an existing MessageTemplate
      *
@@ -7342,19 +7693,6 @@ A ShippingMethod, OrganizationUnit and Priority are required
         request?: EVA.Core.Management.UpdateRefundCorrectionReason;
         response?: EVA.Core.EmptyResponseMessage;
     }
-    /**
-     * TODO: Needs documentation
-     *
-     * @export
-     * @class UpdateRepair
-     * @implements {EvaService}
-     */
-    class UpdateRepair implements IEvaServiceDefinition {
-        name: string;
-        path: string;
-        request?: EVA.Core.Management.UpdateRepair;
-        response?: EVA.Core.EmptyResponseMessage;
-    }
     /**
      * Update a return reason
      *