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

package/lib/EVA.Core.Management.Services.js

@@ -129,6 +129,20 @@ But if the list is a mixed product list, all updates will be applied according t
         response;
     }
     CoreManagement.AddUserBoughtProductDetail = AddUserBoughtProductDetail;
+    /**
+     * Answer a survey question
+     *
+     * @export
+     * @class AnswerSurveyQuestion
+     * @implements {EvaService}
+     */
+    class AnswerSurveyQuestion {
+        name = 'CoreManagement:AnswerSurveyQuestion';
+        path = '/message/AnswerSurveyQuestion';
+        request;
+        response;
+    }
+    CoreManagement.AnswerSurveyQuestion = AnswerSurveyQuestion;
     /**
      * Archive a case.
      *
@@ -1021,6 +1035,20 @@ When this OrganizationUnitSet doesn't have this PaymentType yet, it will be crea
         response;
     }
     CoreManagement.CreateOrderLedgerType = CreateOrderLedgerType;
+    /**
+     * Creates a new company associated with the organization unit type
+     *
+     * @export
+     * @class CreateOrganizationUnitCompany
+     * @implements {EvaService}
+     */
+    class CreateOrganizationUnitCompany {
+        name = 'CoreManagement:CreateOrganizationUnitCompany';
+        path = '/message/CreateOrganizationUnitCompany';
+        request;
+        response;
+    }
+    CoreManagement.CreateOrganizationUnitCompany = CreateOrganizationUnitCompany;
     /**
      * Create an organization unit country
      *
@@ -1606,6 +1634,48 @@ Name is required
         response;
     }
     CoreManagement.CreateSupplierProduct = CreateSupplierProduct;
+    /**
+     * Creates a new survey
+     *
+     * @export
+     * @class CreateSurvey
+     * @implements {EvaService}
+     */
+    class CreateSurvey {
+        name = 'CoreManagement:CreateSurvey';
+        path = '/message/CreateSurvey';
+        request;
+        response;
+    }
+    CoreManagement.CreateSurvey = CreateSurvey;
+    /**
+     * Creates a new survey
+     *
+     * @export
+     * @class CreateSurveyQuestion
+     * @implements {EvaService}
+     */
+    class CreateSurveyQuestion {
+        name = 'CoreManagement:CreateSurveyQuestion';
+        path = '/message/CreateSurveyQuestion';
+        request;
+        response;
+    }
+    CoreManagement.CreateSurveyQuestion = CreateSurveyQuestion;
+    /**
+     * Creates a new survey question route
+     *
+     * @export
+     * @class CreateSurveyQuestionRoute
+     * @implements {EvaService}
+     */
+    class CreateSurveyQuestionRoute {
+        name = 'CoreManagement:CreateSurveyQuestionRoute';
+        path = '/message/CreateSurveyQuestionRoute';
+        request;
+        response;
+    }
+    CoreManagement.CreateSurveyQuestionRoute = CreateSurveyQuestionRoute;
     /**
      * Create a new UnitOfMeasure
      *
@@ -1690,6 +1760,23 @@ Name is required
         response;
     }
     CoreManagement.CreateVisibilityGroup = CreateVisibilityGroup;
+    /**
+     * 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 {
+        name = 'CoreManagement:DeactivateSurvey';
+        path = '/message/DeactivateSurvey';
+        request;
+        response;
+    }
+    CoreManagement.DeactivateSurvey = DeactivateSurvey;
     /**
      * Delete an existing Account
      *
@@ -2720,6 +2807,48 @@ When it's SupplierBarcode all matching barcodes will be removed
         response;
     }
     CoreManagement.DeleteSupplierProduct = DeleteSupplierProduct;
+    /**
+     * Update a survey
+     *
+     * @export
+     * @class DeleteSurvey
+     * @implements {EvaService}
+     */
+    class DeleteSurvey {
+        name = 'CoreManagement:DeleteSurvey';
+        path = '/message/DeleteSurvey';
+        request;
+        response;
+    }
+    CoreManagement.DeleteSurvey = DeleteSurvey;
+    /**
+     * Delete a survey question
+     *
+     * @export
+     * @class DeleteSurveyQuestion
+     * @implements {EvaService}
+     */
+    class DeleteSurveyQuestion {
+        name = 'CoreManagement:DeleteSurveyQuestion';
+        path = '/message/DeleteSurveyQuestion';
+        request;
+        response;
+    }
+    CoreManagement.DeleteSurveyQuestion = DeleteSurveyQuestion;
+    /**
+     * Delete a survey question route.
+     *
+     * @export
+     * @class DeleteSurveyQuestionRoute
+     * @implements {EvaService}
+     */
+    class DeleteSurveyQuestionRoute {
+        name = 'CoreManagement:DeleteSurveyQuestionRoute';
+        path = '/message/DeleteSurveyQuestionRoute';
+        request;
+        response;
+    }
+    CoreManagement.DeleteSurveyQuestionRoute = DeleteSurveyQuestionRoute;
     /**
      * Delete a UnitOfMeasure
      *
@@ -3325,6 +3454,20 @@ A duplicated discount will not be Active and Verified.
         response;
     }
     CoreManagement.DuplicateDiscountTemplate = DuplicateDiscountTemplate;
+    /**
+     * Duplicate an existing MessageTemplate
+     *
+     * @export
+     * @class DuplicateMessageTemplate
+     * @implements {EvaService}
+     */
+    class DuplicateMessageTemplate {
+        name = 'CoreManagement:DuplicateMessageTemplate';
+        path = '/message/DuplicateMessageTemplate';
+        request;
+        response;
+    }
+    CoreManagement.DuplicateMessageTemplate = DuplicateMessageTemplate;
     /**
      * Duplicate the requirements of an existing set to a new set.
      *
@@ -3735,6 +3878,34 @@ If available a Description and/or DefaultValue will be returned
         response;
     }
     CoreManagement.GetAvailableShippingMethodHandlers = GetAvailableShippingMethodHandlers;
+    /**
+     * Returns available survey triggers.
+     *
+     * @export
+     * @class GetAvailableSurveyTriggers
+     * @implements {EvaService}
+     */
+    class GetAvailableSurveyTriggers {
+        name = 'CoreManagement:GetAvailableSurveyTriggers';
+        path = '/message/GetAvailableSurveyTriggers';
+        request;
+        response;
+    }
+    CoreManagement.GetAvailableSurveyTriggers = GetAvailableSurveyTriggers;
+    /**
+     * Get all available surveys for user
+     *
+     * @export
+     * @class GetAvailableSurveys
+     * @implements {EvaService}
+     */
+    class GetAvailableSurveys {
+        name = 'CoreManagement:GetAvailableSurveys';
+        path = '/message/GetAvailableSurveys';
+        request;
+        response;
+    }
+    CoreManagement.GetAvailableSurveys = GetAvailableSurveys;
     /**
      * Get the available UserProperties on which requirements can be set.
      *
@@ -4466,6 +4637,20 @@ At this moment the supported DeviceTypes are:
         response;
     }
     CoreManagement.GetOrderLoyaltyProgramPaymentTypes = GetOrderLoyaltyProgramPaymentTypes;
+    /**
+     * GetOrganizationUnitCompany
+     *
+     * @export
+     * @class GetOrganizationUnitCompany
+     * @implements {EvaService}
+     */
+    class GetOrganizationUnitCompany {
+        name = 'CoreManagement:GetOrganizationUnitCompany';
+        path = '/message/GetOrganizationUnitCompany';
+        request;
+        response;
+    }
+    CoreManagement.GetOrganizationUnitCompany = GetOrganizationUnitCompany;
     /**
      * Gets an `OrganizationUnitSet` by its ID and returns the set's basic information.
      *
@@ -5059,6 +5244,48 @@ These handlers are custom build to fetch values for ProductRequirements from ext
         response;
     }
     CoreManagement.GetSupportedFunctionalities = GetSupportedFunctionalities;
+    /**
+     * Get the survey
+     *
+     * @export
+     * @class GetSurveyByID
+     * @implements {EvaService}
+     */
+    class GetSurveyByID {
+        name = 'CoreManagement:GetSurveyByID';
+        path = '/message/GetSurveyByID';
+        request;
+        response;
+    }
+    CoreManagement.GetSurveyByID = GetSurveyByID;
+    /**
+     * Get a question that is already answered (to navigate back and forth in the survey)
+     *
+     * @export
+     * @class GetSurveyQuestionAnswer
+     * @implements {EvaService}
+     */
+    class GetSurveyQuestionAnswer {
+        name = 'CoreManagement:GetSurveyQuestionAnswer';
+        path = '/message/GetSurveyQuestionAnswer';
+        request;
+        response;
+    }
+    CoreManagement.GetSurveyQuestionAnswer = GetSurveyQuestionAnswer;
+    /**
+     * Get the survey question
+     *
+     * @export
+     * @class GetSurveyQuestionByID
+     * @implements {EvaService}
+     */
+    class GetSurveyQuestionByID {
+        name = 'CoreManagement:GetSurveyQuestionByID';
+        path = '/message/GetSurveyQuestionByID';
+        request;
+        response;
+    }
+    CoreManagement.GetSurveyQuestionByID = GetSurveyQuestionByID;
     /**
      * List the UnitOfMeasures
      *
@@ -6636,6 +6863,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
@@ -6720,6 +6949,34 @@ The page size `Limit` has a maximum value of `1.024` for this service (unless `D
         response;
     }
     CoreManagement.ListSupplierProducts = ListSupplierProducts;
+    /**
+     * List the survey questions
+     *
+     * @export
+     * @class ListSurveyQuestions
+     * @implements {EvaService}
+     */
+    class ListSurveyQuestions {
+        name = 'CoreManagement:ListSurveyQuestions';
+        path = '/message/ListSurveyQuestions';
+        request;
+        response;
+    }
+    CoreManagement.ListSurveyQuestions = ListSurveyQuestions;
+    /**
+     * List the surveys
+     *
+     * @export
+     * @class ListSurveys
+     * @implements {EvaService}
+     */
+    class ListSurveys {
+        name = 'CoreManagement:ListSurveys';
+        path = '/message/ListSurveys';
+        request;
+        response;
+    }
+    CoreManagement.ListSurveys = ListSurveys;
     /**
      * TODO: Needs documentation
      *
@@ -6996,6 +7253,25 @@ Also the MessageTemplate `QRCodePrintingTemplate` can be configured in Stencil.
         response;
     }
     CoreManagement.ProcessUnshippedPurchaseOrdersFromExcel = ProcessUnshippedPurchaseOrdersFromExcel;
+    /**
+     * 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 {
+        name = 'CoreManagement:PublishSurvey';
+        path = '/message/PublishSurvey';
+        request;
+        response;
+    }
+    CoreManagement.PublishSurvey = PublishSurvey;
     /**
      * Push bought products for users. Only accepts 10000 users per request
      *
@@ -7869,6 +8145,20 @@ Will apply all changes or no changes in case of an error
         response;
     }
     CoreManagement.SetSettings = SetSettings;
+    /**
+     * Takes in all routings of a question and sets their sequences.
+     *
+     * @export
+     * @class SetSurveyQuestionRoutingSequences
+     * @implements {EvaService}
+     */
+    class SetSurveyQuestionRoutingSequences {
+        name = 'CoreManagement:SetSurveyQuestionRoutingSequences';
+        path = '/message/SetSurveyQuestionRoutingSequences';
+        request;
+        response;
+    }
+    CoreManagement.SetSurveyQuestionRoutingSequences = SetSurveyQuestionRoutingSequences;
     /**
      * Update the Roles for an User. The roles provided will replace any existing roles on this user!
 
@@ -7887,6 +8177,20 @@ The UserType defines as which UserType the User will act when logging in. For em
         response;
     }
     CoreManagement.SetUserRoles = SetUserRoles;
+    /**
+     * Start a survey
+     *
+     * @export
+     * @class StartSurvey
+     * @implements {EvaService}
+     */
+    class StartSurvey {
+        name = 'CoreManagement:StartSurvey';
+        path = '/message/StartSurvey';
+        request;
+        response;
+    }
+    CoreManagement.StartSurvey = StartSurvey;
     /**
      * Unblock a users subscription.
      *
@@ -8551,6 +8855,20 @@ When the budget is cleared or raised above the current used budget, or `Deactiva
         response;
     }
     CoreManagement.UpdateOrderLedgerType = UpdateOrderLedgerType;
+    /**
+     * Updates the details of companies associated with the organization unit type.
+     *
+     * @export
+     * @class UpdateOrganizationUnitCompany
+     * @implements {EvaService}
+     */
+    class UpdateOrganizationUnitCompany {
+        name = 'CoreManagement:UpdateOrganizationUnitCompany';
+        path = '/message/UpdateOrganizationUnitCompany';
+        request;
+        response;
+    }
+    CoreManagement.UpdateOrganizationUnitCompany = UpdateOrganizationUnitCompany;
     /**
      * Update the Cashhandler for an additional Currency
      *
@@ -9166,6 +9484,50 @@ Updates the given requirements and removes all other requirements from the Subsc
         response;
     }
     CoreManagement.UpdateSupplierProductStock = UpdateSupplierProductStock;
+    /**
+     * 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 {
+        name = 'CoreManagement:UpdateSurvey';
+        path = '/message/UpdateSurvey';
+        request;
+        response;
+    }
+    CoreManagement.UpdateSurvey = UpdateSurvey;
+    /**
+     * Update a survey question
+     *
+     * @export
+     * @class UpdateSurveyQuestion
+     * @implements {EvaService}
+     */
+    class UpdateSurveyQuestion {
+        name = 'CoreManagement:UpdateSurveyQuestion';
+        path = '/message/UpdateSurveyQuestion';
+        request;
+        response;
+    }
+    CoreManagement.UpdateSurveyQuestion = UpdateSurveyQuestion;
+    /**
+     * Update a survey question route
+     *
+     * @export
+     * @class UpdateSurveyQuestionRoute
+     * @implements {EvaService}
+     */
+    class UpdateSurveyQuestionRoute {
+        name = 'CoreManagement:UpdateSurveyQuestionRoute';
+        path = '/message/UpdateSurveyQuestionRoute';
+        request;
+        response;
+    }
+    CoreManagement.UpdateSurveyQuestionRoute = UpdateSurveyQuestionRoute;
     /**
      * Update an existing UnitOfMeasure
      *