@epilot/customer-portal-client 0.16.0 → 0.16.1-rc.2

package/dist/openapi.d.ts

@@ -24,6 +24,10 @@ declare namespace Components {
         export type Unauthorized = Schemas.ErrorResp;
     }
     namespace Schemas {
+        export interface ActionLabel {
+            en?: string | null;
+            de?: string | null;
+        }
         export interface ActionWidget {
             id: string;
             type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET";
@@ -805,6 +809,15 @@ declare namespace Components {
              * 5da0a718-c822-403d-9f5d-20d4584e0528
              */
             EntityId /* uuid */;
+            /**
+             * ID of the advanced MFA with login link and login code
+             */
+            advancedMFA?: /**
+             * Entity ID
+             * example:
+             * 5da0a718-c822-403d-9f5d-20d4584e0528
+             */
+            EntityId /* uuid */;
             /**
              * ID of the email template for forgot password
              */
@@ -850,6 +863,15 @@ declare namespace Components {
              * 5da0a718-c822-403d-9f5d-20d4584e0528
              */
             EntityId /* uuid */;
+            /**
+             * ID of the email template for workflow step assignment
+             */
+            onWorkflowStepAssigned?: /**
+             * Entity ID
+             * example:
+             * 5da0a718-c822-403d-9f5d-20d4584e0528
+             */
+            EntityId /* uuid */;
         }
         export interface Entity {
             [name: string]: any;
@@ -1310,6 +1332,12 @@ declare namespace Components {
              */
             paid_date?: string; // date
         }
+        export interface JourneyActions {
+            journey_id?: string | null;
+            action_label?: ActionLabel;
+            slug?: string | null;
+            rules?: Rule[] | null;
+        }
         /**
          * The meter entity
          */
@@ -1633,6 +1661,14 @@ declare namespace Components {
                  * Billing feature flag
                  */
                 billing?: boolean;
+                /**
+                 * Change due date feature flag
+                 */
+                change_due_date?: boolean;
+                /**
+                 * Advanced MFA feature flag
+                 */
+                advanced_mfa?: boolean;
             };
             /**
              * AWS Cognito Pool details for the portal
@@ -1656,6 +1692,41 @@ declare namespace Components {
                  * eu-central-1_CUEQRNbUb
                  */
                 cognito_user_pool_id?: string;
+                /**
+                 * Password policy for the portal
+                 */
+                password_policy?: {
+                    /**
+                     * Minimum password length
+                     * example:
+                     * 8
+                     */
+                    minimum_length?: number;
+                    /**
+                     * Require lowercase characters
+                     * example:
+                     * true
+                     */
+                    require_lowercase?: boolean;
+                    /**
+                     * Require uppercase characters
+                     * example:
+                     * true
+                     */
+                    require_uppercase?: boolean;
+                    /**
+                     * Require numbers
+                     * example:
+                     * true
+                     */
+                    require_numbers?: boolean;
+                    /**
+                     * Require symbols
+                     * example:
+                     * true
+                     */
+                    require_symbols?: boolean;
+                };
             };
             /**
              * Stringified object with configuration details
@@ -2043,6 +2114,11 @@ declare namespace Components {
              */
             paid_date?: string; // date
         }
+        export interface Rule {
+            entity?: string | null;
+            attribute?: string | null;
+            attribute_value?: string | null;
+        }
         export interface SaveEntityFile {
             entity_id: /**
              * Entity ID
@@ -2224,6 +2300,14 @@ declare namespace Components {
                  * Billing feature flag
                  */
                 billing?: boolean;
+                /**
+                 * Change due date feature flag
+                 */
+                change_due_date?: boolean;
+                /**
+                 * Advanced MFA feature flag
+                 */
+                advanced_mfa?: boolean;
             };
             /**
              * AWS Cognito Pool details for the portal
@@ -2247,6 +2331,41 @@ declare namespace Components {
                  * eu-central-1_CUEQRNbUb
                  */
                 cognito_user_pool_id?: string;
+                /**
+                 * Password policy for the portal
+                 */
+                password_policy?: {
+                    /**
+                     * Minimum password length
+                     * example:
+                     * 8
+                     */
+                    minimum_length?: number;
+                    /**
+                     * Require lowercase characters
+                     * example:
+                     * true
+                     */
+                    require_lowercase?: boolean;
+                    /**
+                     * Require uppercase characters
+                     * example:
+                     * true
+                     */
+                    require_uppercase?: boolean;
+                    /**
+                     * Require numbers
+                     * example:
+                     * true
+                     */
+                    require_numbers?: boolean;
+                    /**
+                     * Require symbols
+                     * example:
+                     * true
+                     */
+                    require_symbols?: boolean;
+                };
             };
             /**
              * Stringified object with configuration details
@@ -2731,7 +2850,6 @@ declare namespace Paths {
         namespace Responses {
             export interface $201 {
                 message: "User created successfully";
-                response: /* The portal user entity */ Components.Schemas.PortalUser;
             }
             export type $400 = Components.Responses.InvalidRequest;
             export type $500 = Components.Responses.InternalServerError;
@@ -3088,6 +3206,7 @@ declare namespace Paths {
                 entity?: /* The mapped contact of the portal user */ Components.Schemas.Contact;
                 files?: /* The file entity */ Components.Schemas.File[];
                 relations?: Components.Schemas.EntityItem[];
+                journey_actions?: Components.Schemas.JourneyActions[];
             }
             export type $401 = Components.Responses.Unauthorized;
             export type $403 = Components.Responses.Forbidden;
@@ -3175,6 +3294,7 @@ declare namespace Paths {
                  * }
                  */
                 Components.Schemas.WorkflowExecution[];
+                journey_actions?: Components.Schemas.JourneyActions[];
             }
             export type $401 = Components.Responses.Unauthorized;
             export type $403 = Components.Responses.Forbidden;
@@ -3309,6 +3429,27 @@ declare namespace Paths {
             export type $500 = Components.Responses.InternalServerError;
         }
     }
+    namespace GetExternalLinks {
+        namespace Parameters {
+            export type ContactId = /**
+             * Entity ID
+             * example:
+             * 5da0a718-c822-403d-9f5d-20d4584e0528
+             */
+            Components.Schemas.EntityId /* uuid */;
+            export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
+        }
+        export interface QueryParameters {
+            origin?: Parameters.Origin;
+            contactId?: Parameters.ContactId;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.JourneyActions[];
+            export type $401 = Components.Responses.Unauthorized;
+            export type $403 = Components.Responses.Forbidden;
+            export type $500 = Components.Responses.InternalServerError;
+        }
+    }
     namespace GetFileById {
         namespace Parameters {
             export type Id = /**
@@ -3419,6 +3560,7 @@ declare namespace Paths {
                  * }
                  */
                 Components.Schemas.WorkflowExecution[];
+                journey_actions?: Components.Schemas.JourneyActions[];
             }
             export type $401 = Components.Responses.Unauthorized;
             export type $403 = Components.Responses.Forbidden;
@@ -3509,6 +3651,7 @@ declare namespace Paths {
                  * }
                  */
                 Components.Schemas.WorkflowExecution[];
+                journey_actions?: Components.Schemas.JourneyActions[];
             }
             export type $401 = Components.Responses.Unauthorized;
             export type $403 = Components.Responses.Forbidden;
@@ -4454,6 +4597,16 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeletePortal.Responses.$204>
+  /**
+   * getExternalLinks - getExternalLinks
+   * 
+   * Retrieves the portal configuration external links.
+   */
+  'getExternalLinks'(
+    parameters?: Parameters<Paths.GetExternalLinks.QueryParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetExternalLinks.Responses.$200>
   /**
    * getPublicPortalConfig - getPublicPortalConfig
    * 
@@ -5137,6 +5290,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DeletePortal.Responses.$204>
   }
+  ['/v2/portal/external-links']: {
+    /**
+     * getExternalLinks - getExternalLinks
+     * 
+     * Retrieves the portal configuration external links.
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetExternalLinks.QueryParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetExternalLinks.Responses.$200>
+  }
   ['/v2/portal/public/portal/config']: {
     /**
      * getPublicPortalConfig - getPublicPortalConfig

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/customer-portal-client",
-  "version": "0.16.0",
+  "version": "0.16.1-rc.2",
   "description": "API Client for epilot portal API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/openapi-runtime.json

@@ -109,6 +109,23 @@
         ]
       }
     },
+    "/v2/portal/external-links": {
+      "get": {
+        "operationId": "getExternalLinks",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "origin",
+            "required": false
+          },
+          {
+            "in": "query",
+            "name": "contactId",
+            "required": false
+          }
+        ]
+      }
+    },
     "/v2/portal/public/portal/config": {
       "get": {
         "operationId": "getPublicPortalConfig",

package/src/openapi.json

@@ -140,9 +140,6 @@
                       "enum": [
                         "User created successfully"
                       ]
-                    },
-                    "response": {
-                      "$ref": "#/components/schemas/PortalUser"
                     }
                   }
                 }
@@ -433,6 +430,66 @@
         }
       }
     },
+    "/v2/portal/external-links": {
+      "get": {
+        "operationId": "getExternalLinks",
+        "summary": "getExternalLinks",
+        "description": "Retrieves the portal configuration external links.",
+        "tags": [
+          "ECP Admin",
+          "ECP"
+        ],
+        "parameters": [
+          {
+            "in": "query",
+            "name": "origin",
+            "required": false,
+            "schema": {
+              "$ref": "#/components/schemas/Origin"
+            },
+            "description": "Origin of the portal"
+          },
+          {
+            "in": "query",
+            "name": "contactId",
+            "required": false,
+            "schema": {
+              "$ref": "#/components/schemas/EntityId"
+            },
+            "description": "Contact ID of the user"
+          }
+        ],
+        "security": [
+          {
+            "EitherAuth": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Portal config links retrieved successfully.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/JourneyActions"
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "$ref": "#/components/responses/Unauthorized"
+          },
+          "403": {
+            "$ref": "#/components/responses/Forbidden"
+          },
+          "500": {
+            "$ref": "#/components/responses/InternalServerError"
+          }
+        }
+      }
+    },
     "/v2/portal/public/portal/config": {
       "get": {
         "operationId": "getPublicPortalConfig",
@@ -1129,6 +1186,12 @@
                       "items": {
                         "$ref": "#/components/schemas/EntityItem"
                       }
+                    },
+                    "journey_actions": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/JourneyActions"
+                      }
                     }
                   }
                 }
@@ -1954,6 +2017,12 @@
                       "items": {
                         "$ref": "#/components/schemas/WorkflowExecution"
                       }
+                    },
+                    "journey_actions": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/JourneyActions"
+                      }
                     }
                   }
                 }
@@ -2350,6 +2419,12 @@
                       "items": {
                         "$ref": "#/components/schemas/WorkflowExecution"
                       }
+                    },
+                    "journey_actions": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/JourneyActions"
+                      }
                     }
                   }
                 }
@@ -2571,6 +2646,12 @@
                       "items": {
                         "$ref": "#/components/schemas/WorkflowExecution"
                       }
+                    },
+                    "journey_actions": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/JourneyActions"
+                      }
                     }
                   }
                 }
@@ -4185,6 +4266,11 @@
             "$ref": "#/components/schemas/EntityId",
             "description": "ID of the confirmation email template upon registration"
           },
+          "advancedMFA": {
+            "$ref": "#/components/schemas/EntityId",
+            "nullable": true,
+            "description": "ID of the advanced MFA with login link and login code"
+          },
           "forgotPassword": {
             "$ref": "#/components/schemas/EntityId",
             "description": "ID of the email template for forgot password"
@@ -4204,6 +4290,10 @@
           "onDocUpload": {
             "$ref": "#/components/schemas/EntityId",
             "description": "ID of the email template for document upload"
+          },
+          "onWorkflowStepAssigned": {
+            "$ref": "#/components/schemas/EntityId",
+            "description": "ID of the email template for workflow step assignment"
           }
         }
       },
@@ -4527,6 +4617,14 @@
               "billing": {
                 "type": "boolean",
                 "description": "Billing feature flag"
+              },
+              "change_due_date": {
+                "type": "boolean",
+                "description": "Change due date feature flag"
+              },
+              "advanced_mfa": {
+                "type": "boolean",
+                "description": "Advanced MFA feature flag"
               }
             }
           },
@@ -4548,6 +4646,37 @@
                 "type": "string",
                 "example": "eu-central-1_CUEQRNbUb",
                 "description": "Cognito user pool ID"
+              },
+              "password_policy": {
+                "type": "object",
+                "description": "Password policy for the portal",
+                "properties": {
+                  "minimum_length": {
+                    "type": "integer",
+                    "example": 8,
+                    "description": "Minimum password length"
+                  },
+                  "require_lowercase": {
+                    "type": "boolean",
+                    "example": true,
+                    "description": "Require lowercase characters"
+                  },
+                  "require_uppercase": {
+                    "type": "boolean",
+                    "example": true,
+                    "description": "Require uppercase characters"
+                  },
+                  "require_numbers": {
+                    "type": "boolean",
+                    "example": true,
+                    "description": "Require numbers"
+                  },
+                  "require_symbols": {
+                    "type": "boolean",
+                    "example": true,
+                    "description": "Require symbols"
+                  }
+                }
               }
             }
           },
@@ -6152,6 +6281,61 @@
           "action"
         ]
       },
+      "ActionLabel": {
+        "type": "object",
+        "properties": {
+          "en": {
+            "type": "string",
+            "nullable": true
+          },
+          "de": {
+            "type": "string",
+            "nullable": true
+          }
+        }
+      },
+      "Rule": {
+        "type": "object",
+        "properties": {
+          "entity": {
+            "type": "string",
+            "nullable": true
+          },
+          "attribute": {
+            "type": "string",
+            "nullable": true
+          },
+          "attribute_value": {
+            "type": "string",
+            "nullable": true
+          }
+        }
+      },
+      "JourneyActions": {
+        "type": "object",
+        "properties": {
+          "journey_id": {
+            "type": "string",
+            "nullable": true
+          },
+          "action_label": {
+            "type": "object",
+            "$ref": "#/components/schemas/ActionLabel",
+            "nullable": true
+          },
+          "slug": {
+            "type": "string",
+            "nullable": true
+          },
+          "rules": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Rule"
+            },
+            "nullable": true
+          }
+        }
+      },
       "WorkflowExecution": {
         "type": "object",
         "properties": {},