@epilot/sdk 2.19.0 → 2.19.2

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 (143) hide show
  1. package/definitions/app-runtime.json +1 -1
  2. package/definitions/app.json +135 -3
  3. package/definitions/targeting-runtime.json +1 -1
  4. package/definitions/targeting.json +240 -49
  5. package/dist/apis/access-token.cjs +6 -6
  6. package/dist/apis/access-token.js +1 -1
  7. package/dist/apis/address-suggestions.cjs +6 -6
  8. package/dist/apis/address-suggestions.js +1 -1
  9. package/dist/apis/address.cjs +6 -6
  10. package/dist/apis/address.js +1 -1
  11. package/dist/apis/ai-agents.cjs +6 -6
  12. package/dist/apis/ai-agents.js +1 -1
  13. package/dist/apis/app.cjs +8 -8
  14. package/dist/apis/app.d.cts +2 -2
  15. package/dist/apis/app.d.ts +2 -2
  16. package/dist/apis/app.js +2 -2
  17. package/dist/apis/audit-logs.cjs +6 -6
  18. package/dist/apis/audit-logs.js +1 -1
  19. package/dist/apis/automation.cjs +6 -6
  20. package/dist/apis/automation.js +1 -1
  21. package/dist/apis/billing.cjs +6 -6
  22. package/dist/apis/billing.js +1 -1
  23. package/dist/apis/blueprint-manifest.cjs +6 -6
  24. package/dist/apis/blueprint-manifest.js +1 -1
  25. package/dist/apis/calendar.cjs +6 -6
  26. package/dist/apis/calendar.js +1 -1
  27. package/dist/apis/configuration-hub.cjs +6 -6
  28. package/dist/apis/configuration-hub.js +1 -1
  29. package/dist/apis/consent.cjs +6 -6
  30. package/dist/apis/consent.js +1 -1
  31. package/dist/apis/customer-portal.cjs +6 -6
  32. package/dist/apis/customer-portal.js +1 -1
  33. package/dist/apis/dashboard.cjs +6 -6
  34. package/dist/apis/dashboard.js +1 -1
  35. package/dist/apis/data-governance.cjs +6 -6
  36. package/dist/apis/data-governance.js +1 -1
  37. package/dist/apis/deduplication.cjs +6 -6
  38. package/dist/apis/deduplication.js +1 -1
  39. package/dist/apis/design.cjs +6 -6
  40. package/dist/apis/design.js +1 -1
  41. package/dist/apis/document.cjs +6 -6
  42. package/dist/apis/document.js +1 -1
  43. package/dist/apis/email-settings.cjs +6 -6
  44. package/dist/apis/email-settings.js +1 -1
  45. package/dist/apis/email-template.cjs +6 -6
  46. package/dist/apis/email-template.js +1 -1
  47. package/dist/apis/entity-mapping.cjs +6 -6
  48. package/dist/apis/entity-mapping.js +1 -1
  49. package/dist/apis/entity.cjs +6 -6
  50. package/dist/apis/entity.js +1 -1
  51. package/dist/apis/environments.cjs +6 -6
  52. package/dist/apis/environments.js +1 -1
  53. package/dist/apis/event-catalog.cjs +6 -6
  54. package/dist/apis/event-catalog.js +1 -1
  55. package/dist/apis/file.cjs +6 -6
  56. package/dist/apis/file.js +1 -1
  57. package/dist/apis/iban.cjs +6 -6
  58. package/dist/apis/iban.js +1 -1
  59. package/dist/apis/integration-toolkit.cjs +6 -6
  60. package/dist/apis/integration-toolkit.js +1 -1
  61. package/dist/apis/journey.cjs +6 -6
  62. package/dist/apis/journey.js +1 -1
  63. package/dist/apis/kanban.cjs +6 -6
  64. package/dist/apis/kanban.js +1 -1
  65. package/dist/apis/message.cjs +6 -6
  66. package/dist/apis/message.js +1 -1
  67. package/dist/apis/metering.cjs +6 -6
  68. package/dist/apis/metering.js +1 -1
  69. package/dist/apis/notes.cjs +6 -6
  70. package/dist/apis/notes.js +1 -1
  71. package/dist/apis/notification.cjs +6 -6
  72. package/dist/apis/notification.js +1 -1
  73. package/dist/apis/organization.cjs +6 -6
  74. package/dist/apis/organization.js +1 -1
  75. package/dist/apis/partner-directory.cjs +6 -6
  76. package/dist/apis/partner-directory.js +1 -1
  77. package/dist/apis/permissions.cjs +6 -6
  78. package/dist/apis/permissions.js +1 -1
  79. package/dist/apis/pricing-tier.cjs +6 -6
  80. package/dist/apis/pricing-tier.js +1 -1
  81. package/dist/apis/pricing.cjs +6 -6
  82. package/dist/apis/pricing.js +1 -1
  83. package/dist/apis/purpose.cjs +6 -6
  84. package/dist/apis/purpose.js +1 -1
  85. package/dist/apis/query.cjs +6 -6
  86. package/dist/apis/query.js +1 -1
  87. package/dist/apis/sandbox.cjs +6 -6
  88. package/dist/apis/sandbox.js +1 -1
  89. package/dist/apis/sharing.cjs +6 -6
  90. package/dist/apis/sharing.js +1 -1
  91. package/dist/apis/snapshot.cjs +6 -6
  92. package/dist/apis/snapshot.js +1 -1
  93. package/dist/apis/submission.cjs +6 -6
  94. package/dist/apis/submission.js +1 -1
  95. package/dist/apis/target.cjs +6 -6
  96. package/dist/apis/target.js +1 -1
  97. package/dist/apis/targeting.cjs +8 -8
  98. package/dist/apis/targeting.d.cts +2 -2
  99. package/dist/apis/targeting.d.ts +2 -2
  100. package/dist/apis/targeting.js +2 -2
  101. package/dist/apis/template-variables.cjs +6 -6
  102. package/dist/apis/template-variables.js +1 -1
  103. package/dist/apis/user.cjs +6 -6
  104. package/dist/apis/user.js +1 -1
  105. package/dist/apis/validation-rules.cjs +6 -6
  106. package/dist/apis/validation-rules.js +1 -1
  107. package/dist/apis/webhooks.cjs +6 -6
  108. package/dist/apis/webhooks.js +1 -1
  109. package/dist/apis/workflow-definition.cjs +6 -6
  110. package/dist/apis/workflow-definition.js +1 -1
  111. package/dist/apis/workflow.cjs +6 -6
  112. package/dist/apis/workflow.js +1 -1
  113. package/dist/app-RZ2JCNZ7.js +7 -0
  114. package/dist/app-U7UEBBWK.cjs +7 -0
  115. package/dist/app-runtime-2MEGUF3G.cjs +5 -0
  116. package/dist/{app-runtime-NBGFHFT2.js → app-runtime-T63JMR4T.js} +1 -1
  117. package/dist/{app.d-CZDjyxee.d.cts → app.d-CyI0Leab.d.cts} +137 -2
  118. package/dist/{app.d-CZDjyxee.d.ts → app.d-CyI0Leab.d.ts} +137 -2
  119. package/dist/{chunk-TNRT33VQ.js → chunk-4MILKZOO.js} +1 -1
  120. package/dist/{chunk-XHVIF7AC.cjs → chunk-HPSTDQ62.cjs} +1 -1
  121. package/dist/{chunk-W3SPZ6V5.cjs → chunk-MDUJKPDR.cjs} +1 -1
  122. package/dist/{chunk-UH24GU2Z.js → chunk-MSFE3E7D.js} +1 -1
  123. package/dist/{chunk-C543QHBO.cjs → chunk-QWWGJOYR.cjs} +4 -4
  124. package/dist/{chunk-BVCHHE2R.js → chunk-UC3IKFHD.js} +4 -4
  125. package/dist/index.cjs +12 -12
  126. package/dist/index.d.cts +2 -2
  127. package/dist/index.d.ts +2 -2
  128. package/dist/index.js +3 -3
  129. package/dist/js-yaml-DLCVPJ7G.js +0 -0
  130. package/dist/targeting-BTVCLYFW.cjs +7 -0
  131. package/dist/targeting-NWYDE3E7.js +7 -0
  132. package/dist/{targeting-runtime-HWL6PLJF.cjs → targeting-runtime-AB6BMJ6U.cjs} +2 -2
  133. package/dist/{targeting-runtime-L5RGDNSH.js → targeting-runtime-S22V2UEE.js} +1 -1
  134. package/dist/{targeting.d-DaK3kwZg.d.cts → targeting.d-16SvPyj4.d.cts} +295 -77
  135. package/dist/{targeting.d-DaK3kwZg.d.ts → targeting.d-16SvPyj4.d.ts} +295 -77
  136. package/docs/app.md +336 -173
  137. package/docs/targeting.md +229 -31
  138. package/package.json +11 -12
  139. package/dist/app-IXCUVIHD.js +0 -7
  140. package/dist/app-RKHOTF7Z.cjs +0 -7
  141. package/dist/app-runtime-AAQHTC7F.cjs +0 -5
  142. package/dist/targeting-A2X6X7BF.js +0 -7
  143. package/dist/targeting-CSGKITGV.cjs +0 -7
@@ -67,35 +67,47 @@ declare namespace Components {
67
67
  Schemas.ClientError;
68
68
  export interface DiscoverCampaignsResponse {
69
69
  /**
70
- * Number of matching NBAs.
70
+ * Number of matching NBAs. Counts `results` only — dismissed ones are excluded.
71
71
  */
72
72
  hits: number;
73
73
  /**
74
74
  * Matching NBAs, sorted by priority (desc); one entry per campaign.
75
75
  */
76
- results: {
77
- campaign_id: /**
78
- * example:
79
- * b8c01433-5556-4e2b-aad4-6f5348d1df84
80
- */
81
- Schemas.BaseUUID /* uuid */;
82
- nba: /**
83
- * A Next Best Action configured on a campaign's Entity-UI channel.
84
- * This is the canonical NBA contract shared by discovery (this API), authoring, and rendering.
85
- * NBA content is single-language in v1; text fields may contain `{{placeholders}}` resolved at render time.
86
- *
87
- */
88
- Schemas.NextBestAction;
89
- /**
90
- * The recipient's current Entity-UI status for this campaign, present only
91
- * when a recipient record already exists (i.e. the entity has previously seen
92
- * or clicked this NBA). Absent when the entity has not yet interacted with it.
93
- * Dismissed NBAs are filtered out server-side, so this is only ever `seen` or
94
- * `clicked`. Lets the client skip a redundant `seen` call for NBAs already seen.
95
- *
96
- */
97
- status?: "seen" | "dismissed" | "clicked";
98
- }[];
76
+ results: /* One discovered Next Best Action, plus this entity's interaction state for it. */ Schemas.DiscoverResult[];
77
+ /**
78
+ * NBAs this entity has dismissed that would otherwise be in `results` — same shape,
79
+ * also priority-sorted. Returned so the client can show the agent what it hid and
80
+ * offer to restore it, without a second round-trip.
81
+ *
82
+ * Only currently-relevant dismissals appear: each one is matched against its
83
+ * campaign's target exactly like a visible NBA, so a dismissal is dropped once the
84
+ * campaign ends or the entity stops matching. Capped, so this is not a complete
85
+ * dismissal history.
86
+ *
87
+ */
88
+ dismissed: /* One discovered Next Best Action, plus this entity's interaction state for it. */ Schemas.DiscoverResult[];
89
+ }
90
+ export interface EmailStatsResponse {
91
+ /**
92
+ * Recipients with a recorded email status (the KPI denominator).
93
+ */
94
+ total_emailed: number;
95
+ sent: number;
96
+ /**
97
+ * Currently always 0 (Delivery events are not published yet).
98
+ */
99
+ delivered: number;
100
+ bounced: number;
101
+ /**
102
+ * Bounces classified permanent (bounced_hard + bounced_soft = bounced).
103
+ */
104
+ bounced_hard: number;
105
+ /**
106
+ * Bounces classified transient.
107
+ */
108
+ bounced_soft: number;
109
+ complained: number;
110
+ failed: number;
99
111
  }
100
112
  export interface GetTargetQueriesResponse {
101
113
  /**
@@ -322,7 +334,7 @@ declare namespace Components {
322
334
  * example:
323
335
  * CAMPAIGN_NOT_FOUND
324
336
  */
325
- code: "CAMPAIGN_NOT_FOUND" | "CAMPAIGN_HAS_NO_TARGET" | "CAMPAIGN_HAS_NO_DELIVERY_METHOD" | "CAMPAIGN_HAS_JOB_IN_PROGRESS" | "CAMPAIGN_HAS_UNEXPECTED_STATUS" | "JOB_TOKEN_MISSING" | "TARGET_WITHOUT_FILTERS";
337
+ code: "CAMPAIGN_NOT_FOUND" | "CAMPAIGN_HAS_NO_TARGET" | "CAMPAIGN_HAS_NO_DELIVERY_METHOD" | "INVALID_NEXT_BEST_ACTION" | "CAMPAIGN_HAS_JOB_IN_PROGRESS" | "CAMPAIGN_HAS_UNEXPECTED_STATUS" | "JOB_TOKEN_MISSING" | "TARGET_WITHOUT_FILTERS";
326
338
  } | {
327
339
  /**
328
340
  * A descriptive error message.
@@ -382,6 +394,52 @@ declare namespace Components {
382
394
  */
383
395
  entity_schema: string;
384
396
  }
397
+ /**
398
+ * One discovered Next Best Action, plus this entity's interaction state for it.
399
+ */
400
+ export interface DiscoverResult {
401
+ campaign_id: /**
402
+ * example:
403
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
404
+ */
405
+ BaseUUID /* uuid */;
406
+ nba: /**
407
+ * A Next Best Action configured on a campaign's Entity-UI channel.
408
+ * This is the canonical NBA contract shared by discovery (this API), authoring, and rendering.
409
+ * NBA content is single-language in v1; text fields may contain `{{placeholders}}` resolved at render time.
410
+ *
411
+ */
412
+ NextBestAction;
413
+ /**
414
+ * The recipient's current Entity-UI status for this campaign, present only when a
415
+ * recipient record already exists (i.e. the entity has previously seen, clicked or
416
+ * dismissed this NBA). Absent when the entity has not yet interacted with it.
417
+ *
418
+ * In `results` this is only ever `seen` or `clicked`; in `dismissed` it is always
419
+ * `dismissed`. Lets the client skip a redundant `seen` call for NBAs already seen.
420
+ *
421
+ */
422
+ status?: "seen" | "dismissed" | "clicked";
423
+ /**
424
+ * When `status` was last written. Present whenever `status` is. Lets the client show how
425
+ * long ago an NBA was dismissed.
426
+ *
427
+ */
428
+ status_updated_at?: string; // date-time
429
+ }
430
+ /**
431
+ * SES bounce classification: `permanent` (hard) or `transient` (soft).
432
+ */
433
+ export type EmailBounceType = "permanent" | "transient";
434
+ /**
435
+ * Delivery status of the email a campaign's automation sends to a recipient. Set to `sent`
436
+ * once the automation hands the email off, then updated asynchronously as SES notifications
437
+ * arrive (`bounced` / `complained`; an SES Reject maps to `bounced`). `failed` is a send-time
438
+ * failure (the automation execution could not send at all), distinct from an asynchronous
439
+ * bounce. `delivered` is reserved for when Delivery events are published.
440
+ *
441
+ */
442
+ export type EmailStatus = "sent" | "delivered" | "bounced" | "complained" | "failed";
385
443
  /**
386
444
  * Lifecycle status of a Next Best Action on the Entity-UI channel. Unlike the portal
387
445
  * channel there is no `sent` state: an NBA recipient is born at `seen`, the moment the
@@ -1509,15 +1567,11 @@ declare namespace Components {
1509
1567
  * The NBA's single call-to-action.
1510
1568
  */
1511
1569
  cta: {
1512
- type: "journey" | "workflow" | "url";
1570
+ type: "journey" | "workflow" | "flow";
1513
1571
  /**
1514
- * Journey id, workflow definition id, or URL, depending on `type`.
1572
+ * Journey id, workflow definition id, or flow template id, depending on `type`.
1515
1573
  */
1516
1574
  target: string;
1517
- /**
1518
- * Optional CTA button label.
1519
- */
1520
- label?: string;
1521
1575
  /**
1522
1576
  * Journey context parameters (journey CTA only). Maps the journey's declared
1523
1577
  * context parameters so the journey knows which entity it is about. Discovery
@@ -1560,24 +1614,57 @@ declare namespace Components {
1560
1614
  */
1561
1615
  EntityUiStatus;
1562
1616
  entity_ui_status_updated_at?: string; // date-time
1563
- resolution?: /**
1564
- * Cross-channel resolution of a campaign for a recipient. Unlike the per-channel `*_status`
1565
- * fields (where `dismissed` is channel-local), a resolution suppresses the campaign on EVERY
1566
- * channel — the 360 Entity-UI card and the portal teaser alike. Server-managed and read-only:
1567
- * never sent by a client. Absence means unresolved.
1617
+ /**
1618
+ * The Entity-UI status the recipient held immediately before it was dismissed, so
1619
+ * `entity_ui:restore` can put it back without losing a recorded click.
1620
+ *
1621
+ * Server-managed — never send this from a client; it is ignored on write. Meaningful
1622
+ * **only while** `entity_ui_status` is `dismissed`: a restore intentionally leaves the
1623
+ * value behind rather than clearing it, so a stale value after a restore is expected and
1624
+ * must not be read.
1568
1625
  *
1569
1626
  */
1570
- Resolution;
1627
+ entity_ui_status_before_dismiss?: "seen" | "dismissed" | "clicked";
1628
+ /**
1629
+ * The message entity id of the email sent to this recipient by the campaign's automation
1630
+ * (not the SES/provider message id), used to correlate SES delivery notifications back to
1631
+ * the recipient. Server-managed.
1632
+ *
1633
+ */
1634
+ message_entity_id?: string;
1635
+ email_status?: /**
1636
+ * Delivery status of the email a campaign's automation sends to a recipient. Set to `sent`
1637
+ * once the automation hands the email off, then updated asynchronously as SES notifications
1638
+ * arrive (`bounced` / `complained`; an SES Reject maps to `bounced`). `failed` is a send-time
1639
+ * failure (the automation execution could not send at all), distinct from an asynchronous
1640
+ * bounce. `delivered` is reserved for when Delivery events are published.
1641
+ *
1642
+ */
1643
+ EmailStatus;
1644
+ email_status_updated_at?: string; // date-time
1645
+ email_bounce_type?: /* SES bounce classification: `permanent` (hard) or `transient` (soft). */ EmailBounceType;
1646
+ /**
1647
+ * SES bounce sub-type (e.g. `General`, `NoEmail`, `MailboxFull`).
1648
+ */
1649
+ email_bounce_subtype?: string;
1650
+ /**
1651
+ * SES complaint feedback type (e.g. `abuse`, `fraud`), set for complaints.
1652
+ */
1653
+ email_complaint_type?: string;
1654
+ /**
1655
+ * Human-readable failure reason — the SES bounce `diagnosticCode`, the complaint
1656
+ * feedback type, or a send-time error message.
1657
+ *
1658
+ */
1659
+ email_bounce_reason?: string;
1660
+ /**
1661
+ * The raw SES notification (or send error) kept verbatim for a detail view.
1662
+ */
1663
+ email_send_error?: {
1664
+ [name: string]: any;
1665
+ };
1571
1666
  updated_at?: string; // date-time
1572
1667
  }
1573
- /**
1574
- * Cross-channel resolution of a campaign for a recipient. Unlike the per-channel `*_status`
1575
- * fields (where `dismissed` is channel-local), a resolution suppresses the campaign on EVERY
1576
- * channel — the 360 Entity-UI card and the portal teaser alike. Server-managed and read-only:
1577
- * never sent by a client. Absence means unresolved.
1578
- *
1579
- */
1580
- export type Resolution = "accepted";
1581
1668
  export interface RetriggerAutomationsRequest {
1582
1669
  /**
1583
1670
  * List of recipient IDs to retrigger automations for
@@ -1914,6 +2001,23 @@ declare namespace Paths {
1914
2001
  export type $500 = Components.Responses.ServerErrorResponse;
1915
2002
  }
1916
2003
  }
2004
+ namespace GetEmailStats {
2005
+ namespace Parameters {
2006
+ export type CampaignId = /**
2007
+ * example:
2008
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
2009
+ */
2010
+ Components.Schemas.BaseUUID /* uuid */;
2011
+ }
2012
+ export interface PathParameters {
2013
+ campaign_id: Parameters.CampaignId;
2014
+ }
2015
+ namespace Responses {
2016
+ export type $200 = Components.Responses.EmailStatsResponse;
2017
+ export type $400 = Components.Responses.ClientErrorResponse;
2018
+ export type $500 = Components.Responses.ServerErrorResponse;
2019
+ }
2020
+ }
1917
2021
  namespace GetRecipients {
1918
2022
  namespace Parameters {
1919
2023
  export type AutomationStatus = Components.Schemas.AutomationStatus[];
@@ -1922,6 +2026,15 @@ declare namespace Paths {
1922
2026
  * b8c01433-5556-4e2b-aad4-6f5348d1df84
1923
2027
  */
1924
2028
  Components.Schemas.BaseUUID /* uuid */;
2029
+ export type EmailStatus = /**
2030
+ * Delivery status of the email a campaign's automation sends to a recipient. Set to `sent`
2031
+ * once the automation hands the email off, then updated asynchronously as SES notifications
2032
+ * arrive (`bounced` / `complained`; an SES Reject maps to `bounced`). `failed` is a send-time
2033
+ * failure (the automation execution could not send at all), distinct from an asynchronous
2034
+ * bounce. `delivered` is reserved for when Delivery events are published.
2035
+ *
2036
+ */
2037
+ Components.Schemas.EmailStatus;
1925
2038
  export type Limit = number;
1926
2039
  export type Next = string;
1927
2040
  export type PortalStatus = Components.Schemas.PortalStatus;
@@ -1936,6 +2049,7 @@ declare namespace Paths {
1936
2049
  q?: Parameters.Q;
1937
2050
  automation_status?: Parameters.AutomationStatus;
1938
2051
  portal_status?: Parameters.PortalStatus;
2052
+ email_status?: Parameters.EmailStatus;
1939
2053
  }
1940
2054
  namespace Responses {
1941
2055
  export type $200 = Components.Responses.RecipientsResponse;
@@ -1967,6 +2081,30 @@ declare namespace Paths {
1967
2081
  export type $500 = Components.Responses.ServerErrorResponse;
1968
2082
  }
1969
2083
  }
2084
+ namespace RestoreRecipientEntityUiStatus {
2085
+ namespace Parameters {
2086
+ export type CampaignId = /**
2087
+ * example:
2088
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
2089
+ */
2090
+ Components.Schemas.BaseUUID /* uuid */;
2091
+ export type RecipientId = /**
2092
+ * example:
2093
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
2094
+ */
2095
+ Components.Schemas.BaseUUID /* uuid */;
2096
+ }
2097
+ export interface PathParameters {
2098
+ campaign_id: Parameters.CampaignId;
2099
+ recipient_id: Parameters.RecipientId;
2100
+ }
2101
+ namespace Responses {
2102
+ export type $200 = Components.Responses.RecipientResponse;
2103
+ export type $404 = Components.Responses.ClientErrorResponse;
2104
+ export type $409 = Components.Responses.ClientErrorResponse;
2105
+ export type $500 = Components.Responses.ServerErrorResponse;
2106
+ }
2107
+ }
1970
2108
  namespace RetriggerCampaignAutomations {
1971
2109
  namespace Parameters {
1972
2110
  export type CampaignId = /**
@@ -2080,7 +2218,7 @@ declare namespace Paths {
2080
2218
 
2081
2219
  interface OperationMethods {
2082
2220
  /**
2083
- * changeCampaignStatus - Change the status of a campaign
2221
+ * changeCampaignStatus - changeCampaignStatus
2084
2222
  *
2085
2223
  * Change the status of a campaign to a desired status.
2086
2224
  *
@@ -2095,7 +2233,7 @@ interface OperationMethods {
2095
2233
  config?: AxiosRequestConfig
2096
2234
  ): OperationResponse<Paths.ChangeCampaignStatus.Responses.$200>
2097
2235
  /**
2098
- * getCampaignJobStatus - Get the status of a campaign's automation job
2236
+ * getCampaignJobStatus - getCampaignJobStatus
2099
2237
  *
2100
2238
  * Get the status of a campaign's automation job
2101
2239
  */
@@ -2105,7 +2243,7 @@ interface OperationMethods {
2105
2243
  config?: AxiosRequestConfig
2106
2244
  ): OperationResponse<Paths.GetCampaignJobStatus.Responses.$200>
2107
2245
  /**
2108
- * getCampaignPortals - Get portals usage info for a campaign
2246
+ * getCampaignPortals - getCampaignPortals
2109
2247
  *
2110
2248
  * Get the list of portals and its widgets where the campaign is used.
2111
2249
  *
@@ -2116,7 +2254,7 @@ interface OperationMethods {
2116
2254
  config?: AxiosRequestConfig
2117
2255
  ): OperationResponse<Paths.GetCampaignPortals.Responses.$200>
2118
2256
  /**
2119
- * retriggerCampaignAutomations - Retrigger automations for campaign recipients
2257
+ * retriggerCampaignAutomations - retriggerCampaignAutomations
2120
2258
  *
2121
2259
  * Retrigger automation executions for specific campaign recipients that have failed.
2122
2260
  *
@@ -2133,7 +2271,7 @@ interface OperationMethods {
2133
2271
  config?: AxiosRequestConfig
2134
2272
  ): OperationResponse<Paths.RetriggerCampaignAutomations.Responses.$200>
2135
2273
  /**
2136
- * setupCampaign - Set up a campaign with related entities and configurations
2274
+ * setupCampaign - setupCampaign
2137
2275
  *
2138
2276
  * Creates a `campaign` entity together with its related entities and configurations in a single call.
2139
2277
  * Used by the campaign wizard UI, but not restricted to it.
@@ -2145,7 +2283,7 @@ interface OperationMethods {
2145
2283
  config?: AxiosRequestConfig
2146
2284
  ): OperationResponse<Paths.SetupCampaign.Responses.$201>
2147
2285
  /**
2148
- * matchCampaigns - Match campaigns
2286
+ * matchCampaigns - matchCampaigns
2149
2287
  *
2150
2288
  * Match campaigns based on target entities.
2151
2289
  *
@@ -2158,7 +2296,7 @@ interface OperationMethods {
2158
2296
  config?: AxiosRequestConfig
2159
2297
  ): OperationResponse<Paths.MatchCampaigns.Responses.$200>
2160
2298
  /**
2161
- * discoverCampaigns - Discover Entity-UI Next Best Actions for an entity
2299
+ * discoverCampaigns - discoverCampaigns
2162
2300
  *
2163
2301
  * Given an entity, returns the Next Best Actions it should see on the Entity-UI channel.
2164
2302
  *
@@ -2176,7 +2314,7 @@ interface OperationMethods {
2176
2314
  config?: AxiosRequestConfig
2177
2315
  ): OperationResponse<Paths.DiscoverCampaigns.Responses.$200>
2178
2316
  /**
2179
- * matchTargets - Match targets
2317
+ * matchTargets - matchTargets
2180
2318
  *
2181
2319
  * Find targets from the provided list that include the provide entities.
2182
2320
  *
@@ -2187,7 +2325,7 @@ interface OperationMethods {
2187
2325
  config?: AxiosRequestConfig
2188
2326
  ): OperationResponse<Paths.MatchTargets.Responses.$200>
2189
2327
  /**
2190
- * getTargetQueries - Get target queries
2328
+ * getTargetQueries - getTargetQueries
2191
2329
  *
2192
2330
  * Transform target filters into Lucene queries for the provided target IDs.
2193
2331
  * Returns the transformed query string for each target along with any errors encountered.
@@ -2199,7 +2337,7 @@ interface OperationMethods {
2199
2337
  config?: AxiosRequestConfig
2200
2338
  ): OperationResponse<Paths.GetTargetQueries.Responses.$200>
2201
2339
  /**
2202
- * createRecipient - Create a recipient associated with a campaign
2340
+ * createRecipient - createRecipient
2203
2341
  *
2204
2342
  * Creates a new recipient associated with a campaign.
2205
2343
  */
@@ -2209,7 +2347,7 @@ interface OperationMethods {
2209
2347
  config?: AxiosRequestConfig
2210
2348
  ): OperationResponse<Paths.CreateRecipient.Responses.$201>
2211
2349
  /**
2212
- * updateRecipient - Update a recipient
2350
+ * updateRecipient - updateRecipient
2213
2351
  *
2214
2352
  * Updates a recipient's attributes.
2215
2353
  */
@@ -2219,7 +2357,7 @@ interface OperationMethods {
2219
2357
  config?: AxiosRequestConfig
2220
2358
  ): OperationResponse<Paths.UpdateRecipient.Responses.$200>
2221
2359
  /**
2222
- * updateRecipientPortalStatus - Update portal status for a campaign recipient
2360
+ * updateRecipientPortalStatus - updateRecipientPortalStatus
2223
2361
  *
2224
2362
  * Updates the portal status for a specific campaign recipient.
2225
2363
  * The portal_status_updated_at timestamp is automatically set when the status changes.
@@ -2236,7 +2374,7 @@ interface OperationMethods {
2236
2374
  config?: AxiosRequestConfig
2237
2375
  ): OperationResponse<Paths.UpdateRecipientPortalStatus.Responses.$200>
2238
2376
  /**
2239
- * updateRecipientEntityUiStatus - Update Entity-UI (Next Best Action) status for a campaign recipient
2377
+ * updateRecipientEntityUiStatus - updateRecipientEntityUiStatus
2240
2378
  *
2241
2379
  * Records a Next Best Action interaction for a recipient on the Entity-UI channel.
2242
2380
  *
@@ -2248,7 +2386,7 @@ interface OperationMethods {
2248
2386
  * - `seen`: lazily creates the recipient; a no-op success if a status already exists
2249
2387
  * - From `seen`: can change to `clicked` or `dismissed`
2250
2388
  * - From `clicked`: can change to `dismissed`
2251
- * - From `dismissed`: cannot be changed (final state)
2389
+ * - From `dismissed`: cannot be changed via this operation — use `entity_ui:restore`
2252
2390
  *
2253
2391
  * `dismissed` and `clicked` require an existing recipient (404 otherwise, since an NBA is
2254
2392
  * born at `seen`) and reject invalid transitions (409).
@@ -2262,7 +2400,30 @@ interface OperationMethods {
2262
2400
  config?: AxiosRequestConfig
2263
2401
  ): OperationResponse<Paths.UpdateRecipientEntityUiStatus.Responses.$200>
2264
2402
  /**
2265
- * getRecipients - Get campaign recipients
2403
+ * restoreRecipientEntityUiStatus - Undo a dismissal on the Entity-UI (Next Best Action) channel
2404
+ *
2405
+ * Reverses a dismissal so the Next Best Action becomes visible to the entity again. This is
2406
+ * the only way out of `dismissed` — `entity_ui:status` cannot leave that state.
2407
+ *
2408
+ * The recipient's status is restored to whatever it was immediately before the dismissal
2409
+ * (recorded in `entity_ui_status_before_dismiss`), so a `clicked` NBA that was dismissed
2410
+ * returns to `clicked` and does not lose its recorded click. Falls back to `seen` when no
2411
+ * previous status was recorded.
2412
+ *
2413
+ * Scoped to the Entity-UI channel only: the recipient's portal and automation state is never
2414
+ * touched. Takes no request body — the recipient's current state fully determines the result.
2415
+ *
2416
+ * Returns 404 when the recipient has no Entity-UI status at all, and 409 when it has one but
2417
+ * is not currently `dismissed` (there is nothing to undo).
2418
+ *
2419
+ */
2420
+ 'restoreRecipientEntityUiStatus'(
2421
+ parameters?: Parameters<Paths.RestoreRecipientEntityUiStatus.PathParameters> | null,
2422
+ data?: any,
2423
+ config?: AxiosRequestConfig
2424
+ ): OperationResponse<Paths.RestoreRecipientEntityUiStatus.Responses.$200>
2425
+ /**
2426
+ * getRecipients - getRecipients
2266
2427
  *
2267
2428
  * Get a paginated list of recipients for a campaign.
2268
2429
  */
@@ -2271,12 +2432,26 @@ interface OperationMethods {
2271
2432
  data?: any,
2272
2433
  config?: AxiosRequestConfig
2273
2434
  ): OperationResponse<Paths.GetRecipients.Responses.$200>
2435
+ /**
2436
+ * getEmailStats - getEmailStats
2437
+ *
2438
+ * Aggregate email delivery counts for a campaign, for the KPI summary on the campaign UI.
2439
+ * Counts cover the email (automation) channel only; `total_emailed` is the number of
2440
+ * recipients with a recorded email status. `delivered` is derivable as
2441
+ * `total_emailed - bounced - complained - failed`.
2442
+ *
2443
+ */
2444
+ 'getEmailStats'(
2445
+ parameters?: Parameters<Paths.GetEmailStats.PathParameters> | null,
2446
+ data?: any,
2447
+ config?: AxiosRequestConfig
2448
+ ): OperationResponse<Paths.GetEmailStats.Responses.$200>
2274
2449
  }
2275
2450
 
2276
2451
  interface PathsDictionary {
2277
2452
  ['/v1/campaign/{campaign_id}/status']: {
2278
2453
  /**
2279
- * changeCampaignStatus - Change the status of a campaign
2454
+ * changeCampaignStatus - changeCampaignStatus
2280
2455
  *
2281
2456
  * Change the status of a campaign to a desired status.
2282
2457
  *
@@ -2293,7 +2468,7 @@ interface PathsDictionary {
2293
2468
  }
2294
2469
  ['/v1/campaign/{campaign_id}/job']: {
2295
2470
  /**
2296
- * getCampaignJobStatus - Get the status of a campaign's automation job
2471
+ * getCampaignJobStatus - getCampaignJobStatus
2297
2472
  *
2298
2473
  * Get the status of a campaign's automation job
2299
2474
  */
@@ -2305,7 +2480,7 @@ interface PathsDictionary {
2305
2480
  }
2306
2481
  ['/v1/campaign/{campaign_id}/portals']: {
2307
2482
  /**
2308
- * getCampaignPortals - Get portals usage info for a campaign
2483
+ * getCampaignPortals - getCampaignPortals
2309
2484
  *
2310
2485
  * Get the list of portals and its widgets where the campaign is used.
2311
2486
  *
@@ -2318,7 +2493,7 @@ interface PathsDictionary {
2318
2493
  }
2319
2494
  ['/v1/campaign/{campaign_id}/automations:retrigger']: {
2320
2495
  /**
2321
- * retriggerCampaignAutomations - Retrigger automations for campaign recipients
2496
+ * retriggerCampaignAutomations - retriggerCampaignAutomations
2322
2497
  *
2323
2498
  * Retrigger automation executions for specific campaign recipients that have failed.
2324
2499
  *
@@ -2337,7 +2512,7 @@ interface PathsDictionary {
2337
2512
  }
2338
2513
  ['/v1/campaign:setup']: {
2339
2514
  /**
2340
- * setupCampaign - Set up a campaign with related entities and configurations
2515
+ * setupCampaign - setupCampaign
2341
2516
  *
2342
2517
  * Creates a `campaign` entity together with its related entities and configurations in a single call.
2343
2518
  * Used by the campaign wizard UI, but not restricted to it.
@@ -2351,7 +2526,7 @@ interface PathsDictionary {
2351
2526
  }
2352
2527
  ['/v1/campaign:match']: {
2353
2528
  /**
2354
- * matchCampaigns - Match campaigns
2529
+ * matchCampaigns - matchCampaigns
2355
2530
  *
2356
2531
  * Match campaigns based on target entities.
2357
2532
  *
@@ -2366,7 +2541,7 @@ interface PathsDictionary {
2366
2541
  }
2367
2542
  ['/v1/campaign:discover']: {
2368
2543
  /**
2369
- * discoverCampaigns - Discover Entity-UI Next Best Actions for an entity
2544
+ * discoverCampaigns - discoverCampaigns
2370
2545
  *
2371
2546
  * Given an entity, returns the Next Best Actions it should see on the Entity-UI channel.
2372
2547
  *
@@ -2386,7 +2561,7 @@ interface PathsDictionary {
2386
2561
  }
2387
2562
  ['/v1/target:match']: {
2388
2563
  /**
2389
- * matchTargets - Match targets
2564
+ * matchTargets - matchTargets
2390
2565
  *
2391
2566
  * Find targets from the provided list that include the provide entities.
2392
2567
  *
@@ -2399,7 +2574,7 @@ interface PathsDictionary {
2399
2574
  }
2400
2575
  ['/v1/target/queries']: {
2401
2576
  /**
2402
- * getTargetQueries - Get target queries
2577
+ * getTargetQueries - getTargetQueries
2403
2578
  *
2404
2579
  * Transform target filters into Lucene queries for the provided target IDs.
2405
2580
  * Returns the transformed query string for each target along with any errors encountered.
@@ -2413,7 +2588,7 @@ interface PathsDictionary {
2413
2588
  }
2414
2589
  ['/v1/campaign/{campaign_id}/recipient']: {
2415
2590
  /**
2416
- * createRecipient - Create a recipient associated with a campaign
2591
+ * createRecipient - createRecipient
2417
2592
  *
2418
2593
  * Creates a new recipient associated with a campaign.
2419
2594
  */
@@ -2425,7 +2600,7 @@ interface PathsDictionary {
2425
2600
  }
2426
2601
  ['/v1/campaign/{campaign_id}/recipient/{recipient_id}']: {
2427
2602
  /**
2428
- * updateRecipient - Update a recipient
2603
+ * updateRecipient - updateRecipient
2429
2604
  *
2430
2605
  * Updates a recipient's attributes.
2431
2606
  */
@@ -2437,7 +2612,7 @@ interface PathsDictionary {
2437
2612
  }
2438
2613
  ['/v1/campaign/{campaign_id}/recipient/{recipient_id}/portal:status']: {
2439
2614
  /**
2440
- * updateRecipientPortalStatus - Update portal status for a campaign recipient
2615
+ * updateRecipientPortalStatus - updateRecipientPortalStatus
2441
2616
  *
2442
2617
  * Updates the portal status for a specific campaign recipient.
2443
2618
  * The portal_status_updated_at timestamp is automatically set when the status changes.
@@ -2456,7 +2631,7 @@ interface PathsDictionary {
2456
2631
  }
2457
2632
  ['/v1/campaign/{campaign_id}/recipient/{recipient_id}/entity_ui:status']: {
2458
2633
  /**
2459
- * updateRecipientEntityUiStatus - Update Entity-UI (Next Best Action) status for a campaign recipient
2634
+ * updateRecipientEntityUiStatus - updateRecipientEntityUiStatus
2460
2635
  *
2461
2636
  * Records a Next Best Action interaction for a recipient on the Entity-UI channel.
2462
2637
  *
@@ -2468,7 +2643,7 @@ interface PathsDictionary {
2468
2643
  * - `seen`: lazily creates the recipient; a no-op success if a status already exists
2469
2644
  * - From `seen`: can change to `clicked` or `dismissed`
2470
2645
  * - From `clicked`: can change to `dismissed`
2471
- * - From `dismissed`: cannot be changed (final state)
2646
+ * - From `dismissed`: cannot be changed via this operation — use `entity_ui:restore`
2472
2647
  *
2473
2648
  * `dismissed` and `clicked` require an existing recipient (404 otherwise, since an NBA is
2474
2649
  * born at `seen`) and reject invalid transitions (409).
@@ -2482,9 +2657,34 @@ interface PathsDictionary {
2482
2657
  config?: AxiosRequestConfig
2483
2658
  ): OperationResponse<Paths.UpdateRecipientEntityUiStatus.Responses.$200>
2484
2659
  }
2660
+ ['/v1/campaign/{campaign_id}/recipient/{recipient_id}/entity_ui:restore']: {
2661
+ /**
2662
+ * restoreRecipientEntityUiStatus - Undo a dismissal on the Entity-UI (Next Best Action) channel
2663
+ *
2664
+ * Reverses a dismissal so the Next Best Action becomes visible to the entity again. This is
2665
+ * the only way out of `dismissed` — `entity_ui:status` cannot leave that state.
2666
+ *
2667
+ * The recipient's status is restored to whatever it was immediately before the dismissal
2668
+ * (recorded in `entity_ui_status_before_dismiss`), so a `clicked` NBA that was dismissed
2669
+ * returns to `clicked` and does not lose its recorded click. Falls back to `seen` when no
2670
+ * previous status was recorded.
2671
+ *
2672
+ * Scoped to the Entity-UI channel only: the recipient's portal and automation state is never
2673
+ * touched. Takes no request body — the recipient's current state fully determines the result.
2674
+ *
2675
+ * Returns 404 when the recipient has no Entity-UI status at all, and 409 when it has one but
2676
+ * is not currently `dismissed` (there is nothing to undo).
2677
+ *
2678
+ */
2679
+ 'post'(
2680
+ parameters?: Parameters<Paths.RestoreRecipientEntityUiStatus.PathParameters> | null,
2681
+ data?: any,
2682
+ config?: AxiosRequestConfig
2683
+ ): OperationResponse<Paths.RestoreRecipientEntityUiStatus.Responses.$200>
2684
+ }
2485
2685
  ['/v1/campaign/{campaign_id}/recipients']: {
2486
2686
  /**
2487
- * getRecipients - Get campaign recipients
2687
+ * getRecipients - getRecipients
2488
2688
  *
2489
2689
  * Get a paginated list of recipients for a campaign.
2490
2690
  */
@@ -2494,6 +2694,22 @@ interface PathsDictionary {
2494
2694
  config?: AxiosRequestConfig
2495
2695
  ): OperationResponse<Paths.GetRecipients.Responses.$200>
2496
2696
  }
2697
+ ['/v1/campaign/{campaign_id}/email-stats']: {
2698
+ /**
2699
+ * getEmailStats - getEmailStats
2700
+ *
2701
+ * Aggregate email delivery counts for a campaign, for the KPI summary on the campaign UI.
2702
+ * Counts cover the email (automation) channel only; `total_emailed` is the number of
2703
+ * recipients with a recorded email status. `delivered` is derivable as
2704
+ * `total_emailed - bounced - complained - failed`.
2705
+ *
2706
+ */
2707
+ 'get'(
2708
+ parameters?: Parameters<Paths.GetEmailStats.PathParameters> | null,
2709
+ data?: any,
2710
+ config?: AxiosRequestConfig
2711
+ ): OperationResponse<Paths.GetEmailStats.Responses.$200>
2712
+ }
2497
2713
  }
2498
2714
 
2499
2715
  type Client = OpenAPIClient<OperationMethods, PathsDictionary>
@@ -2517,6 +2733,9 @@ type CampaignStatus = Components.Schemas.CampaignStatus;
2517
2733
  type ClientError = Components.Schemas.ClientError;
2518
2734
  type CreateRecipientPayload = Components.Schemas.CreateRecipientPayload;
2519
2735
  type DiscoverCampaignsParams = Components.Schemas.DiscoverCampaignsParams;
2736
+ type DiscoverResult = Components.Schemas.DiscoverResult;
2737
+ type EmailBounceType = Components.Schemas.EmailBounceType;
2738
+ type EmailStatus = Components.Schemas.EmailStatus;
2520
2739
  type EntityUiStatus = Components.Schemas.EntityUiStatus;
2521
2740
  type ExecutionSummaryItem = Components.Schemas.ExecutionSummaryItem;
2522
2741
  type GetTargetQueriesParams = Components.Schemas.GetTargetQueriesParams;
@@ -2527,7 +2746,6 @@ type NextBestAction = Components.Schemas.NextBestAction;
2527
2746
  type PortalRecipientPayload = Components.Schemas.PortalRecipientPayload;
2528
2747
  type PortalStatus = Components.Schemas.PortalStatus;
2529
2748
  type Recipient = Components.Schemas.Recipient;
2530
- type Resolution = Components.Schemas.Resolution;
2531
2749
  type RetriggerAutomationsRequest = Components.Schemas.RetriggerAutomationsRequest;
2532
2750
  type RetriggerAutomationsResult = Components.Schemas.RetriggerAutomationsResult;
2533
2751
  type ServerError = Components.Schemas.ServerError;
@@ -2540,4 +2758,4 @@ type UpdateEntityUiStatusRequest = Components.Schemas.UpdateEntityUiStatusReques
2540
2758
  type UpdatePortalStatusRequest = Components.Schemas.UpdatePortalStatusRequest;
2541
2759
  type UpdateRecipientPayload = Components.Schemas.UpdateRecipientPayload;
2542
2760
 
2543
- export { type AutomationRecipientPayload as A, type BaseEntityAcl as B, type Client as C, type DiscoverCampaignsParams as D, type EntityUiStatus as E, type SetupTariffChangeCampaignResponse as F, type GetTargetQueriesParams as G, type TargetQueryResult as H, type UpdatePortalStatusRequest as I, type JobStatus as J, type UpdateRecipientPayload as K, type MatchCampaignParams as M, type NextBestAction as N, type OperationMethods as O, Paths as P, type Recipient as R, type ServerError as S, type Target as T, type UpdateEntityUiStatusRequest as U, Components as a, type PathsDictionary as b, type AutomationStatus as c, type BaseEntityOwner as d, type BaseError as e, type BaseNanoID as f, type BaseRecipientPayload as g, type BaseRelation as h, type BaseSystemFields as i, type BaseSystemFieldsRequired as j, type BaseSystemId as k, type BaseTags as l, type BaseUUID as m, type Campaign as n, type CampaignStatus as o, type ClientError as p, type CreateRecipientPayload as q, type ExecutionSummaryItem as r, type MatchTargetParams as s, type PortalRecipientPayload as t, type PortalStatus as u, type Resolution as v, type RetriggerAutomationsRequest as w, type RetriggerAutomationsResult as x, type SetupCampaignRequest as y, type SetupTariffChangeCampaignRequest as z };
2761
+ export { type AutomationRecipientPayload as A, type BaseEntityAcl as B, type Client as C, type DiscoverCampaignsParams as D, type EmailBounceType as E, type SetupCampaignRequest as F, type GetTargetQueriesParams as G, type SetupTariffChangeCampaignRequest as H, type SetupTariffChangeCampaignResponse as I, type JobStatus as J, type TargetQueryResult as K, type UpdatePortalStatusRequest as L, type MatchCampaignParams as M, type NextBestAction as N, type OperationMethods as O, Paths as P, type UpdateRecipientPayload as Q, type Recipient as R, type ServerError as S, type Target as T, type UpdateEntityUiStatusRequest as U, Components as a, type PathsDictionary as b, type AutomationStatus as c, type BaseEntityOwner as d, type BaseError as e, type BaseNanoID as f, type BaseRecipientPayload as g, type BaseRelation as h, type BaseSystemFields as i, type BaseSystemFieldsRequired as j, type BaseSystemId as k, type BaseTags as l, type BaseUUID as m, type Campaign as n, type CampaignStatus as o, type ClientError as p, type CreateRecipientPayload as q, type DiscoverResult as r, type EmailStatus as s, type EntityUiStatus as t, type ExecutionSummaryItem as u, type MatchTargetParams as v, type PortalRecipientPayload as w, type PortalStatus as x, type RetriggerAutomationsRequest as y, type RetriggerAutomationsResult as z };