@epilot/customer-portal-client 0.11.0 → 0.11.2-rc1

package/dist/openapi.d.ts

@@ -19,7 +19,7 @@ declare namespace Components {
     namespace Schemas {
         export interface ActionWidget {
             id: string;
-            type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET";
+            type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET";
             /**
              * Index of the widget in the list, used for ordering (left or right)
              */
@@ -216,32 +216,6 @@ declare namespace Components {
              */
             phone?: string | null;
         }
-        export interface AuthConfig {
-            /**
-             * AWS Cognito User Pool ID
-             * example:
-             * eu-central-1_CUEQRNbUb
-             */
-            user_pool_id: string;
-            /**
-             * AWS Cognito User Pool Client ID
-             * example:
-             * 6bsd0jkgoie74k2i8mrhc1vest
-             */
-            user_pool_client_id: string;
-            /**
-             * AWS Cognito User Pool Identity Pool ID
-             * example:
-             * eu-central-1:a63af1f7-ab86-4ab5-a0eb-f461cb37c2b1
-             */
-            user_pool_identity_pool_id?: string;
-            /**
-             * Portal ID
-             * example:
-             * 7h2hwdj7hhjsdcjkq03eidna3ep
-             */
-            portal_id: string;
-        }
         export interface Balance {
             /**
              * Current balance of the customer in cents. (precision 2)
@@ -460,7 +434,7 @@ declare namespace Components {
         }
         export interface ContentWidget {
             id: string;
-            type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET";
+            type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET";
             /**
              * Index of the widget in the list, used for ordering (left or right)
              */
@@ -632,43 +606,19 @@ declare namespace Components {
              * example:
              * 2
              */
-            billing_schedule_by_month_day?: number;
-            /**
-             * Defines the start date for the billing schedule
-             * example:
-             * 2020-01-01T00:00:00.000Z
-             */
-            billing_schedule_start_date?: string; // date
-            /**
-             * Defines the end date for the billing schedule
-             * example:
-             * 2020-01-01T00:00:00.000Z
-             */
-            billing_schedule_end_date?: string; // date
+            billing_due_day?: number;
             /**
              * Set amount for installments in cents. (precision 2)
              * example:
              * 10050
              */
             installment_amount?: number;
-            /**
-             * Set amount for installments in decimal string representation.
-             * example:
-             * 100.50
-             */
-            installment_amount_decimal?: string;
             /**
              * Current balance of the contract in cents. (precision 2)
              * example:
              * 8990
              */
             balance?: number;
-            /**
-             * Current balance of the contract in decimal string representation.
-             * example:
-             * 89.90
-             */
-            balance_amount_decimal?: string;
             balance_currency?: /**
              * Currency code in ISO 4217 format
              * example:
@@ -772,7 +722,7 @@ declare namespace Components {
         }
         export interface DocumentWidget {
             id: string;
-            type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET";
+            type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET";
             /**
              * Index of the widget in the list, used for ordering (left or right)
              */
@@ -967,7 +917,7 @@ declare namespace Components {
         export type EntitySlug = "contact" | "contract" | "file" | "order" | "opportunity" | "product" | "price" | "meter" | "meter_counter";
         export interface EntityWidget {
             id: string;
-            type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET";
+            type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET";
             /**
              * Index of the widget in the list, used for ordering (left or right)
              */
@@ -988,23 +938,6 @@ declare namespace Components {
              */
             message?: string;
         }
-        /**
-         * example:
-         * {
-         *   "exists": true,
-         *   "active": false
-         * }
-         */
-        export interface Exists {
-            /**
-             * Indicate whether the item exists
-             */
-            exists: boolean;
-            /**
-             * Indicate whether the item is active
-             */
-            active?: boolean;
-        }
         export type ExtraSchemaAttributes = {
             /**
              * Attribute name
@@ -1187,6 +1120,20 @@ declare namespace Components {
              */
             effect?: "allow" | "deny";
         }
+        export interface IdentifierAttribute {
+            /**
+             * Label attribute
+             */
+            label?: string;
+            /**
+             * Name of the attribute
+             */
+            name?: string;
+            /**
+             * Type of the secondary attribute
+             */
+            type?: string;
+        }
         /**
          * An entity that describes an installment billing event.
          */
@@ -1494,7 +1441,7 @@ declare namespace Components {
         export type Origin = "END_CUSTOMER_PORTAL" | "INSTALLER_PORTAL";
         export interface PaymentWidget {
             id: string;
-            type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET";
+            type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET";
             /**
              * Index of the widget in the list, used for ordering (left or right)
              */
@@ -1719,6 +1666,12 @@ declare namespace Components {
              * 12345
              */
             id?: string;
+            /**
+             * ID of the organization
+             * example:
+             * 12345
+             */
+            organization_id?: string;
             /**
              * Name of the organization
              * example:
@@ -1796,7 +1749,7 @@ declare namespace Components {
             _updated_at: string; // date-time
             _schema: "portal_user";
         }
-        export type PortalWidget = EntityWidget | ContentWidget | ActionWidget | TeaserWidget | DocumentWidget;
+        export type PortalWidget = EntityWidget | ContentWidget | ActionWidget | TeaserWidget | DocumentWidget | PaymentWidget;
         /**
          * The product entity
          */
@@ -2045,7 +1998,7 @@ declare namespace Components {
         }
         export interface TeaserWidget {
             id: string;
-            type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET";
+            type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET";
             /**
              * Index of the widget in the list, used for ordering (left or right)
              */
@@ -2312,7 +2265,7 @@ declare namespace Components {
         }
         export interface WidgetBase {
             id: string;
-            type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET";
+            type: "ACTION_WIDGET" | "CONTENT_WIDGET" | "ENTITY_WIDGET" | "TEASER_WIDGET" | "DOCUMENT_WIDGET" | "PAYMENT_WIDGET";
             /**
              * Index of the widget in the list, used for ordering (left or right)
              */
@@ -2790,10 +2743,6 @@ declare namespace Paths {
     }
     namespace GetBillingEvents {
         namespace Parameters {
-            /**
-             * List billing events for all contracts/orders of specific customer
-             */
-            export type CustomerId = string;
             /**
              * List billing events after this date
              */
@@ -2816,7 +2765,6 @@ declare namespace Paths {
             event_type?: /* Type of billing event to filter by */ Parameters.EventType;
             date_after?: /* List billing events after this date */ Parameters.DateAfter /* date-time */;
             date_before?: /* List billing events before this date */ Parameters.DateBefore /* date-time */;
-            customer_id?: /* List billing events for all contracts/orders of specific customer */ Parameters.CustomerId;
         }
         namespace Responses {
             export interface $200 {
@@ -2990,20 +2938,6 @@ declare namespace Paths {
         }
     }
     namespace GetCustomerBalance {
-        namespace Parameters {
-            /**
-             * example:
-             * 1e3f0d58-69d2-4dbb-9a43-3ee63d862e8e
-             */
-            export type CustomerId = string;
-        }
-        export interface PathParameters {
-            customer_id: /**
-             * example:
-             * 1e3f0d58-69d2-4dbb-9a43-3ee63d862e8e
-             */
-            Parameters.CustomerId;
-        }
         namespace Responses {
             export type $200 = Components.Schemas.Balance;
         }
@@ -3532,6 +3466,37 @@ declare namespace Paths {
             export type $500 = Components.Responses.InternalServerError;
         }
     }
+    namespace GetRegistrationIdentifiers {
+        namespace Responses {
+            export interface $200 {
+                /**
+                 * example:
+                 * {
+                 *   "contact": [
+                 *     {
+                 *       "label": "First name",
+                 *       "name": "first_name",
+                 *       "type": "string"
+                 *     }
+                 *   ],
+                 *   "contract": [
+                 *     {
+                 *       "label": "Contract number",
+                 *       "name": "contract_number",
+                 *       "type": "string"
+                 *     }
+                 *   ]
+                 * }
+                 */
+                data?: {
+                    [name: string]: Components.Schemas.IdentifierAttribute[];
+                };
+            }
+            export type $401 = Components.Responses.Unauthorized;
+            export type $403 = Components.Responses.Forbidden;
+            export type $500 = Components.Responses.InternalServerError;
+        }
+    }
     namespace GetSchemas {
         namespace Responses {
             export interface $200 {
@@ -3585,12 +3550,14 @@ declare namespace Paths {
     }
     namespace ReplaceECPTemplateVariables {
         export interface RequestBody {
-            /**
-             * ID of the contact
-             * example:
-             * 7aa44fb8-d60e-40cc-9a3a-ba09a1ff7f51
-             */
-            contactId?: string;
+            [name: string]: {
+                /**
+                 * ID of the contact
+                 * example:
+                 * 7aa44fb8-d60e-40cc-9a3a-ba09a1ff7f51
+                 */
+                _id?: string;
+            };
         }
         namespace Responses {
             export interface $200 {
@@ -3600,6 +3567,11 @@ declare namespace Paths {
                      * https://end-customer-portal.ecp.dev.epilot.io/register?contactId=7aa44fb8-d60e-40cc-9a3a-ba09a1ff7f51&email=john@doe.com
                      */
                     invitationLink?: string;
+                    /**
+                     * example:
+                     * https://end-customer-portal.ecp.dev.epilot.io/documents
+                     */
+                    newDocumentLink?: string;
                 };
                 installerPortal?: {
                     /**
@@ -3607,6 +3579,11 @@ declare namespace Paths {
                      * https://installer-portal.ecp.dev.epilot.io/register?contactId=7aa44fb8-d60e-40cc-9a3a-ba09a1ff7f51&email=john@doe.com
                      */
                     invitationLink?: string;
+                    /**
+                     * example:
+                     * https://installer-portal.ecp.dev.epilot.io/documents
+                     */
+                    newDocumentLink?: string;
                 };
             }
             export type $401 = Components.Responses.Unauthorized;
@@ -4477,6 +4454,16 @@ export interface OperationMethods {
     data?: Paths.SavePortalFiles.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.SavePortalFiles.Responses.$201>
+  /**
+   * getRegistrationIdentifiers - getRegistrationIdentifiers
+   * 
+   * Get valid attributes from entities that can be used as identifier to map contact to user on registration
+   */
+  'getRegistrationIdentifiers'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetRegistrationIdentifiers.Responses.$200>
   /**
    * getAllFiles - getAllFiles
    * 
@@ -4533,7 +4520,7 @@ export interface OperationMethods {
    * Get total balance across all contracts and orders of a customer entity.
    */
   'getCustomerBalance'(
-    parameters?: Parameters<Paths.GetCustomerBalance.PathParameters> | null,
+    parameters?: Parameters<UnknownParamsObject> | null,
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetCustomerBalance.Responses.$200>
@@ -5168,6 +5155,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.SavePortalFiles.Responses.$201>
   }
+  ['/v2/portal/registration/identifiers']: {
+    /**
+     * getRegistrationIdentifiers - getRegistrationIdentifiers
+     * 
+     * Get valid attributes from entities that can be used as identifier to map contact to user on registration
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetRegistrationIdentifiers.Responses.$200>
+  }
   ['/v2/portal/user/files']: {
     /**
      * getAllFiles - getAllFiles
@@ -5228,14 +5227,14 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetBillingEvents.Responses.$200>
   }
-  ['/v2/portal/billing/customers/{customer_id}/balance']: {
+  ['/v2/portal/billing/customers/balance']: {
     /**
      * getCustomerBalance - getCustomerBalance
      * 
      * Get total balance across all contracts and orders of a customer entity.
      */
     'get'(
-      parameters?: Parameters<Paths.GetCustomerBalance.PathParameters> | null,
+      parameters?: Parameters<UnknownParamsObject> | null,
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetCustomerBalance.Responses.$200>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/customer-portal-client",
-  "version": "0.11.0",
+  "version": "0.11.2-rc1",
   "description": "API Client for epilot portal API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -45,24 +45,24 @@
   "author": "epilot GmbH",
   "license": "UNLICENSED",
   "peerDependencies": {
-    "axios": "^0.25.0"
+    "axios": "^1.6.2"
   },
   "dependencies": {
     "buffer": "^6.0.3",
     "https-browserify": "^1.0.0",
-    "openapi-client-axios": "^7.1.3",
+    "openapi-client-axios": "^7.5.1",
     "stream-http": "^3.1.1",
     "url": "^0.11.0",
     "util": "^0.12.3"
   },
   "devDependencies": {
     "@types/jest": "^26.0.20",
-    "axios": "^0.25.0",
+    "axios": "^1.6.2",
     "copy-webpack-plugin": "^7.0.0",
     "jest": "^26.6.3",
     "json-loader": "^0.5.7",
     "openapi-client-axios-typegen": "^7.4.1",
-    "openapicmd": "^1.17.0",
+    "openapicmd": "^2.1.0",
     "ts-jest": "^26.5.0",
     "ts-loader": "^8.0.14",
     "ts-node": "^10.9.1",

package/src/openapi-runtime.json

@@ -204,7 +204,6 @@
       "post": {
         "operationId": "replaceECPTemplateVariables",
         "requestBody": {
-          "required": true,
           "content": {
             "application/json": {}
           }
@@ -694,6 +693,11 @@
         }
       }
     },
+    "/v2/portal/registration/identifiers": {
+      "get": {
+        "operationId": "getRegistrationIdentifiers"
+      }
+    },
     "/v2/portal/user/files": {
       "get": {
         "operationId": "getAllFiles",
@@ -763,24 +767,13 @@
           {
             "name": "date_before",
             "in": "query"
-          },
-          {
-            "name": "customer_id",
-            "in": "query"
           }
         ]
       }
     },
-    "/v2/portal/billing/customers/{customer_id}/balance": {
+    "/v2/portal/billing/customers/balance": {
       "get": {
-        "operationId": "getCustomerBalance",
-        "parameters": [
-          {
-            "name": "customer_id",
-            "in": "path",
-            "required": true
-          }
-        ]
+        "operationId": "getCustomerBalance"
       }
     },
     "/v2/portal/admin:login-as-user": {