@springtree/eva-services-core-management 3.0.0-beta.6 → 3.0.0-beta.7

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

@@ -2571,6 +2571,19 @@ export interface UpdateCustomField {
     TypeKey: string | null | undefined;
 }
 /**
+* Add required custom fields to ManualDiscount
+*/
+export interface AddRequiredCustomFieldsToManualDiscount {
+    /**
+    * Entity type: CustomField
+    */
+    CustomFieldIDs: string[];
+    /**
+    * Entity type: Discount
+    */
+    DiscountID: string;
+}
+/**
 * Add security roles to ManualDiscount
 */
 export interface AddRolesToManualDiscount {
@@ -2658,6 +2671,10 @@ export interface CreateDiscount {
     OrganizationUnitSetID: string;
     PromotionLabel?: string;
     /**
+    * For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
+    */
+    RequiredCustomFields?: string[];
+    /**
     * Entity type: OrganizationUnit
     */
     RestitutionOrganizationUnitID?: string;
@@ -3054,6 +3071,7 @@ export interface GetDiscountByIDResponse {
     OrganizationUnitSetName?: string;
     OrganizationUnitSetType?: DataModelsOrganizationUnitSetTypes;
     PromotionLabel?: string;
+    RequiredCustomFields?: string[];
     /**
     * Entity type: OrganizationUnit
     */
@@ -3544,6 +3562,20 @@ export interface MoveDiscountLayer {
     ID: string;
 }
 /**
+* Remove required custom fields from ManualDiscount
+*/
+export interface RemoveRequiredCustomFieldsFromManualDiscount {
+    /**
+    * Entity type: CustomField
+    */
+    CustomFieldIDs?: string[];
+    /**
+    * Entity type: Discount
+    */
+    DiscountID: string;
+    RemoveAllRequiredCustomFields?: boolean;
+}
+/**
 * Remove security roles from ManualDiscount
 */
 export interface RemoveRolesFromManualDiscount {
@@ -3628,6 +3660,15 @@ export interface DiscountsSearchDiscountsByQueryResponse_DiscountDto {
     UserUsageReloadStrategy?: string;
 }
 /**
+* Takes in all discount layers and sets their sequences. All layers except the system layer are required.
+*/
+export interface SetDiscountLayerSequences {
+    /**
+    * Entity type: DiscountLayer
+    */
+    Layers: string[];
+}
+/**
 * Update an existing discount
 */
 export interface UpdateDiscount {
@@ -3694,6 +3735,10 @@ export interface UpdateDiscount {
     OrganizationUnitSetID: string;
     PromotionLabel?: string;
     /**
+    * For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
+    */
+    RequiredCustomFields: string[] | null | undefined;
+    /**
     * Entity type: OrganizationUnit
     */
     RestitutionOrganizationUnitID?: string;
@@ -3923,6 +3968,10 @@ export interface ValidateDiscount {
     */
     OrganizationUnitSetID: string;
     /**
+    * For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
+    */
+    RequiredCustomFields?: string[];
+    /**
     * Entity type: OrganizationUnit
     */
     RestitutionOrganizationUnitID?: string;
@@ -4479,6 +4528,10 @@ export interface GiftCardsListGiftCardConfigurationsResponse_GiftCardConfigurati
 * `ProductGiftCard`: an item that describes the giftcard properties of a product with type GiftCard
 */
 export interface ListProductGiftCards {
+    /**
+    * Entity type: ProductPropertyType
+    */
+    IncludedProductProperties?: string[];
     PageConfig?: PageConfig<GiftCardsListProductGiftCardsFilter>;
 }
 export interface ListProductGiftCardsResponse {
@@ -4501,6 +4554,7 @@ export interface GiftCardsListProductGiftCardsResponse_ProductGiftCardDto {
     */
     ID: string;
     IsDigital: boolean;
+    Product?: SearchIProductSearchItem;
     /**
     * Entity type: Product
     */
@@ -5023,6 +5077,19 @@ export interface AddLoyaltyProgramPriceList {
     PriceListID: string;
 }
 /**
+* Add a custom field requirement to the loyalty program. NOTE THAT a custom field can only be set once as a requirement.
+*/
+export interface AddLoyaltyProgramRequiredCustomField {
+    /**
+    * Entity type: CustomField
+    */
+    CustomFieldID: string;
+    /**
+    * Entity type: LoyaltyProgram
+    */
+    LoyaltyProgramID: string;
+}
+/**
 * Archive a point awarding rule
 */
 export interface ArchivePointAwardingRule {
@@ -5887,6 +5954,32 @@ export interface LoyaltyListLoyaltyProgramProductLimitationsResponse_Item {
     QuantityLimitPerUser?: number;
 }
 /**
+* List the loyalty program CustomFieldRequirements
+*/
+export interface ListLoyaltyProgramRequiredCustomFields {
+    InitialPageConfig?: PageTokenConfig<Record<string, string | null> | null>;
+    /**
+    * Entity type: LoyaltyProgram
+    */
+    LoyaltyProgramID: string;
+    PageToken?: string;
+}
+export interface ListLoyaltyProgramRequiredCustomFieldsResponse {
+    Error?: ServiceError;
+    Metadata?: ResponseMessageMetadata;
+    NextPageToken?: string;
+    PreviousPageToken?: string;
+    Results?: LoyaltyListLoyaltyProgramRequiredCustomFieldsResponse_CustomField[];
+}
+export interface LoyaltyListLoyaltyProgramRequiredCustomFieldsResponse_CustomField {
+    BackendID?: string;
+    /**
+    * Entity type: CustomField
+    */
+    ID: string;
+    Name?: string;
+}
+/**
 * List the LoyaltyPrograms
 */
 export interface ListLoyaltyPrograms {
@@ -6051,6 +6144,7 @@ export interface LoyaltyPushLoyaltyProgram {
     * 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;
+    RequiredCustomFields?: string[];
     /**
     * 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.
@@ -6167,7 +6261,7 @@ export interface LoyaltyPushLoyaltyProgram_PushPointAwardingRule {
 }
 export interface LoyaltyPushLoyaltyProgram_PushPointAwardingRuleCondition {
     Data?: LoyaltyRulesIPointAwardingConditionData;
-    ID?: string;
+    ID: string;
     Type: 'ORDERAMOUNT' | 'PRODUCT' | 'USERCUSTOMFIELD';
 }
 export interface PushLoyaltyProgramResponse {
@@ -6248,6 +6342,7 @@ export interface PushLoyaltyProgram_Async {
     * 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;
+    RequiredCustomFields?: string[];
     /**
     * 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.
@@ -6340,7 +6435,20 @@ export interface RemoveLoyaltyProgramPriceList {
     PriceListID: string;
 }
 /**
-* Set the loyalty program payment types for the order.
+* Removes a custom field requirement from a loyalty program.
+*/
+export interface RemoveLoyaltyProgramRequiredCustomField {
+    /**
+    * Entity type: CustomField
+    */
+    CustomFieldID: string;
+    /**
+    * Entity type: LoyaltyProgram
+    */
+    LoyaltyProgramID: string;
+}
+/**
+* Set the optional loyalty program payment types for the order.
 */
 export interface SetOrderLoyaltyProgramPaymentTypes {
     /**
@@ -6349,6 +6457,7 @@ export interface SetOrderLoyaltyProgramPaymentTypes {
     OrderID: string;
     /**
     * Entity type: LoyaltyProgramPaymentType
+    * When left empty no optional payment types will be available. Required payment types cannot be unselected.
     */
     SelectedLoyaltyProgramPaymentTypes: string[];
 }