@epilot/sdk 2.18.20 → 2.18.22

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 (146) hide show
  1. package/definitions/ai-agents.json +121 -27
  2. package/definitions/customer-portal-runtime.json +1 -1
  3. package/definitions/customer-portal.json +207 -17
  4. package/definitions/integration-toolkit.json +26 -6
  5. package/dist/ai-agents-ME5VRKMY.cjs +7 -0
  6. package/dist/ai-agents-MY4QE4CP.js +7 -0
  7. package/dist/{ai-agents.d-BnR7CAeJ.d.cts → ai-agents.d-B3TkP4mo.d.cts} +152 -52
  8. package/dist/{ai-agents.d-BnR7CAeJ.d.ts → ai-agents.d-B3TkP4mo.d.ts} +152 -52
  9. package/dist/apis/access-token.cjs +6 -6
  10. package/dist/apis/access-token.js +1 -1
  11. package/dist/apis/address-suggestions.cjs +6 -6
  12. package/dist/apis/address-suggestions.js +1 -1
  13. package/dist/apis/address.cjs +6 -6
  14. package/dist/apis/address.js +1 -1
  15. package/dist/apis/ai-agents.cjs +6 -6
  16. package/dist/apis/ai-agents.d.cts +2 -2
  17. package/dist/apis/ai-agents.d.ts +2 -2
  18. package/dist/apis/ai-agents.js +1 -1
  19. package/dist/apis/app.cjs +6 -6
  20. package/dist/apis/app.js +1 -1
  21. package/dist/apis/audit-logs.cjs +6 -6
  22. package/dist/apis/audit-logs.js +1 -1
  23. package/dist/apis/automation.cjs +6 -6
  24. package/dist/apis/automation.js +1 -1
  25. package/dist/apis/billing.cjs +6 -6
  26. package/dist/apis/billing.js +1 -1
  27. package/dist/apis/blueprint-manifest.cjs +6 -6
  28. package/dist/apis/blueprint-manifest.js +1 -1
  29. package/dist/apis/calendar.cjs +6 -6
  30. package/dist/apis/calendar.js +1 -1
  31. package/dist/apis/configuration-hub.cjs +6 -6
  32. package/dist/apis/configuration-hub.js +1 -1
  33. package/dist/apis/consent.cjs +6 -6
  34. package/dist/apis/consent.js +1 -1
  35. package/dist/apis/customer-portal.cjs +8 -8
  36. package/dist/apis/customer-portal.d.cts +2 -2
  37. package/dist/apis/customer-portal.d.ts +2 -2
  38. package/dist/apis/customer-portal.js +2 -2
  39. package/dist/apis/dashboard.cjs +6 -6
  40. package/dist/apis/dashboard.js +1 -1
  41. package/dist/apis/data-governance.cjs +6 -6
  42. package/dist/apis/data-governance.js +1 -1
  43. package/dist/apis/deduplication.cjs +6 -6
  44. package/dist/apis/deduplication.js +1 -1
  45. package/dist/apis/design.cjs +6 -6
  46. package/dist/apis/design.js +1 -1
  47. package/dist/apis/document.cjs +6 -6
  48. package/dist/apis/document.js +1 -1
  49. package/dist/apis/email-settings.cjs +6 -6
  50. package/dist/apis/email-settings.js +1 -1
  51. package/dist/apis/email-template.cjs +6 -6
  52. package/dist/apis/email-template.js +1 -1
  53. package/dist/apis/entity-mapping.cjs +6 -6
  54. package/dist/apis/entity-mapping.js +1 -1
  55. package/dist/apis/entity.cjs +6 -6
  56. package/dist/apis/entity.js +1 -1
  57. package/dist/apis/environments.cjs +6 -6
  58. package/dist/apis/environments.js +1 -1
  59. package/dist/apis/event-catalog.cjs +6 -6
  60. package/dist/apis/event-catalog.js +1 -1
  61. package/dist/apis/file.cjs +6 -6
  62. package/dist/apis/file.js +1 -1
  63. package/dist/apis/iban.cjs +6 -6
  64. package/dist/apis/iban.js +1 -1
  65. package/dist/apis/integration-toolkit.cjs +6 -6
  66. package/dist/apis/integration-toolkit.d.cts +2 -2
  67. package/dist/apis/integration-toolkit.d.ts +2 -2
  68. package/dist/apis/integration-toolkit.js +1 -1
  69. package/dist/apis/journey.cjs +6 -6
  70. package/dist/apis/journey.js +1 -1
  71. package/dist/apis/kanban.cjs +6 -6
  72. package/dist/apis/kanban.js +1 -1
  73. package/dist/apis/message.cjs +6 -6
  74. package/dist/apis/message.js +1 -1
  75. package/dist/apis/metering.cjs +6 -6
  76. package/dist/apis/metering.js +1 -1
  77. package/dist/apis/notes.cjs +6 -6
  78. package/dist/apis/notes.js +1 -1
  79. package/dist/apis/notification.cjs +6 -6
  80. package/dist/apis/notification.js +1 -1
  81. package/dist/apis/organization.cjs +6 -6
  82. package/dist/apis/organization.js +1 -1
  83. package/dist/apis/partner-directory.cjs +6 -6
  84. package/dist/apis/partner-directory.js +1 -1
  85. package/dist/apis/permissions.cjs +6 -6
  86. package/dist/apis/permissions.js +1 -1
  87. package/dist/apis/pricing-tier.cjs +6 -6
  88. package/dist/apis/pricing-tier.js +1 -1
  89. package/dist/apis/pricing.cjs +6 -6
  90. package/dist/apis/pricing.js +1 -1
  91. package/dist/apis/purpose.cjs +6 -6
  92. package/dist/apis/purpose.js +1 -1
  93. package/dist/apis/query.cjs +6 -6
  94. package/dist/apis/query.js +1 -1
  95. package/dist/apis/sandbox.cjs +6 -6
  96. package/dist/apis/sandbox.js +1 -1
  97. package/dist/apis/sharing.cjs +6 -6
  98. package/dist/apis/sharing.js +1 -1
  99. package/dist/apis/snapshot.cjs +6 -6
  100. package/dist/apis/snapshot.js +1 -1
  101. package/dist/apis/submission.cjs +6 -6
  102. package/dist/apis/submission.js +1 -1
  103. package/dist/apis/target.cjs +6 -6
  104. package/dist/apis/target.js +1 -1
  105. package/dist/apis/targeting.cjs +6 -6
  106. package/dist/apis/targeting.js +1 -1
  107. package/dist/apis/template-variables.cjs +6 -6
  108. package/dist/apis/template-variables.js +1 -1
  109. package/dist/apis/user.cjs +6 -6
  110. package/dist/apis/user.js +1 -1
  111. package/dist/apis/validation-rules.cjs +6 -6
  112. package/dist/apis/validation-rules.js +1 -1
  113. package/dist/apis/webhooks.cjs +6 -6
  114. package/dist/apis/webhooks.js +1 -1
  115. package/dist/apis/workflow-definition.cjs +6 -6
  116. package/dist/apis/workflow-definition.js +1 -1
  117. package/dist/apis/workflow.cjs +6 -6
  118. package/dist/apis/workflow.js +1 -1
  119. package/dist/{chunk-EPDH37RS.js → chunk-AWKA7GZQ.js} +1 -1
  120. package/dist/{chunk-YGOX7IZC.cjs → chunk-QAEAAKLA.cjs} +4 -4
  121. package/dist/{chunk-LKV3RKOP.cjs → chunk-QKEPXYEF.cjs} +1 -1
  122. package/dist/{chunk-JH7NETLC.js → chunk-S6BWLYUQ.js} +4 -4
  123. package/dist/customer-portal-JLUT56QQ.js +7 -0
  124. package/dist/customer-portal-NUYHT3HX.cjs +7 -0
  125. package/dist/{customer-portal-runtime-FZQLCEJQ.js → customer-portal-runtime-6CECA6UW.js} +1 -1
  126. package/dist/{customer-portal-runtime-7WW3YRWJ.cjs → customer-portal-runtime-QMONBHLN.cjs} +2 -2
  127. package/dist/{customer-portal.d-JVkJjm_e.d.cts → customer-portal.d-Ce8-UnSY.d.cts} +794 -42
  128. package/dist/{customer-portal.d-JVkJjm_e.d.ts → customer-portal.d-Ce8-UnSY.d.ts} +794 -42
  129. package/dist/index.cjs +10 -10
  130. package/dist/index.d.cts +3 -3
  131. package/dist/index.d.ts +3 -3
  132. package/dist/index.js +2 -2
  133. package/dist/integration-toolkit-LMRJVLJA.js +7 -0
  134. package/dist/integration-toolkit-YMVNGSQ5.cjs +7 -0
  135. package/dist/{integration-toolkit.d-CoMi10QU.d.ts → integration-toolkit.d-Dj-tULW0.d.cts} +26 -13
  136. package/dist/{integration-toolkit.d-CoMi10QU.d.cts → integration-toolkit.d-Dj-tULW0.d.ts} +26 -13
  137. package/docs/ai-agents.md +76 -19
  138. package/docs/customer-portal.md +209 -13
  139. package/docs/integration-toolkit.md +6 -5
  140. package/package.json +1 -1
  141. package/dist/ai-agents-3JK4UU2G.js +0 -7
  142. package/dist/ai-agents-XST3YUFA.cjs +0 -7
  143. package/dist/customer-portal-JDIXJD6C.cjs +0 -7
  144. package/dist/customer-portal-WIRQ7UCN.js +0 -7
  145. package/dist/integration-toolkit-GR4ZQAY5.cjs +0 -7
  146. package/dist/integration-toolkit-XGQNDLIZ.js +0 -7
@@ -10,6 +10,9 @@ declare namespace Components {
10
10
  * Error message
11
11
  */
12
12
  message?: string;
13
+ /**
14
+ * Machine-readable cause, when the API can name one. `PORTAL_USER_PENDING_ACTIVATION` means the portal user is authenticated but not mapped to a contact yet, so re-authenticating will not help.
15
+ */
13
16
  reason: "invalid_token";
14
17
  }
15
18
  export type Conflict = Schemas.ErrorResp;
@@ -28,6 +31,9 @@ declare namespace Components {
28
31
  export type InternalServerError = Schemas.ErrorResp;
29
32
  export type InvalidRequest = Schemas.ErrorResp;
30
33
  export type InvalidRequestCreateMeterReading = {
34
+ /**
35
+ * Machine-readable cause, when the API can name one. `PORTAL_USER_PENDING_ACTIVATION` means the portal user is authenticated but not mapped to a contact yet, so re-authenticating will not help.
36
+ */
31
37
  reason?: "plausibility_check_failed" | "contract_period" | "no_counter" | "no_direction" | "timestamp_future" | "less_than_previous" | "greater_than_subsequent" | "meter_decommissioned" | "plausibility_check_failed";
32
38
  upper_limit: number;
33
39
  lower_limit: number;
@@ -2944,6 +2950,22 @@ declare namespace Components {
2944
2950
  */
2945
2951
  auto_create_cognito_user?: boolean;
2946
2952
  }
2953
+ /**
2954
+ * Linearized portal workflows of a single entity
2955
+ */
2956
+ export interface EntityPortalWorkflows {
2957
+ entity_id: string;
2958
+ /**
2959
+ * Empty when the entity has no portal-relevant workflow
2960
+ */
2961
+ portal_workflows: /**
2962
+ * A portal-facing projection of a workflow execution (V1 or V2), with the execution
2963
+ * graph already linearized by the Workflows API into a flat, ordered list of
2964
+ * portal-visible tasks.
2965
+ *
2966
+ */
2967
+ PortalWorkflow[];
2968
+ }
2947
2969
  /**
2948
2970
  * Response for entity get request
2949
2971
  */
@@ -3296,6 +3318,10 @@ declare namespace Components {
3296
3318
  * Error message
3297
3319
  */
3298
3320
  message?: string;
3321
+ /**
3322
+ * Machine-readable cause, when the API can name one. `PORTAL_USER_PENDING_ACTIVATION` means the portal user is authenticated but not mapped to a contact yet, so re-authenticating will not help.
3323
+ */
3324
+ reason?: string;
3299
3325
  }
3300
3326
  /**
3301
3327
  * example:
@@ -4713,6 +4739,20 @@ declare namespace Components {
4713
4739
  */
4714
4740
  is_new?: boolean;
4715
4741
  }
4742
+ export interface FilePreviewResult {
4743
+ /**
4744
+ * What kind of preview (if any) is available. "pdf" covers both native PDFs and Office documents that were converted to PDF server-side. "unsupported" means no preview is available and the caller should fall back to download.
4745
+ */
4746
+ kind: "pdf" | "image" | "unsupported";
4747
+ /**
4748
+ * A Content-Disposition: inline URL to render in a preview viewer. Present only when kind is "pdf" or "image". Short-lived — do not cache across dialog opens.
4749
+ */
4750
+ url?: string; // uri
4751
+ /**
4752
+ * Optional download URL for the file, returned for any kind — including "unsupported" — whenever the file entity exposes one. It is only a Content-Disposition: attachment URL for files with access_control "private", where it is a short-lived signed URL; for any other access level it is the file entity's plain public/CDN object URL, which carries no attachment disposition and may render inline in the browser. Absent when the file entity exposes no usable URL, so clients must handle it being missing.
4753
+ */
4754
+ download_url?: string; // uri
4755
+ }
4716
4756
  export interface Grant {
4717
4757
  /**
4718
4758
  * Action for granting permission
@@ -6578,9 +6618,10 @@ declare namespace Components {
6578
6618
  * providers not in the list are deleted. Omit the field to leave SSO
6579
6619
  * configuration unchanged; send an empty array to remove all providers.
6580
6620
  *
6581
- * Each provider is persisted verbatim — `oidc_config.client_secret` is stored
6582
- * as sent. Customers are encouraged to reference an org env secret via
6583
- * `{{ env.VAR }}` rather than embed raw values.
6621
+ * Secrets: a provider sent without `oidc_config.client_secret` keeps the
6622
+ * stored secret for the same slug; an explicit empty string clears it.
6623
+ * `getPortalConfigV3` returns providers with raw secrets redacted;
6624
+ * `{{ env.VAR }}` references pass through.
6584
6625
  *
6585
6626
  */
6586
6627
  identity_providers?: ProviderPublicConfig[];
@@ -8098,7 +8139,10 @@ declare namespace Components {
8098
8139
  use_case_slug: string;
8099
8140
  }
8100
8141
  export type Source = "ECP" | "ERP" | "360" | "journey-submission";
8101
- export type SwappableConfig = "all" | "domain" | "users" | "email_templates";
8142
+ /**
8143
+ * Optional configuration item that a portal swap can additionally include. The swap always transfers the pages and the functional experience config that keep the portal working. These items are opt-in on top of that and are OFF by default. Domain and access/security settings (domain, cognito_details, auth_settings) can never be swapped and are therefore not part of this enum.
8144
+ */
8145
+ export type SwappableConfig = "email_templates";
8102
8146
  export type TariffType = "ht" | "nt";
8103
8147
  export interface TeaserWidget {
8104
8148
  id: string;
@@ -8196,9 +8240,10 @@ declare namespace Components {
8196
8240
  * providers not in the list are deleted. Omit the field to leave SSO
8197
8241
  * configuration unchanged; send an empty array to remove all providers.
8198
8242
  *
8199
- * Each provider is persisted verbatim — `oidc_config.client_secret` is stored
8200
- * as sent. Customers are encouraged to reference an org env secret via
8201
- * `{{ env.VAR }}` rather than embed raw values.
8243
+ * Secrets: a provider sent without `oidc_config.client_secret` keeps the
8244
+ * stored secret for the same slug; an explicit empty string clears it.
8245
+ * `getPortalConfigV3` returns providers with raw secrets redacted;
8246
+ * `{{ env.VAR }}` references pass through.
8202
8247
  *
8203
8248
  */
8204
8249
  identity_providers?: /**
@@ -8264,9 +8309,10 @@ declare namespace Components {
8264
8309
  * providers not in the list are deleted. Omit the field to leave SSO
8265
8310
  * configuration unchanged; send an empty array to remove all providers.
8266
8311
  *
8267
- * Each provider is persisted verbatim — `oidc_config.client_secret` is stored
8268
- * as sent. Customers are encouraged to reference an org env secret via
8269
- * `{{ env.VAR }}` rather than embed raw values.
8312
+ * Secrets: a provider sent without `oidc_config.client_secret` keeps the
8313
+ * stored secret for the same slug; an explicit empty string clears it.
8314
+ * `getPortalConfigV3` returns providers with raw secrets redacted;
8315
+ * `{{ env.VAR }}` references pass through.
8270
8316
  *
8271
8317
  */
8272
8318
  identity_providers?: /**
@@ -8851,9 +8897,10 @@ declare namespace Components {
8851
8897
  * providers not in the list are deleted. Omit the field to leave SSO
8852
8898
  * configuration unchanged; send an empty array to remove all providers.
8853
8899
  *
8854
- * Each provider is persisted verbatim — `oidc_config.client_secret` is stored
8855
- * as sent. Customers are encouraged to reference an org env secret via
8856
- * `{{ env.VAR }}` rather than embed raw values.
8900
+ * Secrets: a provider sent without `oidc_config.client_secret` keeps the
8901
+ * stored secret for the same slug; an explicit empty string clears it.
8902
+ * `getPortalConfigV3` returns providers with raw secrets redacted;
8903
+ * `{{ env.VAR }}` references pass through.
8857
8904
  *
8858
8905
  */
8859
8906
  identity_providers?: /**
@@ -11740,6 +11787,621 @@ declare namespace Paths {
11740
11787
  export type $500 = Components.Responses.InternalServerError;
11741
11788
  }
11742
11789
  }
11790
+ namespace GetEntityPortalWorkflowsBatch {
11791
+ export interface RequestBody {
11792
+ entities: [
11793
+ {
11794
+ /**
11795
+ * ID of the entity
11796
+ */
11797
+ id: string;
11798
+ /**
11799
+ * Schema slug of the entity
11800
+ * example:
11801
+ * order
11802
+ */
11803
+ slug: string;
11804
+ },
11805
+ {
11806
+ /**
11807
+ * ID of the entity
11808
+ */
11809
+ id: string;
11810
+ /**
11811
+ * Schema slug of the entity
11812
+ * example:
11813
+ * order
11814
+ */
11815
+ slug: string;
11816
+ }?,
11817
+ {
11818
+ /**
11819
+ * ID of the entity
11820
+ */
11821
+ id: string;
11822
+ /**
11823
+ * Schema slug of the entity
11824
+ * example:
11825
+ * order
11826
+ */
11827
+ slug: string;
11828
+ }?,
11829
+ {
11830
+ /**
11831
+ * ID of the entity
11832
+ */
11833
+ id: string;
11834
+ /**
11835
+ * Schema slug of the entity
11836
+ * example:
11837
+ * order
11838
+ */
11839
+ slug: string;
11840
+ }?,
11841
+ {
11842
+ /**
11843
+ * ID of the entity
11844
+ */
11845
+ id: string;
11846
+ /**
11847
+ * Schema slug of the entity
11848
+ * example:
11849
+ * order
11850
+ */
11851
+ slug: string;
11852
+ }?,
11853
+ {
11854
+ /**
11855
+ * ID of the entity
11856
+ */
11857
+ id: string;
11858
+ /**
11859
+ * Schema slug of the entity
11860
+ * example:
11861
+ * order
11862
+ */
11863
+ slug: string;
11864
+ }?,
11865
+ {
11866
+ /**
11867
+ * ID of the entity
11868
+ */
11869
+ id: string;
11870
+ /**
11871
+ * Schema slug of the entity
11872
+ * example:
11873
+ * order
11874
+ */
11875
+ slug: string;
11876
+ }?,
11877
+ {
11878
+ /**
11879
+ * ID of the entity
11880
+ */
11881
+ id: string;
11882
+ /**
11883
+ * Schema slug of the entity
11884
+ * example:
11885
+ * order
11886
+ */
11887
+ slug: string;
11888
+ }?,
11889
+ {
11890
+ /**
11891
+ * ID of the entity
11892
+ */
11893
+ id: string;
11894
+ /**
11895
+ * Schema slug of the entity
11896
+ * example:
11897
+ * order
11898
+ */
11899
+ slug: string;
11900
+ }?,
11901
+ {
11902
+ /**
11903
+ * ID of the entity
11904
+ */
11905
+ id: string;
11906
+ /**
11907
+ * Schema slug of the entity
11908
+ * example:
11909
+ * order
11910
+ */
11911
+ slug: string;
11912
+ }?,
11913
+ {
11914
+ /**
11915
+ * ID of the entity
11916
+ */
11917
+ id: string;
11918
+ /**
11919
+ * Schema slug of the entity
11920
+ * example:
11921
+ * order
11922
+ */
11923
+ slug: string;
11924
+ }?,
11925
+ {
11926
+ /**
11927
+ * ID of the entity
11928
+ */
11929
+ id: string;
11930
+ /**
11931
+ * Schema slug of the entity
11932
+ * example:
11933
+ * order
11934
+ */
11935
+ slug: string;
11936
+ }?,
11937
+ {
11938
+ /**
11939
+ * ID of the entity
11940
+ */
11941
+ id: string;
11942
+ /**
11943
+ * Schema slug of the entity
11944
+ * example:
11945
+ * order
11946
+ */
11947
+ slug: string;
11948
+ }?,
11949
+ {
11950
+ /**
11951
+ * ID of the entity
11952
+ */
11953
+ id: string;
11954
+ /**
11955
+ * Schema slug of the entity
11956
+ * example:
11957
+ * order
11958
+ */
11959
+ slug: string;
11960
+ }?,
11961
+ {
11962
+ /**
11963
+ * ID of the entity
11964
+ */
11965
+ id: string;
11966
+ /**
11967
+ * Schema slug of the entity
11968
+ * example:
11969
+ * order
11970
+ */
11971
+ slug: string;
11972
+ }?,
11973
+ {
11974
+ /**
11975
+ * ID of the entity
11976
+ */
11977
+ id: string;
11978
+ /**
11979
+ * Schema slug of the entity
11980
+ * example:
11981
+ * order
11982
+ */
11983
+ slug: string;
11984
+ }?,
11985
+ {
11986
+ /**
11987
+ * ID of the entity
11988
+ */
11989
+ id: string;
11990
+ /**
11991
+ * Schema slug of the entity
11992
+ * example:
11993
+ * order
11994
+ */
11995
+ slug: string;
11996
+ }?,
11997
+ {
11998
+ /**
11999
+ * ID of the entity
12000
+ */
12001
+ id: string;
12002
+ /**
12003
+ * Schema slug of the entity
12004
+ * example:
12005
+ * order
12006
+ */
12007
+ slug: string;
12008
+ }?,
12009
+ {
12010
+ /**
12011
+ * ID of the entity
12012
+ */
12013
+ id: string;
12014
+ /**
12015
+ * Schema slug of the entity
12016
+ * example:
12017
+ * order
12018
+ */
12019
+ slug: string;
12020
+ }?,
12021
+ {
12022
+ /**
12023
+ * ID of the entity
12024
+ */
12025
+ id: string;
12026
+ /**
12027
+ * Schema slug of the entity
12028
+ * example:
12029
+ * order
12030
+ */
12031
+ slug: string;
12032
+ }?,
12033
+ {
12034
+ /**
12035
+ * ID of the entity
12036
+ */
12037
+ id: string;
12038
+ /**
12039
+ * Schema slug of the entity
12040
+ * example:
12041
+ * order
12042
+ */
12043
+ slug: string;
12044
+ }?,
12045
+ {
12046
+ /**
12047
+ * ID of the entity
12048
+ */
12049
+ id: string;
12050
+ /**
12051
+ * Schema slug of the entity
12052
+ * example:
12053
+ * order
12054
+ */
12055
+ slug: string;
12056
+ }?,
12057
+ {
12058
+ /**
12059
+ * ID of the entity
12060
+ */
12061
+ id: string;
12062
+ /**
12063
+ * Schema slug of the entity
12064
+ * example:
12065
+ * order
12066
+ */
12067
+ slug: string;
12068
+ }?,
12069
+ {
12070
+ /**
12071
+ * ID of the entity
12072
+ */
12073
+ id: string;
12074
+ /**
12075
+ * Schema slug of the entity
12076
+ * example:
12077
+ * order
12078
+ */
12079
+ slug: string;
12080
+ }?,
12081
+ {
12082
+ /**
12083
+ * ID of the entity
12084
+ */
12085
+ id: string;
12086
+ /**
12087
+ * Schema slug of the entity
12088
+ * example:
12089
+ * order
12090
+ */
12091
+ slug: string;
12092
+ }?,
12093
+ {
12094
+ /**
12095
+ * ID of the entity
12096
+ */
12097
+ id: string;
12098
+ /**
12099
+ * Schema slug of the entity
12100
+ * example:
12101
+ * order
12102
+ */
12103
+ slug: string;
12104
+ }?,
12105
+ {
12106
+ /**
12107
+ * ID of the entity
12108
+ */
12109
+ id: string;
12110
+ /**
12111
+ * Schema slug of the entity
12112
+ * example:
12113
+ * order
12114
+ */
12115
+ slug: string;
12116
+ }?,
12117
+ {
12118
+ /**
12119
+ * ID of the entity
12120
+ */
12121
+ id: string;
12122
+ /**
12123
+ * Schema slug of the entity
12124
+ * example:
12125
+ * order
12126
+ */
12127
+ slug: string;
12128
+ }?,
12129
+ {
12130
+ /**
12131
+ * ID of the entity
12132
+ */
12133
+ id: string;
12134
+ /**
12135
+ * Schema slug of the entity
12136
+ * example:
12137
+ * order
12138
+ */
12139
+ slug: string;
12140
+ }?,
12141
+ {
12142
+ /**
12143
+ * ID of the entity
12144
+ */
12145
+ id: string;
12146
+ /**
12147
+ * Schema slug of the entity
12148
+ * example:
12149
+ * order
12150
+ */
12151
+ slug: string;
12152
+ }?,
12153
+ {
12154
+ /**
12155
+ * ID of the entity
12156
+ */
12157
+ id: string;
12158
+ /**
12159
+ * Schema slug of the entity
12160
+ * example:
12161
+ * order
12162
+ */
12163
+ slug: string;
12164
+ }?,
12165
+ {
12166
+ /**
12167
+ * ID of the entity
12168
+ */
12169
+ id: string;
12170
+ /**
12171
+ * Schema slug of the entity
12172
+ * example:
12173
+ * order
12174
+ */
12175
+ slug: string;
12176
+ }?,
12177
+ {
12178
+ /**
12179
+ * ID of the entity
12180
+ */
12181
+ id: string;
12182
+ /**
12183
+ * Schema slug of the entity
12184
+ * example:
12185
+ * order
12186
+ */
12187
+ slug: string;
12188
+ }?,
12189
+ {
12190
+ /**
12191
+ * ID of the entity
12192
+ */
12193
+ id: string;
12194
+ /**
12195
+ * Schema slug of the entity
12196
+ * example:
12197
+ * order
12198
+ */
12199
+ slug: string;
12200
+ }?,
12201
+ {
12202
+ /**
12203
+ * ID of the entity
12204
+ */
12205
+ id: string;
12206
+ /**
12207
+ * Schema slug of the entity
12208
+ * example:
12209
+ * order
12210
+ */
12211
+ slug: string;
12212
+ }?,
12213
+ {
12214
+ /**
12215
+ * ID of the entity
12216
+ */
12217
+ id: string;
12218
+ /**
12219
+ * Schema slug of the entity
12220
+ * example:
12221
+ * order
12222
+ */
12223
+ slug: string;
12224
+ }?,
12225
+ {
12226
+ /**
12227
+ * ID of the entity
12228
+ */
12229
+ id: string;
12230
+ /**
12231
+ * Schema slug of the entity
12232
+ * example:
12233
+ * order
12234
+ */
12235
+ slug: string;
12236
+ }?,
12237
+ {
12238
+ /**
12239
+ * ID of the entity
12240
+ */
12241
+ id: string;
12242
+ /**
12243
+ * Schema slug of the entity
12244
+ * example:
12245
+ * order
12246
+ */
12247
+ slug: string;
12248
+ }?,
12249
+ {
12250
+ /**
12251
+ * ID of the entity
12252
+ */
12253
+ id: string;
12254
+ /**
12255
+ * Schema slug of the entity
12256
+ * example:
12257
+ * order
12258
+ */
12259
+ slug: string;
12260
+ }?,
12261
+ {
12262
+ /**
12263
+ * ID of the entity
12264
+ */
12265
+ id: string;
12266
+ /**
12267
+ * Schema slug of the entity
12268
+ * example:
12269
+ * order
12270
+ */
12271
+ slug: string;
12272
+ }?,
12273
+ {
12274
+ /**
12275
+ * ID of the entity
12276
+ */
12277
+ id: string;
12278
+ /**
12279
+ * Schema slug of the entity
12280
+ * example:
12281
+ * order
12282
+ */
12283
+ slug: string;
12284
+ }?,
12285
+ {
12286
+ /**
12287
+ * ID of the entity
12288
+ */
12289
+ id: string;
12290
+ /**
12291
+ * Schema slug of the entity
12292
+ * example:
12293
+ * order
12294
+ */
12295
+ slug: string;
12296
+ }?,
12297
+ {
12298
+ /**
12299
+ * ID of the entity
12300
+ */
12301
+ id: string;
12302
+ /**
12303
+ * Schema slug of the entity
12304
+ * example:
12305
+ * order
12306
+ */
12307
+ slug: string;
12308
+ }?,
12309
+ {
12310
+ /**
12311
+ * ID of the entity
12312
+ */
12313
+ id: string;
12314
+ /**
12315
+ * Schema slug of the entity
12316
+ * example:
12317
+ * order
12318
+ */
12319
+ slug: string;
12320
+ }?,
12321
+ {
12322
+ /**
12323
+ * ID of the entity
12324
+ */
12325
+ id: string;
12326
+ /**
12327
+ * Schema slug of the entity
12328
+ * example:
12329
+ * order
12330
+ */
12331
+ slug: string;
12332
+ }?,
12333
+ {
12334
+ /**
12335
+ * ID of the entity
12336
+ */
12337
+ id: string;
12338
+ /**
12339
+ * Schema slug of the entity
12340
+ * example:
12341
+ * order
12342
+ */
12343
+ slug: string;
12344
+ }?,
12345
+ {
12346
+ /**
12347
+ * ID of the entity
12348
+ */
12349
+ id: string;
12350
+ /**
12351
+ * Schema slug of the entity
12352
+ * example:
12353
+ * order
12354
+ */
12355
+ slug: string;
12356
+ }?,
12357
+ {
12358
+ /**
12359
+ * ID of the entity
12360
+ */
12361
+ id: string;
12362
+ /**
12363
+ * Schema slug of the entity
12364
+ * example:
12365
+ * order
12366
+ */
12367
+ slug: string;
12368
+ }?,
12369
+ {
12370
+ /**
12371
+ * ID of the entity
12372
+ */
12373
+ id: string;
12374
+ /**
12375
+ * Schema slug of the entity
12376
+ * example:
12377
+ * order
12378
+ */
12379
+ slug: string;
12380
+ }?,
12381
+ {
12382
+ /**
12383
+ * ID of the entity
12384
+ */
12385
+ id: string;
12386
+ /**
12387
+ * Schema slug of the entity
12388
+ * example:
12389
+ * order
12390
+ */
12391
+ slug: string;
12392
+ }?
12393
+ ];
12394
+ }
12395
+ namespace Responses {
12396
+ export interface $200 {
12397
+ results?: /* Linearized portal workflows of a single entity */ Components.Schemas.EntityPortalWorkflows[];
12398
+ }
12399
+ export type $400 = Components.Responses.InvalidRequest;
12400
+ export type $401 = Components.Responses.Unauthorized;
12401
+ export type $403 = Components.Responses.Forbidden;
12402
+ export type $500 = Components.Responses.InternalServerError;
12403
+ }
12404
+ }
11743
12405
  namespace GetEntityWorkflows {
11744
12406
  namespace Parameters {
11745
12407
  /**
@@ -11916,6 +12578,26 @@ declare namespace Paths {
11916
12578
  export type $500 = Components.Responses.InternalServerError;
11917
12579
  }
11918
12580
  }
12581
+ namespace GetFilePreview {
12582
+ namespace Parameters {
12583
+ export type Id = /**
12584
+ * Entity ID
12585
+ * example:
12586
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
12587
+ */
12588
+ Components.Schemas.EntityId /* uuid */;
12589
+ }
12590
+ export interface PathParameters {
12591
+ id: Parameters.Id;
12592
+ }
12593
+ namespace Responses {
12594
+ export type $200 = Components.Schemas.FilePreviewResult;
12595
+ export type $401 = Components.Responses.Unauthorized;
12596
+ export type $403 = Components.Responses.Forbidden;
12597
+ export type $404 = Components.Responses.NotFound;
12598
+ export type $500 = Components.Responses.InternalServerError;
12599
+ }
12600
+ }
11919
12601
  namespace GetFilesCountByEntity {
11920
12602
  namespace Responses {
11921
12603
  export type $200 = Components.Schemas.EntityFileCount[];
@@ -15003,6 +15685,10 @@ declare namespace Paths {
15003
15685
  * The email address registered in the journey's Login & Registration block
15004
15686
  */
15005
15687
  journey_registration_email?: string;
15688
+ /**
15689
+ * The portal selected on the journey's Login & Registration block, used to target the registration link to that portal
15690
+ */
15691
+ journey_registration_portal_id?: string;
15006
15692
  };
15007
15693
  };
15008
15694
  }
@@ -15436,9 +16122,9 @@ declare namespace Paths {
15436
16122
  */
15437
16123
  Components.Schemas.PortalId;
15438
16124
  /**
15439
- * Items to swap
16125
+ * Optional, opt-in configuration items to additionally swap on top of the always-swapped pages and functional config. Defaults to an empty list (nothing extra swapped). Domain and access/security settings can never be swapped.
15440
16126
  */
15441
- items_to_swap?: Components.Schemas.SwappableConfig[];
16127
+ items_to_swap?: /* Optional configuration item that a portal swap can additionally include. The swap always transfers the pages and the functional experience config that keep the portal working. These items are opt-in on top of that and are OFF by default. Domain and access/security settings (domain, cognito_details, auth_settings) can never be swapped and are therefore not part of this enum. */ Components.Schemas.SwappableConfig[];
15442
16128
  }
15443
16129
  namespace Responses {
15444
16130
  export interface $200 {
@@ -16431,7 +17117,7 @@ interface OperationMethods {
16431
17117
  config?: AxiosRequestConfig
16432
17118
  ): OperationResponse<Paths.GetPublicPortalExtensionDetailsV3.Responses.$200>
16433
17119
  /**
16434
- * getConsumption - Get Consumption
17120
+ * getConsumption - getConsumption
16435
17121
  *
16436
17122
  * Get energy consumption data between a given time period.
16437
17123
  */
@@ -16441,7 +17127,7 @@ interface OperationMethods {
16441
17127
  config?: AxiosRequestConfig
16442
17128
  ): OperationResponse<Paths.GetConsumption.Responses.$200>
16443
17129
  /**
16444
- * prepareVisualizationExport - Prepare Visualization Export
17130
+ * prepareVisualizationExport - prepareVisualizationExport
16445
17131
  *
16446
17132
  * Asks an installed App to prepare a downloadable export of a visualization (consumption chart, dynamic tariff chart, etc.). The export is produced by the third-party App via a configured portal extension hook of type `dataExport` — this endpoint does not generate the file itself, it forwards the request to the configured hook and returns the descriptor the App provides (typically a `download_url`).
16447
17133
  *
@@ -16452,7 +17138,7 @@ interface OperationMethods {
16452
17138
  config?: AxiosRequestConfig
16453
17139
  ): OperationResponse<Paths.PrepareVisualizationExport.Responses.$200>
16454
17140
  /**
16455
- * getVisualizationMetadata - Get Visualization Metadata
17141
+ * getVisualizationMetadata - getVisualizationMetadata
16456
17142
  *
16457
17143
  * Returns runtime metadata describing how a visualization (consumption / price / cost chart) should be rendered for a given portal context (meter, contract, etc). Resolves the extension's `visualizationMetadata` hook implicitly from `app_id` + `extensionId` and invokes it. Supplies the response as a structured payload that the portal uses to configure type/aggregation options, supported intervals, and the available data range.
16458
17144
  *
@@ -16463,7 +17149,7 @@ interface OperationMethods {
16463
17149
  config?: AxiosRequestConfig
16464
17150
  ): OperationResponse<Paths.GetVisualizationMetadata.Responses.$200>
16465
17151
  /**
16466
- * getCosts - Get Costs
17152
+ * getCosts - getCosts
16467
17153
  *
16468
17154
  * Get energy cost data between a given time period.
16469
17155
  */
@@ -16473,7 +17159,7 @@ interface OperationMethods {
16473
17159
  config?: AxiosRequestConfig
16474
17160
  ): OperationResponse<Paths.GetCosts.Responses.$200>
16475
17161
  /**
16476
- * getPrices - Get Prices
17162
+ * getPrices - getPrices
16477
17163
  *
16478
17164
  * Get energy prices data between a given time period.
16479
17165
  */
@@ -17309,6 +17995,16 @@ interface OperationMethods {
17309
17995
  data?: any,
17310
17996
  config?: AxiosRequestConfig
17311
17997
  ): OperationResponse<Paths.GetFileById.Responses.$200>
17998
+ /**
17999
+ * getFilePreview - getFilePreview
18000
+ *
18001
+ * resolves an in-portal preview for a file. Returns a Content-Disposition: inline URL for directly-previewable files (PDF, common image formats), or a document-api PDF conversion result for the Office formats it currently supports (docx/xls/xlsx/xlsm) -- NOT doc/csv/pptx, which document-api's conversion does not cover today. Returns { kind: "unsupported" } (no url) for anything else, so the caller can fall back to the existing download flow. An optional `download_url` is returned for all kinds — including "unsupported" — whenever the file entity exposes one, so the client can render a real anchor for its Download action; it is only a Content-Disposition: attachment URL for private files, and for other access levels it is the plain object URL, which may render inline. The previewability decision is made server-side from the file's own filename/mime_type — never trust a client-supplied kind for anything security-sensitive.
18002
+ */
18003
+ 'getFilePreview'(
18004
+ parameters?: Parameters<Paths.GetFilePreview.PathParameters> | null,
18005
+ data?: any,
18006
+ config?: AxiosRequestConfig
18007
+ ): OperationResponse<Paths.GetFilePreview.Responses.$200>
17312
18008
  /**
17313
18009
  * trackFileDownloaded - trackFileDownloaded
17314
18010
  *
@@ -17320,7 +18016,7 @@ interface OperationMethods {
17320
18016
  config?: AxiosRequestConfig
17321
18017
  ): OperationResponse<Paths.TrackFileDownloaded.Responses.$200>
17322
18018
  /**
17323
- * getFilesCountByEntity - getFileCountByEntity
18019
+ * getFilesCountByEntity - getFilesCountByEntity
17324
18020
  *
17325
18021
  * Fetch file counts for all ECP user related entities
17326
18022
  */
@@ -17474,7 +18170,7 @@ interface OperationMethods {
17474
18170
  config?: AxiosRequestConfig
17475
18171
  ): OperationResponse<Paths.UpdateWorkflowStepAsDone.Responses.$200>
17476
18172
  /**
17477
- * getEntityWorkflows - Get workflows for an entity
18173
+ * getEntityWorkflows - getEntityWorkflows
17478
18174
  *
17479
18175
  * Get all workflows associated with an entity (requires access to the entity)
17480
18176
  */
@@ -17484,7 +18180,7 @@ interface OperationMethods {
17484
18180
  config?: AxiosRequestConfig
17485
18181
  ): OperationResponse<Paths.GetEntityWorkflows.Responses.$200>
17486
18182
  /**
17487
- * getEntityPortalWorkflows - Get linearized workflows for an entity
18183
+ * getEntityPortalWorkflows - getEntityPortalWorkflows
17488
18184
  *
17489
18185
  * Get all portal-relevant workflows associated with an entity (requires access to the entity),
17490
18186
  * linearized by the Workflows API into a flat, ordered list of portal-visible tasks.
@@ -17504,7 +18200,25 @@ interface OperationMethods {
17504
18200
  config?: AxiosRequestConfig
17505
18201
  ): OperationResponse<Paths.GetEntityPortalWorkflows.Responses.$200>
17506
18202
  /**
17507
- * uploadMeterReadingPhoto - Upload Meter Reading Photo
18203
+ * getEntityPortalWorkflowsBatch - getEntityPortalWorkflowsBatch
18204
+ *
18205
+ * Batch variant of `getEntityPortalWorkflows`: returns portal-relevant workflows for
18206
+ * up to 50 entities — schemas may differ — in a single call, each already linearized
18207
+ * by the Workflows API into a flat, ordered list of portal-visible tasks.
18208
+ *
18209
+ * Intended for portal list views (e.g. an entity list where every card shows its
18210
+ * workflow progress). Entities the portal user cannot access are omitted from the
18211
+ * response; an entry with an empty task list means the entity has no portal-relevant
18212
+ * workflow.
18213
+ *
18214
+ */
18215
+ 'getEntityPortalWorkflowsBatch'(
18216
+ parameters?: Parameters<UnknownParamsObject> | null,
18217
+ data?: Paths.GetEntityPortalWorkflowsBatch.RequestBody,
18218
+ config?: AxiosRequestConfig
18219
+ ): OperationResponse<Paths.GetEntityPortalWorkflowsBatch.Responses.$200>
18220
+ /**
18221
+ * uploadMeterReadingPhoto - uploadMeterReadingPhoto
17508
18222
  *
17509
18223
  * Uploads a Meter Reading photo and - if enabled - gives back data extracted from the photo.
17510
18224
  */
@@ -17514,7 +18228,7 @@ interface OperationMethods {
17514
18228
  config?: AxiosRequestConfig
17515
18229
  ): OperationResponse<Paths.UploadMeterReadingPhoto.Responses.$200>
17516
18230
  /**
17517
- * createMeterReading - Create Meter Reading
18231
+ * createMeterReading - createMeterReading
17518
18232
  *
17519
18233
  * Inserts a new meter reading.
17520
18234
  */
@@ -17524,7 +18238,9 @@ interface OperationMethods {
17524
18238
  config?: AxiosRequestConfig
17525
18239
  ): OperationResponse<Paths.CreateMeterReading.Responses.$200>
17526
18240
  /**
17527
- * getAllowedMeterReadingRange - Get allowed reading range for all counters of a meter from the configured
18241
+ * getAllowedMeterReadingRange - getAllowedMeterReadingRange
18242
+ *
18243
+ * Get allowed reading range for all counters of a meter from the configured
17528
18244
  * third-party plausibility check hook using 'range' mode. This endpoint requires
17529
18245
  * a plausibility check hook to be configured for the portal.
17530
18246
  *
@@ -17535,7 +18251,7 @@ interface OperationMethods {
17535
18251
  config?: AxiosRequestConfig
17536
18252
  ): OperationResponse<Paths.GetAllowedMeterReadingRange.Responses.$200>
17537
18253
  /**
17538
- * getMeterReadings - Get meter readings with optional template resolution
18254
+ * getMeterReadings - getMeterReadings
17539
18255
  *
17540
18256
  * Fetches meter readings for a counter and optionally resolves Handlebars
17541
18257
  * template strings against each reading object using @epilot/variables.
@@ -17782,7 +18498,7 @@ interface OperationMethods {
17782
18498
  config?: AxiosRequestConfig
17783
18499
  ): OperationResponse<Paths.GetUserEntryPoint.Responses.$200>
17784
18500
  /**
17785
- * updateCampaignPortalBlockStatus - Update Campaign Portal Block Status
18501
+ * updateCampaignPortalBlockStatus - updateCampaignPortalBlockStatus
17786
18502
  *
17787
18503
  * Updates the status of a campaign portal block for multiple recipients.
17788
18504
  */
@@ -18176,7 +18892,7 @@ interface PathsDictionary {
18176
18892
  }
18177
18893
  ['/v2/portal/consumption']: {
18178
18894
  /**
18179
- * getConsumption - Get Consumption
18895
+ * getConsumption - getConsumption
18180
18896
  *
18181
18897
  * Get energy consumption data between a given time period.
18182
18898
  */
@@ -18188,7 +18904,7 @@ interface PathsDictionary {
18188
18904
  }
18189
18905
  ['/v2/portal/visualization:export']: {
18190
18906
  /**
18191
- * prepareVisualizationExport - Prepare Visualization Export
18907
+ * prepareVisualizationExport - prepareVisualizationExport
18192
18908
  *
18193
18909
  * Asks an installed App to prepare a downloadable export of a visualization (consumption chart, dynamic tariff chart, etc.). The export is produced by the third-party App via a configured portal extension hook of type `dataExport` — this endpoint does not generate the file itself, it forwards the request to the configured hook and returns the descriptor the App provides (typically a `download_url`).
18194
18910
  *
@@ -18201,7 +18917,7 @@ interface PathsDictionary {
18201
18917
  }
18202
18918
  ['/v2/portal/visualization/metadata']: {
18203
18919
  /**
18204
- * getVisualizationMetadata - Get Visualization Metadata
18920
+ * getVisualizationMetadata - getVisualizationMetadata
18205
18921
  *
18206
18922
  * Returns runtime metadata describing how a visualization (consumption / price / cost chart) should be rendered for a given portal context (meter, contract, etc). Resolves the extension's `visualizationMetadata` hook implicitly from `app_id` + `extensionId` and invokes it. Supplies the response as a structured payload that the portal uses to configure type/aggregation options, supported intervals, and the available data range.
18207
18923
  *
@@ -18214,7 +18930,7 @@ interface PathsDictionary {
18214
18930
  }
18215
18931
  ['/v2/portal/costs']: {
18216
18932
  /**
18217
- * getCosts - Get Costs
18933
+ * getCosts - getCosts
18218
18934
  *
18219
18935
  * Get energy cost data between a given time period.
18220
18936
  */
@@ -18226,7 +18942,7 @@ interface PathsDictionary {
18226
18942
  }
18227
18943
  ['/v2/portal/prices']: {
18228
18944
  /**
18229
- * getPrices - Get Prices
18945
+ * getPrices - getPrices
18230
18946
  *
18231
18947
  * Get energy prices data between a given time period.
18232
18948
  */
@@ -19199,6 +19915,18 @@ interface PathsDictionary {
19199
19915
  config?: AxiosRequestConfig
19200
19916
  ): OperationResponse<Paths.GetFileById.Responses.$200>
19201
19917
  }
19918
+ ['/v2/portal/user/file/{id}/preview']: {
19919
+ /**
19920
+ * getFilePreview - getFilePreview
19921
+ *
19922
+ * resolves an in-portal preview for a file. Returns a Content-Disposition: inline URL for directly-previewable files (PDF, common image formats), or a document-api PDF conversion result for the Office formats it currently supports (docx/xls/xlsx/xlsm) -- NOT doc/csv/pptx, which document-api's conversion does not cover today. Returns { kind: "unsupported" } (no url) for anything else, so the caller can fall back to the existing download flow. An optional `download_url` is returned for all kinds — including "unsupported" — whenever the file entity exposes one, so the client can render a real anchor for its Download action; it is only a Content-Disposition: attachment URL for private files, and for other access levels it is the plain object URL, which may render inline. The previewability decision is made server-side from the file's own filename/mime_type — never trust a client-supplied kind for anything security-sensitive.
19923
+ */
19924
+ 'get'(
19925
+ parameters?: Parameters<Paths.GetFilePreview.PathParameters> | null,
19926
+ data?: any,
19927
+ config?: AxiosRequestConfig
19928
+ ): OperationResponse<Paths.GetFilePreview.Responses.$200>
19929
+ }
19202
19930
  ['/v2/portal/user/file/{id}/downloaded']: {
19203
19931
  /**
19204
19932
  * trackFileDownloaded - trackFileDownloaded
@@ -19213,7 +19941,7 @@ interface PathsDictionary {
19213
19941
  }
19214
19942
  ['/v2/portal/user/files/count-by-entity']: {
19215
19943
  /**
19216
- * getFilesCountByEntity - getFileCountByEntity
19944
+ * getFilesCountByEntity - getFilesCountByEntity
19217
19945
  *
19218
19946
  * Fetch file counts for all ECP user related entities
19219
19947
  */
@@ -19395,7 +20123,7 @@ interface PathsDictionary {
19395
20123
  }
19396
20124
  ['/v2/portal/entity/{slug}/{id}/workflows']: {
19397
20125
  /**
19398
- * getEntityWorkflows - Get workflows for an entity
20126
+ * getEntityWorkflows - getEntityWorkflows
19399
20127
  *
19400
20128
  * Get all workflows associated with an entity (requires access to the entity)
19401
20129
  */
@@ -19407,7 +20135,7 @@ interface PathsDictionary {
19407
20135
  }
19408
20136
  ['/v2/portal/entity/{slug}/{id}/workflows/linearized']: {
19409
20137
  /**
19410
- * getEntityPortalWorkflows - Get linearized workflows for an entity
20138
+ * getEntityPortalWorkflows - getEntityPortalWorkflows
19411
20139
  *
19412
20140
  * Get all portal-relevant workflows associated with an entity (requires access to the entity),
19413
20141
  * linearized by the Workflows API into a flat, ordered list of portal-visible tasks.
@@ -19427,9 +20155,29 @@ interface PathsDictionary {
19427
20155
  config?: AxiosRequestConfig
19428
20156
  ): OperationResponse<Paths.GetEntityPortalWorkflows.Responses.$200>
19429
20157
  }
20158
+ ['/v2/portal/entities/workflows/linearized/batch']: {
20159
+ /**
20160
+ * getEntityPortalWorkflowsBatch - getEntityPortalWorkflowsBatch
20161
+ *
20162
+ * Batch variant of `getEntityPortalWorkflows`: returns portal-relevant workflows for
20163
+ * up to 50 entities — schemas may differ — in a single call, each already linearized
20164
+ * by the Workflows API into a flat, ordered list of portal-visible tasks.
20165
+ *
20166
+ * Intended for portal list views (e.g. an entity list where every card shows its
20167
+ * workflow progress). Entities the portal user cannot access are omitted from the
20168
+ * response; an entry with an empty task list means the entity has no portal-relevant
20169
+ * workflow.
20170
+ *
20171
+ */
20172
+ 'post'(
20173
+ parameters?: Parameters<UnknownParamsObject> | null,
20174
+ data?: Paths.GetEntityPortalWorkflowsBatch.RequestBody,
20175
+ config?: AxiosRequestConfig
20176
+ ): OperationResponse<Paths.GetEntityPortalWorkflowsBatch.Responses.$200>
20177
+ }
19430
20178
  ['/v2/portal/metering/reading/photo']: {
19431
20179
  /**
19432
- * uploadMeterReadingPhoto - Upload Meter Reading Photo
20180
+ * uploadMeterReadingPhoto - uploadMeterReadingPhoto
19433
20181
  *
19434
20182
  * Uploads a Meter Reading photo and - if enabled - gives back data extracted from the photo.
19435
20183
  */
@@ -19441,7 +20189,7 @@ interface PathsDictionary {
19441
20189
  }
19442
20190
  ['/v2/portal/metering/reading']: {
19443
20191
  /**
19444
- * createMeterReading - Create Meter Reading
20192
+ * createMeterReading - createMeterReading
19445
20193
  *
19446
20194
  * Inserts a new meter reading.
19447
20195
  */
@@ -19453,7 +20201,9 @@ interface PathsDictionary {
19453
20201
  }
19454
20202
  ['/v2/portal/metering/reading/allowed-range/{meter_id}']: {
19455
20203
  /**
19456
- * getAllowedMeterReadingRange - Get allowed reading range for all counters of a meter from the configured
20204
+ * getAllowedMeterReadingRange - getAllowedMeterReadingRange
20205
+ *
20206
+ * Get allowed reading range for all counters of a meter from the configured
19457
20207
  * third-party plausibility check hook using 'range' mode. This endpoint requires
19458
20208
  * a plausibility check hook to be configured for the portal.
19459
20209
  *
@@ -19466,7 +20216,7 @@ interface PathsDictionary {
19466
20216
  }
19467
20217
  ['/v2/portal/metering/readings']: {
19468
20218
  /**
19469
- * getMeterReadings - Get meter readings with optional template resolution
20219
+ * getMeterReadings - getMeterReadings
19470
20220
  *
19471
20221
  * Fetches meter readings for a counter and optionally resolves Handlebars
19472
20222
  * template strings against each reading object using @epilot/variables.
@@ -19743,7 +20493,7 @@ interface PathsDictionary {
19743
20493
  }
19744
20494
  ['/v2/portal/campaign/{campaign_id}/entity:status']: {
19745
20495
  /**
19746
- * updateCampaignPortalBlockStatus - Update Campaign Portal Block Status
20496
+ * updateCampaignPortalBlockStatus - updateCampaignPortalBlockStatus
19747
20497
  *
19748
20498
  * Updates the status of a campaign portal block for multiple recipients.
19749
20499
  */
@@ -20047,6 +20797,7 @@ type EntityGetParams = Components.Schemas.EntityGetParams;
20047
20797
  type EntityId = Components.Schemas.EntityId;
20048
20798
  type EntityItem = Components.Schemas.EntityItem;
20049
20799
  type EntityMatchingConfig = Components.Schemas.EntityMatchingConfig;
20800
+ type EntityPortalWorkflows = Components.Schemas.EntityPortalWorkflows;
20050
20801
  type EntityResponse = Components.Schemas.EntityResponse;
20051
20802
  type EntityResponseGroupedWithHits = Components.Schemas.EntityResponseGroupedWithHits;
20052
20803
  type EntityResponseWithHits = Components.Schemas.EntityResponseWithHits;
@@ -20079,6 +20830,7 @@ type ExtraSchemaAttributes = Components.Schemas.ExtraSchemaAttributes;
20079
20830
  type FailedRuleErrorResp = Components.Schemas.FailedRuleErrorResp;
20080
20831
  type File = Components.Schemas.File;
20081
20832
  type FileItem = Components.Schemas.FileItem;
20833
+ type FilePreviewResult = Components.Schemas.FilePreviewResult;
20082
20834
  type Grant = Components.Schemas.Grant;
20083
20835
  type IdentifierAttribute = Components.Schemas.IdentifierAttribute;
20084
20836
  type InstallmentEvent = Components.Schemas.InstallmentEvent;
@@ -20166,4 +20918,4 @@ type WorfklowIdentifier = Components.Schemas.WorfklowIdentifier;
20166
20918
  type WorkflowExecution = Components.Schemas.WorkflowExecution;
20167
20919
  type WorkflowStep = Components.Schemas.WorkflowStep;
20168
20920
 
20169
- export { type EntityItem as $, type AcceptanceDecision as A, type Balance as B, type Client as C, type CommonConfigAttributesV3 as D, type Contact as E, type ContactCountRequest as F, type ContactExistsRequest as G, type ContentWidget as H, type ContextEntities as I, type ContextEntity as J, type Contract as K, type ContractIdentifier as L, type CreateUserRequest as M, type Currency as N, type OperationMethods as O, Paths as P, type DataRetrievalItem as Q, DeleteEntityFile as R, type Direction as S, type DocumentWidget as T, type DomainSettings as U, type EmailTemplates as V, type Entity as W, type EntityEditRule as X, type EntityFileCount as Y, type EntityGetParams as Z, type EntityId as _, Components as a, type PortalId as a$, type EntityMatchingConfig as a0, type EntityResponse as a1, type EntityResponseGroupedWithHits as a2, type EntityResponseWithHits as a3, type EntitySearchParams as a4, type EntitySlug as a5, type EntitySlugConfig as a6, type EntityTemplates as a7, type EntityWidget as a8, type ErrorResp as a9, type JourneyActions as aA, type JuiceSettings as aB, type Meter as aC, type MeterChartWidget as aD, type MeterReading as aE, type MeterReadingPhoto as aF, type MeterReadingPhotoData as aG, type MeterReadingWidget as aH, type MobileBranding as aI, type MobileBuildStatus as aJ, type MobileConfig as aK, type MobileConfigUpdate as aL, type MobileOtaConfig as aM, type MoblieOIDCConfig as aN, type OIDCProviderConfig as aO, type OIDCProviderMetadata as aP, type Opportunity as aQ, type Order as aR, type OrganizationSettings as aS, type Origin as aT, type OtaPortal as aU, type Page as aV, type PageRequest as aW, type PaymentWidget as aX, type PortalConfig as aY, type PortalConfigV3 as aZ, type PortalDataExportColumn as a_, type Exists as aa, type Extension as ab, type ExtensionAuthBlock as ac, type ExtensionConfig as ad, type ExtensionHook as ae, type ExtensionHookChangeEmail as af, type ExtensionHookChangePassword as ag, type ExtensionHookConsumptionDataRetrieval as ah, type ExtensionHookContractIdentification as ai, type ExtensionHookCostDataRetrieval as aj, type ExtensionHookDataExport as ak, type ExtensionHookDeleteAccount as al, type ExtensionHookMeterReadingPlausibilityCheck as am, type ExtensionHookPriceDataRetrieval as an, type ExtensionHookRegistrationIdentifiersCheck as ao, type ExtensionHookSelection as ap, type ExtensionHookVisualizationMetadata as aq, type ExtensionSeamlessLink as ar, type ExternalLink as as, type ExtraSchemaAttributes as at, type FailedRuleErrorResp as au, type File as av, type FileItem as aw, type Grant as ax, type IdentifierAttribute as ay, type InstallmentEvent as az, type PathsDictionary as b, type PortalTaskConfig as b0, type PortalUser as b1, type PortalUserRegistrationStatus as b2, type PortalWidget as b3, type PortalWorkflow as b4, type PortalWorkflowTask as b5, type Product as b6, type ProductRecommendationsWidget as b7, type ProviderConfig as b8, type ProviderDisplayName as b9, type SecureProxyConfig as bA, type Source as bB, type SwappableConfig as bC, type TariffType as bD, type TeaserWidget as bE, type TriggerPortalFlow as bF, type UpdateOnlyPortalConfigAttributes as bG, type UpsertPortalConfig as bH, type UpsertPortalConfigV3 as bI, UpsertPortalWidget as bJ, type UserRequest as bK, type VisualizationDataRange as bL, type VisualizationMetadata as bM, type VisualizationTypeOption as bN, type WidgetAction as bO, type WidgetBase as bP, type WorfklowIdentifier as bQ, type WorkflowExecution as bR, type WorkflowStep as bS, type ProviderPublicConfig as ba, type ProviderSlug as bb, type PublicAppDetails as bc, type PublicChangeEmailDetails as bd, type PublicChangePasswordDetails as be, type PublicContractIdentificationDetails as bf, type PublicDataRetrievalHookDetails as bg, type PublicDeleteAccountDetails as bh, type PublicExtensionCapabilities as bi, type PublicExtensionDetails as bj, type PublicMeterReadingPlausibilityCheckDetails as bk, type PublicSelfManagementExplanation as bl, type ReadBy as bm, type ReadingStatus as bn, type Reason as bo, type RegistrationIdentifier as bp, type ReimbursementEvent as bq, type Rule as br, type SAMLProviderConfig as bs, type SSOCallbackRequest as bt, type SSOCallbackResponse as bu, type SSOLoginToken as bv, SaveEntityFile as bw, type SavePortalFile as bx, type Schema as by, type SearchIncludes as bz, type AccountExistsRequest as c, type ActionLabel as d, type ActionWidget as e, type Activity as f, type ActivityCallerContext as g, type ActivityId as h, type ActivityItem as i, type AdditionalContactAttribute as j, type AdminUser as k, type AllowedFileExtensions as l, type AttributeMappingConfig as m, type AuthConfig as n, type BaseBillingEvent as o, type BaseEntity as p, type BillingAccount as q, type BillingEvent as r, type Block as s, type BlockId as t, type BlockProps as u, type BlockRequest as v, type BlockType as w, type BusinessPartnerItem as x, type CampaignWidget as y, type CommonConfigAttributes as z };
20921
+ export { type EntityItem as $, type AcceptanceDecision as A, type Balance as B, type Client as C, type CommonConfigAttributesV3 as D, type Contact as E, type ContactCountRequest as F, type ContactExistsRequest as G, type ContentWidget as H, type ContextEntities as I, type ContextEntity as J, type Contract as K, type ContractIdentifier as L, type CreateUserRequest as M, type Currency as N, type OperationMethods as O, Paths as P, type DataRetrievalItem as Q, DeleteEntityFile as R, type Direction as S, type DocumentWidget as T, type DomainSettings as U, type EmailTemplates as V, type Entity as W, type EntityEditRule as X, type EntityFileCount as Y, type EntityGetParams as Z, type EntityId as _, Components as a, type PortalConfigV3 as a$, type EntityMatchingConfig as a0, type EntityPortalWorkflows as a1, type EntityResponse as a2, type EntityResponseGroupedWithHits as a3, type EntityResponseWithHits as a4, type EntitySearchParams as a5, type EntitySlug as a6, type EntitySlugConfig as a7, type EntityTemplates as a8, type EntityWidget as a9, type IdentifierAttribute as aA, type InstallmentEvent as aB, type JourneyActions as aC, type JuiceSettings as aD, type Meter as aE, type MeterChartWidget as aF, type MeterReading as aG, type MeterReadingPhoto as aH, type MeterReadingPhotoData as aI, type MeterReadingWidget as aJ, type MobileBranding as aK, type MobileBuildStatus as aL, type MobileConfig as aM, type MobileConfigUpdate as aN, type MobileOtaConfig as aO, type MoblieOIDCConfig as aP, type OIDCProviderConfig as aQ, type OIDCProviderMetadata as aR, type Opportunity as aS, type Order as aT, type OrganizationSettings as aU, type Origin as aV, type OtaPortal as aW, type Page as aX, type PageRequest as aY, type PaymentWidget as aZ, type PortalConfig as a_, type ErrorResp as aa, type Exists as ab, type Extension as ac, type ExtensionAuthBlock as ad, type ExtensionConfig as ae, type ExtensionHook as af, type ExtensionHookChangeEmail as ag, type ExtensionHookChangePassword as ah, type ExtensionHookConsumptionDataRetrieval as ai, type ExtensionHookContractIdentification as aj, type ExtensionHookCostDataRetrieval as ak, type ExtensionHookDataExport as al, type ExtensionHookDeleteAccount as am, type ExtensionHookMeterReadingPlausibilityCheck as an, type ExtensionHookPriceDataRetrieval as ao, type ExtensionHookRegistrationIdentifiersCheck as ap, type ExtensionHookSelection as aq, type ExtensionHookVisualizationMetadata as ar, type ExtensionSeamlessLink as as, type ExternalLink as at, type ExtraSchemaAttributes as au, type FailedRuleErrorResp as av, type File as aw, type FileItem as ax, type FilePreviewResult as ay, type Grant as az, type PathsDictionary as b, type PortalDataExportColumn as b0, type PortalId as b1, type PortalTaskConfig as b2, type PortalUser as b3, type PortalUserRegistrationStatus as b4, type PortalWidget as b5, type PortalWorkflow as b6, type PortalWorkflowTask as b7, type Product as b8, type ProductRecommendationsWidget as b9, type Schema as bA, type SearchIncludes as bB, type SecureProxyConfig as bC, type Source as bD, type SwappableConfig as bE, type TariffType as bF, type TeaserWidget as bG, type TriggerPortalFlow as bH, type UpdateOnlyPortalConfigAttributes as bI, type UpsertPortalConfig as bJ, type UpsertPortalConfigV3 as bK, UpsertPortalWidget as bL, type UserRequest as bM, type VisualizationDataRange as bN, type VisualizationMetadata as bO, type VisualizationTypeOption as bP, type WidgetAction as bQ, type WidgetBase as bR, type WorfklowIdentifier as bS, type WorkflowExecution as bT, type WorkflowStep as bU, type ProviderConfig as ba, type ProviderDisplayName as bb, type ProviderPublicConfig as bc, type ProviderSlug as bd, type PublicAppDetails as be, type PublicChangeEmailDetails as bf, type PublicChangePasswordDetails as bg, type PublicContractIdentificationDetails as bh, type PublicDataRetrievalHookDetails as bi, type PublicDeleteAccountDetails as bj, type PublicExtensionCapabilities as bk, type PublicExtensionDetails as bl, type PublicMeterReadingPlausibilityCheckDetails as bm, type PublicSelfManagementExplanation as bn, type ReadBy as bo, type ReadingStatus as bp, type Reason as bq, type RegistrationIdentifier as br, type ReimbursementEvent as bs, type Rule as bt, type SAMLProviderConfig as bu, type SSOCallbackRequest as bv, type SSOCallbackResponse as bw, type SSOLoginToken as bx, SaveEntityFile as by, type SavePortalFile as bz, type AccountExistsRequest as c, type ActionLabel as d, type ActionWidget as e, type Activity as f, type ActivityCallerContext as g, type ActivityId as h, type ActivityItem as i, type AdditionalContactAttribute as j, type AdminUser as k, type AllowedFileExtensions as l, type AttributeMappingConfig as m, type AuthConfig as n, type BaseBillingEvent as o, type BaseEntity as p, type BillingAccount as q, type BillingEvent as r, type Block as s, type BlockId as t, type BlockProps as u, type BlockRequest as v, type BlockType as w, type BusinessPartnerItem as x, type CampaignWidget as y, type CommonConfigAttributes as z };