@epilot/app-client 0.9.3 → 0.9.5

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/dist/openapi.d.ts CHANGED
@@ -1234,6 +1234,7 @@ declare namespace Components {
1234
1234
  * Identifier of the hook. Should not change between updates.
1235
1235
  */
1236
1236
  id?: string;
1237
+ name?: TranslatedString;
1237
1238
  } & (/**
1238
1239
  * 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:
1239
1240
  * - 200 with contact id if exactly one contact is found
@@ -1308,6 +1309,7 @@ declare namespace Components {
1308
1309
  * Identifier of the hook. Should not change between updates.
1309
1310
  */
1310
1311
  id?: string;
1312
+ name?: TranslatedString;
1311
1313
  }
1312
1314
  /**
1313
1315
  * Hook that will allow using the specified source as data for consumption visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
@@ -1316,6 +1318,10 @@ declare namespace Components {
1316
1318
  */
1317
1319
  export interface PortalExtensionHookConsumptionDataRetrieval {
1318
1320
  type: "consumptionDataRetrieval";
1321
+ /**
1322
+ * Intervals supported by the API. If omitted, it is assumed that all intervals are supported.
1323
+ */
1324
+ intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M")[];
1319
1325
  auth?: PortalExtensionAuthBlock;
1320
1326
  call: {
1321
1327
  /**
@@ -1345,12 +1351,16 @@ declare namespace Components {
1345
1351
  [name: string]: string;
1346
1352
  };
1347
1353
  };
1348
- resolved: {
1354
+ resolved?: {
1349
1355
  /**
1350
1356
  * Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
1351
1357
  */
1352
1358
  dataPath?: string;
1353
1359
  };
1360
+ /**
1361
+ * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
1362
+ */
1363
+ use_static_ips?: boolean;
1354
1364
  }
1355
1365
  /**
1356
1366
  * Hook that replaces the built-in contract identification for self-assignment. This hook makes a POST call whenever a user is trying to self-assign a contract to find the corresponding contract(s). The expected response to the call is:
@@ -1400,6 +1410,10 @@ declare namespace Components {
1400
1410
  */
1401
1411
  en: string;
1402
1412
  };
1413
+ /**
1414
+ * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
1415
+ */
1416
+ use_static_ips?: boolean;
1403
1417
  }
1404
1418
  /**
1405
1419
  * Hook that will allow using the specified source as data for consumption visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
@@ -1408,6 +1422,10 @@ declare namespace Components {
1408
1422
  */
1409
1423
  export interface PortalExtensionHookCostDataRetrieval {
1410
1424
  type: "costDataRetrieval";
1425
+ /**
1426
+ * Intervals supported by the API. If omitted, it is assumed that all intervals are supported.
1427
+ */
1428
+ intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M")[];
1411
1429
  auth?: PortalExtensionAuthBlock;
1412
1430
  call: {
1413
1431
  /**
@@ -1443,6 +1461,10 @@ declare namespace Components {
1443
1461
  */
1444
1462
  dataPath?: string;
1445
1463
  };
1464
+ /**
1465
+ * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
1466
+ */
1467
+ use_static_ips?: boolean;
1446
1468
  }
1447
1469
  /**
1448
1470
  * Hook that checks the plausibility of meter readings before they are saved. This hook makes a POST call whenever a user is trying to save a meter reading. The expected response to the call is:
@@ -1477,7 +1499,7 @@ declare namespace Components {
1477
1499
  /**
1478
1500
  * Response to the call
1479
1501
  */
1480
- resolved: {
1502
+ resolved?: {
1481
1503
  /**
1482
1504
  * Indicate whether the meter reading is plausible
1483
1505
  * example:
@@ -1497,6 +1519,10 @@ declare namespace Components {
1497
1519
  */
1498
1520
  lower_limit?: string;
1499
1521
  };
1522
+ /**
1523
+ * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
1524
+ */
1525
+ use_static_ips?: boolean;
1500
1526
  }
1501
1527
  /**
1502
1528
  * Hook that will allow using the specified source as data for price visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
@@ -1505,6 +1531,10 @@ declare namespace Components {
1505
1531
  */
1506
1532
  export interface PortalExtensionHookPriceDataRetrieval {
1507
1533
  type: "priceDataRetrieval";
1534
+ /**
1535
+ * Intervals supported by the API. If omitted, it is assumed that all intervals are supported.
1536
+ */
1537
+ intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M")[];
1508
1538
  auth?: PortalExtensionAuthBlock;
1509
1539
  call: {
1510
1540
  /**
@@ -1534,12 +1564,16 @@ declare namespace Components {
1534
1564
  [name: string]: string;
1535
1565
  };
1536
1566
  };
1537
- resolved: {
1567
+ resolved?: {
1538
1568
  /**
1539
1569
  * Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
1540
1570
  */
1541
1571
  dataPath?: string;
1542
1572
  };
1573
+ /**
1574
+ * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
1575
+ */
1576
+ use_static_ips?: boolean;
1543
1577
  }
1544
1578
  /**
1545
1579
  * 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:
@@ -1572,6 +1606,10 @@ declare namespace Components {
1572
1606
  */
1573
1607
  result: string;
1574
1608
  };
1609
+ /**
1610
+ * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
1611
+ */
1612
+ use_static_ips?: boolean;
1575
1613
  }
1576
1614
  export interface PortalExtensionSeamlessLink {
1577
1615
  /**
package/dist/openapi.json CHANGED
@@ -2156,6 +2156,9 @@
2156
2156
  "id": {
2157
2157
  "type": "string",
2158
2158
  "description": "Identifier of the hook. Should not change between updates."
2159
+ },
2160
+ "name": {
2161
+ "$ref": "#/components/schemas/TranslatedString"
2159
2162
  }
2160
2163
  }
2161
2164
  },
@@ -2206,6 +2209,11 @@
2206
2209
  "result"
2207
2210
  ],
2208
2211
  "additionalProperties": false
2212
+ },
2213
+ "use_static_ips": {
2214
+ "type": "boolean",
2215
+ "description": "If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.",
2216
+ "default": false
2209
2217
  }
2210
2218
  },
2211
2219
  "required": [
@@ -2280,6 +2288,11 @@
2280
2288
  "en"
2281
2289
  ],
2282
2290
  "description": "Explanation of the hook."
2291
+ },
2292
+ "use_static_ips": {
2293
+ "type": "boolean",
2294
+ "description": "If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.",
2295
+ "default": false
2283
2296
  }
2284
2297
  },
2285
2298
  "required": [
@@ -2354,12 +2367,16 @@
2354
2367
  }
2355
2368
  },
2356
2369
  "additionalProperties": false
2370
+ },
2371
+ "use_static_ips": {
2372
+ "type": "boolean",
2373
+ "description": "If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.",
2374
+ "default": false
2357
2375
  }
2358
2376
  },
2359
2377
  "required": [
2360
2378
  "type",
2361
- "call",
2362
- "resolved"
2379
+ "call"
2363
2380
  ],
2364
2381
  "additionalProperties": false
2365
2382
  },
@@ -2373,6 +2390,19 @@
2373
2390
  "priceDataRetrieval"
2374
2391
  ]
2375
2392
  },
2393
+ "intervals": {
2394
+ "type": "array",
2395
+ "description": "Intervals supported by the API. If omitted, it is assumed that all intervals are supported.",
2396
+ "items": {
2397
+ "type": "string",
2398
+ "enum": [
2399
+ "PT15M",
2400
+ "PT1H",
2401
+ "P1D",
2402
+ "P1M"
2403
+ ]
2404
+ }
2405
+ },
2376
2406
  "auth": {
2377
2407
  "$ref": "#/components/schemas/PortalExtensionAuthBlock"
2378
2408
  },
@@ -2427,12 +2457,16 @@
2427
2457
  }
2428
2458
  },
2429
2459
  "additionalProperties": false
2460
+ },
2461
+ "use_static_ips": {
2462
+ "type": "boolean",
2463
+ "description": "If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.",
2464
+ "default": false
2430
2465
  }
2431
2466
  },
2432
2467
  "required": [
2433
2468
  "type",
2434
- "call",
2435
- "resolved"
2469
+ "call"
2436
2470
  ],
2437
2471
  "additionalProperties": false
2438
2472
  },
@@ -2446,6 +2480,19 @@
2446
2480
  "consumptionDataRetrieval"
2447
2481
  ]
2448
2482
  },
2483
+ "intervals": {
2484
+ "type": "array",
2485
+ "description": "Intervals supported by the API. If omitted, it is assumed that all intervals are supported.",
2486
+ "items": {
2487
+ "type": "string",
2488
+ "enum": [
2489
+ "PT15M",
2490
+ "PT1H",
2491
+ "P1D",
2492
+ "P1M"
2493
+ ]
2494
+ }
2495
+ },
2449
2496
  "auth": {
2450
2497
  "$ref": "#/components/schemas/PortalExtensionAuthBlock"
2451
2498
  },
@@ -2500,12 +2547,16 @@
2500
2547
  }
2501
2548
  },
2502
2549
  "additionalProperties": false
2550
+ },
2551
+ "use_static_ips": {
2552
+ "type": "boolean",
2553
+ "description": "If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.",
2554
+ "default": false
2503
2555
  }
2504
2556
  },
2505
2557
  "required": [
2506
2558
  "type",
2507
- "call",
2508
- "resolved"
2559
+ "call"
2509
2560
  ],
2510
2561
  "additionalProperties": false
2511
2562
  },
@@ -2519,6 +2570,19 @@
2519
2570
  "costDataRetrieval"
2520
2571
  ]
2521
2572
  },
2573
+ "intervals": {
2574
+ "type": "array",
2575
+ "description": "Intervals supported by the API. If omitted, it is assumed that all intervals are supported.",
2576
+ "items": {
2577
+ "type": "string",
2578
+ "enum": [
2579
+ "PT15M",
2580
+ "PT1H",
2581
+ "P1D",
2582
+ "P1M"
2583
+ ]
2584
+ }
2585
+ },
2522
2586
  "auth": {
2523
2587
  "$ref": "#/components/schemas/PortalExtensionAuthBlock"
2524
2588
  },
@@ -2573,6 +2637,11 @@
2573
2637
  }
2574
2638
  },
2575
2639
  "additionalProperties": false
2640
+ },
2641
+ "use_static_ips": {
2642
+ "type": "boolean",
2643
+ "description": "If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.",
2644
+ "default": false
2576
2645
  }
2577
2646
  },
2578
2647
  "required": [
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/app-client",
3
- "version": "0.9.3",
3
+ "version": "0.9.5",
4
4
  "description": "JavaScript client library for the epilot App API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",