oro-sdk-apis 1.55.0 → 1.56.0

package/package.json

@@ -1,5 +1,5 @@
 {
-    "version": "1.55.0",
+    "version": "1.56.0",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",
     "files": [

package/src/models/workflow.ts

@@ -268,6 +268,32 @@ export interface WorkflowData {
      * (optional) the description of the service this workflow provides
      */
     serviceDescription?: string
+    /**
+     * (optional) rules to hide certain payment plans depending on the workflow answers
+     */
+    hidePlanRules?: HidePlanRule[]
+}
+
+export interface HidePlanRule {
+    /**
+     * the stripe plan id from the practice service
+     */
+    idPlan: string
+    /**
+     * Questions to apply yup rules on in, if rules are met then hide the plan
+     */
+    rules: QuestionHidePlanRule | QuestionHidePlanRule[] | QuestionHidePlanRule[][]
+}
+
+export interface QuestionHidePlanRule {
+    /**
+     * the id of the question to check the rule on
+     */
+    questionId: string
+    /**
+     * a collection of yup validated rules (same exact syntax we used for the workflow formValidation field, please reuse same functions)
+     */
+    yupRuleValueToHide: any
 }
 
 /**