@springtree/eva-services-core-management 2.21.1 → 2.23.0

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

@@ -120,6 +120,19 @@ But if the list is a mixed product list, all updates will be applied according t
         request?: EVA.Core.Management.AddUserBoughtProductDetail;
         response?: EVA.Core.Management.UserBoughtProductResponse;
     }
+    /**
+     * Answer a survey question
+     *
+     * @export
+     * @class AnswerSurveyQuestion
+     * @implements {EvaService}
+     */
+    class AnswerSurveyQuestion implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.AnswerSurveyQuestion;
+        response?: EVA.Core.Management.QuestionResponse;
+    }
     /**
      * Archive a case.
      *
@@ -950,6 +963,19 @@ When this OrganizationUnitSet doesn't have this PaymentType yet, it will be crea
         request?: EVA.Core.Management.CreateOrderLedgerType;
         response?: EVA.Core.Management.CreateOrderLedgerTypeResponse;
     }
+    /**
+     * Creates a new company associated with the organization unit type
+     *
+     * @export
+     * @class CreateOrganizationUnitCompany
+     * @implements {EvaService}
+     */
+    class CreateOrganizationUnitCompany implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.CreateOrganizationUnitCompany;
+        response?: EVA.Core.Management.CreateOrganizationUnitCompanyResponse;
+    }
     /**
      * Create an organization unit country
      *
@@ -1496,6 +1522,45 @@ Name is required
         request?: EVA.Core.Management.CreateSupplierProduct;
         response?: EVA.Core.Management.CreateSupplierProductResponse;
     }
+    /**
+     * Creates a new survey
+     *
+     * @export
+     * @class CreateSurvey
+     * @implements {EvaService}
+     */
+    class CreateSurvey implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.CreateSurvey;
+        response?: EVA.Core.Management.CreateSurveyResponse;
+    }
+    /**
+     * Creates a new survey
+     *
+     * @export
+     * @class CreateSurveyQuestion
+     * @implements {EvaService}
+     */
+    class CreateSurveyQuestion implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.CreateSurveyQuestion;
+        response?: EVA.Core.Management.CreateSurveyQuestionResponse;
+    }
+    /**
+     * Creates a new survey question route
+     *
+     * @export
+     * @class CreateSurveyQuestionRoute
+     * @implements {EvaService}
+     */
+    class CreateSurveyQuestionRoute implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.CreateSurveyQuestionRoute;
+        response?: EVA.Core.Management.CreateSurveyQuestionRouteResponse;
+    }
     /**
      * Create a new UnitOfMeasure
      *
@@ -1574,6 +1639,22 @@ Name is required
         request?: EVA.Core.Management.CreateVisibilityGroup;
         response?: EVA.Core.Management.CreateVisibilityGroupResponse;
     }
+    /**
+     * Deactivates a survey.
+NOTE THAT this deactivates all published versions of the survey, so it can no longer be responded to at the end of the grace period.
+It will also take the survey back into draft.
+The survey is re-enabled when a new version is published.
+     *
+     * @export
+     * @class DeactivateSurvey
+     * @implements {EvaService}
+     */
+    class DeactivateSurvey implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.DeactivateSurvey;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
     /**
      * Delete an existing Account
      *
@@ -2531,6 +2612,45 @@ When it's SupplierBarcode all matching barcodes will be removed
         request?: EVA.Core.Management.DeleteSupplierProduct;
         response?: EVA.Core.EmptyResponseMessage;
     }
+    /**
+     * Update a survey
+     *
+     * @export
+     * @class DeleteSurvey
+     * @implements {EvaService}
+     */
+    class DeleteSurvey implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.DeleteSurvey;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
+    /**
+     * Delete a survey question
+     *
+     * @export
+     * @class DeleteSurveyQuestion
+     * @implements {EvaService}
+     */
+    class DeleteSurveyQuestion implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.DeleteSurveyQuestion;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
+    /**
+     * Delete a survey question route.
+     *
+     * @export
+     * @class DeleteSurveyQuestionRoute
+     * @implements {EvaService}
+     */
+    class DeleteSurveyQuestionRoute implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.DeleteSurveyQuestionRoute;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
     /**
      * Delete a UnitOfMeasure
      *
@@ -2739,7 +2859,7 @@ File in state processing or processed can't be deleted due to generated financia
         name: string;
         path: string;
         request?: EVA.Core.Management.DownloadCouponExcel;
-        response?: EVA.Core.ResourceWithBlobIDResponseMessage;
+        response?: EVA.Core.Management.DownloadCouponExcelResponse;
     }
     /**
      * Download template to upload an excel with coupons.
@@ -2778,7 +2898,7 @@ File in state processing or processed can't be deleted due to generated financia
         name: string;
         path: string;
         request?: EVA.Core.AsyncRequestResultRequest;
-        response?: EVA.Core.ResourceWithBlobIDResponseMessage;
+        response?: EVA.Core.Management.DownloadCouponExcelResponse;
     }
     /**
      * Download an Excel sample which can be filled with customers. The populated excel can be uploaded through the `UploadCustomers` service.
@@ -3093,6 +3213,19 @@ A duplicated discount will not be Active and Verified.
         request?: EVA.Core.Management.DuplicateDiscountTemplate;
         response?: EVA.Core.Management.CreateDiscountTemplateResponse;
     }
+    /**
+     * Duplicate an existing MessageTemplate
+     *
+     * @export
+     * @class DuplicateMessageTemplate
+     * @implements {EvaService}
+     */
+    class DuplicateMessageTemplate implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.DuplicateMessageTemplate;
+        response?: EVA.Core.Management.DuplicateMessageTemplateResponse;
+    }
     /**
      * Duplicate the requirements of an existing set to a new set.
      *
@@ -3474,6 +3607,32 @@ If available a Description and/or DefaultValue will be returned
         request?: EVA.Core.Management.GetAvailableShippingMethodHandlers;
         response?: EVA.Core.Management.GetAvailableShippingMethodHandlersResponse;
     }
+    /**
+     * Returns available survey triggers.
+     *
+     * @export
+     * @class GetAvailableSurveyTriggers
+     * @implements {EvaService}
+     */
+    class GetAvailableSurveyTriggers implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.GetAvailableSurveyTriggers;
+        response?: EVA.Core.Management.GetAvailableSurveyTriggersResponse;
+    }
+    /**
+     * Get all available surveys for user
+     *
+     * @export
+     * @class GetAvailableSurveys
+     * @implements {EvaService}
+     */
+    class GetAvailableSurveys implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.GetAvailableSurveys;
+        response?: EVA.Core.Management.GetAvailableSurveysResponse;
+    }
     /**
      * Get the available UserProperties on which requirements can be set.
      *
@@ -4153,6 +4312,19 @@ At this moment the supported DeviceTypes are:
         request?: EVA.Core.Management.GetOrderLoyaltyProgramPaymentTypes;
         response?: EVA.Core.Management.GetOrderLoyaltyProgramPaymentTypesResponse;
     }
+    /**
+     * GetOrganizationUnitCompany
+     *
+     * @export
+     * @class GetOrganizationUnitCompany
+     * @implements {EvaService}
+     */
+    class GetOrganizationUnitCompany implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.GetOrganizationUnitCompany;
+        response?: EVA.Core.Management.GetOrganizationUnitCompanyResponse;
+    }
     /**
      * Gets an `OrganizationUnitSet` by its ID and returns the set's basic information.
      *
@@ -4704,6 +4876,45 @@ These handlers are custom build to fetch values for ProductRequirements from ext
         request?: EVA.Core.Management.GetSupportedFunctionalities;
         response?: EVA.Core.Management.GetSupportedFunctionalitiesResponse;
     }
+    /**
+     * Get the survey
+     *
+     * @export
+     * @class GetSurveyByID
+     * @implements {EvaService}
+     */
+    class GetSurveyByID implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.GetSurveyByID;
+        response?: EVA.Core.Management.GetSurveyByIDResponse;
+    }
+    /**
+     * Get a question that is already answered (to navigate back and forth in the survey)
+     *
+     * @export
+     * @class GetSurveyQuestionAnswer
+     * @implements {EvaService}
+     */
+    class GetSurveyQuestionAnswer implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.GetSurveyQuestionAnswer;
+        response?: EVA.Core.Management.GetSurveyQuestionAnswerResponse;
+    }
+    /**
+     * Get the survey question
+     *
+     * @export
+     * @class GetSurveyQuestionByID
+     * @implements {EvaService}
+     */
+    class GetSurveyQuestionByID implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.GetSurveyQuestionByID;
+        response?: EVA.Core.Management.GetSurveyQuestionByIDResponse;
+    }
     /**
      * List the UnitOfMeasures
      *
@@ -6173,6 +6384,8 @@ It is required to supply some OrganizationUnitIDs or some ProductIDs in the Page
      * List the Stock per product/stocklabel for a subset of OrganizationUnits.
 
 The page size `Limit` has a maximum value of `1.024` for this service (unless `DownloadOverview` is `true`).
+
+If neither `OrganizationUnitIDs` nor `OrganizationUnitSetID` are specified, the service will return an empty result.
      *
      * @export
      * @class ListStockForOrganizationUnits
@@ -6251,6 +6464,32 @@ The page size `Limit` has a maximum value of `1.024` for this service (unless `D
         request?: EVA.Core.Management.ListSupplierProducts;
         response?: EVA.Core.Management.ListSupplierProductsResponse;
     }
+    /**
+     * List the survey questions
+     *
+     * @export
+     * @class ListSurveyQuestions
+     * @implements {EvaService}
+     */
+    class ListSurveyQuestions implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.ListSurveyQuestions;
+        response?: EVA.Core.Management.ListSurveyQuestionsResponse;
+    }
+    /**
+     * List the surveys
+     *
+     * @export
+     * @class ListSurveys
+     * @implements {EvaService}
+     */
+    class ListSurveys implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.ListSurveys;
+        response?: EVA.Core.Management.ListSurveysResponse;
+    }
     /**
      * TODO: Needs documentation
      *
@@ -6509,6 +6748,24 @@ Also the MessageTemplate `QRCodePrintingTemplate` can be configured in Stencil.
         request?: EVA.Core.Management.ProcessUnshippedPurchaseOrdersFromExcel;
         response?: EVA.Core.EmptyResponseMessage;
     }
+    /**
+     * Publishes all changes made to the survey.
+
+Service will return an error when the survey is already published.
+
+Survey cannot be published by the same user as the one who created / modified the survey, unless they have the right 'SurveySelfPublish'.
+The service will return an error if the same user without the right 'SurveySelfPublish' tries to publish the survey.
+     *
+     * @export
+     * @class PublishSurvey
+     * @implements {EvaService}
+     */
+    class PublishSurvey implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.PublishSurvey;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
     /**
      * Push bought products for users. Only accepts 10000 users per request
      *
@@ -7326,6 +7583,19 @@ Will apply all changes or no changes in case of an error
         request?: EVA.Core.Management.SetSettings;
         response?: EVA.Core.EmptyResponseMessage;
     }
+    /**
+     * Takes in all routings of a question and sets their sequences.
+     *
+     * @export
+     * @class SetSurveyQuestionRoutingSequences
+     * @implements {EvaService}
+     */
+    class SetSurveyQuestionRoutingSequences implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.SetSurveyQuestionRoutingSequences;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
     /**
      * Update the Roles for an User. The roles provided will replace any existing roles on this user!
 
@@ -7343,6 +7613,19 @@ The UserType defines as which UserType the User will act when logging in. For em
         request?: EVA.Core.Management.SetUserRoles;
         response?: EVA.Core.EmptyResponseMessage;
     }
+    /**
+     * Start a survey
+     *
+     * @export
+     * @class StartSurvey
+     * @implements {EvaService}
+     */
+    class StartSurvey implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.StartSurvey;
+        response?: EVA.Core.Management.StartSurveyResponse;
+    }
     /**
      * Unblock a users subscription.
      *
@@ -7961,6 +8244,19 @@ When the budget is cleared or raised above the current used budget, or `Deactiva
         request?: EVA.Core.Management.UpdateOrderLedgerType;
         response?: EVA.Core.Management.UpdateOrderLedgerTypeResponse;
     }
+    /**
+     * Updates the details of companies associated with the organization unit type.
+     *
+     * @export
+     * @class UpdateOrganizationUnitCompany
+     * @implements {EvaService}
+     */
+    class UpdateOrganizationUnitCompany implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.UpdateOrganizationUnitCompany;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
     /**
      * Update the Cashhandler for an additional Currency
      *
@@ -8535,6 +8831,47 @@ Updates the given requirements and removes all other requirements from the Subsc
         request?: EVA.Core.Management.UpdateSupplierProductStock;
         response?: EVA.Core.EmptyResponseMessage;
     }
+    /**
+     * Update a survey.
+NOTE THAT after update, the published survey will remain active and the current data will be taken into draft mode for republishing.
+After publishing you can no longer change the OrganizationUnitSetID, SurveyContext, TriggerEventType and (depending on the TriggerEventType) some of the TriggerEventData properties.
+     *
+     * @export
+     * @class UpdateSurvey
+     * @implements {EvaService}
+     */
+    class UpdateSurvey implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.UpdateSurvey;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
+    /**
+     * Update a survey question
+     *
+     * @export
+     * @class UpdateSurveyQuestion
+     * @implements {EvaService}
+     */
+    class UpdateSurveyQuestion implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.UpdateSurveyQuestion;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
+    /**
+     * Update a survey question route
+     *
+     * @export
+     * @class UpdateSurveyQuestionRoute
+     * @implements {EvaService}
+     */
+    class UpdateSurveyQuestionRoute implements IEvaServiceDefinition {
+        name: string;
+        path: string;
+        request?: EVA.Core.Management.UpdateSurveyQuestionRoute;
+        response?: EVA.Core.EmptyResponseMessage;
+    }
     /**
      * Update an existing UnitOfMeasure
      *