@hanzo/crm 0.0.0-stage → 0.1.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 (109) hide show
  1. package/LICENSE-MIT +21 -0
  2. package/LICENSE.md +21 -0
  3. package/NOTICE +52 -0
  4. package/README.md +72 -2
  5. package/dist/CrmModule.d.ts +4 -0
  6. package/dist/CrmModule.d.ts.map +1 -0
  7. package/dist/CrmModule.js +78 -0
  8. package/dist/CrmModule.js.map +1 -0
  9. package/dist/crm/Access.d.ts +10 -0
  10. package/dist/crm/Access.d.ts.map +1 -0
  11. package/dist/crm/Access.js +35 -0
  12. package/dist/crm/Access.js.map +1 -0
  13. package/dist/crm/Actions.d.ts +38 -0
  14. package/dist/crm/Actions.d.ts.map +1 -0
  15. package/dist/crm/Actions.js +224 -0
  16. package/dist/crm/Actions.js.map +1 -0
  17. package/dist/crm/Create.d.ts +13 -0
  18. package/dist/crm/Create.d.ts.map +1 -0
  19. package/dist/crm/Create.js +64 -0
  20. package/dist/crm/Create.js.map +1 -0
  21. package/dist/crm/Import.d.ts +7 -0
  22. package/dist/crm/Import.d.ts.map +1 -0
  23. package/dist/crm/Import.js +94 -0
  24. package/dist/crm/Import.js.map +1 -0
  25. package/dist/crm/Record.d.ts +6 -0
  26. package/dist/crm/Record.d.ts.map +1 -0
  27. package/dist/crm/Record.js +257 -0
  28. package/dist/crm/Record.js.map +1 -0
  29. package/dist/crm/Records.d.ts +33 -0
  30. package/dist/crm/Records.d.ts.map +1 -0
  31. package/dist/crm/Records.js +277 -0
  32. package/dist/crm/Records.js.map +1 -0
  33. package/dist/crm/Timeline.d.ts +22 -0
  34. package/dist/crm/Timeline.d.ts.map +1 -0
  35. package/dist/crm/Timeline.js +117 -0
  36. package/dist/crm/Timeline.js.map +1 -0
  37. package/dist/crm/csv.d.ts +75 -0
  38. package/dist/crm/csv.d.ts.map +1 -0
  39. package/dist/crm/csv.js +300 -0
  40. package/dist/crm/csv.js.map +1 -0
  41. package/dist/crm/importer.d.ts +39 -0
  42. package/dist/crm/importer.d.ts.map +1 -0
  43. package/dist/crm/importer.js +147 -0
  44. package/dist/crm/importer.js.map +1 -0
  45. package/dist/crm/objects.d.ts +80 -0
  46. package/dist/crm/objects.d.ts.map +1 -0
  47. package/dist/crm/objects.js +167 -0
  48. package/dist/crm/objects.js.map +1 -0
  49. package/dist/crm/schema.d.ts +58 -0
  50. package/dist/crm/schema.d.ts.map +1 -0
  51. package/dist/crm/schema.js +175 -0
  52. package/dist/crm/schema.js.map +1 -0
  53. package/dist/crm/studio/Sequences.d.ts +4 -0
  54. package/dist/crm/studio/Sequences.d.ts.map +1 -0
  55. package/dist/crm/studio/Sequences.js +114 -0
  56. package/dist/crm/studio/Sequences.js.map +1 -0
  57. package/dist/crm/studio/logic.d.ts +32 -0
  58. package/dist/crm/studio/logic.d.ts.map +1 -0
  59. package/dist/crm/studio/logic.js +59 -0
  60. package/dist/crm/studio/logic.js.map +1 -0
  61. package/dist/crm/studio/style.d.ts +8 -0
  62. package/dist/crm/studio/style.d.ts.map +1 -0
  63. package/dist/crm/studio/style.js +21 -0
  64. package/dist/crm/studio/style.js.map +1 -0
  65. package/dist/crm/suppression.d.ts +11 -0
  66. package/dist/crm/suppression.d.ts.map +1 -0
  67. package/dist/crm/suppression.js +20 -0
  68. package/dist/crm/suppression.js.map +1 -0
  69. package/dist/index.d.ts +12 -0
  70. package/dist/index.d.ts.map +1 -0
  71. package/dist/index.js +19 -0
  72. package/dist/index.js.map +1 -0
  73. package/dist/lib/base-data/api.d.ts +48 -0
  74. package/dist/lib/base-data/api.d.ts.map +1 -0
  75. package/dist/lib/base-data/api.js +2 -0
  76. package/dist/lib/base-data/api.js.map +1 -0
  77. package/dist/lib/base-data/client.d.ts +29 -0
  78. package/dist/lib/base-data/client.d.ts.map +1 -0
  79. package/dist/lib/base-data/client.js +76 -0
  80. package/dist/lib/base-data/client.js.map +1 -0
  81. package/dist/lib/base-data/fields.d.ts +103 -0
  82. package/dist/lib/base-data/fields.d.ts.map +1 -0
  83. package/dist/lib/base-data/fields.js +251 -0
  84. package/dist/lib/base-data/fields.js.map +1 -0
  85. package/dist/lib/base-data/html.d.ts +20 -0
  86. package/dist/lib/base-data/html.d.ts.map +1 -0
  87. package/dist/lib/base-data/html.js +49 -0
  88. package/dist/lib/base-data/html.js.map +1 -0
  89. package/dist/lib/base-data/query.d.ts +50 -0
  90. package/dist/lib/base-data/query.d.ts.map +1 -0
  91. package/dist/lib/base-data/query.js +220 -0
  92. package/dist/lib/base-data/query.js.map +1 -0
  93. package/dist/lib/crm.d.ts +374 -0
  94. package/dist/lib/crm.d.ts.map +1 -0
  95. package/dist/lib/crm.js +337 -0
  96. package/dist/lib/crm.js.map +1 -0
  97. package/dist/lib/host.d.ts +117 -0
  98. package/dist/lib/host.d.ts.map +1 -0
  99. package/dist/lib/host.js +43 -0
  100. package/dist/lib/host.js.map +1 -0
  101. package/dist/lib/live.d.ts +5 -0
  102. package/dist/lib/live.d.ts.map +1 -0
  103. package/dist/lib/live.js +63 -0
  104. package/dist/lib/live.js.map +1 -0
  105. package/dist/nav.d.ts +7 -0
  106. package/dist/nav.d.ts.map +1 -0
  107. package/dist/nav.js +18 -0
  108. package/dist/nav.js.map +1 -0
  109. package/package.json +58 -3
@@ -0,0 +1 @@
1
+ {"version":3,"file":"query.js","sourceRoot":"","sources":["../../../src/lib/base-data/query.ts"],"names":[],"mappings":"AA+BA,kDAAkD;AAClD,MAAM,UAAU,GAAG,CAAC,CAAU;IAC5B,OAAO,IAAI,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAA;AAC3E,CAAC;AAED,MAAM,GAAG,GAAG,CAAC,CAAU,EAAiB,EAAE;IACxC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE;QAAE,OAAO,IAAI,CAAA;IACtC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,QAAQ,IAAK,CAAY;QAAE,OAAO,GAAG,CAAE,CAAyB,CAAC,MAAM,CAAC,CAAA;IAC1H,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;IACnB,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;AACtC,CAAC,CAAA;AAED,wEAAwE;AACxE,MAAM,UAAU,KAAK,CAAC,CAAU;IAC9B,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE;QAAE,OAAO,EAAE,CAAA;IACpC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;IAC1B,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;IACzC,IAAI,CAAC;QAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAA;IAClB,MAAM,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAA;IACrB,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;AACtE,CAAC;AAED,MAAM,KAAK,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,GAAG,gBAAgB,CAAC,CAAA;AAC1D,MAAM,GAAG,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,GAAG,gBAAgB,CAAC,CAAA;AAExD;;;;GAIG;AACH,MAAM,UAAU,GAA6B;IAC3C,QAAQ,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC;IACnC,MAAM,EAAE,CAAC,cAAc,EAAE,kBAAkB,CAAC;IAC5C,MAAM,EAAE,CAAC,oBAAoB,EAAE,kBAAkB,CAAC;IAClD,KAAK,EAAE,CAAC,gBAAgB,EAAE,kBAAkB,CAAC;IAC7C,OAAO,EAAE,CAAC,gBAAgB,EAAE,aAAa,EAAE,cAAc,EAAE,iBAAiB,EAAE,gBAAgB,CAAC;CAChG,CAAA;AACD,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAA;AAEvD,yFAAyF;AACzF,SAAS,QAAQ,CAAC,KAAgB,EAAE,CAAS,EAAE,MAAM,GAAG,KAAK;IAC3D,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IACpC,IAAI,CAAC,KAAK;QAAE,OAAO,GAAG,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;IACnH,mGAAmG;IACnG,OAAO,MAAM;QACX,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,IAAI,IAAI,CAAC,cAAc,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACzF,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AAC5D,CAAC;AAED,2FAA2F;AAC3F,MAAM,OAAO,GAA2B,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,oBAAoB,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAA;AAEzH,iFAAiF;AACjF,MAAM,KAAK,GAAG,MAAM,CAAA;AAEpB,MAAM,GAAG,GAAG,CAAC,EAAY,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;AAChF,MAAM,EAAE,GAAG,CAAC,EAAY,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;AAE/E,MAAM,GAAG,GAAG,CAAC,CAAU,EAAY,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAE,CAAuC,CAAC,EAAE,IAAK,CAAyB,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;AAEpQ,MAAM,KAAK,GAAG,CAAC,CAAU,EAAsB,EAAE;IAC/C,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IACtC,MAAM,IAAI,GAAG,CAAC,CAAU,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACpE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AACvC,CAAC,CAAA;AAED,kFAAkF;AAClF,MAAM,UAAU,UAAU,CAAC,KAAgB,EAAE,IAAgB;IAC3D,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,CAAA;IACpB,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,CAAA;IAClB,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,CAAA;IAEpB,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,YAAY,EAAE,CAAC;QAC5C,MAAM,KAAK,GAAG,EAAE,KAAK,SAAS,CAAA;QAC9B,IAAI,CAAC,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAA;QAC3D,IAAI,CAAC,KAAK,UAAU;YAAE,OAAO,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC,CAAC,GAAG,CAAC,uBAAuB,CAAA;QAC7F,IAAI,CAAC,KAAK,MAAM;YAAE,OAAO,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAA;QAC/D,IAAI,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1B,8EAA8E;YAC9E,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;YACvB,IAAI,CAAC,IAAI;gBAAE,OAAO,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,OAAO,CAAA;YACnD,OAAO,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,IAAI,QAAQ,CAAC,CAAC,CAAA;QACvG,CAAC;QACD,OAAO,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAA;IACxC,CAAC;IAED,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,UAAU,EAAE,CAAC;QACvC,MAAM,IAAI,GAAG,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAA;QACvD,MAAM,KAAK,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAC/E,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;YACrB,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YAC3C,MAAM,KAAK,GAAG,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;YACxH,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;QACvC,CAAC;QACD,MAAM,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACzB,IAAI,CAAC,IAAI,IAAI;YAAE,OAAO,EAAE,CAAA;QACxB,MAAM,GAAG,GAA8C,EAAE,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,CAAA;QACvH,OAAO,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;IACxD,CAAC;IAED,IAAI,CAAC,KAAK,MAAM,IAAI,CAAC,KAAK,UAAU,EAAE,CAAC;QACrC,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;YACrB,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;YAC7C,MAAM,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;YAC1G,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;QACnC,CAAC;QACD,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC7B,IAAI,CAAC,GAAG;YAAE,OAAO,EAAE,CAAA;QACnB,QAAQ,EAAE,EAAE,CAAC;YACX,KAAK,IAAI,EAAE,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,OAAO,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,OAAO,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;YACvE,KAAK,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;YACvE,KAAK,IAAI,EAAE,OAAO,GAAG,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,EAAE,CAAA;YACtC,KAAK,KAAK,EAAE,OAAO,GAAG,CAAC,OAAO,KAAK,CAAC,GAAG,CAAC,EAAE,CAAA;YAC1C,6FAA6F;YAC7F,KAAK,IAAI,EAAE,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;YAC7D,KAAK,KAAK,EAAE,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,OAAO,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;YAC7D,SAAS,OAAO,EAAE,CAAA;QACpB,CAAC;IACH,CAAC;IAED,IAAI,CAAC,KAAK,MAAM,EAAE,CAAC;QACjB,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,EAAE;YAAE,OAAO,EAAE,CAAA;QACtD,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,KAAK,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,MAAM,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC,CAAA;QAC3E,OAAO,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,CAAA;IAC1D,CAAC;IAED,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,UAAU,EAAE,CAAC;QACvC,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,SAAS,IAAI,CAAC,CAAC,GAAG,CAAC,CAAA;QACxC,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC9B,IAAI,CAAC,MAAM,CAAC,MAAM;YAAE,OAAO,EAAE,CAAA;QAC7B,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAA;QAC7B,IAAI,EAAE,KAAK,SAAS;YAAE,OAAO,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAC1E,IAAI,EAAE,KAAK,IAAI;YAAE,OAAO,GAAG,CAAC,IAAI,EAAE,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;QACtD,IAAI,EAAE,KAAK,OAAO;YAAE,OAAO,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;QAC5F,wDAAwD;QACxD,IAAI,CAAC,KAAK,UAAU,IAAI,EAAE,KAAK,UAAU;YAAE,OAAO,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACjH,IAAI,CAAC,KAAK,UAAU,IAAI,EAAE,KAAK,aAAa;YAAE,OAAO,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACtH,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAA;IAClH,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAA;IACpB,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IACvB,MAAM,KAAK,GAAG,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;IACzE,QAAQ,EAAE,EAAE,CAAC;QACX,KAAK,UAAU,EAAE,OAAO,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;QAC7C,KAAK,aAAa,EAAE,OAAO,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QACtD,kGAAkG;QAClG,KAAK,IAAI,EAAE,OAAO,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE,CAAA;QAC9J,KAAK,OAAO,EAAE,OAAO,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,OAAO,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,CAAC,KAAK,CAAC,EAAE,CAAA;QACzK,SAAS,OAAO,EAAE,CAAA;IACpB,CAAC;AACH,CAAC;AAED,2CAA2C;AAC3C,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,CAAA;AAEtG;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,KAAgB;IAC5C,IAAI,2BAA2B,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;QAAE,OAAO,CAAC,GAAG,KAAK,CAAC,IAAI,iBAAiB,EAAE,GAAG,KAAK,CAAC,IAAI,gBAAgB,CAAC,CAAA;IACxH,OAAO,CAAC,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,EAAE,CAAC,CAAA;AACnC,CAAC;AAED,mGAAmG;AACnG,MAAM,UAAU,YAAY,CAAC,MAA4B,EAAE,MAA0B;IACnF,MAAM,CAAC,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAA;IAC/B,IAAI,CAAC,CAAC;QAAE,OAAO,EAAE,CAAA;IACjB,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAChG,MAAM,OAAO,GAAG,MAAM;SACnB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,IAAI,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,4BAA4B,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SACzH,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAClE,MAAM,GAAG,GAAG,CAAC,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC,CAAA;IAClC,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;AAClC,CAAC;AAED,kFAAkF;AAClF,MAAM,SAAS,GAA2B;IACxC,QAAQ,EAAE,WAAW;IACrB,MAAM,EAAE,cAAc;IACtB,MAAM,EAAE,oBAAoB;IAC5B,KAAK,EAAE,gBAAgB;IACvB,OAAO,EAAE,aAAa;IACtB,QAAQ,EAAE,cAAc;IACxB,KAAK,EAAE,MAAM;CACd,CAAA;AAED,MAAM,UAAU,MAAM,CAAC,MAA4B,EAAE,KAAiB;IACpE,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;IACtD,OAAO,KAAK;SACT,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACT,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;QAC7B,IAAI,CAAC,CAAC;YAAE,OAAO,EAAE,CAAA;QACjB,MAAM,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QACxH,OAAO,GAAG,CAAC,CAAC,GAAG,KAAK,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,CAAA;IAChD,CAAC,CAAC;SACD,MAAM,CAAC,OAAO,CAAC;SACf,IAAI,CAAC,GAAG,CAAC,CAAA;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,MAA4B,EAAE,IAAe,EAAE,KAAc;IACrF,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;IACtD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO;SACvB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACT,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;QAC7B,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAClC,CAAC,CAAC;SACD,MAAM,CAAC,OAAO,CAAC,CAAA;IAClB,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAClF,MAAM,KAAK,GAAG,CAAC,KAAK,IAAI,EAAE,EAAE,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IACvF,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAA;AACrF,CAAC"}
@@ -0,0 +1,374 @@
1
+ /**
2
+ * CRM API — the org's records, the mail the cloud files on them, and the drip.
3
+ *
4
+ * The CRM is not its own service. Its records are collections of the org's Base
5
+ * (hanzoai/base module `crm`, installed when the org is given the beta), served by
6
+ * Base's own record routes under /v1/base, which authorise every read and write by
7
+ * the caller's IAM role in the org, and which search, filter, sort and page on the
8
+ * server:
9
+ *
10
+ * GET /v1/base/collections/:name a collection's fields, labels and options
11
+ * GET /v1/base/collections/:name/records one page, by Base filter and sort
12
+ * GET, POST, PATCH, DELETE …/records[/:id] one record
13
+ * POST /v1/base/modules/crm grow the org's CRM to the module this cloud ships
14
+ *
15
+ * Mail and outreach are the cloud's: every message the org sends (POST /v1/email,
16
+ * POST /v1/marketing/mail, a sequence's step) is filed on the recipient's record as
17
+ * an `email` activity (cloud apps/crm FileMail) and refused for an address on the
18
+ * org's suppression list. Sequences are cloud apps/marketing's drip: a sequence's
19
+ * steps, made active, and the addresses enrolled in it.
20
+ *
21
+ * Whether the org has the CRM at all is its `crm` enablement, the beta (`beta`);
22
+ * an org without the module answers 404 for every collection here.
23
+ */
24
+ import type { BaseListResult, BaseRecord, ListRecordsParams } from './base-data/api.js';
25
+ import type { BaseCollection } from './base-data/fields.js';
26
+ import { paragraphs, plain } from './base-data/html.js';
27
+ /**
28
+ * A time as epoch seconds. Base writes a date as "2026-10-18 21:30:00.000Z" (UTC), and
29
+ * a calendar string without a zone is read as UTC too, never in the browser's zone.
30
+ */
31
+ export declare const time: (v: unknown) => number;
32
+ /** A time as Base stores a date: "2026-10-30 14:05:00.000Z". */
33
+ export declare const stamp: (d?: Date) => string;
34
+ export { paragraphs, plain };
35
+ /** A filed mail's state, as the cloud writes it in `data.status`. */
36
+ export type MailStatus = 'sent' | 'suppressed' | 'failed' | 'delivered' | 'opened' | 'clicked' | 'bounced' | 'complained';
37
+ /** Whether a status means the mail reached the inbox. */
38
+ export declare const reached: (s: MailStatus) => boolean;
39
+ export type EmailMessageRecord = {
40
+ id: string;
41
+ org?: string;
42
+ status: 'queued' | 'sent' | 'delivered' | 'failed';
43
+ from?: string;
44
+ to: string[];
45
+ subject?: string;
46
+ text?: string;
47
+ html?: string;
48
+ provider?: string;
49
+ created_at: string;
50
+ error?: string;
51
+ /** The rail's own id for the message (SES MessageId, SendGrid X-Message-Id). */
52
+ provider_id?: string;
53
+ };
54
+ /** One recipient POST /v1/email would not send to, and why (suppressed, invalid…). */
55
+ export type EmailRefusal = {
56
+ address: string;
57
+ status: number;
58
+ reason: string;
59
+ };
60
+ /** POST /v1/email's answer: one message per recipient it sent to, and each it refused. */
61
+ export type EmailSend = {
62
+ messages: EmailMessageRecord[];
63
+ refused: EmailRefusal[];
64
+ };
65
+ /** The refusals as the route answers them; anything malformed is dropped. */
66
+ export declare function refusalsOf(raw: unknown): EmailRefusal[];
67
+ export type SendEmailInput = {
68
+ from?: string;
69
+ to: string[];
70
+ subject: string;
71
+ text?: string;
72
+ html?: string;
73
+ provider?: string;
74
+ headers?: Record<string, string>;
75
+ };
76
+ /**
77
+ * An address as POST /v1/email/verify judged it. `unverified` is the verifier not
78
+ * answering (signed out, limited, unreachable): it is never read as a pass.
79
+ */
80
+ export type Verification = {
81
+ email: string;
82
+ status: 'verified' | 'invalid' | 'disposable' | 'unverified';
83
+ /** Every check asked for passed. */
84
+ valid: boolean;
85
+ reachable: 'yes' | 'no' | 'unknown';
86
+ /** The first check that did not pass, or why nothing was checked. */
87
+ reason: string;
88
+ domain?: string;
89
+ hasMx: boolean;
90
+ disposable: boolean;
91
+ role: boolean;
92
+ free: boolean;
93
+ suggestion?: string;
94
+ };
95
+ /** POST /v1/email/verify's answer (cloud apps/email types.go). */
96
+ type CheckWire = {
97
+ status: 'pass' | 'fail' | 'unknown' | 'skipped';
98
+ reason?: string;
99
+ };
100
+ export type VerifyWire = {
101
+ email: string;
102
+ checks?: {
103
+ syntax?: CheckWire & {
104
+ username?: string;
105
+ domain?: string;
106
+ };
107
+ domain?: CheckWire;
108
+ mx?: CheckWire & {
109
+ records?: string[];
110
+ };
111
+ classification?: CheckWire & {
112
+ disposable?: boolean;
113
+ free?: boolean;
114
+ role?: boolean;
115
+ };
116
+ smtp?: CheckWire & {
117
+ deliverable?: boolean;
118
+ catch_all?: boolean;
119
+ };
120
+ };
121
+ suggestions?: {
122
+ email: string;
123
+ reason: string;
124
+ }[];
125
+ };
126
+ /** The answer read: the first failing check decides; a check that could not run leaves the address unverified. */
127
+ export declare function judge(email: string, w: VerifyWire): Verification;
128
+ /** Whose timeline: a record by the relation an activity names it by, or a person not yet a record by their address. */
129
+ export type Whose = {
130
+ person?: string;
131
+ company?: string;
132
+ opportunity?: string;
133
+ candidate?: string;
134
+ email?: string;
135
+ };
136
+ /**
137
+ * The activities filter for a timeline. A candidate's is read by its own relation:
138
+ * asked by none of these, it read the mail filed to an empty address, which is
139
+ * nothing, so a logged call or meeting, and the application itself, never showed
140
+ * (hanzo-inc/cloud#478).
141
+ */
142
+ export declare function timelineFilter(who: Whose): string;
143
+ /** One entry of a record's timeline: an activity the cloud or the team filed, newest first. */
144
+ export type TimelineEvent = {
145
+ id: string;
146
+ /** email, form, note, call, meeting… */
147
+ kind: string;
148
+ /** out for a mail the org sent, in for one it received. */
149
+ direction: string;
150
+ subject: string;
151
+ snippet: string;
152
+ /** The activity's own text, as plain text. */
153
+ body: string;
154
+ /** Unix seconds. */
155
+ at: number;
156
+ to: string;
157
+ by: string;
158
+ /** sent until a report arrives; suppressed or failed when it never left. */
159
+ status: MailStatus;
160
+ /** The rail it left by (ses, sendgrid, mail…). */
161
+ rail: string;
162
+ /** Why it was suppressed, failed or bounced. */
163
+ reason: string;
164
+ /** Every report in order: delivered, opened, clicked, bounced… */
165
+ events: {
166
+ status: MailStatus;
167
+ at: number;
168
+ }[];
169
+ /** A form's answers as filed, question by question. */
170
+ answers: {
171
+ question: string;
172
+ answer: string;
173
+ }[];
174
+ };
175
+ export declare function normalizeTimelineEvent(raw: unknown): TimelineEvent;
176
+ /**
177
+ * A drip sequence as cloud apps/marketing keeps it. An audience send is a one-step
178
+ * sequence the audience is enrolled into — the drip engine, the suppression gate and
179
+ * the signed unsubscribe footer are the delivery; there is no separate blast.
180
+ */
181
+ export type Sequence = {
182
+ id: string;
183
+ name: string;
184
+ status: 'draft' | 'active' | 'archived';
185
+ createdAt: number;
186
+ updatedAt: number;
187
+ };
188
+ /** One message of a sequence: `delaySeconds` after the previous step (after enrollment for the first). */
189
+ export type SequenceStep = {
190
+ id: string;
191
+ sequenceId: string;
192
+ idx: number;
193
+ delaySeconds: number;
194
+ subject: string;
195
+ body: string;
196
+ createdAt: number;
197
+ };
198
+ /** One person walking a sequence: `active` until its last step is due and taken, then `completed`; or `canceled`. */
199
+ export type Enrollment = {
200
+ id: string;
201
+ sequenceId: string;
202
+ address: string;
203
+ channel: string;
204
+ currentStep: number;
205
+ status: 'active' | 'completed' | 'canceled';
206
+ /** Unix seconds the current step comes due; 0 once the walk is done. */
207
+ nextRunAt: number;
208
+ enrolledAt: number;
209
+ updatedAt: number;
210
+ };
211
+ /** A saved cohort: no `event` is every mailable customer in the org. */
212
+ export type Audience = {
213
+ id: string;
214
+ name: string;
215
+ event: string;
216
+ windowDays: number;
217
+ createdAt: number;
218
+ updatedAt: number;
219
+ };
220
+ /** An enroll's fan-out: how many the request named, started now, and had already taken. */
221
+ export type EnrollResult = {
222
+ resolved: number;
223
+ enrolled: number;
224
+ alreadyEnrolled: number;
225
+ enrollmentId?: string;
226
+ };
227
+ /** One opt-out as the cloud keeps it (apps/marketing suppress.go): (channel, address) is the key, per org. */
228
+ export type MarketingSuppression = {
229
+ channel: string;
230
+ address: string;
231
+ /** Free text; the one-click footer link records "one-click unsubscribe". */
232
+ reason: string;
233
+ /** Unix seconds. */
234
+ createdAt: number;
235
+ };
236
+ /**
237
+ * Whether the org's send gate refuses one address
238
+ * (GET /v1/marketing/suppressions/check?address=). `scope` says which list refused
239
+ * it: the address itself, its company domain, or the platform's blocklist. A cloud
240
+ * without the check answers 404, and that is `unknown` — never "not suppressed".
241
+ */
242
+ export type SuppressionCheck = {
243
+ state: 'suppressed';
244
+ reason?: string;
245
+ scope?: 'address' | 'domain' | 'platform';
246
+ } | {
247
+ state: 'clear';
248
+ } | {
249
+ state: 'unknown';
250
+ why: string;
251
+ };
252
+ export declare const CrmApi: {
253
+ /** Whether a resume is a file uploaded to the org's storage (`/v1/s3/buckets/…`). */
254
+ isUpload: (u: string) => boolean;
255
+ /** The signed download of an uploaded file: the org's own, for a member alone. */
256
+ download: (u: string) => Promise<string>;
257
+ /**
258
+ * Whether `org` has the CRM: its `crm` enablement, the beta. Any member reads its
259
+ * own org's.
260
+ */
261
+ beta: (org: string) => Promise<boolean>;
262
+ /**
263
+ * A collection's fields, labels and options. Held for the page, and kept in the
264
+ * browser between visits so a table's first page is asked for at once: the kept
265
+ * schema answers now and the server's replaces it for the next read. `fresh` asks
266
+ * the server and waits.
267
+ */
268
+ schema: (collection: string, fresh?: boolean) => Promise<BaseCollection>;
269
+ /**
270
+ * Grow the org's CRM to the module this cloud ships (POST /v1/base/modules/crm):
271
+ * what is missing is added, and nothing the org has is changed. Org admins only;
272
+ * the schemas read before it are read again after.
273
+ */
274
+ grow: () => Promise<{
275
+ grew: boolean;
276
+ }>;
277
+ /** One page of records, searched, filtered and sorted by Base. */
278
+ list: (collection: string, q: ListRecordsParams) => Promise<BaseListResult<BaseRecord>>;
279
+ /** Every record a query admits, page by page, up to `max`, for an export or a bulk action. */
280
+ each: (collection: string, q: Omit<ListRecordsParams, 'page' | 'perPage'>, max: number, onPage?: (done: number, total: number) => void) => Promise<BaseRecord[]>;
281
+ get: (collection: string, id: string, expand?: string) => Promise<BaseRecord>;
282
+ create: (collection: string, body: Record<string, unknown>) => Promise<BaseRecord>;
283
+ update: (collection: string, id: string, body: Record<string, unknown>) => Promise<BaseRecord>;
284
+ remove: (collection: string, id: string) => Promise<void>;
285
+ /**
286
+ * A record's timeline: every activity filed on it, newest first. A person with no
287
+ * record yet is read by the mail filed to their address.
288
+ */
289
+ timeline: (who: Whose) => Promise<TimelineEvent[]>;
290
+ email: {
291
+ /** One address through POST /v1/email/verify, signed in. `smtp` also asks the mail host. */
292
+ verify: (email: string, opts?: {
293
+ smtp?: boolean;
294
+ }) => Promise<Verification>;
295
+ /**
296
+ * An address's domain and whether it is free mail, by the verifier's own list
297
+ * (POST /v1/email/verify, syntax + classification: no DNS, no mailbox probe).
298
+ * Null when it cannot say.
299
+ */
300
+ classify: (email: string) => Promise<{
301
+ domain: string;
302
+ free: boolean;
303
+ } | null>;
304
+ /**
305
+ * One message through POST /v1/email. The cloud files it on the recipient's CRM
306
+ * record and refuses a suppressed address or company; a refusal or a failure is
307
+ * thrown, never recorded here as sent.
308
+ */
309
+ sendMessage: (input: SendEmailInput) => Promise<EmailSend>;
310
+ /**
311
+ * One email to one person from their record (POST /v1/marketing/mail): the org's
312
+ * own mailbox when it has one, else notify, never to an address that opted out,
313
+ * filed on the person's timeline. Org admins and SuperAdmins send.
314
+ */
315
+ sendCrmMail: (input: {
316
+ to: string;
317
+ subject: string;
318
+ body: string;
319
+ person?: string;
320
+ }) => Promise<{
321
+ sent: boolean;
322
+ at: string;
323
+ }>;
324
+ };
325
+ marketing: {
326
+ /** The org's sequences, most recently updated first. */
327
+ listSequences: () => Promise<Sequence[]>;
328
+ /** One sequence and its steps in send order. */
329
+ getSequence: (id: string) => Promise<{
330
+ sequence: Sequence;
331
+ steps: SequenceStep[];
332
+ }>;
333
+ /** A new sequence, as a draft: nothing sends until it is made active and someone is enrolled. */
334
+ createSequence: (name: string) => Promise<Sequence>;
335
+ /** Append a message: `delaySeconds` after the previous step, or after enrollment for the first. */
336
+ addStep: (id: string, step: {
337
+ delaySeconds: number;
338
+ subject: string;
339
+ body: string;
340
+ }) => Promise<SequenceStep>;
341
+ /** draft, active or archived; only an active sequence takes enrollments. */
342
+ setSequenceStatus: (id: string, status: Sequence['status']) => Promise<{
343
+ id: string;
344
+ status: string;
345
+ }>;
346
+ /** Enroll one address or a saved audience; the sequence must be active. */
347
+ enroll: (id: string, who: {
348
+ address: string;
349
+ } | {
350
+ audienceId: string;
351
+ }) => Promise<EnrollResult>;
352
+ /** Everyone walking a sequence, in any state, most recently enrolled first. */
353
+ listEnrollments: (id: string) => Promise<Enrollment[]>;
354
+ /** Stop one person's walk; a completed or canceled one reads as not found. */
355
+ cancelEnrollment: (id: string, eid: string) => Promise<unknown>;
356
+ /** The org's saved audiences. */
357
+ listAudiences: () => Promise<Audience[]>;
358
+ /** Every address the org's send gate refuses, newest first (GET /v1/marketing/suppressions). */
359
+ listSuppressions: () => Promise<MarketingSuppression[]>;
360
+ /** Opt one address out of email for the org. The cloud refuses a member who is not an org admin; that is thrown. */
361
+ addSuppression: (address: string, reason: string) => Promise<MarketingSuppression>;
362
+ /** One address against the send gate; any failure to answer is `unknown`, with why. */
363
+ checkSuppression: (address: string) => Promise<SuppressionCheck>;
364
+ /**
365
+ * Re-subscribe one entry on email: an address, or a company as "@example.com"
366
+ * (DELETE /v1/marketing/suppressions?address=&channel=, 204; 404 when it was not
367
+ * on the list). Org admin or SuperAdmin; the cloud refuses anyone else.
368
+ */
369
+ removeSuppression: (entry: string) => Promise<void>;
370
+ /** Opt a whole company out of email: the "@domain" entry every address at it answers to. */
371
+ suppressCompany: (domain: string, reason: string) => Promise<MarketingSuppression>;
372
+ };
373
+ };
374
+ //# sourceMappingURL=crm.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"crm.d.ts","sourceRoot":"","sources":["../../src/lib/crm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,OAAO,KAAK,EAAc,cAAc,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AAChG,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACxD,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AAkBpD;;;GAGG;AACH,eAAO,MAAM,IAAI,MAAO,OAAO,KAAG,MAOjC,CAAA;AAED,gEAAgE;AAChE,eAAO,MAAM,KAAK,OAAO,IAAI,KAAgB,MAA2C,CAAA;AAGxF,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,CAAA;AAI5B,qEAAqE;AACrE,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,YAAY,GAAG,QAAQ,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,YAAY,CAAA;AAIzH,yDAAyD;AACzD,eAAO,MAAM,OAAO,MAAO,UAAU,KAAG,OAAiE,CAAA;AAEzG,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,CAAA;IAClD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,EAAE,EAAE,MAAM,EAAE,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,gFAAgF;IAChF,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,sFAAsF;AACtF,MAAM,MAAM,YAAY,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AAE9E,0FAA0F;AAC1F,MAAM,MAAM,SAAS,GAAG;IAAE,QAAQ,EAAE,kBAAkB,EAAE,CAAC;IAAC,OAAO,EAAE,YAAY,EAAE,CAAA;CAAE,CAAA;AAEnF,6EAA6E;AAC7E,wBAAgB,UAAU,CAAC,GAAG,EAAE,OAAO,GAAG,YAAY,EAAE,CAOvD;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,EAAE,EAAE,MAAM,EAAE,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACjC,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,UAAU,GAAG,SAAS,GAAG,YAAY,GAAG,YAAY,CAAA;IAC5D,oCAAoC;IACpC,KAAK,EAAE,OAAO,CAAA;IACd,SAAS,EAAE,KAAK,GAAG,IAAI,GAAG,SAAS,CAAA;IACnC,qEAAqE;IACrE,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,OAAO,CAAA;IACd,UAAU,EAAE,OAAO,CAAA;IACnB,IAAI,EAAE,OAAO,CAAA;IACb,IAAI,EAAE,OAAO,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,kEAAkE;AAClE,KAAK,SAAS,GAAG;IAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA;AACrF,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE;QACP,MAAM,CAAC,EAAE,SAAS,GAAG;YAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;YAAC,MAAM,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;QAC3D,MAAM,CAAC,EAAE,SAAS,CAAA;QAClB,EAAE,CAAC,EAAE,SAAS,GAAG;YAAE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;SAAE,CAAA;QACvC,cAAc,CAAC,EAAE,SAAS,GAAG;YAAE,UAAU,CAAC,EAAE,OAAO,CAAC;YAAC,IAAI,CAAC,EAAE,OAAO,CAAC;YAAC,IAAI,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;QACrF,IAAI,CAAC,EAAE,SAAS,GAAG;YAAE,WAAW,CAAC,EAAE,OAAO,CAAC;YAAC,SAAS,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;KAClE,CAAA;IACD,WAAW,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAClD,CAAA;AAMD,kHAAkH;AAClH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,UAAU,GAAG,YAAY,CAoBhE;AAID,uHAAuH;AACvH,MAAM,MAAM,KAAK,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA;AAEnH;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,KAAK,GAAG,MAAM,CAOjD;AAED,+FAA+F;AAC/F,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,EAAE,MAAM,CAAA;IACV,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAA;IACZ,2DAA2D;IAC3D,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAA;IACZ,oBAAoB;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,EAAE,EAAE,MAAM,CAAA;IACV,EAAE,EAAE,MAAM,CAAA;IACV,4EAA4E;IAC5E,MAAM,EAAE,UAAU,CAAA;IAClB,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAA;IACZ,gDAAgD;IAChD,MAAM,EAAE,MAAM,CAAA;IACd,kEAAkE;IAClE,MAAM,EAAE;QAAE,MAAM,EAAE,UAAU,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAC5C,uDAAuD;IACvD,OAAO,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAChD,CAAA;AASD,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,OAAO,GAAG,aAAa,CAyBlE;AAID;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAA;AAElI,0GAA0G;AAC1G,MAAM,MAAM,YAAY,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAA;AAElJ,qHAAqH;AACrH,MAAM,MAAM,UAAU,GAAG;IACvB,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,QAAQ,GAAG,WAAW,GAAG,UAAU,CAAA;IAC3C,wEAAwE;IACxE,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,wEAAwE;AACxE,MAAM,MAAM,QAAQ,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAA;AAE5H,2FAA2F;AAC3F,MAAM,MAAM,YAAY,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA;AAQjH,8GAA8G;AAC9G,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,4EAA4E;IAC5E,MAAM,EAAE,MAAM,CAAA;IACd,oBAAoB;IACpB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GACxB;IAAE,KAAK,EAAE,YAAY,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,UAAU,CAAA;CAAE,GACnF;IAAE,KAAK,EAAE,OAAO,CAAA;CAAE,GAClB;IAAE,KAAK,EAAE,SAAS,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAA;AASrC,eAAO,MAAM,MAAM;IACjB,qFAAqF;IACrF,QAAQ,MAAM,MAAM,KAAG,OAAO;IAC9B,kFAAkF;IAClF,QAAQ,MAAM,MAAM,KAAG,OAAO,CAAC,MAAM,CAAC;IAEtC;;;OAGG;IACH,IAAI,QAAQ,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;IAKrC;;;;;OAKG;IACH,MAAM,eAAe,MAAM,sBAAkB,OAAO,CAAC,cAAc,CAAC;IA8BpE;;;;OAIG;IACH,IAAI,QAAY,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,CAAA;KAAE,CAAC;IAQ1C,kEAAkE;IAClE,IAAI,eAAe,MAAM,KAAK,iBAAiB,KAAG,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAErF,8FAA8F;IAC9F,IAAI,eAAqB,MAAM,KAAK,IAAI,CAAC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC,OAAO,MAAM,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,KAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAWpK,GAAG,eAAe,MAAM,MAAM,MAAM,WAAW,MAAM,KAAG,OAAO,CAAC,UAAU,CAAC;IAK3E,MAAM,eAAe,MAAM,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAG,OAAO,CAAC,UAAU,CAAC;IAChF,MAAM,eAAe,MAAM,MAAM,MAAM,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAG,OAAO,CAAC,UAAU,CAAC;IAC5F,MAAM,eAAe,MAAM,MAAM,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;IAEvD;;;OAGG;IACH,QAAQ,QAAQ,KAAK,KAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAMhD,KAAK;QACH,4FAA4F;QAC5F,MAAM,UAAgB,MAAM,SAAS;YAAE,IAAI,CAAC,EAAE,OAAO,CAAA;SAAE,KAAG,OAAO,CAAC,YAAY,CAAC;QAU/E;;;;WAIG;QACH,QAAQ,UAAgB,MAAM,KAAG,OAAO,CAAC;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAWlF;;;;WAIG;QACH,WAAW,UAAgB,cAAc,KAAG,OAAO,CAAC,SAAS,CAAC;QAY9D;;;;WAIG;QACH,WAAW,UAAgB;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAC;YAAC,MAAM,CAAC,EAAE,MAAM,CAAA;SAAE,KAAG,OAAO,CAAC;YAAE,IAAI,EAAE,OAAO,CAAC;YAAC,EAAE,EAAE,MAAM,CAAA;SAAE,CAAC;;IAMpI,SAAS;QACP,wDAAwD;QACxD,aAAa,QAAY,OAAO,CAAC,QAAQ,EAAE,CAAC;QAE5C,gDAAgD;QAChD,WAAW,OAAa,MAAM,KAAG,OAAO,CAAC;YAAE,QAAQ,EAAE,QAAQ,CAAC;YAAC,KAAK,EAAE,YAAY,EAAE,CAAA;SAAE,CAAC;QAKvF,iGAAiG;QACjG,cAAc,SAAS,MAAM,KAAG,OAAO,CAAC,QAAQ,CAAC;QAEjD,mGAAmG;QACnG,OAAO,OAAO,MAAM,QAAQ;YAAE,YAAY,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,KAAG,OAAO,CAAC,YAAY,CAAC;QAG3G,4EAA4E;QAC5E,iBAAiB,OAAO,MAAM,UAAU,QAAQ,CAAC,QAAQ,CAAC,KAAG,OAAO,CAAC;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAC;QAGpG,2EAA2E;QAC3E,MAAM,OAAO,MAAM,OAAO;YAAE,OAAO,EAAE,MAAM,CAAA;SAAE,GAAG;YAAE,UAAU,EAAE,MAAM,CAAA;SAAE,KAAG,OAAO,CAAC,YAAY,CAAC;QAG9F,+EAA+E;QAC/E,eAAe,OAAa,MAAM,KAAG,OAAO,CAAC,UAAU,EAAE,CAAC;QAG1D,8EAA8E;QAC9E,gBAAgB,OAAO,MAAM,OAAO,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;QAG7D,iCAAiC;QACjC,aAAa,QAAY,OAAO,CAAC,QAAQ,EAAE,CAAC;QAE5C,gGAAgG;QAChG,gBAAgB,QAAY,OAAO,CAAC,oBAAoB,EAAE,CAAC;QAK3D,oHAAoH;QACpH,cAAc,YAAY,MAAM,UAAU,MAAM,KAAG,OAAO,CAAC,oBAAoB,CAAC;QAGhF,uFAAuF;QACvF,gBAAgB,YAAkB,MAAM,KAAG,OAAO,CAAC,gBAAgB,CAAC;QAcpE;;;;WAIG;QACH,iBAAiB,UAAU,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;QAGjD,4FAA4F;QAC5F,eAAe,WAAW,MAAM,UAAU,MAAM,KAAG,OAAO,CAAC,oBAAoB,CAAC;;CAGnF,CAAA"}