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

package/src/openapi.json

@@ -779,16 +779,18 @@
         ],
         "requestBody": {
           "description": "ECPVariables payload",
-          "required": true,
           "content": {
             "application/json": {
               "schema": {
                 "type": "object",
-                "properties": {
-                  "contactId": {
-                    "type": "string",
-                    "example": "7aa44fb8-d60e-40cc-9a3a-ba09a1ff7f51",
-                    "description": "ID of the contact"
+                "additionalProperties": {
+                  "type": "object",
+                  "properties": {
+                    "_id": {
+                      "type": "string",
+                      "example": "7aa44fb8-d60e-40cc-9a3a-ba09a1ff7f51",
+                      "description": "ID of the contact"
+                    }
                   }
                 }
               }
@@ -809,6 +811,10 @@
                         "invitationLink": {
                           "type": "string",
                           "example": "https://end-customer-portal.ecp.dev.epilot.io/register?contactId=7aa44fb8-d60e-40cc-9a3a-ba09a1ff7f51&email=john@doe.com"
+                        },
+                        "newDocumentLink": {
+                          "type": "string",
+                          "example": "https://end-customer-portal.ecp.dev.epilot.io/documents"
                         }
                       }
                     },
@@ -818,6 +824,10 @@
                         "invitationLink": {
                           "type": "string",
                           "example": "https://installer-portal.ecp.dev.epilot.io/register?contactId=7aa44fb8-d60e-40cc-9a3a-ba09a1ff7f51&email=john@doe.com"
+                        },
+                        "newDocumentLink": {
+                          "type": "string",
+                          "example": "https://installer-portal.ecp.dev.epilot.io/documents"
                         }
                       }
                     }
@@ -3047,6 +3057,69 @@
         }
       }
     },
+    "/v2/portal/registration/identifiers": {
+      "get": {
+        "operationId": "getRegistrationIdentifiers",
+        "summary": "getRegistrationIdentifiers",
+        "description": "Get valid attributes from entities that can be used as identifier to map contact to user on registration",
+        "tags": [
+          "ECP Admin"
+        ],
+        "security": [
+          {
+            "EpilotAuth": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "A dictionary of identifier attributes per entity schema are returned successfully.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "data": {
+                      "type": "object",
+                      "additionalProperties": {
+                        "type": "array",
+                        "items": {
+                          "$ref": "#/components/schemas/IdentifierAttribute"
+                        }
+                      },
+                      "example": {
+                        "contact": [
+                          {
+                            "label": "First name",
+                            "name": "first_name",
+                            "type": "string"
+                          }
+                        ],
+                        "contract": [
+                          {
+                            "label": "Contract number",
+                            "name": "contract_number",
+                            "type": "string"
+                          }
+                        ]
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "$ref": "#/components/responses/Unauthorized"
+          },
+          "403": {
+            "$ref": "#/components/responses/Forbidden"
+          },
+          "500": {
+            "$ref": "#/components/responses/InternalServerError"
+          }
+        }
+      }
+    },
     "/v2/portal/user/files": {
       "get": {
         "operationId": "getAllFiles",
@@ -3339,14 +3412,6 @@
               "format": "date-time",
               "description": "List billing events before this date"
             }
-          },
-          {
-            "name": "customer_id",
-            "in": "query",
-            "schema": {
-              "type": "string",
-              "description": "List billing events for all contracts/orders of specific customer"
-            }
           }
         ],
         "responses": {
@@ -3376,31 +3441,19 @@
         }
       }
     },
-    "/v2/portal/billing/customers/{customer_id}/balance": {
+    "/v2/portal/billing/customers/balance": {
       "get": {
         "operationId": "getCustomerBalance",
         "summary": "getCustomerBalance",
         "description": "Get total balance across all contracts and orders of a customer entity.",
         "security": [
           {
-            "EpilotAuth": []
+            "PortalAuth": []
           }
         ],
         "tags": [
           "Balance"
         ],
-        "parameters": [
-          {
-            "name": "customer_id",
-            "in": "path",
-            "description": "Customer entity ID (contact or account)",
-            "required": true,
-            "schema": {
-              "type": "string",
-              "example": "1e3f0d58-69d2-4dbb-9a43-3ee63d862e8e"
-            }
-          }
-        ],
         "responses": {
           "200": {
             "description": "OK",
@@ -3673,24 +3726,6 @@
         "type": "http",
         "scheme": "bearer",
         "description": "Epilot Bearer Token"
-      },
-      "AsOrganization": {
-        "type": "apiKey",
-        "in": "header",
-        "name": "x-ivy-org-id",
-        "description": "Set organization id as internal user"
-      },
-      "AsContact": {
-        "type": "apiKey",
-        "in": "header",
-        "name": "x-contact-id",
-        "description": "Set contact id as internal user"
-      },
-      "AsCustomer": {
-        "type": "apiKey",
-        "in": "header",
-        "name": "x-portal-user-id",
-        "description": "Set portal id as customer"
       }
     },
     "schemas": {
@@ -4219,6 +4254,12 @@
           {
             "properties": {
               "id": {
+                "type": "string",
+                "example": 12345,
+                "description": "ID of the organization",
+                "deprecated": true
+              },
+              "organization_id": {
                 "type": "string",
                 "example": 12345,
                 "description": "ID of the organization"
@@ -4293,7 +4334,8 @@
               "CONTENT_WIDGET",
               "ENTITY_WIDGET",
               "TEASER_WIDGET",
-              "DOCUMENT_WIDGET"
+              "DOCUMENT_WIDGET",
+              "PAYMENT_WIDGET"
             ]
           },
           "listIndex": {
@@ -4493,6 +4535,9 @@
           },
           {
             "$ref": "#/components/schemas/DocumentWidget"
+          },
+          {
+            "$ref": "#/components/schemas/PaymentWidget"
           }
         ]
       },
@@ -4766,56 +4811,6 @@
           }
         }
       },
-      "AuthConfig": {
-        "type": "object",
-        "properties": {
-          "user_pool_id": {
-            "type": "string",
-            "example": "eu-central-1_CUEQRNbUb",
-            "description": "AWS Cognito User Pool ID"
-          },
-          "user_pool_client_id": {
-            "type": "string",
-            "example": "6bsd0jkgoie74k2i8mrhc1vest",
-            "description": "AWS Cognito User Pool Client ID"
-          },
-          "user_pool_identity_pool_id": {
-            "type": "string",
-            "example": "eu-central-1:a63af1f7-ab86-4ab5-a0eb-f461cb37c2b1",
-            "description": "AWS Cognito User Pool Identity Pool ID"
-          },
-          "portal_id": {
-            "type": "string",
-            "example": "7h2hwdj7hhjsdcjkq03eidna3ep",
-            "description": "Portal ID"
-          }
-        },
-        "required": [
-          "user_pool_id",
-          "user_pool_client_id",
-          "portal_id"
-        ]
-      },
-      "Exists": {
-        "type": "object",
-        "required": [
-          "exists"
-        ],
-        "properties": {
-          "exists": {
-            "type": "boolean",
-            "description": "Indicate whether the item exists"
-          },
-          "active": {
-            "type": "boolean",
-            "description": "Indicate whether the item is active"
-          }
-        },
-        "example": {
-          "exists": true,
-          "active": false
-        }
-      },
       "EntitySlug": {
         "description": "URL-friendly identifier for the entity schema",
         "type": "string",
@@ -5168,45 +5163,23 @@
                 "description": "The start date of the contract.",
                 "example": "2021-01-01"
               },
-              "billing_schedule_by_month_day": {
+              "billing_due_day": {
                 "type": "integer",
                 "description": "Defines the day of the month in which the installments are due.",
                 "minimum": 1,
                 "maximum": 31,
                 "example": 2
               },
-              "billing_schedule_start_date": {
-                "type": "string",
-                "format": "date",
-                "description": "Defines the start date for the billing schedule",
-                "example": "2020-01-01T00:00:00.000Z"
-              },
-              "billing_schedule_end_date": {
-                "type": "string",
-                "format": "date",
-                "description": "Defines the end date for the billing schedule",
-                "example": "2020-01-01T00:00:00.000Z"
-              },
               "installment_amount": {
                 "type": "integer",
                 "description": "Set amount for installments in cents. (precision 2)",
                 "example": 10050
               },
-              "installment_amount_decimal": {
-                "type": "string",
-                "description": "Set amount for installments in decimal string representation.",
-                "example": "100.50"
-              },
               "balance": {
                 "type": "integer",
                 "description": "Current balance of the contract in cents. (precision 2)",
                 "example": 8990
               },
-              "balance_amount_decimal": {
-                "type": "string",
-                "description": "Current balance of the contract in decimal string representation.",
-                "example": "89.90"
-              },
               "balance_currency": {
                 "$ref": "#/components/schemas/Currency"
               }
@@ -5884,6 +5857,23 @@
         "required": [
           "slug"
         ]
+      },
+      "IdentifierAttribute": {
+        "type": "object",
+        "properties": {
+          "label": {
+            "type": "string",
+            "description": "Label attribute"
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the attribute"
+          },
+          "type": {
+            "type": "string",
+            "description": "Type of the secondary attribute"
+          }
+        }
       }
     }
   },