@springtree/eva-services-core-management 3.0.0-beta.3 → 3.0.0-beta.4

package/lib/eva-services-core-management.d.ts

@@ -5037,19 +5037,6 @@ export interface ArchivePointAwardingRule {
     ID: string;
 }
 /**
-* Attach a product limitation to a payment type.
-*/
-export interface AttachLoyaltyProgramProductLimitationToPaymentType {
-    /**
-    * Entity type: LoyaltyProgramPaymentType
-    */
-    LoyaltyProgramPaymentTypeID: string;
-    /**
-    * Entity type: LoyaltyProgramProductLimitation
-    */
-    LoyaltyProgramProductLimitationID: string;
-}
-/**
 * Attach a loyalty program to an order
 */
 export interface AttachLoyaltyProgramToOrder {
@@ -5065,6 +5052,9 @@ export interface AttachLoyaltyProgramToOrder {
     * Entity type: User
     */
     UserID?: string;
+    /**
+    * When set, the UserID will also become required so we can verify the UserIdentifier.
+    */
     UserIdentifier?: string;
 }
 /**
@@ -5222,6 +5212,7 @@ export interface CreateLoyaltyProgramPaymentType {
     * Entity type: PaymentType
     */
     PaymentTypeID: string;
+    ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
     Required?: boolean;
     Sequence?: number;
     TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
@@ -5265,6 +5256,10 @@ export interface CreateLoyaltyProgramResponse {
     */
     ID: string;
     Metadata?: ResponseMessageMetadata;
+    /**
+    * Entity type: Subscription
+    */
+    SubscriptionID: string;
 }
 /**
 * Create a point awarding rule.
@@ -5383,19 +5378,6 @@ export interface DetachLoyaltyProgramFromOrder {
     OrderID: string;
 }
 /**
-* Detach a product limitation from a payment type.
-*/
-export interface DetachLoyaltyProgramProductLimitationFromPaymentType {
-    /**
-    * Entity type: LoyaltyProgramPaymentType
-    */
-    LoyaltyProgramPaymentTypeID: string;
-    /**
-    * Entity type: LoyaltyProgramProductLimitation
-    */
-    LoyaltyProgramProductLimitationID: string;
-}
-/**
 * Disable a point awarding rule
 */
 export interface DisablePointAwardingRule {
@@ -5532,6 +5514,7 @@ export interface GetLoyaltyProgramPaymentTypeResponse {
     */
     PaymentTypeID: string;
     PaymentTypeName?: string;
+    ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
     Required: boolean;
     Sequence: number;
     TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
@@ -5647,6 +5630,34 @@ export interface GetLoyaltyProgramResponse {
     UserMaximumUsage?: number;
 }
 /**
+* Get the available loyalty program payment methods for the given order.
+*/
+export interface GetOrderLoyaltyProgramPaymentTypes {
+    /**
+    * Entity type: Order
+    */
+    OrderID: string;
+}
+export interface GetOrderLoyaltyProgramPaymentTypesResponse {
+    Error?: ServiceError;
+    Metadata?: ResponseMessageMetadata;
+    Options?: LoyaltyGetOrderLoyaltyProgramPaymentTypesResponse_Option[];
+}
+export interface LoyaltyGetOrderLoyaltyProgramPaymentTypesResponse_Option {
+    BackendID?: string;
+    /**
+    * Entity type: LoyaltyProgramPaymentType
+    */
+    ID: string;
+    /**
+    * Entity type: PaymentType
+    */
+    PaymentTypeID: string;
+    PaymentTypeName?: string;
+    Required: boolean;
+    Sequence: number;
+}
+/**
 * Get loyalty point rule.
 */
 export interface GetPointAwardingRule {
@@ -5863,7 +5874,21 @@ export interface LoyaltyListLoyaltyProgramProductLimitationsResponse_Item {
     */
     ID: string;
     Name?: string;
+    /**
+    * The quantity limit over the entire product limitation product set per order.
+    */
+    OverallQuantityLimitPerOrder?: number;
+    /**
+    * The quantity limit over the entire product limitation product set per user.
+    */
+    OverallQuantityLimitPerUser?: number;
+    /**
+    * The quantity limit per product within the product limitation product set per order.
+    */
     QuantityLimitPerOrder?: number;
+    /**
+    * The quantity limit per product within the product limitation product set per user.
+    */
     QuantityLimitPerUser?: number;
 }
 /**
@@ -5936,6 +5961,14 @@ export interface LoyaltyListPointAwardingRulesResponse_Rule {
 export interface LoyaltyLoyaltyProgramProductLimitationData {
     Filters?: Record<string, SearchFilterModel>;
     /**
+    * The quantity limit over the entire product limitation product set per order.
+    */
+    OverallQuantityLimitPerOrder?: number;
+    /**
+    * The quantity limit over the entire product limitation product set per user.
+    */
+    OverallQuantityLimitPerUser?: number;
+    /**
     * Entity type: Product
     */
     ProductIDs?: string[];
@@ -5943,17 +5976,25 @@ export interface LoyaltyLoyaltyProgramProductLimitationData {
     * Entity type: ProductSearchTemplate
     */
     ProductSearchID?: string;
+    /**
+    * The quantity limit per product within the product limitation product set per order.
+    */
     QuantityLimitPerOrder?: number;
+    /**
+    * The quantity limit per product within the product limitation product set per user.
+    */
     QuantityLimitPerUser?: number;
 }
 /**
 * Push a LoyaltyProgram.
+* If it doesn't exist it will be created, otherwise is will be updated.
+* Sub entities will also be created or updated, but will not be removed.
 */
-export interface PushLoyaltyProgram {
+export interface LoyaltyPushLoyaltyProgram {
     /**
     * Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
     */
-    AllowUnsubscribeBy?: DataModelsAllowUnsubscribeByType;
+    AllowUnsubscribeBy: DataModelsAllowUnsubscribeByType;
     /**
     * When true, the loyalty program will not automatically be applied to the order when a customer is attached and all conditions are met.
     * When false, the loyalty program will automatically be applied if all conditions are met.
@@ -5981,7 +6022,7 @@ export interface PushLoyaltyProgram {
     * Entity type: LoyaltyProgram
     */
     ID: string;
-    LoyaltyPointUsageOptions?: DataModelsLoyaltyPointUsageOptions;
+    LoyaltyPointUsageOptions: DataModelsLoyaltyPointUsageOptions;
     /**
     * Entity type: LoyaltyProgramGroup
     */
@@ -5991,12 +6032,12 @@ export interface PushLoyaltyProgram {
     OrganizationUnitSets?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramOrganizationUnitSet[];
     PaymentTypes?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType[];
     PointAwardingRules?: LoyaltyPushLoyaltyProgram_PushPointAwardingRule[];
-    PointExpirationPolicyData?: TAnyValue;
+    PointExpirationPolicyData?: Record<string, TAnyValue>;
     PointExpirationPolicyType?: string;
-    PointPendingPolicyData?: TAnyValue;
+    PointPendingPolicyData?: Record<string, TAnyValue>;
     PointPendingPolicyType?: string;
     /**
-    * Entity type: LoyaltyProgramCondition
+    * Entity type: PriceList
     */
     PriceLists?: string[];
     ProductLimitations?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation[];
@@ -6032,7 +6073,7 @@ export interface PushLoyaltyProgram {
     /**
     * Handling when a user is unsubscribed and re-subscribes.
     */
-    ResubscribeHandling?: DataModelsResubscribeHandlingType;
+    ResubscribeHandling: DataModelsResubscribeHandlingType;
     StartDate?: string;
     Status: DataModelsLoyaltyProgramStatus;
     UserBudget?: number;
@@ -6057,7 +6098,7 @@ export interface PushLoyaltyProgram {
     UserMaximumUsage?: number;
 }
 export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramCondition {
-    Data: TAnyValue;
+    Data: Record<string, TAnyValue>;
     /**
     * Entity type: LoyaltyProgramCondition
     */
@@ -6092,9 +6133,12 @@ export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType {
     UserMaximumUsage?: number;
 }
 export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation {
+    ApplyToPriceList?: boolean;
     Filters?: Record<string, SearchFilterModel>;
     ID: string;
     Name: string;
+    OverallQuantityLimitPerOrder?: number;
+    OverallQuantityLimitPerUser?: number;
     /**
     * Entity type: Product
     */
@@ -6138,6 +6182,125 @@ export interface PushLoyaltyProgramResponse {
     */
     ID: string;
     Metadata?: ResponseMessageMetadata;
+    /**
+    * Entity type: Subscription
+    */
+    SubscriptionID: string;
+}
+export interface PushLoyaltyProgram_Async {
+    /**
+    * Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
+    */
+    AllowUnsubscribeBy: DataModelsAllowUnsubscribeByType;
+    /**
+    * When true, the loyalty program will not automatically be applied to the order when a customer is attached and all conditions are met.
+    * When false, the loyalty program will automatically be applied if all conditions are met.
+    */
+    ApplyManuallyOnly?: boolean;
+    /**
+    * When true, if a non anonymous customer is attached to the order they will be automatically subscribed on finishing the order.
+    * When false, the customer will not be subscribed.
+    *
+    * This is ignore when`RequiresSubscribedCustomer` or `RequiresSubscriptionValidation` is set to true.
+    */
+    AutoSubscribeCustomer?: boolean;
+    Budget?: number;
+    /**
+    * Entity type: Currency
+    */
+    BudgetCurrencyID?: string;
+    Conditions?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramCondition[];
+    Data?: TAnyValue;
+    DeactivateWhenBudgetIsReached?: boolean;
+    Description?: string;
+    EndDate?: string;
+    Handler: string;
+    /**
+    * Entity type: LoyaltyProgram
+    */
+    ID: string;
+    LoyaltyPointUsageOptions: DataModelsLoyaltyPointUsageOptions;
+    /**
+    * Entity type: LoyaltyProgramGroup
+    */
+    LoyaltyProgramGroupID?: string;
+    Name: string;
+    Options: DataModelsLoyaltyProgramOptions;
+    OrganizationUnitSets?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramOrganizationUnitSet[];
+    PaymentTypes?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType[];
+    PointAwardingRules?: LoyaltyPushLoyaltyProgram_PushPointAwardingRule[];
+    PointExpirationPolicyData?: Record<string, TAnyValue>;
+    PointExpirationPolicyType?: string;
+    PointPendingPolicyData?: Record<string, TAnyValue>;
+    PointPendingPolicyType?: string;
+    /**
+    * Entity type: PriceList
+    */
+    PriceLists?: string[];
+    ProductLimitations?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation[];
+    ReactivateProgramWhenPossible?: boolean;
+    ReloadPolicy?: string;
+    /**
+    * When true, the loyalty program will only be applied when a customer is attached to the order.
+    *
+    * When false, the loyalty program can be attached to the order even if there is no customer attached.
+    */
+    RequireCustomer?: boolean;
+    /**
+    * When set to true, subscribing the user will require a UserIdentifier to be given.
+    * Attention!
+    * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
+    * 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.
+    */
+    RequireManualUserIdentifier?: boolean;
+    /**
+    * 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.
+    * Also, this will make the `RequireCustomer` automatically true and `AutoSubscribeCustomer` false.
+    *
+    * 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.
+    */
+    RequiresSubscribedCustomer?: boolean;
+    /**
+    * When true, the order will require that the attached customer on the order will be validated by providing the UserIdentifier in the `AttachBenefitProgramToOrder` service.
+    * Also, this will make the `RequireCustomer` and `RequiresSubscribedCustomer` automatically true and `AutoSubscribeCustomer` false.
+    *
+    * When false, this validation isn't required.
+    */
+    RequiresSubscriptionValidation?: boolean;
+    /**
+    * Handling when a user is unsubscribed and re-subscribes.
+    */
+    ResubscribeHandling: DataModelsResubscribeHandlingType;
+    StartDate?: string;
+    Status: DataModelsLoyaltyProgramStatus;
+    UserBudget?: number;
+    /**
+    * Attention!
+    * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
+    * 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.
+    */
+    UserIdentifierPrefix?: string;
+    /**
+    * Attention!
+    * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
+    * 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.
+    */
+    UserIdentifierStartNumber?: string;
+    /**
+    * Attention!
+    * This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
+    * 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.
+    */
+    UserIdentifierSuffix?: string;
+    UserMaximumUsage?: number;
+}
+export interface PushLoyaltyProgram_AsyncResponse {
+    Error?: ServiceError;
+    JobID?: string;
+    Metadata?: ResponseMessageMetadata;
+}
+export interface PushLoyaltyProgram_AsyncResult {
+    JobID?: string;
 }
 /**
 * Rebalance loyalty points of a user
@@ -6182,6 +6345,19 @@ export interface RemoveLoyaltyProgramPriceList {
     PriceListID: string;
 }
 /**
+* Set the loyalty program payment types for the order.
+*/
+export interface SetOrderLoyaltyProgramPaymentTypes {
+    /**
+    * Entity type: Order
+    */
+    OrderID: string;
+    /**
+    * Entity type: LoyaltyProgramPaymentType
+    */
+    SelectedLoyaltyProgramPaymentTypes: string[];
+}
+/**
 * Update an existing LoyaltyProgram
 */
 export interface UpdateLoyaltyProgram {
@@ -6356,6 +6532,7 @@ export interface UpdateLoyaltyProgramPaymentType {
     ID: string;
     MaximumAmountPerOrder?: number;
     MaximumPercentageOfUserBudgetPerOrder?: number;
+    ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
     Required?: boolean;
     Sequence?: number;
     TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
@@ -8859,6 +9036,10 @@ export interface CreatePriceListAdjustment {
     PriceListID: string;
     PricingGroupID?: string;
     Sequence?: number;
+    /**
+    * 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.
+    */
+    SkipRecalculation?: boolean;
     Type: string;
 }
 export interface CreatePriceListAdjustmentResponse {
@@ -8955,6 +9136,10 @@ export interface DeletePriceListAdjustment {
     * Entity type: PriceListAdjustment
     */
     ID: string;
+    /**
+    * 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.
+    */
+    SkipRecalculation?: boolean;
 }
 /**
 * Delete a PriceListManualInputAdjustment
@@ -9429,6 +9614,10 @@ export interface UpdatePriceListAdjustment {
     ParentAdjustmentID?: string;
     PricingGroupID: string | null | undefined;
     Sequence?: number;
+    /**
+    * 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.
+    */
+    SkipRecalculation?: boolean;
     Type: string;
 }
 /**