@epilot/sdk 2.8.0-rc.0 → 2.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (293) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +0 -1
  3. package/definitions/automation.json +120 -0
  4. package/definitions/blueprint-manifest-runtime.json +1 -1
  5. package/definitions/blueprint-manifest.json +744 -20
  6. package/definitions/customer-portal-runtime.json +1 -1
  7. package/definitions/customer-portal.json +317 -26
  8. package/definitions/design.json +51 -1
  9. package/definitions/event-catalog-runtime.json +1 -1
  10. package/definitions/event-catalog.json +168 -12
  11. package/definitions/file-runtime.json +1 -1
  12. package/definitions/file.json +152 -4
  13. package/definitions/integration-toolkit-runtime.json +1 -1
  14. package/definitions/integration-toolkit.json +782 -13
  15. package/definitions/notes-runtime.json +1 -1
  16. package/definitions/notes.json +123 -1
  17. package/definitions/pricing.json +224 -406
  18. package/definitions/targeting-runtime.json +1 -1
  19. package/definitions/targeting.json +257 -7
  20. package/definitions/webhooks.json +31 -0
  21. package/dist/README-46VYEGGW.js +7 -0
  22. package/dist/README-IVBISSWB.cjs +7 -0
  23. package/dist/{_index-YTOJUFGD.js → _index-5FB6F5YY.js} +0 -3
  24. package/dist/{_index-HTUXYSTD.cjs → _index-DB2VV4PQ.cjs} +1 -4
  25. package/dist/apis/access-token.cjs +6 -6
  26. package/dist/apis/access-token.js +1 -1
  27. package/dist/apis/address-suggestions.cjs +6 -6
  28. package/dist/apis/address-suggestions.js +1 -1
  29. package/dist/apis/address.cjs +6 -6
  30. package/dist/apis/address.js +1 -1
  31. package/dist/apis/ai-agents.cjs +6 -6
  32. package/dist/apis/ai-agents.js +1 -1
  33. package/dist/apis/app.cjs +6 -6
  34. package/dist/apis/app.js +1 -1
  35. package/dist/apis/audit-logs.cjs +6 -6
  36. package/dist/apis/audit-logs.js +1 -1
  37. package/dist/apis/automation.cjs +6 -6
  38. package/dist/apis/automation.d.cts +2 -2
  39. package/dist/apis/automation.d.ts +2 -2
  40. package/dist/apis/automation.js +1 -1
  41. package/dist/apis/billing.cjs +6 -6
  42. package/dist/apis/billing.js +1 -1
  43. package/dist/apis/blueprint-manifest.cjs +8 -8
  44. package/dist/apis/blueprint-manifest.d.cts +2 -2
  45. package/dist/apis/blueprint-manifest.d.ts +2 -2
  46. package/dist/apis/blueprint-manifest.js +2 -2
  47. package/dist/apis/calendar.cjs +6 -6
  48. package/dist/apis/calendar.js +1 -1
  49. package/dist/apis/configuration-hub.cjs +6 -6
  50. package/dist/apis/configuration-hub.js +1 -1
  51. package/dist/apis/consent.cjs +6 -6
  52. package/dist/apis/consent.js +1 -1
  53. package/dist/apis/customer-portal.cjs +8 -8
  54. package/dist/apis/customer-portal.d.cts +2 -2
  55. package/dist/apis/customer-portal.d.ts +2 -2
  56. package/dist/apis/customer-portal.js +2 -2
  57. package/dist/apis/dashboard.cjs +6 -6
  58. package/dist/apis/dashboard.js +1 -1
  59. package/dist/apis/data-governance.cjs +6 -6
  60. package/dist/apis/data-governance.js +1 -1
  61. package/dist/apis/deduplication.cjs +6 -6
  62. package/dist/apis/deduplication.js +1 -1
  63. package/dist/apis/design.cjs +6 -6
  64. package/dist/apis/design.d.cts +2 -2
  65. package/dist/apis/design.d.ts +2 -2
  66. package/dist/apis/design.js +1 -1
  67. package/dist/apis/document.cjs +6 -6
  68. package/dist/apis/document.js +1 -1
  69. package/dist/apis/email-settings.cjs +6 -6
  70. package/dist/apis/email-settings.js +1 -1
  71. package/dist/apis/email-template.cjs +6 -6
  72. package/dist/apis/email-template.js +1 -1
  73. package/dist/apis/entity-mapping.cjs +6 -6
  74. package/dist/apis/entity-mapping.js +1 -1
  75. package/dist/apis/entity.cjs +6 -6
  76. package/dist/apis/entity.js +1 -1
  77. package/dist/apis/environments.cjs +6 -6
  78. package/dist/apis/environments.js +1 -1
  79. package/dist/apis/event-catalog.cjs +8 -8
  80. package/dist/apis/event-catalog.d.cts +2 -2
  81. package/dist/apis/event-catalog.d.ts +2 -2
  82. package/dist/apis/event-catalog.js +2 -2
  83. package/dist/apis/file.cjs +8 -8
  84. package/dist/apis/file.d.cts +2 -2
  85. package/dist/apis/file.d.ts +2 -2
  86. package/dist/apis/file.js +2 -2
  87. package/dist/apis/iban.cjs +6 -6
  88. package/dist/apis/iban.js +1 -1
  89. package/dist/apis/integration-toolkit.cjs +8 -8
  90. package/dist/apis/integration-toolkit.d.cts +2 -2
  91. package/dist/apis/integration-toolkit.d.ts +2 -2
  92. package/dist/apis/integration-toolkit.js +2 -2
  93. package/dist/apis/journey.cjs +6 -6
  94. package/dist/apis/journey.js +1 -1
  95. package/dist/apis/kanban.cjs +6 -6
  96. package/dist/apis/kanban.js +1 -1
  97. package/dist/apis/message.cjs +6 -6
  98. package/dist/apis/message.js +1 -1
  99. package/dist/apis/metering.cjs +6 -6
  100. package/dist/apis/metering.js +1 -1
  101. package/dist/apis/notes.cjs +8 -8
  102. package/dist/apis/notes.d.cts +2 -2
  103. package/dist/apis/notes.d.ts +2 -2
  104. package/dist/apis/notes.js +2 -2
  105. package/dist/apis/notification.cjs +6 -6
  106. package/dist/apis/notification.js +1 -1
  107. package/dist/apis/organization.cjs +6 -6
  108. package/dist/apis/organization.js +1 -1
  109. package/dist/apis/partner-directory.cjs +6 -6
  110. package/dist/apis/partner-directory.js +1 -1
  111. package/dist/apis/permissions.cjs +6 -6
  112. package/dist/apis/permissions.js +1 -1
  113. package/dist/apis/pricing-tier.cjs +6 -6
  114. package/dist/apis/pricing-tier.js +1 -1
  115. package/dist/apis/pricing.cjs +6 -6
  116. package/dist/apis/pricing.d.cts +2 -2
  117. package/dist/apis/pricing.d.ts +2 -2
  118. package/dist/apis/pricing.js +1 -1
  119. package/dist/apis/purpose.cjs +6 -6
  120. package/dist/apis/purpose.js +1 -1
  121. package/dist/apis/query.cjs +6 -6
  122. package/dist/apis/query.js +1 -1
  123. package/dist/apis/sandbox.cjs +6 -6
  124. package/dist/apis/sandbox.js +1 -1
  125. package/dist/apis/sharing.cjs +6 -6
  126. package/dist/apis/sharing.js +1 -1
  127. package/dist/apis/submission.cjs +6 -6
  128. package/dist/apis/submission.js +1 -1
  129. package/dist/apis/target.cjs +6 -6
  130. package/dist/apis/target.js +1 -1
  131. package/dist/apis/targeting.cjs +8 -8
  132. package/dist/apis/targeting.d.cts +2 -2
  133. package/dist/apis/targeting.d.ts +2 -2
  134. package/dist/apis/targeting.js +2 -2
  135. package/dist/apis/template-variables.cjs +6 -6
  136. package/dist/apis/template-variables.js +1 -1
  137. package/dist/apis/user.cjs +6 -6
  138. package/dist/apis/user.js +1 -1
  139. package/dist/apis/validation-rules.cjs +6 -6
  140. package/dist/apis/validation-rules.js +1 -1
  141. package/dist/apis/webhooks.cjs +6 -6
  142. package/dist/apis/webhooks.d.cts +2 -2
  143. package/dist/apis/webhooks.d.ts +2 -2
  144. package/dist/apis/webhooks.js +1 -1
  145. package/dist/apis/workflow-definition.cjs +6 -6
  146. package/dist/apis/workflow-definition.js +1 -1
  147. package/dist/apis/workflow.cjs +6 -6
  148. package/dist/apis/workflow.js +1 -1
  149. package/dist/automation-S6NFS5KU.cjs +7 -0
  150. package/dist/automation-W75XZG7B.js +7 -0
  151. package/dist/{automation.d-Du6-uiz5.d.cts → automation.d-DS_YXDE8.d.cts} +300 -1
  152. package/dist/{automation.d-Du6-uiz5.d.ts → automation.d-DS_YXDE8.d.ts} +300 -1
  153. package/dist/blueprint-manifest-6DEYW5MW.js +7 -0
  154. package/dist/blueprint-manifest-GCV7H74X.cjs +7 -0
  155. package/dist/{blueprint-manifest-runtime-QN2IECSA.cjs → blueprint-manifest-runtime-EIDOROIQ.cjs} +2 -2
  156. package/dist/{blueprint-manifest-runtime-5UN52LW5.js → blueprint-manifest-runtime-FRLU3ZSF.js} +1 -1
  157. package/dist/{blueprint-manifest.d-BPyzoR0X.d.ts → blueprint-manifest.d-B8yDxagC.d.cts} +572 -6
  158. package/dist/{blueprint-manifest.d-BPyzoR0X.d.cts → blueprint-manifest.d-B8yDxagC.d.ts} +572 -6
  159. package/dist/chunk-4M5V6BIT.cjs +14 -0
  160. package/dist/chunk-4YBWMDFP.js +14 -0
  161. package/dist/{chunk-KJPOUJBU.cjs → chunk-5ZXGKLB6.cjs} +1 -1
  162. package/dist/{chunk-PTEJYAYJ.js → chunk-774ASAAH.js} +1 -1
  163. package/dist/{chunk-WM74R3BD.js → chunk-7V7ECXTZ.js} +1 -1
  164. package/dist/{chunk-54KWFSCM.js → chunk-ALMZO57K.js} +21 -23
  165. package/dist/chunk-FDS727SL.cjs +14 -0
  166. package/dist/{chunk-4FFGRWLS.cjs → chunk-I53TWOTX.cjs} +1 -1
  167. package/dist/chunk-LSPXLT3A.js +14 -0
  168. package/dist/chunk-M4FO2MI4.js +14 -0
  169. package/dist/chunk-MCK2QUSD.cjs +14 -0
  170. package/dist/chunk-NGHCQ2FA.cjs +14 -0
  171. package/dist/chunk-RDVFQOCQ.js +14 -0
  172. package/dist/{chunk-RW5JOHG7.js → chunk-WIQXF7DD.js} +1 -1
  173. package/dist/{chunk-F5Z6I7TF.cjs → chunk-WPBRWQPL.cjs} +21 -23
  174. package/dist/{chunk-M2SSGV7K.cjs → chunk-ZOQUGWQL.cjs} +1 -1
  175. package/dist/customer-portal-4DXHY42V.js +7 -0
  176. package/dist/customer-portal-5OSGSYGF.cjs +7 -0
  177. package/dist/{customer-portal-runtime-IYHJ3RME.cjs → customer-portal-runtime-HA6CPWB4.cjs} +2 -2
  178. package/dist/{customer-portal-runtime-ZYU3WIXY.js → customer-portal-runtime-TDHV2YVY.js} +1 -1
  179. package/dist/{customer-portal.d-CTTCBAZI.d.cts → customer-portal.d-BRwiQehb.d.cts} +763 -31
  180. package/dist/{customer-portal.d-CTTCBAZI.d.ts → customer-portal.d-BRwiQehb.d.ts} +763 -31
  181. package/dist/data-governance-2U5UU4GM.cjs +7 -0
  182. package/dist/data-governance-36Y33JVG.js +7 -0
  183. package/dist/design-DUFBH5ZB.js +7 -0
  184. package/dist/design-W3D3UPGB.cjs +7 -0
  185. package/dist/{design.d-BRre8iLg.d.ts → design.d-DzSDu8cy.d.cts} +41 -3
  186. package/dist/{design.d-BRre8iLg.d.cts → design.d-DzSDu8cy.d.ts} +41 -3
  187. package/dist/event-catalog-3YOQ46ZW.js +7 -0
  188. package/dist/event-catalog-HLWUT7RM.cjs +7 -0
  189. package/dist/{event-catalog-runtime-N262TQ3Y.js → event-catalog-runtime-JUSLF3UR.js} +1 -1
  190. package/dist/{event-catalog-runtime-B2BPKQVG.cjs → event-catalog-runtime-RH7542GL.cjs} +2 -2
  191. package/dist/{event-catalog.d-mQJLSYUo.d.ts → event-catalog.d-CXbUn8T1.d.cts} +199 -36
  192. package/dist/{event-catalog.d-mQJLSYUo.d.cts → event-catalog.d-CXbUn8T1.d.ts} +199 -36
  193. package/dist/file-2MSILSPP.cjs +7 -0
  194. package/dist/file-JVFTT5RZ.js +7 -0
  195. package/dist/file-runtime-7AWKNQU6.cjs +5 -0
  196. package/dist/{file-runtime-BIRMXYRH.js → file-runtime-DKGFS44O.js} +1 -1
  197. package/dist/{file.d-DTlrbI40.d.cts → file.d-BjlMgTwj.d.cts} +218 -5
  198. package/dist/{file.d-DTlrbI40.d.ts → file.d-BjlMgTwj.d.ts} +218 -5
  199. package/dist/index.cjs +27 -35
  200. package/dist/index.d.cts +56 -58
  201. package/dist/index.d.ts +56 -58
  202. package/dist/index.js +16 -24
  203. package/dist/integration-toolkit-27Z3VZBZ.cjs +7 -0
  204. package/dist/integration-toolkit-NRLZZFVS.js +7 -0
  205. package/dist/{integration-toolkit-runtime-YHTU4X5J.cjs → integration-toolkit-runtime-FY7QVFL6.cjs} +2 -2
  206. package/dist/{integration-toolkit-runtime-YR4CIMKH.js → integration-toolkit-runtime-HCJ5QLCR.js} +1 -1
  207. package/dist/{integration-toolkit.d-BstNqiJb.d.cts → integration-toolkit.d-BW9RK5G-.d.cts} +1672 -27
  208. package/dist/{integration-toolkit.d-BstNqiJb.d.ts → integration-toolkit.d-BW9RK5G-.d.ts} +1672 -27
  209. package/dist/js-yaml-DLCVPJ7G.js +0 -0
  210. package/dist/notes-6JESMRLW.js +7 -0
  211. package/dist/notes-SLEUSNP4.cjs +7 -0
  212. package/dist/{notes-runtime-CVNAVKPP.js → notes-runtime-I4SWR3PZ.js} +1 -1
  213. package/dist/notes-runtime-YWTRRNH5.cjs +5 -0
  214. package/dist/{notes.d-BcV_m5fe.d.cts → notes.d-rbcyHfiB.d.cts} +101 -3
  215. package/dist/{notes.d-BcV_m5fe.d.ts → notes.d-rbcyHfiB.d.ts} +101 -3
  216. package/dist/pricing-5Y7TZHMR.js +7 -0
  217. package/dist/pricing-BJUABPHU.cjs +7 -0
  218. package/dist/{pricing.d-BHpMU4KU.d.cts → pricing.d-gPt5L7wp.d.cts} +151 -280
  219. package/dist/{pricing.d-BHpMU4KU.d.ts → pricing.d-gPt5L7wp.d.ts} +151 -280
  220. package/dist/targeting-DAFJBPIZ.cjs +7 -0
  221. package/dist/targeting-TGPCRRI6.js +7 -0
  222. package/dist/{targeting-runtime-M2VSTKFT.js → targeting-runtime-D5YUPZQM.js} +1 -1
  223. package/dist/{targeting-runtime-6JFMP262.cjs → targeting-runtime-MLMOM7CK.cjs} +2 -2
  224. package/dist/{targeting.d-BNmcVsNS.d.cts → targeting.d-DxHQbn7-.d.cts} +197 -3
  225. package/dist/{targeting.d-BNmcVsNS.d.ts → targeting.d-DxHQbn7-.d.ts} +197 -3
  226. package/dist/webhooks-6CUXSTPH.cjs +7 -0
  227. package/dist/webhooks-DTNKNJEN.js +7 -0
  228. package/dist/{webhooks.d-ByePoUWs.d.cts → webhooks.d-DKZOMj1P.d.cts} +37 -0
  229. package/dist/{webhooks.d-ByePoUWs.d.ts → webhooks.d-DKZOMj1P.d.ts} +37 -0
  230. package/docs/automation.md +180 -37
  231. package/docs/blueprint-manifest.md +728 -68
  232. package/docs/customer-portal.md +465 -56
  233. package/docs/data-governance.md +17 -17
  234. package/docs/design.md +80 -3
  235. package/docs/event-catalog.md +126 -13
  236. package/docs/file.md +113 -0
  237. package/docs/integration-toolkit.md +488 -19
  238. package/docs/notes.md +47 -1
  239. package/docs/pricing.md +290 -219
  240. package/docs/targeting.md +158 -4
  241. package/docs/webhooks.md +11 -2
  242. package/package.json +11 -21
  243. package/definitions/focus-pocus-runtime.json +0 -1
  244. package/definitions/focus-pocus.json +0 -757
  245. package/dist/README-37TXN4EL.cjs +0 -7
  246. package/dist/README-Z2WITBOR.js +0 -7
  247. package/dist/apis/focus-pocus.cjs +0 -38
  248. package/dist/apis/focus-pocus.d.cts +0 -18
  249. package/dist/apis/focus-pocus.d.ts +0 -18
  250. package/dist/apis/focus-pocus.js +0 -38
  251. package/dist/automation-BMO7ZFTN.cjs +0 -7
  252. package/dist/automation-MEZTSUR3.js +0 -7
  253. package/dist/blueprint-manifest-DBEY5PPI.js +0 -7
  254. package/dist/blueprint-manifest-IEQ6YBY7.cjs +0 -7
  255. package/dist/chunk-3APTSPY4.js +0 -14
  256. package/dist/chunk-5WNEYQII.cjs +0 -14
  257. package/dist/chunk-A6FYGWQ7.cjs +0 -14
  258. package/dist/chunk-BTTPWE2P.js +0 -14
  259. package/dist/chunk-CBDKPGO5.cjs +0 -14
  260. package/dist/chunk-L544VG3B.cjs +0 -14
  261. package/dist/chunk-O2YVXGPZ.js +0 -14
  262. package/dist/chunk-OCMIXJWC.js +0 -14
  263. package/dist/chunk-OPXGJKZR.cjs +0 -14
  264. package/dist/chunk-P42Q6HOW.js +0 -14
  265. package/dist/customer-portal-DR6XFCTQ.js +0 -7
  266. package/dist/customer-portal-PNFBVIAH.cjs +0 -7
  267. package/dist/data-governance-QYFHBCNB.cjs +0 -7
  268. package/dist/data-governance-YS2NA6W4.js +0 -7
  269. package/dist/design-EWZQZ5KX.js +0 -7
  270. package/dist/design-MUUYXB2J.cjs +0 -7
  271. package/dist/event-catalog-37B6JC7G.js +0 -7
  272. package/dist/event-catalog-5JBHJJ2I.cjs +0 -7
  273. package/dist/file-P2FUUER2.js +0 -7
  274. package/dist/file-XTY74SIX.cjs +0 -7
  275. package/dist/file-runtime-24S3QPA7.cjs +0 -5
  276. package/dist/focus-pocus-JGXH42OF.cjs +0 -7
  277. package/dist/focus-pocus-XVDVUYL6.js +0 -7
  278. package/dist/focus-pocus-runtime-QXBBYVX7.js +0 -5
  279. package/dist/focus-pocus-runtime-X6GQ3WI4.cjs +0 -5
  280. package/dist/focus-pocus.d-BRFGe53G.d.cts +0 -489
  281. package/dist/focus-pocus.d-BRFGe53G.d.ts +0 -489
  282. package/dist/integration-toolkit-3I3IPVFN.cjs +0 -7
  283. package/dist/integration-toolkit-XAFQXNQY.js +0 -7
  284. package/dist/notes-K2IIFCX3.cjs +0 -7
  285. package/dist/notes-Q7JGS7O3.js +0 -7
  286. package/dist/notes-runtime-E3YYF74V.cjs +0 -5
  287. package/dist/pricing-R5ENSVPQ.cjs +0 -7
  288. package/dist/pricing-X27CCRI6.js +0 -7
  289. package/dist/targeting-74BV7F7H.cjs +0 -7
  290. package/dist/targeting-W5EKJYR2.js +0 -7
  291. package/dist/webhooks-NZHJBT64.js +0 -7
  292. package/dist/webhooks-SK2STDKR.cjs +0 -7
  293. package/docs/focus-pocus.md +0 -460
@@ -5,6 +5,48 @@ import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, Ope
5
5
 
6
6
  declare namespace Components {
7
7
  namespace Schemas {
8
+ /**
9
+ * Additional data included in the provider entity
10
+ */
11
+ export interface AdditionalProviderData {
12
+ gridOperators: {
13
+ /**
14
+ * The name of the participant
15
+ */
16
+ name: string;
17
+ /**
18
+ * The BDEW/DVGW code number of the participant
19
+ */
20
+ codeNumber: string;
21
+ /**
22
+ * The date from which this data is valid from
23
+ */
24
+ validFrom?: string; // date
25
+ /**
26
+ * The date until which this data is valid to
27
+ */
28
+ validUntil?: string; // date
29
+ }[];
30
+ defaultSuppliers: {
31
+ /**
32
+ * The name of the participant
33
+ */
34
+ name: string;
35
+ /**
36
+ * The BDEW/DVGW code number of the participant
37
+ */
38
+ codeNumber: string;
39
+ /**
40
+ * The date from which this data is valid from
41
+ */
42
+ validFrom?: string; // date
43
+ /**
44
+ * The date until which this data is valid to
45
+ */
46
+ validUntil?: string; // date
47
+ }[];
48
+ marketAreaDetails: /* Market area details for gas */ GasMarketAreaDetails | /* Market area details for power */ PowerMarketAreaDetails;
49
+ }
8
50
  export interface Address {
9
51
  [name: string]: any;
10
52
  /**
@@ -1448,6 +1490,7 @@ declare namespace Components {
1448
1490
  */
1449
1491
  ExternalFeeMappings;
1450
1492
  external_fees_metadata?: ExternalFeeMetadata;
1493
+ external_location_metadata?: /* The provider entity */ ExternalLocationMetadata;
1451
1494
  external_price_metadata?: ExternalPriceMetadata;
1452
1495
  _immutable_pricing_details?: /* The result from the calculation of a set of price items. */ PricingDetails;
1453
1496
  /**
@@ -1556,9 +1599,13 @@ declare namespace Components {
1556
1599
  };
1557
1600
  }
1558
1601
  /**
1559
- * An amount associated with a specific cashback period.
1602
+ * A detail associated with a specific cashback.
1560
1603
  */
1561
1604
  export interface CashbackAmount {
1605
+ /**
1606
+ * The name of the cashback.
1607
+ */
1608
+ cashback_name?: string;
1562
1609
  cashback_period: /* The cashback period, for now it's limited to either 0 months or 12 months */ CashbackPeriod;
1563
1610
  /**
1564
1611
  * The sum of all cashbacks for a specific cashback period
@@ -3689,6 +3736,7 @@ declare namespace Components {
3689
3736
  */
3690
3737
  ExternalFeeMappings;
3691
3738
  external_fees_metadata?: ExternalFeeMetadata;
3739
+ external_location_metadata?: /* The provider entity */ ExternalLocationMetadata;
3692
3740
  external_price_metadata?: ExternalPriceMetadata;
3693
3741
  _immutable_pricing_details?: /* The result from the calculation of a set of price items. */ PricingDetails;
3694
3742
  /**
@@ -4838,6 +4886,28 @@ declare namespace Components {
4838
4886
  [name: string]: any;
4839
4887
  };
4840
4888
  }
4889
+ /**
4890
+ * The provider entity
4891
+ */
4892
+ export interface ExternalLocationMetadata {
4893
+ /**
4894
+ * The provider name
4895
+ */
4896
+ name: string;
4897
+ /**
4898
+ * The provider code
4899
+ */
4900
+ code: string;
4901
+ /**
4902
+ * The type of product
4903
+ */
4904
+ type: "gas" | "power";
4905
+ additionalData: /* Additional data included in the provider entity */ AdditionalProviderData;
4906
+ _meta?: /* Signature meta data payload */ SignatureMeta;
4907
+ inputs?: {
4908
+ [name: string]: any;
4909
+ };
4910
+ }
4841
4911
  export interface ExternalPriceMetadata {
4842
4912
  market: /* The market for a spot market price. */ SpotMarketType;
4843
4913
  bidding_zone: /* The bidding zone for a spot market price. */ SpotMarketBiddingZone;
@@ -4870,6 +4940,23 @@ declare namespace Components {
4870
4940
  * The concession type for gas
4871
4941
  */
4872
4942
  export type GasConcessionType = "standard" | "special";
4943
+ /**
4944
+ * Market area details for gas
4945
+ */
4946
+ export interface GasMarketAreaDetails {
4947
+ /**
4948
+ * The type of gas used
4949
+ */
4950
+ gasType?: "L-Gas" | "H-Gas";
4951
+ /**
4952
+ * The name of the market area
4953
+ */
4954
+ marketArea?: string;
4955
+ /**
4956
+ * The vritual trading point identifier
4957
+ */
4958
+ virtualTradingPoint?: string;
4959
+ }
4873
4960
  /**
4874
4961
  * A market price at a given point in time.
4875
4962
  */
@@ -5214,6 +5301,27 @@ declare namespace Components {
5214
5301
  };
5215
5302
  }[];
5216
5303
  }
5304
+ /**
5305
+ * Market participant data
5306
+ */
5307
+ export interface MarketParticipant {
5308
+ /**
5309
+ * The name of the participant
5310
+ */
5311
+ name: string;
5312
+ /**
5313
+ * The BDEW/DVGW code number of the participant
5314
+ */
5315
+ codeNumber: string;
5316
+ /**
5317
+ * The date from which this data is valid from
5318
+ */
5319
+ validFrom?: string; // date
5320
+ /**
5321
+ * The date until which this data is valid to
5322
+ */
5323
+ validUntil?: string; // date
5324
+ }
5217
5325
  /**
5218
5326
  * Describes how to compute the markup per period. Either `per_unit`, `tiered_volume` or `tiered_flatfee`.
5219
5327
  * - `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity
@@ -5479,8 +5587,18 @@ declare namespace Components {
5479
5587
  items?: {
5480
5588
  price_id: string;
5481
5589
  product_id: string;
5590
+ highlight_config?: OfferHighlightConfig;
5482
5591
  }[];
5483
5592
  }
5593
+ export interface OfferHighlightConfig {
5594
+ unique_selling_point?: string;
5595
+ unique_selling_point_icon?: string;
5596
+ total?: {
5597
+ enabled?: boolean;
5598
+ format?: "absolute" | "relative";
5599
+ only_if_better?: boolean;
5600
+ };
5601
+ }
5484
5602
  /**
5485
5603
  * The opportunity entity
5486
5604
  * example:
@@ -6572,291 +6690,18 @@ declare namespace Components {
6572
6690
  };
6573
6691
  }
6574
6692
  export interface PortalContext {
6693
+ [name: string]: any;
6575
6694
  /**
6576
6695
  * The contract information.
6577
6696
  */
6578
6697
  contract: {
6579
- /**
6580
- * The unique identifier of the contract.
6581
- */
6582
- _id?: string;
6583
- /**
6584
- * Contract Name
6585
- */
6586
- contract_name?: string;
6587
- /**
6588
- * Contract Number
6589
- */
6590
- contract_number?: string;
6591
- /**
6592
- * Assignee user ID
6593
- */
6594
- assignee?: string;
6595
- /**
6596
- * Contract status
6597
- */
6598
- status?: "draft" | "in_approval_process" | "approved" | "active" | "deactivated" | "revoked" | "terminated" | "expired";
6599
- /**
6600
- * Description of the contract
6601
- */
6602
- description?: string;
6603
- /**
6604
- * Billing Account relation
6605
- */
6606
- billing_account?: {
6607
- [key: string]: any;
6608
- };
6609
- /**
6610
- * Account Number
6611
- */
6612
- account_number?: string;
6613
- /**
6614
- * Branch/commodity type (e.g. power, gas, water, waste_water, district_heating, or any custom value)
6615
- */
6616
- branch?: string;
6617
- /**
6618
- * Move In Date
6619
- */
6620
- move_in_date?: string; // date
6621
- /**
6622
- * Move Out Date
6623
- */
6624
- move_out_date?: string; // date
6625
- /**
6626
- * Billing Address
6627
- */
6628
- billing_address?: {
6629
- [key: string]: any;
6630
- };
6631
- /**
6632
- * Delivery Address
6633
- */
6634
- delivery_address?: {
6635
- [key: string]: any;
6636
- }[];
6637
- /**
6638
- * Additional Addresses
6639
- */
6640
- additional_addresses?: {
6641
- [key: string]: any;
6642
- }[];
6643
- /**
6644
- * Date of Termination
6645
- */
6646
- termination_date?: string; // date
6647
- /**
6648
- * Reason For Termination
6649
- */
6650
- termination_reason?: string;
6651
- /**
6652
- * Start Date
6653
- */
6654
- start_date?: string; // date
6655
- /**
6656
- * End Date
6657
- */
6658
- end_date?: string; // date
6659
- /**
6660
- * Customer relation (contact or account)
6661
- */
6662
- customer?: {
6663
- [key: string]: any;
6664
- };
6665
- /**
6666
- * Order relation ID
6667
- */
6668
- order?: string;
6669
- /**
6670
- * Contract type
6671
- */
6672
- type?: "one_time" | "recurring";
6673
- /**
6674
- * Billing Period
6675
- */
6676
- billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
6677
- /**
6678
- * Billing Duration amount
6679
- */
6680
- billing_duration_amount?: number;
6681
- /**
6682
- * Billing Duration Unit
6683
- */
6684
- billing_duration_unit?: "weeks" | "months" | "years";
6685
- /**
6686
- * Notice Time amount
6687
- */
6688
- notice_time_amount?: number;
6689
- /**
6690
- * Notice Time Unit
6691
- */
6692
- notice_time_unit?: "weeks" | "months" | "years";
6693
- /**
6694
- * Termination Time amount
6695
- */
6696
- termination_time_amount?: number;
6697
- /**
6698
- * Termination Time Unit
6699
- */
6700
- termination_time_unit?: "weeks" | "months" | "years";
6701
- /**
6702
- * Renewal Duration amount
6703
- */
6704
- renewal_duration_amount?: number;
6705
- /**
6706
- * Renewal Duration Unit
6707
- */
6708
- renewal_duration_unit?: "weeks" | "months" | "years";
6709
- /**
6710
- * Billing Due Day
6711
- */
6712
- billing_due_day?: number;
6713
- installment_amount?: number;
6714
- /**
6715
- * Balance
6716
- */
6717
- balance?: number;
6718
- /**
6719
- * Meters relation
6720
- */
6721
- meters?: string[];
6722
- /**
6723
- * Payment Details relation
6724
- */
6725
- payment?: {
6726
- [key: string]: any;
6727
- };
6728
- /**
6729
- * Last Sync At
6730
- */
6731
- last_sync_at?: string; // date
6732
- /**
6733
- * External ID
6734
- */
6735
- external_id?: string;
6698
+ [name: string]: any;
6736
6699
  };
6737
6700
  /**
6738
6701
  * The contact information.
6739
6702
  */
6740
6703
  contact: {
6741
- /**
6742
- * The unique identifier of the contact.
6743
- */
6744
- _id?: string;
6745
- /**
6746
- * Salutation
6747
- */
6748
- salutation?: "Mr." | "Ms. / Mrs." | "Company" | "Contact Person" | "Company/Contact Person" | "Spouse" | "Family" | "Ownership" | "Assembly" | "Other";
6749
- /**
6750
- * Title
6751
- */
6752
- title?: "Dr." | "Prof." | "Prof. Dr.";
6753
- /**
6754
- * First Name
6755
- */
6756
- first_name?: string;
6757
- /**
6758
- * Last Name
6759
- */
6760
- last_name?: string;
6761
- /**
6762
- * Customer Number
6763
- */
6764
- customer_number?: string;
6765
- /**
6766
- * Date of Birth
6767
- */
6768
- birthdate?: string; // date
6769
- /**
6770
- * Email addresses
6771
- */
6772
- email?: {
6773
- email?: string; // email
6774
- _primary?: boolean;
6775
- }[];
6776
- /**
6777
- * Phone numbers
6778
- */
6779
- phone?: {
6780
- phone?: string;
6781
- _primary?: boolean;
6782
- }[];
6783
- /**
6784
- * Standard communication method
6785
- */
6786
- communication_preference?: "postal" | "portal";
6787
- /**
6788
- * Addresses
6789
- */
6790
- address?: {
6791
- _primary?: boolean;
6792
- postal_code?: string;
6793
- city?: string;
6794
- street?: string;
6795
- street_number?: string;
6796
- country?: string;
6797
- }[];
6798
- /**
6799
- * Payment methods
6800
- */
6801
- payment?: {
6802
- _primary?: boolean;
6803
- }[];
6804
- /**
6805
- * Account relations
6806
- */
6807
- account?: string[];
6808
- /**
6809
- * Marketing Permission (deprecated)
6810
- */
6811
- marketing_permission?: boolean;
6812
- /**
6813
- * Contact Owner user ID
6814
- */
6815
- contact_owner?: string;
6816
- /**
6817
- * Email Marketing consent
6818
- */
6819
- consent_email_marketing?: {
6820
- [key: string]: any;
6821
- };
6822
- /**
6823
- * SMS Marketing consent
6824
- */
6825
- consent_sms_marketing?: {
6826
- [key: string]: any;
6827
- };
6828
- /**
6829
- * Direct Phone Marketing consent
6830
- */
6831
- consent_phone_call?: {
6832
- [key: string]: any;
6833
- };
6834
- /**
6835
- * Print Marketing consent
6836
- */
6837
- consent_print_marketing?: {
6838
- [key: string]: any;
6839
- };
6840
- /**
6841
- * Portal Users relation
6842
- */
6843
- portal_users?: string[];
6844
- /**
6845
- * Opportunities relation
6846
- */
6847
- opportunities?: string[];
6848
- /**
6849
- * Orders relation
6850
- */
6851
- orders?: string[];
6852
- /**
6853
- * Contracts relation
6854
- */
6855
- contracts?: string[];
6856
- /**
6857
- * External ID
6858
- */
6859
- external_id?: string;
6704
+ [name: string]: any;
6860
6705
  };
6861
6706
  /**
6862
6707
  * Address to use for product availability checks. Include when the catalog should filter products by serviceable area (e.g. postal code coverage).
@@ -6907,6 +6752,19 @@ declare namespace Components {
6907
6752
  journey_target_block?: string;
6908
6753
  }[];
6909
6754
  }
6755
+ /**
6756
+ * Market area details for power
6757
+ */
6758
+ export interface PowerMarketAreaDetails {
6759
+ /**
6760
+ * The EIC of the control zone
6761
+ */
6762
+ controlZone?: string;
6763
+ /**
6764
+ * The EIC of the balancing zone
6765
+ */
6766
+ balancingZone?: string;
6767
+ }
6910
6768
  /**
6911
6769
  * The meter type for power
6912
6770
  */
@@ -8104,6 +7962,7 @@ declare namespace Components {
8104
7962
  */
8105
7963
  ExternalFeeMappings;
8106
7964
  external_fees_metadata?: ExternalFeeMetadata;
7965
+ external_location_metadata?: /* The provider entity */ ExternalLocationMetadata;
8107
7966
  external_price_metadata?: ExternalPriceMetadata;
8108
7967
  _immutable_pricing_details?: /* The result from the calculation of a set of price items. */ PricingDetails;
8109
7968
  /**
@@ -9402,6 +9261,12 @@ declare namespace Components {
9402
9261
  * The provider code
9403
9262
  */
9404
9263
  code: string;
9264
+ /**
9265
+ * The type of product
9266
+ */
9267
+ type: "gas" | "power";
9268
+ additionalData: /* Additional data included in the provider entity */ AdditionalProviderData;
9269
+ _meta?: /* Signature meta data payload */ SignatureMeta;
9405
9270
  }
9406
9271
  /**
9407
9272
  * An amount associated with a specific recurrence.
@@ -9934,9 +9799,9 @@ declare namespace Components {
9934
9799
  */
9935
9800
  recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
9936
9801
  /**
9937
- * The list of cashback sums for each cashback period.
9802
+ * The list of cashbacks applied.
9938
9803
  */
9939
- cashbacks?: (/* An amount associated with a specific cashback period. */ CashbackAmount)[];
9804
+ cashbacks?: (/* A detail associated with a specific cashback. */ CashbackAmount)[];
9940
9805
  /**
9941
9806
  * The aggregated price items recurrences by tax rate
9942
9807
  */
@@ -12110,6 +11975,7 @@ interface PathsDictionary {
12110
11975
  type Client = OpenAPIClient<OperationMethods, PathsDictionary>
12111
11976
 
12112
11977
 
11978
+ type AdditionalProviderData = Components.Schemas.AdditionalProviderData;
12113
11979
  type Address = Components.Schemas.Address;
12114
11980
  type Amounts = Components.Schemas.Amounts;
12115
11981
  type AvailabilityCheckParams = Components.Schemas.AvailabilityCheckParams;
@@ -12170,9 +12036,11 @@ type ExternalCatalogRequest = Components.Schemas.ExternalCatalogRequest;
12170
12036
  type ExternalFeeMapping = Components.Schemas.ExternalFeeMapping;
12171
12037
  type ExternalFeeMappings = Components.Schemas.ExternalFeeMappings;
12172
12038
  type ExternalFeeMetadata = Components.Schemas.ExternalFeeMetadata;
12039
+ type ExternalLocationMetadata = Components.Schemas.ExternalLocationMetadata;
12173
12040
  type ExternalPriceMetadata = Components.Schemas.ExternalPriceMetadata;
12174
12041
  type File = Components.Schemas.File;
12175
12042
  type GasConcessionType = Components.Schemas.GasConcessionType;
12043
+ type GasMarketAreaDetails = Components.Schemas.GasMarketAreaDetails;
12176
12044
  type HistoricMarketPriceRecord = Components.Schemas.HistoricMarketPriceRecord;
12177
12045
  type HistoricMarketPricesResult = Components.Schemas.HistoricMarketPricesResult;
12178
12046
  type HydratedCompositePrice = Components.Schemas.HydratedCompositePrice;
@@ -12180,12 +12048,14 @@ type IntegrationAuthCredentials = Components.Schemas.IntegrationAuthCredentials;
12180
12048
  type IntegrationCredentialsResult = Components.Schemas.IntegrationCredentialsResult;
12181
12049
  type IntegrationId = Components.Schemas.IntegrationId;
12182
12050
  type JourneyContext = Components.Schemas.JourneyContext;
12051
+ type MarketParticipant = Components.Schemas.MarketParticipant;
12183
12052
  type MarkupPricingModel = Components.Schemas.MarkupPricingModel;
12184
12053
  type MetaData = Components.Schemas.MetaData;
12185
12054
  type NonHydratedCompositePrice = Components.Schemas.NonHydratedCompositePrice;
12186
12055
  type OAuthCredentials = Components.Schemas.OAuthCredentials;
12187
12056
  type OAuthIntegration = Components.Schemas.OAuthIntegration;
12188
12057
  type Offer = Components.Schemas.Offer;
12058
+ type OfferHighlightConfig = Components.Schemas.OfferHighlightConfig;
12189
12059
  type Opportunity = Components.Schemas.Opportunity;
12190
12060
  type OpportunitySource = Components.Schemas.OpportunitySource;
12191
12061
  type Order = Components.Schemas.Order;
@@ -12195,6 +12065,7 @@ type OrderSource = Components.Schemas.OrderSource;
12195
12065
  type OrderStatus = Components.Schemas.OrderStatus;
12196
12066
  type PaymentMethod = Components.Schemas.PaymentMethod;
12197
12067
  type PortalContext = Components.Schemas.PortalContext;
12068
+ type PowerMarketAreaDetails = Components.Schemas.PowerMarketAreaDetails;
12198
12069
  type PowerMeterType = Components.Schemas.PowerMeterType;
12199
12070
  type Price = Components.Schemas.Price;
12200
12071
  type PriceAmounts = Components.Schemas.PriceAmounts;
@@ -12252,4 +12123,4 @@ type TypeGetAg = Components.Schemas.TypeGetAg;
12252
12123
  type ValidateAvailabilityFileError = Components.Schemas.ValidateAvailabilityFileError;
12253
12124
  type ValidateAvailabilityFileResult = Components.Schemas.ValidateAvailabilityFileResult;
12254
12125
 
12255
- export { type EntityItem as $, type Address as A, type BaseCompositePrice as B, type Client as C, type CompositePrice as D, type CompositePriceItem as E, type CompositePriceItemDto as F, type ComputePriceParams as G, type ComputePriceParamsBase as H, type ComputePriceParamsGas as I, type ComputePriceParamsPower as J, type ComputePriceResult as K, type ComputedBasePrice as L, type ComputedPriceBreakdown as M, type ComputedPriceComponents as N, type OperationMethods as O, Paths as P, type ConsumptionTypeGetAg as Q, type Coupon as R, type CouponItem as S, type CouponWithoutPromoCodes as T, type Currency as U, type CustomContext as V, type Customer as W, type DiscountAmounts as X, type DynamicTariffInterval as Y, type DynamicTariffMode as Z, type EntityId as _, Components as a, type RecurrenceAmount as a$, type EntityRelation as a0, type Error as a1, type ExternalCatalogConfigurationRequest as a2, type ExternalCatalogCustomRequest as a3, type ExternalCatalogItem as a4, type ExternalCatalogJourneyRequest as a5, type ExternalCatalogPortalRequest as a6, type ExternalCatalogRequest as a7, type ExternalFeeMapping as a8, type ExternalFeeMappings as a9, type PowerMeterType as aA, type Price as aB, type PriceAmounts as aC, type PriceComponentRelation as aD, type PriceConditions as aE, type PriceDynamicTariff as aF, type PriceGetAg as aG, type PriceInputMapping as aH, type PriceInputMappings as aI, type PriceItem as aJ, type PriceItemDto as aK, type PriceItemDtoUnion as aL, type PriceItems as aM, type PriceItemsDto as aN, type PriceTier as aO, type PriceTierDisplayMode as aP, type PricingDetails as aQ, type PricingDetailsResponse as aR, type PricingModel as aS, type Product as aT, type ProductCategory as aU, type ProductRecommendation as aV, type ProductRecommendationResponse as aW, type ProductRecommendationSearch as aX, type PromoCode as aY, type PromoCodeValidationResponse as aZ, type Provider as a_, type ExternalFeeMetadata as aa, type ExternalPriceMetadata as ab, type File as ac, type GasConcessionType as ad, type HistoricMarketPriceRecord as ae, type HistoricMarketPricesResult as af, type HydratedCompositePrice as ag, type IntegrationAuthCredentials as ah, type IntegrationCredentialsResult as ai, type IntegrationId as aj, type JourneyContext as ak, type MarkupPricingModel as al, type MetaData as am, type NonHydratedCompositePrice as an, type OAuthCredentials as ao, type OAuthIntegration as ap, type Offer as aq, type Opportunity as ar, type OpportunitySource as as, type Order as at, type OrderPayload as au, type OrderRelation as av, type OrderSource as aw, type OrderStatus as ax, type PaymentMethod as ay, type PortalContext as az, type PathsDictionary as b, type RecurrenceAmountDto as b0, type RecurrenceAmountWithTax as b1, type RedeemedPromo as b2, type SalesTax as b3, type SaveIntegrationCredentialsParams as b4, type SearchExternalCatalogParams as b5, type SearchExternalCatalogRecommendationsResult as b6, type SearchExternalCatalogResult as b7, type SearchProvidersParams as b8, type SearchProvidersResult as b9, type SearchStreetsParams as ba, type SearchStreetsResult as bb, type SignatureMeta as bc, type SpotMarketBiddingZone as bd, type SpotMarketDataFrequency as be, type SpotMarketType as bf, type Street as bg, type TariffTypeGetAg as bh, type Tax as bi, type TaxAmount as bj, type TaxAmountBreakdown as bk, type TaxAmountDto as bl, type TaxBreakdownInfo as bm, type TierDetails as bn, type TotalDetails as bo, type TypeGetAg as bp, type ValidateAvailabilityFileError as bq, type ValidateAvailabilityFileResult as br, type Amounts as c, type AvailabilityCheckParams as d, type AvailabilityFilters as e, type AvailabilityLocation as f, type AvailabilityResult as g, type AverageMarketPriceRecord as h, type AverageMarketPriceResult as i, type BaseCouponCommon as j, type BaseMarketPriceRecord as k, type BasePriceItem as l, type BasePriceItemCommon as m, type BasePriceItemDto as n, type BasicAuthCredentials as o, type BasicAuthIntegration as p, type BillingPeriod as q, type CartDto as r, type CashbackAmount as s, type CashbackAmounts as t, type CashbackPeriod as u, type CatalogSearch as v, type CatalogSearchResult as w, type CheckoutCart as x, type CheckoutCartResult as y, type CheckoutMode as z };
12126
+ export { type EntityId as $, type AdditionalProviderData as A, type BaseCompositePrice as B, type Client as C, type CheckoutMode as D, type CompositePrice as E, type CompositePriceItem as F, type CompositePriceItemDto as G, type ComputePriceParams as H, type ComputePriceParamsBase as I, type ComputePriceParamsGas as J, type ComputePriceParamsPower as K, type ComputePriceResult as L, type ComputedBasePrice as M, type ComputedPriceBreakdown as N, type OperationMethods as O, Paths as P, type ComputedPriceComponents as Q, type ConsumptionTypeGetAg as R, type Coupon as S, type CouponItem as T, type CouponWithoutPromoCodes as U, type Currency as V, type CustomContext as W, type Customer as X, type DiscountAmounts as Y, type DynamicTariffInterval as Z, type DynamicTariffMode as _, Components as a, type ProductRecommendation as a$, type EntityItem as a0, type EntityRelation as a1, type Error as a2, type ExternalCatalogConfigurationRequest as a3, type ExternalCatalogCustomRequest as a4, type ExternalCatalogItem as a5, type ExternalCatalogJourneyRequest as a6, type ExternalCatalogPortalRequest as a7, type ExternalCatalogRequest as a8, type ExternalFeeMapping as a9, type OrderRelation as aA, type OrderSource as aB, type OrderStatus as aC, type PaymentMethod as aD, type PortalContext as aE, type PowerMarketAreaDetails as aF, type PowerMeterType as aG, type Price as aH, type PriceAmounts as aI, type PriceComponentRelation as aJ, type PriceConditions as aK, type PriceDynamicTariff as aL, type PriceGetAg as aM, type PriceInputMapping as aN, type PriceInputMappings as aO, type PriceItem as aP, type PriceItemDto as aQ, type PriceItemDtoUnion as aR, type PriceItems as aS, type PriceItemsDto as aT, type PriceTier as aU, type PriceTierDisplayMode as aV, type PricingDetails as aW, type PricingDetailsResponse as aX, type PricingModel as aY, type Product as aZ, type ProductCategory as a_, type ExternalFeeMappings as aa, type ExternalFeeMetadata as ab, type ExternalLocationMetadata as ac, type ExternalPriceMetadata as ad, type File as ae, type GasConcessionType as af, type GasMarketAreaDetails as ag, type HistoricMarketPriceRecord as ah, type HistoricMarketPricesResult as ai, type HydratedCompositePrice as aj, type IntegrationAuthCredentials as ak, type IntegrationCredentialsResult as al, type IntegrationId as am, type JourneyContext as an, type MarketParticipant as ao, type MarkupPricingModel as ap, type MetaData as aq, type NonHydratedCompositePrice as ar, type OAuthCredentials as as, type OAuthIntegration as at, type Offer as au, type OfferHighlightConfig as av, type Opportunity as aw, type OpportunitySource as ax, type Order as ay, type OrderPayload as az, type PathsDictionary as b, type ProductRecommendationResponse as b0, type ProductRecommendationSearch as b1, type PromoCode as b2, type PromoCodeValidationResponse as b3, type Provider as b4, type RecurrenceAmount as b5, type RecurrenceAmountDto as b6, type RecurrenceAmountWithTax as b7, type RedeemedPromo as b8, type SalesTax as b9, type SaveIntegrationCredentialsParams as ba, type SearchExternalCatalogParams as bb, type SearchExternalCatalogRecommendationsResult as bc, type SearchExternalCatalogResult as bd, type SearchProvidersParams as be, type SearchProvidersResult as bf, type SearchStreetsParams as bg, type SearchStreetsResult as bh, type SignatureMeta as bi, type SpotMarketBiddingZone as bj, type SpotMarketDataFrequency as bk, type SpotMarketType as bl, type Street as bm, type TariffTypeGetAg as bn, type Tax as bo, type TaxAmount as bp, type TaxAmountBreakdown as bq, type TaxAmountDto as br, type TaxBreakdownInfo as bs, type TierDetails as bt, type TotalDetails as bu, type TypeGetAg as bv, type ValidateAvailabilityFileError as bw, type ValidateAvailabilityFileResult as bx, type Address as c, type Amounts as d, type AvailabilityCheckParams as e, type AvailabilityFilters as f, type AvailabilityLocation as g, type AvailabilityResult as h, type AverageMarketPriceRecord as i, type AverageMarketPriceResult as j, type BaseCouponCommon as k, type BaseMarketPriceRecord as l, type BasePriceItem as m, type BasePriceItemCommon as n, type BasePriceItemDto as o, type BasicAuthCredentials as p, type BasicAuthIntegration as q, type BillingPeriod as r, type CartDto as s, type CashbackAmount as t, type CashbackAmounts as u, type CashbackPeriod as v, type CatalogSearch as w, type CatalogSearchResult as x, type CheckoutCart as y, type CheckoutCartResult as z };
@@ -0,0 +1,7 @@
1
+ "use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
2
+
3
+ // src/docs/targeting.json
4
+ var targeting_default = '# Targeting API\n\n- **Base URL:** `https://targeting.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/targeting](https://docs.epilot.io/api/targeting)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.targeting.changeCampaignStatus(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/targeting\'\n\nconst targetingClient = getClient()\nauthorize(targetingClient, () => \'<token>\')\nconst { data } = await targetingClient.changeCampaignStatus(...)\n```\n\n## Operations\n\n**Campaign**\n- [`changeCampaignStatus`](#changecampaignstatus)\n- [`getCampaignJobStatus`](#getcampaignjobstatus)\n- [`getCampaignPortals`](#getcampaignportals)\n- [`setupCampaign`](#setupcampaign)\n- [`matchCampaigns`](#matchcampaigns)\n\n**Campaign Delivery**\n- [`retriggerCampaignAutomations`](#retriggercampaignautomations)\n\n**Target**\n- [`matchTargets`](#matchtargets)\n- [`getTargetQueries`](#gettargetqueries)\n\n**Campaign Recipient**\n- [`createRecipient`](#createrecipient)\n- [`updateRecipient`](#updaterecipient)\n- [`updateRecipientPortalStatus`](#updaterecipientportalstatus)\n- [`getRecipients`](#getrecipients)\n\n**Schemas**\n- [`BaseError`](#baseerror)\n- [`ServerError`](#servererror)\n- [`ClientError`](#clienterror)\n- [`BaseUUID`](#baseuuid)\n- [`BaseNanoID`](#basenanoid)\n- [`BaseTags`](#basetags)\n- [`BaseRelation`](#baserelation)\n- [`BaseSystemId`](#basesystemid)\n- [`BaseEntityOwner`](#baseentityowner)\n- [`BaseEntityAcl`](#baseentityacl)\n- [`BaseSystemFields`](#basesystemfields)\n- [`BaseSystemFieldsRequired`](#basesystemfieldsrequired)\n- [`CampaignStatus`](#campaignstatus)\n- [`ExecutionSummaryItem`](#executionsummaryitem)\n- [`JobStatus`](#jobstatus)\n- [`Campaign`](#campaign)\n- [`Target`](#target)\n- [`MatchCampaignParams`](#matchcampaignparams)\n- [`MatchTargetParams`](#matchtargetparams)\n- [`GetTargetQueriesParams`](#gettargetqueriesparams)\n- [`TargetQueryResult`](#targetqueryresult)\n- [`AutomationStatus`](#automationstatus)\n- [`PortalStatus`](#portalstatus)\n- [`Recipient`](#recipient)\n- [`BaseRecipientPayload`](#baserecipientpayload)\n- [`AutomationRecipientPayload`](#automationrecipientpayload)\n- [`PortalRecipientPayload`](#portalrecipientpayload)\n- [`CreateRecipientPayload`](#createrecipientpayload)\n- [`UpdateRecipientPayload`](#updaterecipientpayload)\n- [`RetriggerAutomationsRequest`](#retriggerautomationsrequest)\n- [`RetriggerAutomationsResult`](#retriggerautomationsresult)\n- [`UpdatePortalStatusRequest`](#updateportalstatusrequest)\n- [`SetupCampaignRequest`](#setupcampaignrequest)\n- [`SetupTariffChangeCampaignRequest`](#setuptariffchangecampaignrequest)\n- [`SetupTariffChangeCampaignResponse`](#setuptariffchangecampaignresponse)\n\n### `changeCampaignStatus`\n\nChange the status of a campaign\n\n`POST /v1/campaign/{campaign_id}/status`\n\n```ts\nconst { data } = await client.changeCampaignStatus({\n campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "campaign": {\n "_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "_org": "string",\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_schema": "string",\n "_title": "string",\n "_tags": ["string"],\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_acl": {\n "view": ["org:456"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "name": "string",\n "goal": "string",\n "status": "draft",\n "start_date": "1970-01-01",\n "end_date": "1970-01-01",\n "flow_id": "string",\n "job_id": "string",\n "target": {\n "$relation": [\n {\n "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "_tags": ["string"]\n }\n ]\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `getCampaignJobStatus`\n\nGet the status of a campaign\'s automation job\n\n`GET /v1/campaign/{campaign_id}/job`\n\n```ts\nconst { data } = await client.getCampaignJobStatus({\n campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "status": "queued",\n "execution_summary": [\n {\n "execution_id": "string",\n "execution_status": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getCampaignPortals`\n\nGet portals usage info for a campaign\n\n`GET /v1/campaign/{campaign_id}/portals`\n\n```ts\nconst { data } = await client.getCampaignPortals({\n campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "portal": {\n "origin": "string",\n "domain": "string",\n "name": "string"\n },\n "widgets": [\n {\n "id": "string",\n "headline": {\n "en": "string",\n "de": "string"\n }\n }\n ]\n }\n]\n```\n\n</details>\n\n---\n\n### `retriggerCampaignAutomations`\n\nRetrigger automations for campaign recipients\n\n`POST /v1/campaign/{campaign_id}/automations:retrigger`\n\n```ts\nconst { data } = await client.retriggerCampaignAutomations(\n {\n campaign_id: \'example\',\n },\n {\n recipient_ids: [\'3fa85f64-5717-4562-b3fc-2c963f66afa6\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "message": "string",\n "results": [\n {\n "recipient_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "result": "success",\n "execution_id": "string",\n "error": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `setupCampaign`\n\nSet up a campaign with related entities and configurations\n\n`POST /v1/campaign:setup`\n\n```ts\nconst { data } = await client.setupCampaign(\n null,\n {\n type: \'tariff_change\',\n product_recommendation: {\n name: \'string\',\n source_product_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n source_price_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n offers: [\n {\n target_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n items: [\n {\n product_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n price_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n highlight_config: {}\n }\n ]\n }\n ]\n },\n campaign: {\n name: \'string\',\n goal: \'string\',\n target_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n },\n journey: {\n journey_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\'\n },\n channels: {\n portal_widget: {\n portal_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n block_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\'\n },\n email: {\n automation_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\'\n }\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "type": "tariff_change",\n "product_recommendation_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "campaign_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "journey_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "portal_widget_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84"\n}\n```\n\n</details>\n\n---\n\n### `matchCampaigns`\n\nMatch campaigns\n\n`POST /v1/campaign:match`\n\n```ts\nconst { data } = await client.matchCampaigns(\n null,\n {\n entity_refs: [\n {\n entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n entity_schema: \'string\'\n }\n ],\n campaign_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 0,\n "results": [\n {\n "campaign": {\n "_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "_org": "string",\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_schema": "string",\n "_title": "string",\n "_tags": ["string"],\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_acl": {\n "view": ["org:456"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "name": "string",\n "goal": "string",\n "status": "draft",\n "start_date": "1970-01-01",\n "end_date": "1970-01-01",\n "flow_id": "string",\n "job_id": "string",\n "target": {\n "$relation": [\n {\n "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "_tags": ["string"]\n }\n ]\n }\n }\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `matchTargets`\n\nMatch targets\n\n`POST /v1/target:match`\n\n```ts\nconst { data } = await client.matchTargets(\n null,\n {\n entity_refs: [\n {\n entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n entity_schema: \'string\'\n }\n ],\n target_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 0,\n "results": [\n {\n "target": {\n "_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "_org": "string",\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_schema": "string",\n "_title": "string",\n "_tags": ["string"],\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_acl": {\n "view": ["org:456"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "name": "string",\n "description": "string",\n "entity_schema": "string",\n "entity_filters": {}\n }\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getTargetQueries`\n\nGet target queries\n\n`POST /v1/target/queries`\n\n```ts\nconst { data } = await client.getTargetQueries(\n null,\n {\n target_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "target_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "query": "string",\n "error": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createRecipient`\n\nCreate a recipient associated with a campaign\n\n`POST /v1/campaign/{campaign_id}/recipient`\n\n```ts\nconst { data } = await client.createRecipient(\n {\n campaign_id: \'example\',\n },\n {\n entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n entity_schema: \'string\',\n automation_status: \'pending\',\n automation_execution_id: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "entity_schema": "string",\n "title": "string",\n "automation_status": "pending",\n "automation_execution_id": "string",\n "portal_status": "sent",\n "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n "portal_state": {},\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateRecipient`\n\nUpdate a recipient\n\n`PATCH /v1/campaign/{campaign_id}/recipient/{recipient_id}`\n\n```ts\nconst { data } = await client.updateRecipient(\n {\n campaign_id: \'example\',\n recipient_id: \'example\',\n },\n {\n automation_status: \'pending\',\n automation_execution_id: \'string\',\n portal_status: \'sent\',\n portal_state: {}\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "entity_schema": "string",\n "title": "string",\n "automation_status": "pending",\n "automation_execution_id": "string",\n "portal_status": "sent",\n "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n "portal_state": {},\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateRecipientPortalStatus`\n\nUpdate portal status for a campaign recipient\n\n`PATCH /v1/campaign/{campaign_id}/recipient/{recipient_id}/portal:status`\n\n```ts\nconst { data } = await client.updateRecipientPortalStatus(\n {\n campaign_id: \'example\',\n recipient_id: \'example\',\n },\n {\n status: \'sent\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "entity_schema": "string",\n "title": "string",\n "automation_status": "pending",\n "automation_execution_id": "string",\n "portal_status": "sent",\n "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n "portal_state": {},\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `getRecipients`\n\nGet campaign recipients\n\n`GET /v1/campaign/{campaign_id}/recipients`\n\n```ts\nconst { data } = await client.getRecipients({\n campaign_id: \'example\',\n limit: 1,\n next: \'example\',\n q: \'example\',\n automation_status: \'example\',\n portal_status: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "entity_schema": "string",\n "title": "string",\n "automation_status": "pending",\n "automation_execution_id": "string",\n "portal_status": "sent",\n "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n "portal_state": {},\n "updated_at": "1970-01-01T00:00:00.000Z"\n }\n ],\n "next": "string",\n "total": 0\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `BaseError`\n\n```ts\ntype BaseError = {\n status: number\n message: string\n}\n```\n\n### `ServerError`\n\n```ts\ntype ServerError = {\n status: number\n message: string\n}\n```\n\n### `ClientError`\n\nDescribes the structure of a client error response, which can be one of several types:\n1. `MessageError`: Contains a \'message\' field for general descriptive errors.\n2. `CodeError`: Contains a \'code\' field for specific, machine-readable error codes.\n3. `StatusedError`: Contains \'error\' and \'status\' f\n\n```ts\ntype ClientError = {\n message: string\n} | {\n 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"\n} | {\n error: string\n status: number\n}\n```\n\n### `BaseUUID`\n\n```ts\ntype BaseUUID = string // uuid\n```\n\n### `BaseNanoID`\n\n```ts\ntype BaseNanoID = string\n```\n\n### `BaseTags`\n\n```ts\ntype BaseTags = string[]\n```\n\n### `BaseRelation`\n\n```ts\ntype BaseRelation = {\n $relation?: Array<{\n entity_id?: string // uuid\n _tags?: string[]\n }>\n}\n```\n\n### `BaseSystemId`\n\n```ts\ntype BaseSystemId = {\n _id: string // uuid\n}\n```\n\n### `BaseEntityOwner`\n\nThe user / organization owning this entity.\n\nNote: Owner implicitly has access to the entity regardless of ACLs.\n\n\n```ts\ntype BaseEntityOwner = {\n org_id: string\n user_id?: string\n}\n```\n\n### `BaseEntityAcl`\n\nAccess control list (ACL) for an entity. Defines sharing access to external orgs or users.\n\n```ts\ntype BaseEntityAcl = {\n view?: string[]\n edit?: string[]\n delete?: string[]\n}\n```\n\n### `BaseSystemFields`\n\n```ts\ntype BaseSystemFields = {\n _id?: string // uuid\n _org?: string\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n}\n```\n\n### `BaseSystemFieldsRequired`\n\n```ts\ntype BaseSystemFieldsRequired = object\n```\n\n### `CampaignStatus`\n\n```ts\ntype CampaignStatus = "draft" | "activating" | "active" | "inactive"\n```\n\n### `ExecutionSummaryItem`\n\n```ts\ntype ExecutionSummaryItem = {\n execution_id?: string\n execution_status?: string\n}\n```\n\n### `JobStatus`\n\n```ts\ntype JobStatus = {\n status?: "queued" | "processing" | "finished" | "failed" | "cancelled" | "send_report"\n execution_summary?: Array<{\n execution_id?: string\n execution_status?: string\n }>\n}\n```\n\n### `Campaign`\n\n```ts\ntype Campaign = {\n _id?: string // uuid\n _org?: string\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n name?: string\n goal?: string\n status?: "draft" | "activating" | "active" | "inactive"\n start_date?: string // date\n end_date?: string // date\n flow_id?: string\n job_id?: string\n target?: {\n $relation?: Array<{\n entity_id?: { ... }\n _tags?: { ... }\n }>\n }\n}\n```\n\n### `Target`\n\n```ts\ntype Target = {\n _id?: string // uuid\n _org?: string\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n name?: string\n description?: string\n entity_schema?: string\n entity_filters?: Record<string, unknown>\n}\n```\n\n### `MatchCampaignParams`\n\n```ts\ntype MatchCampaignParams = {\n entity_refs: Array<{\n entity_id: string // uuid\n entity_schema: string\n }>\n campaign_ids: string // uuid[]\n}\n```\n\n### `MatchTargetParams`\n\n```ts\ntype MatchTargetParams = {\n entity_refs: Array<{\n entity_id: string // uuid\n entity_schema: string\n }>\n target_ids: string // uuid[]\n}\n```\n\n### `GetTargetQueriesParams`\n\n```ts\ntype GetTargetQueriesParams = {\n target_ids: string // uuid[]\n}\n```\n\n### `TargetQueryResult`\n\n```ts\ntype TargetQueryResult = {\n target_id: string // uuid\n query: string\n error?: string\n}\n```\n\n### `AutomationStatus`\n\n```ts\ntype AutomationStatus = "pending" | "in_progress" | "success" | "failed" | "cancelled"\n```\n\n### `PortalStatus`\n\n```ts\ntype PortalStatus = "sent" | "seen" | "dismissed" | "clicked"\n```\n\n### `Recipient`\n\n```ts\ntype Recipient = {\n entity_id?: string // uuid\n entity_schema?: string\n title?: string\n automation_status?: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n automation_execution_id?: string\n portal_status?: "sent" | "seen" | "dismissed" | "clicked"\n portal_status_updated_at?: string // date-time\n portal_state?: Record<string, unknown>\n updated_at?: string // date-time\n}\n```\n\n### `BaseRecipientPayload`\n\n```ts\ntype BaseRecipientPayload = {\n entity_id: string // uuid\n entity_schema: string\n}\n```\n\n### `AutomationRecipientPayload`\n\n```ts\ntype AutomationRecipientPayload = {\n automation_status: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n automation_execution_id: string\n}\n```\n\n### `PortalRecipientPayload`\n\n```ts\ntype PortalRecipientPayload = {\n portal_status: "sent" | "seen" | "dismissed" | "clicked"\n portal_state?: Record<string, unknown>\n}\n```\n\n### `CreateRecipientPayload`\n\n```ts\ntype CreateRecipientPayload = {\n entity_id: string // uuid\n entity_schema: string\n automation_status: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n automation_execution_id: string\n} | {\n entity_id: string // uuid\n entity_schema: string\n portal_status: "sent" | "seen" | "dismissed" | "clicked"\n portal_state?: Record<string, unknown>\n} | {\n entity_id: string // uuid\n entity_schema: string\n automation_status: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n automation_execution_id: string\n portal_status: "sent" | "seen" | "dismissed" | "clicked"\n portal_state?: Record<string, unknown>\n}\n```\n\n### `UpdateRecipientPayload`\n\n```ts\ntype UpdateRecipientPayload = {\n automation_status?: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n automation_execution_id?: string\n portal_status?: "sent" | "seen" | "dismissed" | "clicked"\n portal_state?: Record<string, unknown>\n}\n```\n\n### `RetriggerAutomationsRequest`\n\n```ts\ntype RetriggerAutomationsRequest = {\n recipient_ids: string // uuid[]\n}\n```\n\n### `RetriggerAutomationsResult`\n\n```ts\ntype RetriggerAutomationsResult = {\n recipient_id: string // uuid\n result: "success" | "failure" | "not_found" | "invalid_status"\n execution_id?: string\n error?: string\n}\n```\n\n### `UpdatePortalStatusRequest`\n\n```ts\ntype UpdatePortalStatusRequest = {\n status: "sent" | "seen" | "dismissed" | "clicked"\n}\n```\n\n### `SetupCampaignRequest`\n\nDiscriminated by `type`. Each campaign variant has its own request shape;\nnew variants are added by introducing a new schema and extending the `oneOf` list.\n\n\n```ts\ntype SetupCampaignRequest = {\n type: "tariff_change"\n product_recommendation: {\n name?: string\n source_product_id?: string // uuid\n source_price_id?: string // uuid\n offers?: Array<{\n target_id?: { ... }\n items: { ... }\n }>\n }\n campaign: {\n name: string\n goal?: string\n target_ids: string // uuid[]\n }\n journey?: {\n journey_id: string // uuid\n }\n channels?: {\n portal_widget?: {\n portal_id: { ... }\n block_id: { ... }\n }\n email?: {\n automation_id: { ... }\n }\n }\n}\n```\n\n### `SetupTariffChangeCampaignRequest`\n\n```ts\ntype SetupTariffChangeCampaignRequest = {\n type: "tariff_change"\n product_recommendation: {\n name?: string\n source_product_id?: string // uuid\n source_price_id?: string // uuid\n offers?: Array<{\n target_id?: { ... }\n items: { ... }\n }>\n }\n campaign: {\n name: string\n goal?: string\n target_ids: string // uuid[]\n }\n journey?: {\n journey_id: string // uuid\n }\n channels?: {\n portal_widget?: {\n portal_id: { ... }\n block_id: { ... }\n }\n email?: {\n automation_id: { ... }\n }\n }\n}\n```\n\n### `SetupTariffChangeCampaignResponse`\n\n```ts\ntype SetupTariffChangeCampaignResponse = {\n type: "tariff_change"\n product_recommendation_id: string // uuid\n campaign_id: string // uuid\n journey_id?: string // uuid\n portal_widget_id?: string // uuid\n}\n```\n';
5
+
6
+
7
+ exports.default = targeting_default;