@epilot/customer-portal-client 0.35.0 → 0.36.0

package/dist/openapi.d.ts

@@ -4579,6 +4579,12 @@ declare namespace Components {
              * 2021-02-09T12:41:43.662Z
              */
             last_modified_at?: string; // date-time
+            /**
+             * The id of the portal
+             * example:
+             * 453ad7bf-86d5-46c8-8252-bcc868df5e3c
+             */
+            portal_id?: string;
         }
         export interface PageRequest {
             [name: string]: any;
@@ -7499,6 +7505,7 @@ declare namespace Paths {
     }
     namespace CheckContactExistsV3 {
         namespace Parameters {
+            export type Domain = string;
             export type PortalId = /**
              * ID of the portal
              * example:
@@ -7507,7 +7514,8 @@ declare namespace Paths {
             Components.Schemas.PortalId;
         }
         export interface QueryParameters {
-            portal_id: Parameters.PortalId;
+            portal_id?: Parameters.PortalId;
+            domain?: Parameters.Domain;
         }
         export type RequestBody = Components.Schemas.ContactExistsRequest;
         namespace Responses {
@@ -7748,6 +7756,7 @@ declare namespace Paths {
     }
     namespace CreateUserV3 {
         namespace Parameters {
+            export type Domain = string;
             export type PortalId = /**
              * ID of the portal
              * example:
@@ -7756,7 +7765,8 @@ declare namespace Paths {
             Components.Schemas.PortalId;
         }
         export interface QueryParameters {
-            portal_id: Parameters.PortalId;
+            portal_id?: Parameters.PortalId;
+            domain?: Parameters.Domain;
         }
         export type RequestBody = Components.Schemas.CreateUserRequest;
         namespace Responses {
@@ -10624,6 +10634,32 @@ declare namespace Paths {
             export type $500 = Components.Responses.InternalServerError;
         }
     }
+    namespace GetPortalWidgetsV3 {
+        namespace Parameters {
+            export type ContractId = /**
+             * Entity ID
+             * example:
+             * 5da0a718-c822-403d-9f5d-20d4584e0528
+             */
+            Components.Schemas.EntityId /* uuid */;
+            export type PortalId = /**
+             * ID of the portal
+             * example:
+             * 453ad7bf-86d5-46c8-8252-bcc868df5e3c
+             */
+            Components.Schemas.PortalId;
+        }
+        export interface QueryParameters {
+            portal_id: Parameters.PortalId;
+            contract_id?: Parameters.ContractId;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.UpsertPortalWidget;
+            export type $401 = Components.Responses.Unauthorized;
+            export type $403 = Components.Responses.Forbidden;
+            export type $500 = Components.Responses.InternalServerError;
+        }
+    }
     namespace GetPrices {
         namespace Parameters {
             export type AppId = string;
@@ -11448,6 +11484,10 @@ declare namespace Paths {
              * The portal ID to look up the portal config. When provided, takes precedence over origin.
              */
             portal_id?: string;
+            /**
+             * Portal domain for identification. Alternative to portal_id or origin.
+             */
+            domain?: string;
         }
         namespace Responses {
             export interface $200 {
@@ -11784,6 +11824,30 @@ declare namespace Paths {
             export type $500 = Components.Responses.InternalServerError;
         }
     }
+    namespace SavePortalFilesV3 {
+        namespace Parameters {
+            export type PortalId = /**
+             * ID of the portal
+             * example:
+             * 453ad7bf-86d5-46c8-8252-bcc868df5e3c
+             */
+            Components.Schemas.PortalId;
+        }
+        export interface QueryParameters {
+            portal_id: Parameters.PortalId;
+        }
+        export type RequestBody = Components.Schemas.SavePortalFile;
+        namespace Responses {
+            export interface $201 {
+                createdFiles?: /* The file entity */ Components.Schemas.File[];
+            }
+            export type $400 = Components.Responses.InvalidRequest;
+            export type $401 = Components.Responses.Unauthorized;
+            export type $403 = Components.Responses.Forbidden;
+            export type $404 = Components.Responses.NotFound;
+            export type $500 = Components.Responses.InternalServerError;
+        }
+    }
     namespace SearchPaymentRelationsInEntities {
         namespace Parameters {
             export type Id = /**
@@ -11895,6 +11959,7 @@ declare namespace Paths {
              * 5da0a718-c822-403d-9f5d-20d4584e0528
              */
             export type ContactId = string; // uuid
+            export type Domain = string;
             /**
              * example:
              * 123
@@ -11908,12 +11973,13 @@ declare namespace Paths {
             Components.Schemas.PortalId;
         }
         export interface QueryParameters {
-            portal_id: Parameters.PortalId;
-            org_id: /**
+            portal_id?: Parameters.PortalId;
+            org_id?: /**
              * example:
              * 123
              */
             Parameters.OrgId;
+            domain?: Parameters.Domain;
             contact_id?: /**
              * example:
              * 5da0a718-c822-403d-9f5d-20d4584e0528
@@ -12072,6 +12138,7 @@ declare namespace Paths {
     }
     namespace TriggerEntityAccessEventV3 {
         namespace Parameters {
+            export type Domain = string;
             export type EntityId = /**
              * Entity ID
              * example:
@@ -12099,7 +12166,8 @@ declare namespace Paths {
         }
         export interface QueryParameters {
             entity_id?: Parameters.EntityId;
-            portal_id: Parameters.PortalId;
+            portal_id?: Parameters.PortalId;
+            domain?: Parameters.Domain;
         }
         namespace Responses {
             export interface $200 {
@@ -12476,6 +12544,27 @@ declare namespace Paths {
             export type $500 = Components.Responses.InternalServerError;
         }
     }
+    namespace UpsertPortalWidgetV3 {
+        namespace Parameters {
+            export type PortalId = /**
+             * ID of the portal
+             * example:
+             * 453ad7bf-86d5-46c8-8252-bcc868df5e3c
+             */
+            Components.Schemas.PortalId;
+        }
+        export interface QueryParameters {
+            portal_id: Parameters.PortalId;
+        }
+        export type RequestBody = Components.Schemas.UpsertPortalWidget;
+        namespace Responses {
+            export type $201 = Components.Schemas.UpsertPortalWidget;
+            export type $400 = Components.Responses.InvalidRequest;
+            export type $401 = Components.Responses.Unauthorized;
+            export type $403 = Components.Responses.Forbidden;
+            export type $500 = Components.Responses.InternalServerError;
+        }
+    }
     namespace UserExists {
         namespace Parameters {
             /**
@@ -12521,6 +12610,7 @@ declare namespace Paths {
     }
     namespace UserExistsV3 {
         namespace Parameters {
+            export type Domain = string;
             /**
              * Email Address of the portal user
              * example:
@@ -12528,7 +12618,7 @@ declare namespace Paths {
              */
             export type Email = string;
             /**
-             * Organization ID
+             * Organization ID (required if domain is not provided)
              * example:
              * 123
              */
@@ -12547,13 +12637,14 @@ declare namespace Paths {
              * user@example.com
              */
             Parameters.Email;
-            org_id: /**
-             * Organization ID
+            org_id?: /**
+             * Organization ID (required if domain is not provided)
              * example:
              * 123
              */
             Parameters.OrgId;
             portal_id?: Parameters.PortalId;
+            domain?: Parameters.Domain;
         }
         namespace Responses {
             export interface $200 {
@@ -12785,7 +12876,11 @@ export interface OperationMethods {
   /**
    * createUserV3 - createUserV3
    * 
-   * Registers a portal user with portal id
+   * Registers a portal user.
+   * Supports two identification methods:
+   * 1. Using portal_id
+   * 2. Using domain
+   * 
    */
   'createUserV3'(
     parameters?: Parameters<Paths.CreateUserV3.QueryParameters> | null,
@@ -13086,6 +13181,36 @@ export interface OperationMethods {
     data?: Paths.UpsertPortalWidget.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.UpsertPortalWidget.Responses.$201>
+  /**
+   * getPortalWidgetsV3 - getPortalWidgetsV3
+   * 
+   * Retrieves the widgets of a portal by portal_id.
+   */
+  'getPortalWidgetsV3'(
+    parameters?: Parameters<Paths.GetPortalWidgetsV3.QueryParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetPortalWidgetsV3.Responses.$200>
+  /**
+   * upsertPortalWidgetV3 - upsertPortalWidgetV3
+   * 
+   * Upsert widget for a portal by portal_id.
+   */
+  'upsertPortalWidgetV3'(
+    parameters?: Parameters<Paths.UpsertPortalWidgetV3.QueryParameters> | null,
+    data?: Paths.UpsertPortalWidgetV3.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.UpsertPortalWidgetV3.Responses.$201>
+  /**
+   * savePortalFilesV3 - savePortalFilesV3
+   * 
+   * Add files to portal by portal_id
+   */
+  'savePortalFilesV3'(
+    parameters?: Parameters<Paths.SavePortalFilesV3.QueryParameters> | null,
+    data?: Paths.SavePortalFilesV3.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.SavePortalFilesV3.Responses.$201>
   /**
    * replaceECPTemplateVariables - replaceECPTemplateVariables
    * 
@@ -13210,6 +13335,10 @@ export interface OperationMethods {
    * checkContactExistsV3 - checkContactExistsV3
    * 
    * True if contact with given identifiers exists.
+   * Supports two identification methods:
+   * 1. Using portal_id
+   * 2. Using domain
+   * 
    */
   'checkContactExistsV3'(
     parameters?: Parameters<Paths.CheckContactExistsV3.QueryParameters> | null,
@@ -13319,7 +13448,11 @@ export interface OperationMethods {
   /**
    * userExistsV3 - userExistsV3
    * 
-   * Checks whether a user exists in the portal
+   * Checks whether a user exists in the portal.
+   * Supports two identification methods:
+   * 1. Using org_id + portal_id
+   * 2. Using domain
+   * 
    */
   'userExistsV3'(
     parameters?: Parameters<Paths.UserExistsV3.QueryParameters> | null,
@@ -13666,6 +13799,11 @@ export interface OperationMethods {
    * 
    * Token is valid for 5 minutes.
    * 
+   * Supports three identification methods (at least one required):
+   * 1. Using portal_id (takes precedence)
+   * 2. Using domain
+   * 3. Using origin (legacy)
+   * 
    */
   'loginToPortalAsUser'(
     parameters?: Parameters<UnknownParamsObject> | null,
@@ -13685,7 +13823,11 @@ export interface OperationMethods {
   /**
    * triggerEntityAccessEventV3 - triggerEntityAccessEventV3
    * 
-   * Trigger entity access event for a portal user
+   * Trigger entity access event for a portal user.
+   * Supports two identification methods:
+   * 1. Using portal_id
+   * 2. Using domain
+   * 
    */
   'triggerEntityAccessEventV3'(
     parameters?: Parameters<Paths.TriggerEntityAccessEventV3.QueryParameters & Paths.TriggerEntityAccessEventV3.PathParameters> | null,
@@ -13805,7 +13947,11 @@ export interface OperationMethods {
    * 
    * Verifies the user with the issuer and matches the identity to an epilot user (or creates a new user).
    * 
-   * Returns parameters to be used with CUSTOM_AUTH flow against Cognito
+   * Returns parameters to be used with CUSTOM_AUTH flow against Cognito.
+   * 
+   * Supports two identification methods:
+   * 1. Using org_id + portal_id
+   * 2. Using domain
    * 
    */
   'ssoLoginV3'(
@@ -14168,7 +14314,11 @@ export interface PathsDictionary {
     /**
      * createUserV3 - createUserV3
      * 
-     * Registers a portal user with portal id
+     * Registers a portal user.
+     * Supports two identification methods:
+     * 1. Using portal_id
+     * 2. Using domain
+     * 
      */
     'post'(
       parameters?: Parameters<Paths.CreateUserV3.QueryParameters> | null,
@@ -14520,6 +14670,40 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetPortalWidgets.Responses.$200>
   }
+  ['/v3/portal/widgets']: {
+    /**
+     * getPortalWidgetsV3 - getPortalWidgetsV3
+     * 
+     * Retrieves the widgets of a portal by portal_id.
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetPortalWidgetsV3.QueryParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetPortalWidgetsV3.Responses.$200>
+    /**
+     * upsertPortalWidgetV3 - upsertPortalWidgetV3
+     * 
+     * Upsert widget for a portal by portal_id.
+     */
+    'post'(
+      parameters?: Parameters<Paths.UpsertPortalWidgetV3.QueryParameters> | null,
+      data?: Paths.UpsertPortalWidgetV3.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.UpsertPortalWidgetV3.Responses.$201>
+  }
+  ['/v3/portal/portal/files']: {
+    /**
+     * savePortalFilesV3 - savePortalFilesV3
+     * 
+     * Add files to portal by portal_id
+     */
+    'post'(
+      parameters?: Parameters<Paths.SavePortalFilesV3.QueryParameters> | null,
+      data?: Paths.SavePortalFilesV3.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.SavePortalFilesV3.Responses.$201>
+  }
   ['/v2/portal/replace-ecp-template-variables']: {
     /**
      * replaceECPTemplateVariables - replaceECPTemplateVariables
@@ -14667,6 +14851,10 @@ export interface PathsDictionary {
      * checkContactExistsV3 - checkContactExistsV3
      * 
      * True if contact with given identifiers exists.
+     * Supports two identification methods:
+     * 1. Using portal_id
+     * 2. Using domain
+     * 
      */
     'post'(
       parameters?: Parameters<Paths.CheckContactExistsV3.QueryParameters> | null,
@@ -14794,7 +14982,11 @@ export interface PathsDictionary {
     /**
      * userExistsV3 - userExistsV3
      * 
-     * Checks whether a user exists in the portal
+     * Checks whether a user exists in the portal.
+     * Supports two identification methods:
+     * 1. Using org_id + portal_id
+     * 2. Using domain
+     * 
      */
     'get'(
       parameters?: Parameters<Paths.UserExistsV3.QueryParameters> | null,
@@ -15201,6 +15393,11 @@ export interface PathsDictionary {
      * 
      * Token is valid for 5 minutes.
      * 
+     * Supports three identification methods (at least one required):
+     * 1. Using portal_id (takes precedence)
+     * 2. Using domain
+     * 3. Using origin (legacy)
+     * 
      */
     'post'(
       parameters?: Parameters<UnknownParamsObject> | null,
@@ -15224,7 +15421,11 @@ export interface PathsDictionary {
     /**
      * triggerEntityAccessEventV3 - triggerEntityAccessEventV3
      * 
-     * Trigger entity access event for a portal user
+     * Trigger entity access event for a portal user.
+     * Supports two identification methods:
+     * 1. Using portal_id
+     * 2. Using domain
+     * 
      */
     'post'(
       parameters?: Parameters<Paths.TriggerEntityAccessEventV3.QueryParameters & Paths.TriggerEntityAccessEventV3.PathParameters> | null,
@@ -15366,7 +15567,11 @@ export interface PathsDictionary {
      * 
      * Verifies the user with the issuer and matches the identity to an epilot user (or creates a new user).
      * 
-     * Returns parameters to be used with CUSTOM_AUTH flow against Cognito
+     * Returns parameters to be used with CUSTOM_AUTH flow against Cognito.
+     * 
+     * Supports two identification methods:
+     * 1. Using org_id + portal_id
+     * 2. Using domain
      * 
      */
     'post'(

package/package.json

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

package/src/openapi-runtime.json

@@ -55,7 +55,12 @@
           {
             "in": "query",
             "name": "portal_id",
-            "required": true
+            "required": false
+          },
+          {
+            "in": "query",
+            "name": "domain",
+            "required": false
           }
         ],
         "requestBody": {
@@ -632,6 +637,60 @@
         "responses": {}
       }
     },
+    "/v3/portal/widgets": {
+      "get": {
+        "operationId": "getPortalWidgetsV3",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "portal_id",
+            "required": true
+          },
+          {
+            "in": "query",
+            "name": "contract_id",
+            "required": false
+          }
+        ],
+        "responses": {}
+      },
+      "post": {
+        "operationId": "upsertPortalWidgetV3",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "portal_id",
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      }
+    },
+    "/v3/portal/portal/files": {
+      "post": {
+        "operationId": "savePortalFilesV3",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "portal_id",
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      }
+    },
     "/v2/portal/replace-ecp-template-variables": {
       "post": {
         "operationId": "replaceECPTemplateVariables",
@@ -769,7 +828,12 @@
           {
             "in": "query",
             "name": "portal_id",
-            "required": true
+            "required": false
+          },
+          {
+            "in": "query",
+            "name": "domain",
+            "required": false
           }
         ],
         "requestBody": {
@@ -925,12 +989,17 @@
           {
             "in": "query",
             "name": "org_id",
-            "required": true
+            "required": false
           },
           {
             "in": "query",
             "name": "portal_id",
             "required": false
+          },
+          {
+            "in": "query",
+            "name": "domain",
+            "required": false
           }
         ],
         "responses": {}
@@ -1542,7 +1611,12 @@
           {
             "name": "portal_id",
             "in": "query",
-            "required": true
+            "required": false
+          },
+          {
+            "name": "domain",
+            "in": "query",
+            "required": false
           }
         ],
         "responses": {}
@@ -1743,12 +1817,17 @@
           {
             "in": "query",
             "name": "portal_id",
-            "required": true
+            "required": false
           },
           {
             "in": "query",
             "name": "org_id",
-            "required": true
+            "required": false
+          },
+          {
+            "in": "query",
+            "name": "domain",
+            "required": false
           },
           {
             "in": "query",