npm - @epilot/customer-portal-client - Versions diffs - 0.17.2 → 0.17.3-rc.0 - Mend

@epilot/customer-portal-client 0.17.2 → 0.17.3-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/dist/openapi.d.ts CHANGED Viewed

@@ -721,10 +721,6 @@ declare namespace Components {
                 number_of_days_before_restriction?: number;
             }[];
             allowed_file_extensions?: /* Allowed file extensions for upload */ AllowedFileExtensions;
-            /**
-             * Configured Portal extensions
-             */
-            extensions?: ExtensionConfig[];
         }
         /**
          * The mapped contact of the portal user
@@ -1433,80 +1429,107 @@ declare namespace Components {
                  */
                 en: string;
             };
+            /**
+             * Name of the extension.
+             */
+            description: {
+                [name: string]: string;
+                /**
+                 * Name of the extension in English.
+                 */
+                en: string;
+            };
             /**
              * Version of the extension.
              */
             version: string;
             /**
-             * Variables available to the extension configurable by the portal administrator.
+             * Options available to the extension configurable by the portal administrator.
              */
-            variables?: {
+            options?: {
                 /**
-                 * Identifier of the variable. Should not change between updates.
+                 * Identifier of the option. Should not change between updates.
                  */
                 id: string;
                 /**
-                 * Name of the variable.
+                 * Name of the option.
                  */
                 name: {
                     [name: string]: string;
                     /**
-                     * Name of the variable in English.
+                     * Name of the option in English.
                      */
                     en: string;
                 };
                 /**
-                 * Type of the variable.
+                 * Type of the option.
                  */
                 type: "secret";
                 /**
-                 * Description of the variable.
+                 * Description of the option.
                  */
                 description?: {
                     [name: string]: string;
                     /**
-                     * Description of the variable in English.
+                     * Description of the option in English.
                      */
                     en: string;
                 };
                 /**
-                 * Default value of the variable.
+                 * Default value of the option.
                  */
                 default?: string;
                 /**
-                 * Indicate whether the variable is required.
+                 * Indicate whether the option is required.
                  */
                 required?: boolean;
             }[];
             /**
-             * Widgets that can be used by portal administrator.
+             * External links added to the portal.
              */
-            widgets?: ({
-                /**
-                 * Identifier of the widget. Should not change between updates.
-                 */
-                id?: string;
-                /**
-                 * Name of the widget.
-                 */
-                name?: {
-                    [name: string]: string;
+            links?: {
+                type: "seamless";
+                authentication?: {
                     /**
-                     * Name of the widget in English.
+                     * HTTP method to use for authentication
                      */
-                    en: string;
+                    method?: string;
+                    /**
+                     * URL to use for authentication. Supports variable interpolation.
+                     */
+                    url: string;
+                    /**
+                     * Parameters to append to the URL. Supports variable interpolation.
+                     */
+                    params?: {
+                        [name: string]: string;
+                    };
+                    /**
+                     * Headers to use for authentication. Supports variable interpolation.
+                     */
+                    headers?: {
+                        [name: string]: string;
+                    };
+                    /**
+                     * JSON body to use for authentication. Supports variable interpolation.
+                     */
+                    body?: {
+                        [name: string]: string;
+                    };
                 };
-                /**
-                 * Description of the widget.
-                 */
-                description?: {
-                    [name: string]: string;
+                redirect: {
                     /**
-                     * Description of the widget in English.
+                     * URL to redirect to. Supports variable interpolation.
                      */
-                    en: string;
+                    url?: string;
+                    /**
+                     * Parameters to append to the URL. Supports variable interpolation.
+                     */
+                    params?: {
+                        [name: string]: string;
+                    };
                 };
-            } & (ExtensionWidgetSeamlessLink))[];
+            }[];
             /**
              * Hooks that influence the behavior of Portal.
              */
@@ -1516,7 +1539,7 @@ declare namespace Components {
                  */
                 id?: string;
             } & (/**
-             * Hook that replaces the built-in registration identifiers check. This hook makes the specified call whenever a user is trying to register to find the corresponding contact. The expected response to the call is:
+             * Hook that replaces the built-in registration identifiers check. This hook makes a POST call whenever a user is trying to register to find the corresponding contact. The expected response to the call is:
              *   - 200 with body `{ "contactId": "uuid" }` if exactly one contact is found
              *   - 404 if no contact is found or more than contact is found
              *
@@ -1546,96 +1569,97 @@ declare namespace Components {
             id?: string;
         }
         /**
-         * Hook that replaces the built-in registration identifiers check. This hook makes the specified call whenever a user is trying to register to find the corresponding contact. The expected response to the call is:
+         * Hook that replaces the built-in registration identifiers check. This hook makes a POST call whenever a user is trying to register to find the corresponding contact. The expected response to the call is:
          *   - 200 with body `{ "contactId": "uuid" }` if exactly one contact is found
          *   - 404 if no contact is found or more than contact is found
          *
          */
         export interface ExtensionHookRegistrationIdentifiersCheck {
             type: "registrationIdentifiersCheck";
-            call: {
+            authentication?: {
                 /**
-                 * URL to call. Supports variable interpolation.
+                 * HTTP method to use for authentication
+                 */
+                method?: string;
+                /**
+                 * URL to use for authentication. Supports variable interpolation.
                  */
                 url: string;
                 /**
-                 * Parameters to append to the URL.
+                 * Parameters to append to the URL. Supports variable interpolation.
                  */
                 params?: {
                     [name: string]: string;
                 };
                 /**
-                 * Headers to use. Supports variable interpolation.
+                 * Headers to use for authentication. Supports variable interpolation.
                  */
-                headers: {
+                headers?: {
                     [name: string]: string;
                 };
-            };
-        }
-        export interface ExtensionWidget {
-            /**
-             * Identifier of the widget. Should not change between updates.
-             */
-            id?: string;
-            /**
-             * Name of the widget.
-             */
-            name?: {
-                [name: string]: string;
                 /**
-                 * Name of the widget in English.
+                 * JSON body to use for authentication. Supports variable interpolation.
                  */
-                en: string;
+                body?: {
+                    [name: string]: string;
+                };
             };
-            /**
-             * Description of the widget.
-             */
-            description?: {
-                [name: string]: string;
+            call: {
                 /**
-                 * Description of the widget in English.
+                 * URL to call. Supports variable interpolation.
                  */
-                en: string;
+                url: string;
+                /**
+                 * Parameters to append to the URL. Supports variable interpolation.
+                 */
+                params?: {
+                    [name: string]: string;
+                };
+                /**
+                 * Headers to use. Supports variable interpolation.
+                 */
+                headers: {
+                    [name: string]: string;
+                };
             };
         }
-        export interface ExtensionWidgetSeamlessLink {
-            type?: "seamlessLink";
+        export interface ExtensionSeamlessLink {
+            type: "seamless";
             authentication?: {
-                type?: "token";
                 /**
                  * HTTP method to use for authentication
                  */
                 method?: string;
                 /**
-                 * URL to use for authentication
+                 * URL to use for authentication. Supports variable interpolation.
                  */
-                url?: string;
+                url: string;
                 /**
-                 * Parameters to append to the URL.
+                 * Parameters to append to the URL. Supports variable interpolation.
                  */
                 params?: {
                     [name: string]: string;
                 };
                 /**
-                 * Headers to use for authentication
+                 * Headers to use for authentication. Supports variable interpolation.
                  */
                 headers?: {
                     [name: string]: string;
                 };
                 /**
-                 * JSON body to use for authentication
+                 * JSON body to use for authentication. Supports variable interpolation.
                  */
                 body?: {
                     [name: string]: string;
                 };
             };
-            redirect?: {
+            redirect: {
                 /**
-                 * URL to redirect to.
+                 * URL to redirect to. Supports variable interpolation.
                  */
                 url?: string;
                 /**
-                 * Parameters to append to the URL.
+                 * Parameters to append to the URL. Supports variable interpolation.
                  */
                 params?: {
                     [name: string]: string;
@@ -2496,10 +2520,6 @@ declare namespace Components {
                 number_of_days_before_restriction?: number;
             }[];
             allowed_file_extensions?: /* Allowed file extensions for upload */ AllowedFileExtensions;
-            /**
-             * Configured Portal extensions
-             */
-            extensions?: ExtensionConfig[];
             /**
              * ID of the organization
              * example:
@@ -2903,6 +2923,10 @@ declare namespace Components {
                     de?: string;
                 };
             }[];
+            /**
+             * Configured Portal extensions
+             */
+            extensions?: ExtensionConfig[];
             /**
              * Default 360 user to notify upon an internal notification
              */
@@ -2935,6 +2959,10 @@ declare namespace Components {
                     de?: string;
                 };
             }[];
+            /**
+             * Configured Portal extensions
+             */
+            extensions?: ExtensionConfig[];
             /**
              * Default 360 user to notify upon an internal notification
              */
@@ -3222,10 +3250,6 @@ declare namespace Components {
                 number_of_days_before_restriction?: number;
             }[];
             allowed_file_extensions?: /* Allowed file extensions for upload */ AllowedFileExtensions;
-            /**
-             * Configured Portal extensions
-             */
-            extensions?: ExtensionConfig[];
         }
         export interface UpsertPortalWidget {
             widgets: PortalWidget[];
@@ -4989,10 +5013,6 @@ declare namespace Paths {
                     number_of_days_before_restriction?: number;
                 }[];
                 allowed_file_extensions?: /* Allowed file extensions for upload */ Components.Schemas.AllowedFileExtensions;
-                /**
-                 * Configured Portal extensions
-                 */
-                extensions?: Components.Schemas.ExtensionConfig[];
                 /**
                  * ID of the organization
                  * example:
@@ -7609,8 +7629,7 @@ export type Extension = Components.Schemas.Extension;
 export type ExtensionConfig = Components.Schemas.ExtensionConfig;
 export type ExtensionHook = Components.Schemas.ExtensionHook;
 export type ExtensionHookRegistrationIdentifiersCheck = Components.Schemas.ExtensionHookRegistrationIdentifiersCheck;
-export type ExtensionWidget = Components.Schemas.ExtensionWidget;
-export type ExtensionWidgetSeamlessLink = Components.Schemas.ExtensionWidgetSeamlessLink;
+export type ExtensionSeamlessLink = Components.Schemas.ExtensionSeamlessLink;
 export type ExtraSchemaAttributes = Components.Schemas.ExtraSchemaAttributes;
 export type FailedRuleErrorResp = Components.Schemas.FailedRuleErrorResp;
 export type File = Components.Schemas.File;

package/package.json CHANGED Viewed

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