@epilot/customer-portal-client 0.37.0 → 0.38.1
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.
- package/LICENSE +21 -0
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +24 -0
- package/dist/openapi.d.ts +124 -82
- package/package.json +14 -15
- package/src/openapi-runtime.json +24 -0
- package/src/openapi.d.ts +16729 -0
- package/src/openapi.json +197 -41
package/src/openapi.json
CHANGED
|
@@ -815,7 +815,19 @@
|
|
|
815
815
|
},
|
|
816
816
|
"type": {
|
|
817
817
|
"type": "string",
|
|
818
|
-
"description": "Optional type of the consumption, such as 'nt' (night time)
|
|
818
|
+
"description": "Optional type of the consumption, such as 'nt' (night time) and 'ht' (high time) or 'feed-in' and 'feed-out'. Can be any string.",
|
|
819
|
+
"example": "nt"
|
|
820
|
+
},
|
|
821
|
+
"aggregation_method": {
|
|
822
|
+
"type": "string",
|
|
823
|
+
"description": "The method used to aggregate the consumption data. Assumed default is 'sum'.",
|
|
824
|
+
"enum": [
|
|
825
|
+
"sum",
|
|
826
|
+
"average",
|
|
827
|
+
"max",
|
|
828
|
+
"min"
|
|
829
|
+
],
|
|
830
|
+
"example": "sum"
|
|
819
831
|
}
|
|
820
832
|
},
|
|
821
833
|
"required": [
|
|
@@ -7231,6 +7243,124 @@
|
|
|
7231
7243
|
}
|
|
7232
7244
|
}
|
|
7233
7245
|
},
|
|
7246
|
+
"/v2/portal/metering/readings": {
|
|
7247
|
+
"post": {
|
|
7248
|
+
"operationId": "getMeterReadings",
|
|
7249
|
+
"summary": "Get meter readings with optional template resolution",
|
|
7250
|
+
"description": "Fetches meter readings for a counter and optionally resolves Handlebars\ntemplate strings against each reading object using @epilot/variables.\n",
|
|
7251
|
+
"tags": [
|
|
7252
|
+
"ECP"
|
|
7253
|
+
],
|
|
7254
|
+
"security": [
|
|
7255
|
+
{
|
|
7256
|
+
"PortalAuth": []
|
|
7257
|
+
}
|
|
7258
|
+
],
|
|
7259
|
+
"requestBody": {
|
|
7260
|
+
"required": true,
|
|
7261
|
+
"content": {
|
|
7262
|
+
"application/json": {
|
|
7263
|
+
"schema": {
|
|
7264
|
+
"type": "object",
|
|
7265
|
+
"required": [
|
|
7266
|
+
"meter_id",
|
|
7267
|
+
"counter_id"
|
|
7268
|
+
],
|
|
7269
|
+
"properties": {
|
|
7270
|
+
"meter_id": {
|
|
7271
|
+
"type": "string"
|
|
7272
|
+
},
|
|
7273
|
+
"counter_id": {
|
|
7274
|
+
"type": "string"
|
|
7275
|
+
},
|
|
7276
|
+
"sort": {
|
|
7277
|
+
"type": "string",
|
|
7278
|
+
"enum": [
|
|
7279
|
+
"asc",
|
|
7280
|
+
"desc"
|
|
7281
|
+
],
|
|
7282
|
+
"default": "desc"
|
|
7283
|
+
},
|
|
7284
|
+
"from": {
|
|
7285
|
+
"type": "integer",
|
|
7286
|
+
"default": 0
|
|
7287
|
+
},
|
|
7288
|
+
"size": {
|
|
7289
|
+
"type": "integer",
|
|
7290
|
+
"default": 10
|
|
7291
|
+
},
|
|
7292
|
+
"templates": {
|
|
7293
|
+
"type": "object",
|
|
7294
|
+
"additionalProperties": {
|
|
7295
|
+
"type": "string"
|
|
7296
|
+
},
|
|
7297
|
+
"description": "Template map (key to Handlebars template string). Each template is resolved per reading."
|
|
7298
|
+
},
|
|
7299
|
+
"counter_templates": {
|
|
7300
|
+
"type": "object",
|
|
7301
|
+
"additionalProperties": {
|
|
7302
|
+
"type": "string"
|
|
7303
|
+
},
|
|
7304
|
+
"description": "Template map resolved against the counter entity."
|
|
7305
|
+
}
|
|
7306
|
+
}
|
|
7307
|
+
}
|
|
7308
|
+
}
|
|
7309
|
+
}
|
|
7310
|
+
},
|
|
7311
|
+
"responses": {
|
|
7312
|
+
"200": {
|
|
7313
|
+
"description": "Meter readings with resolved templates",
|
|
7314
|
+
"content": {
|
|
7315
|
+
"application/json": {
|
|
7316
|
+
"schema": {
|
|
7317
|
+
"type": "object",
|
|
7318
|
+
"properties": {
|
|
7319
|
+
"results": {
|
|
7320
|
+
"type": "array",
|
|
7321
|
+
"items": {
|
|
7322
|
+
"type": "object",
|
|
7323
|
+
"additionalProperties": true,
|
|
7324
|
+
"properties": {
|
|
7325
|
+
"templates_output": {
|
|
7326
|
+
"type": "object",
|
|
7327
|
+
"additionalProperties": {
|
|
7328
|
+
"type": "string"
|
|
7329
|
+
}
|
|
7330
|
+
}
|
|
7331
|
+
}
|
|
7332
|
+
}
|
|
7333
|
+
},
|
|
7334
|
+
"hits": {
|
|
7335
|
+
"type": "integer"
|
|
7336
|
+
},
|
|
7337
|
+
"counter_templates_output": {
|
|
7338
|
+
"type": "object",
|
|
7339
|
+
"additionalProperties": {
|
|
7340
|
+
"type": "string"
|
|
7341
|
+
},
|
|
7342
|
+
"description": "Resolved counter templates."
|
|
7343
|
+
}
|
|
7344
|
+
}
|
|
7345
|
+
}
|
|
7346
|
+
}
|
|
7347
|
+
}
|
|
7348
|
+
},
|
|
7349
|
+
"400": {
|
|
7350
|
+
"$ref": "#/components/responses/InvalidRequest"
|
|
7351
|
+
},
|
|
7352
|
+
"401": {
|
|
7353
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
7354
|
+
},
|
|
7355
|
+
"403": {
|
|
7356
|
+
"$ref": "#/components/responses/Forbidden"
|
|
7357
|
+
},
|
|
7358
|
+
"500": {
|
|
7359
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
7360
|
+
}
|
|
7361
|
+
}
|
|
7362
|
+
}
|
|
7363
|
+
},
|
|
7234
7364
|
"/v2/portal/public/sso/login": {
|
|
7235
7365
|
"post": {
|
|
7236
7366
|
"operationId": "ssoLogin",
|
|
@@ -8969,6 +9099,71 @@
|
|
|
8969
9099
|
}
|
|
8970
9100
|
}
|
|
8971
9101
|
},
|
|
9102
|
+
"/v3/portal/config/clone": {
|
|
9103
|
+
"post": {
|
|
9104
|
+
"operationId": "clonePortalConfig",
|
|
9105
|
+
"summary": "clonePortalConfig",
|
|
9106
|
+
"description": "Creates a new portal by cloning configuration and pages from an existing portal. The new portal gets its own domain, users, email templates, and authentication settings.",
|
|
9107
|
+
"tags": [
|
|
9108
|
+
"ECP Admin"
|
|
9109
|
+
],
|
|
9110
|
+
"security": [
|
|
9111
|
+
{
|
|
9112
|
+
"EpilotAuth": []
|
|
9113
|
+
}
|
|
9114
|
+
],
|
|
9115
|
+
"requestBody": {
|
|
9116
|
+
"description": "Source portal ID and optional name for the cloned portal",
|
|
9117
|
+
"required": true,
|
|
9118
|
+
"content": {
|
|
9119
|
+
"application/json": {
|
|
9120
|
+
"schema": {
|
|
9121
|
+
"type": "object",
|
|
9122
|
+
"required": [
|
|
9123
|
+
"source_portal_id"
|
|
9124
|
+
],
|
|
9125
|
+
"properties": {
|
|
9126
|
+
"source_portal_id": {
|
|
9127
|
+
"$ref": "#/components/schemas/PortalId"
|
|
9128
|
+
},
|
|
9129
|
+
"name": {
|
|
9130
|
+
"type": "string",
|
|
9131
|
+
"description": "Name for the cloned portal. Defaults to \"Copy of <source portal name>\"."
|
|
9132
|
+
}
|
|
9133
|
+
}
|
|
9134
|
+
}
|
|
9135
|
+
}
|
|
9136
|
+
}
|
|
9137
|
+
},
|
|
9138
|
+
"responses": {
|
|
9139
|
+
"201": {
|
|
9140
|
+
"description": "Portal cloned successfully.",
|
|
9141
|
+
"content": {
|
|
9142
|
+
"application/json": {
|
|
9143
|
+
"schema": {
|
|
9144
|
+
"$ref": "#/components/schemas/PortalConfigV3"
|
|
9145
|
+
}
|
|
9146
|
+
}
|
|
9147
|
+
}
|
|
9148
|
+
},
|
|
9149
|
+
"400": {
|
|
9150
|
+
"$ref": "#/components/responses/InvalidRequest"
|
|
9151
|
+
},
|
|
9152
|
+
"401": {
|
|
9153
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
9154
|
+
},
|
|
9155
|
+
"403": {
|
|
9156
|
+
"$ref": "#/components/responses/Forbidden"
|
|
9157
|
+
},
|
|
9158
|
+
"404": {
|
|
9159
|
+
"$ref": "#/components/responses/NotFound"
|
|
9160
|
+
},
|
|
9161
|
+
"500": {
|
|
9162
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
9163
|
+
}
|
|
9164
|
+
}
|
|
9165
|
+
}
|
|
9166
|
+
},
|
|
8972
9167
|
"/v3/portal/partner/invite": {
|
|
8973
9168
|
"post": {
|
|
8974
9169
|
"operationId": "invitePartner",
|
|
@@ -10069,14 +10264,6 @@
|
|
|
10069
10264
|
"type": "boolean",
|
|
10070
10265
|
"description": "Mark true if the domain is an Epilot domain"
|
|
10071
10266
|
},
|
|
10072
|
-
"epilot_domain": {
|
|
10073
|
-
"type": "string",
|
|
10074
|
-
"description": "The URL on which the portal is accessible",
|
|
10075
|
-
"example": "example-portal-12345.ecp.epilot.cloud"
|
|
10076
|
-
},
|
|
10077
|
-
"domain_settings": {
|
|
10078
|
-
"$ref": "#/components/schemas/DomainSettings"
|
|
10079
|
-
},
|
|
10080
10267
|
"design_id": {
|
|
10081
10268
|
"$ref": "#/components/schemas/EntityId",
|
|
10082
10269
|
"description": "ID of the design used to build the portal"
|
|
@@ -10625,24 +10812,6 @@
|
|
|
10625
10812
|
}
|
|
10626
10813
|
}
|
|
10627
10814
|
},
|
|
10628
|
-
"DomainSettings": {
|
|
10629
|
-
"type": "object",
|
|
10630
|
-
"description": "Domain settings for the portal",
|
|
10631
|
-
"properties": {
|
|
10632
|
-
"is_custom_domain_enabled": {
|
|
10633
|
-
"type": "boolean",
|
|
10634
|
-
"description": "Whether the custom domain is enabled"
|
|
10635
|
-
},
|
|
10636
|
-
"is_epilot_domain_enabled": {
|
|
10637
|
-
"type": "boolean",
|
|
10638
|
-
"description": "Whether the Epilot domain is enabled"
|
|
10639
|
-
},
|
|
10640
|
-
"is_redirection_enabled": {
|
|
10641
|
-
"type": "boolean",
|
|
10642
|
-
"description": "Whether the redirection is enabled"
|
|
10643
|
-
}
|
|
10644
|
-
}
|
|
10645
|
-
},
|
|
10646
10815
|
"WidgetBase": {
|
|
10647
10816
|
"type": "object",
|
|
10648
10817
|
"required": [
|
|
@@ -14393,7 +14562,7 @@
|
|
|
14393
14562
|
"timestamp": {
|
|
14394
14563
|
"type": "string",
|
|
14395
14564
|
"description": "If the value is not provided, the system will be set with the time the request is processed.",
|
|
14396
|
-
"example": "2022-10-
|
|
14565
|
+
"example": "2022-10-10"
|
|
14397
14566
|
},
|
|
14398
14567
|
"source": {
|
|
14399
14568
|
"$ref": "#/components/schemas/Source",
|
|
@@ -15254,14 +15423,6 @@
|
|
|
15254
15423
|
"type": "boolean",
|
|
15255
15424
|
"description": "Mark true if the domain is an Epilot domain"
|
|
15256
15425
|
},
|
|
15257
|
-
"epilot_domain": {
|
|
15258
|
-
"type": "string",
|
|
15259
|
-
"description": "The Epilot domain on which the portal is accessible",
|
|
15260
|
-
"example": "example-portal-1.ecp.epilot.io"
|
|
15261
|
-
},
|
|
15262
|
-
"domain_settings": {
|
|
15263
|
-
"$ref": "#/components/schemas/DomainSettings"
|
|
15264
|
-
},
|
|
15265
15426
|
"design_id": {
|
|
15266
15427
|
"$ref": "#/components/schemas/EntityId",
|
|
15267
15428
|
"description": "ID of the design used to build the portal"
|
|
@@ -15818,11 +15979,6 @@
|
|
|
15818
15979
|
"is_canary": {
|
|
15819
15980
|
"type": "boolean",
|
|
15820
15981
|
"description": "Whether the org is in canary mode"
|
|
15821
|
-
},
|
|
15822
|
-
"redirect_to": {
|
|
15823
|
-
"type": "string",
|
|
15824
|
-
"description": "The URL to redirect to",
|
|
15825
|
-
"example": "https://example.com"
|
|
15826
15982
|
}
|
|
15827
15983
|
}
|
|
15828
15984
|
},
|