@epilot/sdk 2.18.23 → 2.18.25

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 (136) hide show
  1. package/definitions/customer-portal-runtime.json +1 -1
  2. package/definitions/customer-portal.json +418 -10
  3. package/definitions/validation-rules.json +67 -2
  4. package/dist/apis/access-token.cjs +6 -6
  5. package/dist/apis/access-token.js +1 -1
  6. package/dist/apis/address-suggestions.cjs +6 -6
  7. package/dist/apis/address-suggestions.js +1 -1
  8. package/dist/apis/address.cjs +6 -6
  9. package/dist/apis/address.js +1 -1
  10. package/dist/apis/ai-agents.cjs +6 -6
  11. package/dist/apis/ai-agents.js +1 -1
  12. package/dist/apis/app.cjs +6 -6
  13. package/dist/apis/app.js +1 -1
  14. package/dist/apis/audit-logs.cjs +6 -6
  15. package/dist/apis/audit-logs.js +1 -1
  16. package/dist/apis/automation.cjs +6 -6
  17. package/dist/apis/automation.js +1 -1
  18. package/dist/apis/billing.cjs +6 -6
  19. package/dist/apis/billing.js +1 -1
  20. package/dist/apis/blueprint-manifest.cjs +6 -6
  21. package/dist/apis/blueprint-manifest.js +1 -1
  22. package/dist/apis/calendar.cjs +6 -6
  23. package/dist/apis/calendar.js +1 -1
  24. package/dist/apis/configuration-hub.cjs +6 -6
  25. package/dist/apis/configuration-hub.js +1 -1
  26. package/dist/apis/consent.cjs +6 -6
  27. package/dist/apis/consent.js +1 -1
  28. package/dist/apis/customer-portal.cjs +8 -8
  29. package/dist/apis/customer-portal.d.cts +2 -2
  30. package/dist/apis/customer-portal.d.ts +2 -2
  31. package/dist/apis/customer-portal.js +2 -2
  32. package/dist/apis/dashboard.cjs +6 -6
  33. package/dist/apis/dashboard.js +1 -1
  34. package/dist/apis/data-governance.cjs +6 -6
  35. package/dist/apis/data-governance.js +1 -1
  36. package/dist/apis/deduplication.cjs +6 -6
  37. package/dist/apis/deduplication.js +1 -1
  38. package/dist/apis/design.cjs +6 -6
  39. package/dist/apis/design.js +1 -1
  40. package/dist/apis/document.cjs +6 -6
  41. package/dist/apis/document.js +1 -1
  42. package/dist/apis/email-settings.cjs +6 -6
  43. package/dist/apis/email-settings.js +1 -1
  44. package/dist/apis/email-template.cjs +6 -6
  45. package/dist/apis/email-template.js +1 -1
  46. package/dist/apis/entity-mapping.cjs +6 -6
  47. package/dist/apis/entity-mapping.js +1 -1
  48. package/dist/apis/entity.cjs +6 -6
  49. package/dist/apis/entity.js +1 -1
  50. package/dist/apis/environments.cjs +6 -6
  51. package/dist/apis/environments.js +1 -1
  52. package/dist/apis/event-catalog.cjs +6 -6
  53. package/dist/apis/event-catalog.js +1 -1
  54. package/dist/apis/file.cjs +6 -6
  55. package/dist/apis/file.js +1 -1
  56. package/dist/apis/iban.cjs +6 -6
  57. package/dist/apis/iban.js +1 -1
  58. package/dist/apis/integration-toolkit.cjs +6 -6
  59. package/dist/apis/integration-toolkit.js +1 -1
  60. package/dist/apis/journey.cjs +6 -6
  61. package/dist/apis/journey.js +1 -1
  62. package/dist/apis/kanban.cjs +6 -6
  63. package/dist/apis/kanban.js +1 -1
  64. package/dist/apis/message.cjs +6 -6
  65. package/dist/apis/message.js +1 -1
  66. package/dist/apis/metering.cjs +6 -6
  67. package/dist/apis/metering.js +1 -1
  68. package/dist/apis/notes.cjs +6 -6
  69. package/dist/apis/notes.js +1 -1
  70. package/dist/apis/notification.cjs +6 -6
  71. package/dist/apis/notification.js +1 -1
  72. package/dist/apis/organization.cjs +6 -6
  73. package/dist/apis/organization.js +1 -1
  74. package/dist/apis/partner-directory.cjs +6 -6
  75. package/dist/apis/partner-directory.js +1 -1
  76. package/dist/apis/permissions.cjs +6 -6
  77. package/dist/apis/permissions.js +1 -1
  78. package/dist/apis/pricing-tier.cjs +6 -6
  79. package/dist/apis/pricing-tier.js +1 -1
  80. package/dist/apis/pricing.cjs +6 -6
  81. package/dist/apis/pricing.js +1 -1
  82. package/dist/apis/purpose.cjs +6 -6
  83. package/dist/apis/purpose.js +1 -1
  84. package/dist/apis/query.cjs +6 -6
  85. package/dist/apis/query.js +1 -1
  86. package/dist/apis/sandbox.cjs +6 -6
  87. package/dist/apis/sandbox.js +1 -1
  88. package/dist/apis/sharing.cjs +6 -6
  89. package/dist/apis/sharing.js +1 -1
  90. package/dist/apis/snapshot.cjs +6 -6
  91. package/dist/apis/snapshot.js +1 -1
  92. package/dist/apis/submission.cjs +6 -6
  93. package/dist/apis/submission.js +1 -1
  94. package/dist/apis/target.cjs +6 -6
  95. package/dist/apis/target.js +1 -1
  96. package/dist/apis/targeting.cjs +6 -6
  97. package/dist/apis/targeting.js +1 -1
  98. package/dist/apis/template-variables.cjs +6 -6
  99. package/dist/apis/template-variables.js +1 -1
  100. package/dist/apis/user.cjs +6 -6
  101. package/dist/apis/user.js +1 -1
  102. package/dist/apis/validation-rules.cjs +6 -6
  103. package/dist/apis/validation-rules.d.cts +2 -2
  104. package/dist/apis/validation-rules.d.ts +2 -2
  105. package/dist/apis/validation-rules.js +1 -1
  106. package/dist/apis/webhooks.cjs +6 -6
  107. package/dist/apis/webhooks.js +1 -1
  108. package/dist/apis/workflow-definition.cjs +6 -6
  109. package/dist/apis/workflow-definition.js +1 -1
  110. package/dist/apis/workflow.cjs +6 -6
  111. package/dist/apis/workflow.js +1 -1
  112. package/dist/{chunk-J57SWYWL.cjs → chunk-6AESXD5D.cjs} +3 -3
  113. package/dist/{chunk-AWKA7GZQ.js → chunk-GB2OJK7Z.js} +1 -1
  114. package/dist/{chunk-QKEPXYEF.cjs → chunk-Q35SXSWS.cjs} +1 -1
  115. package/dist/{chunk-SCBBLLBK.js → chunk-XW3N5APN.js} +3 -3
  116. package/dist/customer-portal-FOLTI3GK.cjs +7 -0
  117. package/dist/customer-portal-HQ3DJCGO.js +7 -0
  118. package/dist/{customer-portal-runtime-6CECA6UW.js → customer-portal-runtime-PIBTR7QG.js} +1 -1
  119. package/dist/{customer-portal-runtime-QMONBHLN.cjs → customer-portal-runtime-UVMYBCJL.cjs} +2 -2
  120. package/dist/{customer-portal.d-Ce8-UnSY.d.cts → customer-portal.d-D44zeiJ4.d.cts} +348 -12
  121. package/dist/{customer-portal.d-Ce8-UnSY.d.ts → customer-portal.d-D44zeiJ4.d.ts} +348 -12
  122. package/dist/index.cjs +10 -10
  123. package/dist/index.d.cts +2 -2
  124. package/dist/index.d.ts +2 -2
  125. package/dist/index.js +2 -2
  126. package/dist/validation-rules-G5BWXUWI.cjs +7 -0
  127. package/dist/validation-rules-NLHK2CD3.js +7 -0
  128. package/dist/{validation-rules.d-BBy6Cw2O.d.cts → validation-rules.d-MvjG-zzw.d.cts} +58 -2
  129. package/dist/{validation-rules.d-BBy6Cw2O.d.ts → validation-rules.d-MvjG-zzw.d.ts} +58 -2
  130. package/docs/customer-portal.md +264 -4
  131. package/docs/validation-rules.md +63 -4
  132. package/package.json +1 -1
  133. package/dist/customer-portal-JLUT56QQ.js +0 -7
  134. package/dist/customer-portal-NUYHT3HX.cjs +0 -7
  135. package/dist/validation-rules-CU5JJKDV.cjs +0 -7
  136. package/dist/validation-rules-M2JVIR7U.js +0 -7
@@ -1,5 +1,5 @@
1
1
  import {
2
2
  require_customer_portal_runtime
3
- } from "./chunk-AWKA7GZQ.js";
3
+ } from "./chunk-GB2OJK7Z.js";
4
4
  import "./chunk-YPSWSI3M.js";
5
5
  export default require_customer_portal_runtime();
@@ -1,5 +1,5 @@
1
1
  "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
2
 
3
- var _chunkQKEPXYEFcjs = require('./chunk-QKEPXYEF.cjs');
3
+ var _chunkQ35SXSWScjs = require('./chunk-Q35SXSWS.cjs');
4
4
  require('./chunk-NJK5F5TF.cjs');
5
- exports. default = _chunkQKEPXYEFcjs.require_customer_portal_runtime.call(void 0, );
5
+ exports. default = _chunkQ35SXSWScjs.require_customer_portal_runtime.call(void 0, );
@@ -1456,6 +1456,10 @@ declare namespace Components {
1456
1456
  global_blocks?: {
1457
1457
  [name: string]: Block;
1458
1458
  };
1459
+ /**
1460
+ * Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
1461
+ */
1462
+ notification_triggers?: NotificationTriggerConfig[];
1459
1463
  }
1460
1464
  export interface CommonConfigAttributesV3 {
1461
1465
  /**
@@ -4738,6 +4742,10 @@ declare namespace Components {
4738
4742
  * Indicate whether the user has not seen/downloaded the file before
4739
4743
  */
4740
4744
  is_new?: boolean;
4745
+ /**
4746
+ * Authorization mode of an externally hosted file's download url. `presigned` (the default) means `public_url` is HMAC-signed and needs no auth header; `token` means it authorizes the caller's bearer token instead and must be fetched with an `Authorization` header. Because `presigned` is the default, the absence of this property does NOT prove the file is stored in epilot — an external file may omit it.
4747
+ */
4748
+ custom_download_url_auth?: "token" | "presigned";
4741
4749
  }
4742
4750
  export interface FilePreviewResult {
4743
4751
  /**
@@ -4748,6 +4756,10 @@ declare namespace Components {
4748
4756
  * 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
4757
  */
4750
4758
  url?: string; // uri
4759
+ /**
4760
+ * When true, `url` only answers to the portal user's bearer token: fetch the bytes with an `Authorization: Bearer <token>` header and render them from an object URL. Only ever set for URLs on an allow-listed ERP file-proxy host.
4761
+ */
4762
+ requires_auth?: boolean;
4751
4763
  /**
4752
4764
  * 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
4765
  */
@@ -5328,6 +5340,26 @@ declare namespace Components {
5328
5340
  */
5329
5341
  client_secret?: string;
5330
5342
  }
5343
+ export interface NotificationTriggerConfig {
5344
+ /**
5345
+ * The 360 event that fires this notification trigger.
5346
+ */
5347
+ trigger_type: "entity_created" | "entity_assigned" | "workflow_step_overdue";
5348
+ /**
5349
+ * For `entity_created` / `entity_assigned` triggers, the entity schema slug (e.g. `opportunity`, `order`) whose creation or assignment fires this trigger. Ignored for other trigger types.
5350
+ * example:
5351
+ * opportunity
5352
+ */
5353
+ entity_schema?: string;
5354
+ /**
5355
+ * Whether this trigger is active.
5356
+ */
5357
+ enabled?: boolean;
5358
+ /**
5359
+ * Entity id of the notification_template to render for this trigger.
5360
+ */
5361
+ template_id?: string; // uuid
5362
+ }
5331
5363
  /**
5332
5364
  * OIDC provider configuration. Values are resolved at SSO invocation time
5333
5365
  * (login / callback), so the fields below may reference org env vars via
@@ -5714,6 +5746,44 @@ declare namespace Components {
5714
5746
  */
5715
5747
  minNativeVersion?: string;
5716
5748
  }
5749
+ export interface OutstandingTask {
5750
+ /**
5751
+ * ID of the entity the task belongs to
5752
+ */
5753
+ entity_id: string;
5754
+ /**
5755
+ * Schema slug of the entity (opportunity, order or contract)
5756
+ */
5757
+ entity_schema: string;
5758
+ /**
5759
+ * Title (_title) of the entity
5760
+ */
5761
+ entity_title: string;
5762
+ /**
5763
+ * Workflow execution id
5764
+ */
5765
+ workflow_id: string;
5766
+ /**
5767
+ * Workflow execution / template name
5768
+ */
5769
+ workflow_name: string;
5770
+ /**
5771
+ * Task (step) id within the workflow execution
5772
+ */
5773
+ step_id: string;
5774
+ /**
5775
+ * Task (step) name
5776
+ */
5777
+ step_name: string;
5778
+ /**
5779
+ * Journey id the customer needs to fill out
5780
+ */
5781
+ journey_id: string;
5782
+ /**
5783
+ * Whether submitting the journey from the portal should auto-complete the task. When false, an internal user completes it.
5784
+ */
5785
+ complete_task_automatically?: boolean;
5786
+ }
5717
5787
  export interface Page {
5718
5788
  [name: string]: any;
5719
5789
  /**
@@ -6524,6 +6594,10 @@ declare namespace Components {
6524
6594
  global_blocks?: {
6525
6595
  [name: string]: Block;
6526
6596
  };
6597
+ /**
6598
+ * Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
6599
+ */
6600
+ notification_triggers?: NotificationTriggerConfig[];
6527
6601
  /**
6528
6602
  * ID of the organization
6529
6603
  * example:
@@ -7245,6 +7319,57 @@ declare namespace Components {
7245
7319
  * 453ad7bf-86d5-46c8-8252-bcc868df5e3c
7246
7320
  */
7247
7321
  export type PortalId = string;
7322
+ /**
7323
+ * A 360 notification addressed to a portal user.
7324
+ */
7325
+ export interface PortalNotification {
7326
+ /**
7327
+ * Stable string identifier of the notification (the numeric notification id as a string).
7328
+ * example:
7329
+ * 1234567890
7330
+ */
7331
+ id: string;
7332
+ /**
7333
+ * Numeric id of the notification, used to mark it as read.
7334
+ * example:
7335
+ * 1234567890
7336
+ */
7337
+ notification_id?: number;
7338
+ /**
7339
+ * Type of notification.
7340
+ * example:
7341
+ * workflow_step_overdue
7342
+ */
7343
+ type?: string;
7344
+ /**
7345
+ * Localized, already-rendered notification title.
7346
+ */
7347
+ title?: {
7348
+ en?: string;
7349
+ de?: string;
7350
+ };
7351
+ /**
7352
+ * Localized, already-rendered notification message.
7353
+ */
7354
+ message?: {
7355
+ en?: string;
7356
+ de?: string;
7357
+ };
7358
+ /**
7359
+ * When the notification was created.
7360
+ */
7361
+ created_at?: string; // date-time
7362
+ /**
7363
+ * Whether the notification has been read by the user.
7364
+ * example:
7365
+ * false
7366
+ */
7367
+ read: boolean;
7368
+ /**
7369
+ * Optional URL the notification points to.
7370
+ */
7371
+ redirect_url?: string;
7372
+ }
7248
7373
  /**
7249
7374
  * Portal-specific (ECP / installer) display config of a workflow task
7250
7375
  */
@@ -7948,7 +8073,7 @@ declare namespace Components {
7948
8073
  */
7949
8074
  ProviderSlug /* [0-9a-z_-]+ */;
7950
8075
  /**
7951
- * URL of the authorization endpoint
8076
+ * Deprecated and ignored; the token endpoint is derived server-side from the provider config.
7952
8077
  * example:
7953
8078
  * https://www.facebook.com/v12.0/dialog/oauth
7954
8079
  */
@@ -8849,6 +8974,10 @@ declare namespace Components {
8849
8974
  global_blocks?: {
8850
8975
  [name: string]: Block;
8851
8976
  };
8977
+ /**
8978
+ * Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
8979
+ */
8980
+ notification_triggers?: NotificationTriggerConfig[];
8852
8981
  }
8853
8982
  export interface UpsertPortalConfigV3 {
8854
8983
  /**
@@ -11133,9 +11262,9 @@ declare namespace Paths {
11133
11262
  */
11134
11263
  export type Size = number;
11135
11264
  /**
11136
- * Key to sort by
11265
+ * Key to sort by. Pass a comma-separated list to apply additional keys as tiebreakers, in order of precedence.
11137
11266
  * example:
11138
- * due_date:asc
11267
+ * paid_date:desc,booking_date:desc
11139
11268
  */
11140
11269
  export type Sort = string;
11141
11270
  }
@@ -11158,9 +11287,9 @@ declare namespace Paths {
11158
11287
  date_after?: /* List billing events after this date */ Parameters.DateAfter /* date-time */;
11159
11288
  date_before?: /* List billing events before this date */ Parameters.DateBefore /* date-time */;
11160
11289
  sort?: /**
11161
- * Key to sort by
11290
+ * Key to sort by. Pass a comma-separated list to apply additional keys as tiebreakers, in order of precedence.
11162
11291
  * example:
11163
- * due_date:asc
11292
+ * paid_date:desc,booking_date:desc
11164
11293
  */
11165
11294
  Parameters.Sort;
11166
11295
  }
@@ -11230,6 +11359,18 @@ declare namespace Paths {
11230
11359
  * kWh
11231
11360
  */
11232
11361
  unit?: string;
11362
+ /**
11363
+ * Optional localized label for this individual value, keyed by ISO 3166-1 alpha-2 language code (same shape as `VisualizationTypeOption.label`). When present, the portal renders it as the data point label instead of the default timestamp-derived label (e.g. to name billing periods or tariff windows).
11364
+ *
11365
+ * example:
11366
+ * {
11367
+ * "en": "Billing period 1",
11368
+ * "de": "Abrechnungszeitraum 1"
11369
+ * }
11370
+ */
11371
+ label?: {
11372
+ [name: string]: string;
11373
+ };
11233
11374
  }[];
11234
11375
  }
11235
11376
  export type $401 = Components.Responses.Unauthorized;
@@ -13372,6 +13513,10 @@ declare namespace Paths {
13372
13513
  global_blocks?: {
13373
13514
  [name: string]: Components.Schemas.Block;
13374
13515
  };
13516
+ /**
13517
+ * Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
13518
+ */
13519
+ notification_triggers?: Components.Schemas.NotificationTriggerConfig[];
13375
13520
  /**
13376
13521
  * ID of the organization
13377
13522
  * example:
@@ -13990,6 +14135,10 @@ declare namespace Paths {
13990
14135
  global_blocks?: {
13991
14136
  [name: string]: Components.Schemas.Block;
13992
14137
  };
14138
+ /**
14139
+ * Configures which 360 events generate an in-app notification for the portal user. Each enabled trigger renders the referenced notification template and creates a notification addressed to the portal user. Admin/builder-only — never exposed via the public portal config.
14140
+ */
14141
+ notification_triggers?: Components.Schemas.NotificationTriggerConfig[];
13993
14142
  /**
13994
14143
  * ID of the organization
13995
14144
  * example:
@@ -14108,6 +14257,21 @@ declare namespace Paths {
14108
14257
  export type $500 = Components.Responses.InternalServerError;
14109
14258
  }
14110
14259
  }
14260
+ namespace GetOutstandingTasks {
14261
+ namespace Responses {
14262
+ export interface $200 {
14263
+ tasks: Components.Schemas.OutstandingTask[];
14264
+ /**
14265
+ * example:
14266
+ * 0
14267
+ */
14268
+ total: number;
14269
+ }
14270
+ export type $401 = Components.Responses.Unauthorized;
14271
+ export type $403 = Components.Responses.Forbidden;
14272
+ export type $500 = Components.Responses.InternalServerError;
14273
+ }
14274
+ }
14111
14275
  namespace GetPortalConfig {
14112
14276
  namespace Parameters {
14113
14277
  export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
@@ -14200,6 +14364,20 @@ declare namespace Paths {
14200
14364
  export type $500 = Components.Responses.InternalServerError;
14201
14365
  }
14202
14366
  }
14367
+ namespace GetPortalNotificationsUnreadCount {
14368
+ namespace Responses {
14369
+ export interface $200 {
14370
+ /**
14371
+ * example:
14372
+ * 3
14373
+ */
14374
+ count?: number;
14375
+ }
14376
+ export type $401 = Components.Responses.Unauthorized;
14377
+ export type $403 = Components.Responses.Forbidden;
14378
+ export type $500 = Components.Responses.InternalServerError;
14379
+ }
14380
+ }
14203
14381
  namespace GetPortalPage {
14204
14382
  namespace Responses {
14205
14383
  export type $200 = Components.Schemas.Page;
@@ -15270,12 +15448,6 @@ declare namespace Paths {
15270
15448
  * Email address of the partner to invite
15271
15449
  */
15272
15450
  email: string;
15273
- represents_contact_list?: /**
15274
- * Entity ID
15275
- * example:
15276
- * 5da0a718-c822-403d-9f5d-20d4584e0528
15277
- */
15278
- Components.Schemas.EntityId /* uuid */[];
15279
15451
  /**
15280
15452
  * Additional contact entity fields to set when creating the contact for the invited user.
15281
15453
  * These are mapped directly to contact entity attributes (e.g. first_name, last_name, phone).
@@ -15352,6 +15524,32 @@ declare namespace Paths {
15352
15524
  export type $500 = Components.Responses.InternalServerError;
15353
15525
  }
15354
15526
  }
15527
+ namespace ListPortalNotifications {
15528
+ namespace Parameters {
15529
+ export type Cursor = string;
15530
+ export type Limit = number;
15531
+ }
15532
+ export interface QueryParameters {
15533
+ cursor?: Parameters.Cursor;
15534
+ limit?: Parameters.Limit;
15535
+ }
15536
+ namespace Responses {
15537
+ export interface $200 {
15538
+ /**
15539
+ * Base64 encoded cursor to fetch the next page. Absent when there are no more results.
15540
+ */
15541
+ cursor?: string;
15542
+ /**
15543
+ * Total number of unread notifications for the user.
15544
+ */
15545
+ total_unread?: number;
15546
+ results?: /* A 360 notification addressed to a portal user. */ Components.Schemas.PortalNotification[];
15547
+ }
15548
+ export type $401 = Components.Responses.Unauthorized;
15549
+ export type $403 = Components.Responses.Forbidden;
15550
+ export type $500 = Components.Responses.InternalServerError;
15551
+ }
15552
+ }
15355
15553
  namespace LoginToPortalAsUser {
15356
15554
  export interface RequestBody {
15357
15555
  /**
@@ -15379,6 +15577,31 @@ declare namespace Paths {
15379
15577
  }
15380
15578
  }
15381
15579
  }
15580
+ namespace MarkAllPortalNotificationsRead {
15581
+ namespace Responses {
15582
+ export interface $204 {
15583
+ }
15584
+ export type $401 = Components.Responses.Unauthorized;
15585
+ export type $403 = Components.Responses.Forbidden;
15586
+ export type $500 = Components.Responses.InternalServerError;
15587
+ }
15588
+ }
15589
+ namespace MarkPortalNotificationRead {
15590
+ namespace Parameters {
15591
+ export type Id = number;
15592
+ }
15593
+ export interface PathParameters {
15594
+ id: Parameters.Id;
15595
+ }
15596
+ namespace Responses {
15597
+ export interface $204 {
15598
+ }
15599
+ export type $400 = Components.Responses.InvalidRequest;
15600
+ export type $401 = Components.Responses.Unauthorized;
15601
+ export type $403 = Components.Responses.Forbidden;
15602
+ export type $500 = Components.Responses.InternalServerError;
15603
+ }
15604
+ }
15382
15605
  namespace MigrateEmailTemplateReferences {
15383
15606
  export interface RequestBody {
15384
15607
  /**
@@ -18179,6 +18402,16 @@ interface OperationMethods {
18179
18402
  data?: any,
18180
18403
  config?: AxiosRequestConfig
18181
18404
  ): OperationResponse<Paths.GetEntityWorkflows.Responses.$200>
18405
+ /**
18406
+ * getOutstandingTasks - Get outstanding workflow tasks for the portal user
18407
+ *
18408
+ * Returns all outstanding workflow journey tasks for the authenticated portal user, across their opportunity, order and contract entities. Each task is an active workflow step that exposes a journey the customer still needs to fill out.
18409
+ */
18410
+ 'getOutstandingTasks'(
18411
+ parameters?: Parameters<UnknownParamsObject> | null,
18412
+ data?: any,
18413
+ config?: AxiosRequestConfig
18414
+ ): OperationResponse<Paths.GetOutstandingTasks.Responses.$200>
18182
18415
  /**
18183
18416
  * getEntityPortalWorkflows - getEntityPortalWorkflows
18184
18417
  *
@@ -18507,6 +18740,46 @@ interface OperationMethods {
18507
18740
  data?: Paths.UpdateCampaignPortalBlockStatus.RequestBody,
18508
18741
  config?: AxiosRequestConfig
18509
18742
  ): OperationResponse<Paths.UpdateCampaignPortalBlockStatus.Responses.$200>
18743
+ /**
18744
+ * listPortalNotifications - listPortalNotifications
18745
+ *
18746
+ * Lists the 360 notifications addressed to the authenticated portal user, newest first. The organization and the portal user are derived from the authenticated session, so a user can only ever read their own notifications.
18747
+ */
18748
+ 'listPortalNotifications'(
18749
+ parameters?: Parameters<Paths.ListPortalNotifications.QueryParameters> | null,
18750
+ data?: any,
18751
+ config?: AxiosRequestConfig
18752
+ ): OperationResponse<Paths.ListPortalNotifications.Responses.$200>
18753
+ /**
18754
+ * getPortalNotificationsUnreadCount - getPortalNotificationsUnreadCount
18755
+ *
18756
+ * Returns the number of unread notifications for the authenticated portal user.
18757
+ */
18758
+ 'getPortalNotificationsUnreadCount'(
18759
+ parameters?: Parameters<UnknownParamsObject> | null,
18760
+ data?: any,
18761
+ config?: AxiosRequestConfig
18762
+ ): OperationResponse<Paths.GetPortalNotificationsUnreadCount.Responses.$200>
18763
+ /**
18764
+ * markAllPortalNotificationsRead - markAllPortalNotificationsRead
18765
+ *
18766
+ * Marks all notifications of the authenticated portal user as read.
18767
+ */
18768
+ 'markAllPortalNotificationsRead'(
18769
+ parameters?: Parameters<UnknownParamsObject> | null,
18770
+ data?: any,
18771
+ config?: AxiosRequestConfig
18772
+ ): OperationResponse<Paths.MarkAllPortalNotificationsRead.Responses.$204>
18773
+ /**
18774
+ * markPortalNotificationRead - markPortalNotificationRead
18775
+ *
18776
+ * Marks a single notification of the authenticated portal user as read.
18777
+ */
18778
+ 'markPortalNotificationRead'(
18779
+ parameters?: Parameters<Paths.MarkPortalNotificationRead.PathParameters> | null,
18780
+ data?: any,
18781
+ config?: AxiosRequestConfig
18782
+ ): OperationResponse<Paths.MarkPortalNotificationRead.Responses.$204>
18510
18783
  /**
18511
18784
  * updateNotificationsStatus - updateNotificationsStatus
18512
18785
  *
@@ -20133,6 +20406,18 @@ interface PathsDictionary {
20133
20406
  config?: AxiosRequestConfig
20134
20407
  ): OperationResponse<Paths.GetEntityWorkflows.Responses.$200>
20135
20408
  }
20409
+ ['/v2/portal/engagement/tasks']: {
20410
+ /**
20411
+ * getOutstandingTasks - Get outstanding workflow tasks for the portal user
20412
+ *
20413
+ * Returns all outstanding workflow journey tasks for the authenticated portal user, across their opportunity, order and contract entities. Each task is an active workflow step that exposes a journey the customer still needs to fill out.
20414
+ */
20415
+ 'get'(
20416
+ parameters?: Parameters<UnknownParamsObject> | null,
20417
+ data?: any,
20418
+ config?: AxiosRequestConfig
20419
+ ): OperationResponse<Paths.GetOutstandingTasks.Responses.$200>
20420
+ }
20136
20421
  ['/v2/portal/entity/{slug}/{id}/workflows/linearized']: {
20137
20422
  /**
20138
20423
  * getEntityPortalWorkflows - getEntityPortalWorkflows
@@ -20503,6 +20788,54 @@ interface PathsDictionary {
20503
20788
  config?: AxiosRequestConfig
20504
20789
  ): OperationResponse<Paths.UpdateCampaignPortalBlockStatus.Responses.$200>
20505
20790
  }
20791
+ ['/v2/portal/notifications']: {
20792
+ /**
20793
+ * listPortalNotifications - listPortalNotifications
20794
+ *
20795
+ * Lists the 360 notifications addressed to the authenticated portal user, newest first. The organization and the portal user are derived from the authenticated session, so a user can only ever read their own notifications.
20796
+ */
20797
+ 'get'(
20798
+ parameters?: Parameters<Paths.ListPortalNotifications.QueryParameters> | null,
20799
+ data?: any,
20800
+ config?: AxiosRequestConfig
20801
+ ): OperationResponse<Paths.ListPortalNotifications.Responses.$200>
20802
+ }
20803
+ ['/v2/portal/notifications/unread-count']: {
20804
+ /**
20805
+ * getPortalNotificationsUnreadCount - getPortalNotificationsUnreadCount
20806
+ *
20807
+ * Returns the number of unread notifications for the authenticated portal user.
20808
+ */
20809
+ 'get'(
20810
+ parameters?: Parameters<UnknownParamsObject> | null,
20811
+ data?: any,
20812
+ config?: AxiosRequestConfig
20813
+ ): OperationResponse<Paths.GetPortalNotificationsUnreadCount.Responses.$200>
20814
+ }
20815
+ ['/v2/portal/notifications/read-all']: {
20816
+ /**
20817
+ * markAllPortalNotificationsRead - markAllPortalNotificationsRead
20818
+ *
20819
+ * Marks all notifications of the authenticated portal user as read.
20820
+ */
20821
+ 'put'(
20822
+ parameters?: Parameters<UnknownParamsObject> | null,
20823
+ data?: any,
20824
+ config?: AxiosRequestConfig
20825
+ ): OperationResponse<Paths.MarkAllPortalNotificationsRead.Responses.$204>
20826
+ }
20827
+ ['/v2/portal/notifications/{id}/read']: {
20828
+ /**
20829
+ * markPortalNotificationRead - markPortalNotificationRead
20830
+ *
20831
+ * Marks a single notification of the authenticated portal user as read.
20832
+ */
20833
+ 'put'(
20834
+ parameters?: Parameters<Paths.MarkPortalNotificationRead.PathParameters> | null,
20835
+ data?: any,
20836
+ config?: AxiosRequestConfig
20837
+ ): OperationResponse<Paths.MarkPortalNotificationRead.Responses.$204>
20838
+ }
20506
20839
  ['/v2/portal/notifications/entity:status']: {
20507
20840
  /**
20508
20841
  * updateNotificationsStatus - updateNotificationsStatus
@@ -20848,6 +21181,7 @@ type MobileConfig = Components.Schemas.MobileConfig;
20848
21181
  type MobileConfigUpdate = Components.Schemas.MobileConfigUpdate;
20849
21182
  type MobileOtaConfig = Components.Schemas.MobileOtaConfig;
20850
21183
  type MoblieOIDCConfig = Components.Schemas.MoblieOIDCConfig;
21184
+ type NotificationTriggerConfig = Components.Schemas.NotificationTriggerConfig;
20851
21185
  type OIDCProviderConfig = Components.Schemas.OIDCProviderConfig;
20852
21186
  type OIDCProviderMetadata = Components.Schemas.OIDCProviderMetadata;
20853
21187
  type Opportunity = Components.Schemas.Opportunity;
@@ -20855,6 +21189,7 @@ type Order = Components.Schemas.Order;
20855
21189
  type OrganizationSettings = Components.Schemas.OrganizationSettings;
20856
21190
  type Origin = Components.Schemas.Origin;
20857
21191
  type OtaPortal = Components.Schemas.OtaPortal;
21192
+ type OutstandingTask = Components.Schemas.OutstandingTask;
20858
21193
  type Page = Components.Schemas.Page;
20859
21194
  type PageRequest = Components.Schemas.PageRequest;
20860
21195
  type PaymentWidget = Components.Schemas.PaymentWidget;
@@ -20862,6 +21197,7 @@ type PortalConfig = Components.Schemas.PortalConfig;
20862
21197
  type PortalConfigV3 = Components.Schemas.PortalConfigV3;
20863
21198
  type PortalDataExportColumn = Components.Schemas.PortalDataExportColumn;
20864
21199
  type PortalId = Components.Schemas.PortalId;
21200
+ type PortalNotification = Components.Schemas.PortalNotification;
20865
21201
  type PortalTaskConfig = Components.Schemas.PortalTaskConfig;
20866
21202
  type PortalUser = Components.Schemas.PortalUser;
20867
21203
  type PortalUserRegistrationStatus = Components.Schemas.PortalUserRegistrationStatus;
@@ -20918,4 +21254,4 @@ type WorfklowIdentifier = Components.Schemas.WorfklowIdentifier;
20918
21254
  type WorkflowExecution = Components.Schemas.WorkflowExecution;
20919
21255
  type WorkflowStep = Components.Schemas.WorkflowStep;
20920
21256
 
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 };
21257
+ 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 PaymentWidget 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 NotificationTriggerConfig as aQ, type OIDCProviderConfig as aR, type OIDCProviderMetadata as aS, type Opportunity as aT, type Order as aU, type OrganizationSettings as aV, type Origin as aW, type OtaPortal as aX, type OutstandingTask as aY, type Page as aZ, type PageRequest 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 PortalConfig as b0, type PortalConfigV3 as b1, type PortalDataExportColumn as b2, type PortalId as b3, type PortalNotification as b4, type PortalTaskConfig as b5, type PortalUser as b6, type PortalUserRegistrationStatus as b7, type PortalWidget as b8, type PortalWorkflow as b9, type SSOLoginToken as bA, SaveEntityFile as bB, type SavePortalFile as bC, type Schema as bD, type SearchIncludes as bE, type SecureProxyConfig as bF, type Source as bG, type SwappableConfig as bH, type TariffType as bI, type TeaserWidget as bJ, type TriggerPortalFlow as bK, type UpdateOnlyPortalConfigAttributes as bL, type UpsertPortalConfig as bM, type UpsertPortalConfigV3 as bN, UpsertPortalWidget as bO, type UserRequest as bP, type VisualizationDataRange as bQ, type VisualizationMetadata as bR, type VisualizationTypeOption as bS, type WidgetAction as bT, type WidgetBase as bU, type WorfklowIdentifier as bV, type WorkflowExecution as bW, type WorkflowStep as bX, type PortalWorkflowTask as ba, type Product as bb, type ProductRecommendationsWidget as bc, type ProviderConfig as bd, type ProviderDisplayName as be, type ProviderPublicConfig as bf, type ProviderSlug as bg, type PublicAppDetails as bh, type PublicChangeEmailDetails as bi, type PublicChangePasswordDetails as bj, type PublicContractIdentificationDetails as bk, type PublicDataRetrievalHookDetails as bl, type PublicDeleteAccountDetails as bm, type PublicExtensionCapabilities as bn, type PublicExtensionDetails as bo, type PublicMeterReadingPlausibilityCheckDetails as bp, type PublicSelfManagementExplanation as bq, type ReadBy as br, type ReadingStatus as bs, type Reason as bt, type RegistrationIdentifier as bu, type ReimbursementEvent as bv, type Rule as bw, type SAMLProviderConfig as bx, type SSOCallbackRequest as by, type SSOCallbackResponse 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 };