@friggframework/core 2.0.0--canary.703.12b980b.0 → 2.0.0--canary.707.df80bfd.0

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 (308) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/CLAUDE.md +28 -0
  3. package/README.md +105 -0
  4. package/application/commands/integration-commands.js +20 -10
  5. package/application/commands/scheduler-commands.js +11 -7
  6. package/application/commands/user-commands.js +17 -5
  7. package/application/index.js +6 -2
  8. package/core/Worker.js +31 -7
  9. package/core/create-handler.js +9 -0
  10. package/credential/repositories/credential-repository-documentdb.js +34 -0
  11. package/credential/repositories/credential-repository-interface.js +15 -0
  12. package/credential/repositories/credential-repository-mongo.js +23 -0
  13. package/credential/repositories/credential-repository-postgres.js +28 -0
  14. package/credential/use-cases/credential-operations-for-user.js +202 -0
  15. package/credential/use-cases/reauthorize-credential-for-user.js +73 -0
  16. package/database/config.js +48 -24
  17. package/database/documentdb-encryption-service.js +9 -22
  18. package/database/documentdb-utils.js +2 -2
  19. package/database/encryption/README.md +78 -14
  20. package/database/encryption/documentdb-encryption-service.md +78 -1
  21. package/database/encryption/encryption-config.js +219 -0
  22. package/database/encryption/encryption-schema-registry.js +121 -24
  23. package/database/encryption/field-encryption-service.js +69 -5
  24. package/database/encryption/integration-mapping-encryption.js +1 -1
  25. package/database/encryption/test-support/fake-ciphertext.js +15 -0
  26. package/database/organization-where.js +18 -0
  27. package/database/prisma.js +15 -38
  28. package/database/unique-violation.js +25 -0
  29. package/database/use-cases/check-encryption-health-use-case.js +43 -52
  30. package/errors/index.js +0 -4
  31. package/extensions/bootstrap-runner.js +43 -0
  32. package/extensions/extension-loader.js +230 -0
  33. package/extensions/index.js +44 -0
  34. package/extensions/initialize-app.js +123 -0
  35. package/extensions/prisma-composer.js +270 -0
  36. package/extensions/route-mounter.js +103 -0
  37. package/extensions/schema-composer.js +188 -0
  38. package/generated/prisma-mongodb/edge.js +33 -42
  39. package/generated/prisma-mongodb/index-browser.js +30 -39
  40. package/generated/prisma-mongodb/index.d.ts +3187 -2005
  41. package/generated/prisma-mongodb/index.js +33 -42
  42. package/generated/prisma-mongodb/package.json +1 -1
  43. package/generated/prisma-mongodb/schema.prisma +86 -59
  44. package/generated/prisma-mongodb/wasm.js +33 -42
  45. package/generated/prisma-postgresql/edge.js +33 -42
  46. package/generated/prisma-postgresql/index-browser.js +30 -39
  47. package/generated/prisma-postgresql/index.d.ts +3380 -2177
  48. package/generated/prisma-postgresql/index.js +33 -42
  49. package/generated/prisma-postgresql/package.json +1 -1
  50. package/generated/prisma-postgresql/schema.prisma +81 -57
  51. package/generated/prisma-postgresql/wasm.js +33 -42
  52. package/handlers/WEBHOOKS.md +0 -29
  53. package/handlers/app-definition-loader.js +128 -19
  54. package/handlers/app-handler-helpers.js +27 -8
  55. package/handlers/backend-utils.js +31 -25
  56. package/handlers/integration-event-dispatcher.js +3 -7
  57. package/handlers/middleware/admin-auth.js +14 -1
  58. package/handlers/routers/auth.js +46 -10
  59. package/handlers/routers/health.js +13 -4
  60. package/handlers/routers/integration-defined-routers.js +144 -92
  61. package/handlers/routers/integration-webhook-routers.js +100 -50
  62. package/handlers/workers/integration-defined-workers.js +5 -2
  63. package/index.js +66 -16
  64. package/infrastructure/scheduler/index.js +19 -6
  65. package/infrastructure/scheduler/netlify-scheduler-adapter.js +216 -0
  66. package/infrastructure/scheduler/scheduled-job-repository.js +118 -0
  67. package/infrastructure/scheduler/scheduler-service-factory.js +55 -7
  68. package/integrations/index.js +1 -14
  69. package/integrations/integration-base.js +2 -163
  70. package/integrations/integration-router.js +132 -102
  71. package/integrations/repositories/integration-mapping-repository-documentdb.js +0 -50
  72. package/integrations/repositories/integration-mapping-repository-interface.js +0 -15
  73. package/integrations/repositories/integration-mapping-repository-mongo.js +0 -29
  74. package/integrations/repositories/integration-mapping-repository-postgres.js +0 -30
  75. package/integrations/repositories/integration-mapping-repository.js +0 -29
  76. package/integrations/repositories/integration-not-found.js +14 -0
  77. package/integrations/repositories/integration-repository-documentdb.js +37 -9
  78. package/integrations/repositories/integration-repository-interface.js +17 -4
  79. package/integrations/repositories/integration-repository-mongo.js +64 -96
  80. package/integrations/repositories/integration-repository-postgres.js +63 -81
  81. package/integrations/repositories/process-repository-mongo.js +1 -1
  82. package/integrations/schedule-config.js +80 -0
  83. package/integrations/tests/doubles/test-integration-repository.js +12 -1
  84. package/integrations/use-cases/create-integration.js +56 -31
  85. package/integrations/use-cases/delete-integration-for-user.js +4 -4
  86. package/integrations/use-cases/dispatch-ongoing-syncs.js +100 -0
  87. package/integrations/use-cases/get-integration-for-user.js +2 -4
  88. package/integrations/use-cases/get-integration-instance.js +4 -4
  89. package/integrations/use-cases/get-integrations-for-user.js +79 -39
  90. package/integrations/use-cases/get-possible-integrations.js +2 -7
  91. package/integrations/use-cases/index.js +7 -1
  92. package/integrations/use-cases/integration-operations-for-user.js +256 -0
  93. package/integrations/use-cases/resolve-integration-ownership.js +177 -0
  94. package/integrations/use-cases/update-integration.js +4 -4
  95. package/integrations/utils/map-integration-dto.js +43 -14
  96. package/management-api/create-management-api-router.js +49 -0
  97. package/management-api/error-response.js +116 -0
  98. package/management-api/management-api-config.js +151 -0
  99. package/management-api/meta-router.js +76 -0
  100. package/management-api/openapi/build-openapi.js +144 -0
  101. package/management-api/openapi/components.js +415 -0
  102. package/management-api/openapi/v1-operations.js +83 -0
  103. package/management-api/openapi/v2-operations.js +264 -0
  104. package/management-api/route-registry.js +411 -0
  105. package/management-api/test-support/http-client.js +39 -0
  106. package/management-api/use-cases/get-management-api-meta.js +57 -0
  107. package/management-api/v1-deprecation.js +120 -0
  108. package/management-api/v2/create-v2-router.js +85 -0
  109. package/management-api/v2/dependencies.js +281 -0
  110. package/management-api/v2/dto.js +143 -0
  111. package/management-api/v2/handlers/authorization.js +94 -0
  112. package/management-api/v2/handlers/credentials.js +33 -0
  113. package/management-api/v2/handlers/entities.js +77 -0
  114. package/management-api/v2/handlers/integrations.js +128 -0
  115. package/management-api/v2/handlers/proxy.js +34 -0
  116. package/management-api/v2/request.js +85 -0
  117. package/management-api/v2/test-support/fake-dependencies.js +103 -0
  118. package/modules/domain/authorization-session.js +144 -0
  119. package/modules/entity-scope.js +15 -0
  120. package/modules/entity-type-registry.js +311 -0
  121. package/modules/index.js +14 -0
  122. package/modules/module-factory.js +12 -0
  123. package/modules/module.js +53 -2
  124. package/modules/proxy/proxy-bases.js +169 -0
  125. package/modules/proxy/proxy-errors.js +31 -0
  126. package/modules/proxy/proxy-path.js +183 -0
  127. package/modules/proxy/proxy-policy.js +277 -0
  128. package/modules/repositories/authorization-session-repository-documentdb.js +112 -0
  129. package/modules/repositories/authorization-session-repository-factory.js +31 -0
  130. package/modules/repositories/authorization-session-repository-interface.js +47 -0
  131. package/modules/repositories/authorization-session-repository-prisma.js +87 -0
  132. package/modules/repositories/entity-not-found.js +18 -0
  133. package/modules/repositories/module-repository-documentdb.js +51 -6
  134. package/modules/repositories/module-repository-interface.js +19 -2
  135. package/modules/repositories/module-repository-mongo.js +67 -74
  136. package/modules/repositories/module-repository-postgres.js +66 -74
  137. package/modules/repositories/module-repository.js +2 -1
  138. package/modules/requester/proxy-request.js +245 -0
  139. package/modules/requester/requester.js +35 -5
  140. package/modules/scope-config.js +192 -0
  141. package/modules/scope-policy.js +112 -0
  142. package/modules/scope-resolution.js +288 -0
  143. package/modules/scope-visibility.js +247 -0
  144. package/modules/tests/doubles/in-memory-authorization-session-repository.js +45 -0
  145. package/modules/tests/doubles/ownership-matching.js +18 -0
  146. package/modules/use-cases/authorize-entity-for-user.js +61 -0
  147. package/modules/use-cases/create-entity-from-credential.js +113 -0
  148. package/modules/use-cases/entity-operations-for-user.js +162 -0
  149. package/modules/use-cases/entity-types.js +139 -0
  150. package/modules/use-cases/execute-entity-proxy-request.js +331 -0
  151. package/modules/use-cases/get-authorization-requirements.js +100 -0
  152. package/modules/use-cases/get-entities-for-user.js +26 -13
  153. package/modules/use-cases/get-entity-module-for-user.js +113 -0
  154. package/modules/use-cases/get-entity-options-by-id.js +10 -4
  155. package/modules/use-cases/get-entity-options-by-type.js +1 -1
  156. package/modules/use-cases/get-module-instance-from-type.js +1 -1
  157. package/modules/use-cases/get-module.js +10 -4
  158. package/modules/use-cases/manage-access.js +21 -0
  159. package/modules/use-cases/multi-step-authorization.js +329 -0
  160. package/modules/use-cases/process-authorization-callback.js +53 -19
  161. package/modules/use-cases/refresh-entity-options.js +10 -4
  162. package/modules/use-cases/test-module-auth.js +10 -4
  163. package/package.json +6 -7
  164. package/prisma-mongodb/schema.prisma +86 -59
  165. package/prisma-postgresql/migrations/20261003000000_add_authorization_session/migration.sql +28 -0
  166. package/prisma-postgresql/migrations/20261015000000_add_organization_membership/migration.sql +26 -0
  167. package/prisma-postgresql/migrations/20261016000000_add_entity_integration_organization/migration.sql +25 -0
  168. package/prisma-postgresql/migrations/20261017000000_add_scheduled_job/migration.sql +28 -0
  169. package/prisma-postgresql/schema.prisma +81 -57
  170. package/providers/index.js +23 -0
  171. package/providers/resolve-provider.js +93 -0
  172. package/providers/runtime-detection.js +124 -0
  173. package/queues/index.js +25 -0
  174. package/queues/providers/index.js +11 -0
  175. package/queues/providers/netlify-background-provider.js +150 -0
  176. package/queues/providers/qstash-queue-provider.js +219 -0
  177. package/queues/providers/sqs-queue-provider.js +70 -0
  178. package/queues/queue-client-interface.js +55 -0
  179. package/queues/queue-message-auth.js +193 -0
  180. package/queues/queue-provider-factory.js +101 -0
  181. package/queues/queue-provider.js +65 -0
  182. package/queues/queuer-util.js +2 -9
  183. package/queues/sqs-queue-client.js +81 -0
  184. package/types/index.d.ts +2 -0
  185. package/types/modules/index.d.ts +214 -0
  186. package/types/user/index.d.ts +134 -0
  187. package/user/adopter-jwt-config.js +177 -0
  188. package/user/adopter-jwt-errors.js +59 -0
  189. package/user/adopter-token-verifier.js +122 -0
  190. package/user/app-user-helpers.js +97 -0
  191. package/user/create-user-authentication.js +64 -0
  192. package/user/membership.js +51 -0
  193. package/user/repositories/organization-membership-record.js +19 -0
  194. package/user/repositories/organization-membership-repository-documentdb.js +106 -0
  195. package/user/repositories/organization-membership-repository-factory.js +42 -0
  196. package/user/repositories/organization-membership-repository-interface.js +57 -0
  197. package/user/repositories/organization-membership-repository-mongo.js +13 -0
  198. package/user/repositories/organization-membership-repository-postgres.js +29 -0
  199. package/user/repositories/organization-membership-repository-prisma.js +81 -0
  200. package/user/repositories/user-repository-documentdb.js +27 -2
  201. package/user/repositories/user-repository-interface.js +18 -0
  202. package/user/repositories/user-repository-mongo.js +24 -0
  203. package/user/repositories/user-repository-postgres.js +18 -0
  204. package/user/tests/doubles/adopter-jwt-fixtures.js +220 -0
  205. package/user/use-cases/authenticate-user.js +7 -1
  206. package/user/use-cases/ensure-organization-membership.js +92 -0
  207. package/user/use-cases/find-individual-users-by-organization.js +54 -0
  208. package/user/use-cases/get-user-from-adopter-jwt.js +95 -124
  209. package/user/use-cases/get-user-from-x-frigg-headers.js +83 -80
  210. package/user/user.js +64 -1
  211. package/errors/mapping-already-exists-error.js +0 -14
  212. package/handlers/workers/integration-triggers.js +0 -25
  213. package/infrastructure/scheduler/recurrence.js +0 -204
  214. package/integrations/define/DESIGN.md +0 -122
  215. package/integrations/define/config.js +0 -98
  216. package/integrations/define/define-app.js +0 -66
  217. package/integrations/define/define-extension.js +0 -154
  218. package/integrations/define/define-integration.js +0 -335
  219. package/integrations/define/examples/deal-alerts.js +0 -140
  220. package/integrations/define/extension-binding.js +0 -174
  221. package/integrations/define/index.js +0 -11
  222. package/integrations/define/json-schema-lite.js +0 -68
  223. package/integrations/define/subscriptions.js +0 -186
  224. package/integrations/define/tests/fixtures/hubspot.js +0 -109
  225. package/integrations/define/tests/fixtures/slack.js +0 -26
  226. package/integrations/define/use.js +0 -39
  227. package/integrations/definitions/README.md +0 -278
  228. package/integrations/definitions/canonical.js +0 -11
  229. package/integrations/definitions/capabilities/AUDIT.md +0 -480
  230. package/integrations/definitions/capabilities/acmeerp.capabilities.json +0 -633
  231. package/integrations/definitions/capabilities/asana.capabilities.json +0 -279
  232. package/integrations/definitions/capabilities/calendly.capabilities.json +0 -385
  233. package/integrations/definitions/capabilities/docusign.capabilities.json +0 -314
  234. package/integrations/definitions/capabilities/fathom.capabilities.json +0 -238
  235. package/integrations/definitions/capabilities/github.capabilities.json +0 -585
  236. package/integrations/definitions/capabilities/hubspot.capabilities.json +0 -822
  237. package/integrations/definitions/capabilities/jira.capabilities.json +0 -391
  238. package/integrations/definitions/capabilities/klaviyo.capabilities.json +0 -503
  239. package/integrations/definitions/capabilities/linear.capabilities.json +0 -378
  240. package/integrations/definitions/capabilities/netsuite.capabilities.json +0 -535
  241. package/integrations/definitions/capabilities/notion.capabilities.json +0 -208
  242. package/integrations/definitions/capabilities/phone.capabilities.json +0 -511
  243. package/integrations/definitions/capabilities/pipedrive.capabilities.json +0 -430
  244. package/integrations/definitions/capabilities/quickbooks.capabilities.json +0 -635
  245. package/integrations/definitions/capabilities/salesforce.capabilities.json +0 -568
  246. package/integrations/definitions/capabilities/shopify.capabilities.json +0 -1128
  247. package/integrations/definitions/capabilities/slack.capabilities.json +0 -373
  248. package/integrations/definitions/capabilities/stripe.capabilities.json +0 -630
  249. package/integrations/definitions/capabilities/webflow.capabilities.json +0 -196
  250. package/integrations/definitions/capabilities/zendesk.capabilities.json +0 -422
  251. package/integrations/definitions/compile.js +0 -80
  252. package/integrations/definitions/config-form.js +0 -137
  253. package/integrations/definitions/examples/acme-erp-quickbooks.definition.json +0 -467
  254. package/integrations/definitions/examples/asana-slack.definition.json +0 -219
  255. package/integrations/definitions/examples/calendly-salesforce.definition.json +0 -459
  256. package/integrations/definitions/examples/docusign-salesforce.definition.json +0 -305
  257. package/integrations/definitions/examples/fathom-hubspot-notion.definition.json +0 -575
  258. package/integrations/definitions/examples/github-linear.definition.json +0 -322
  259. package/integrations/definitions/examples/hubspot-slack.definition.json +0 -427
  260. package/integrations/definitions/examples/klaviyo-hubspot.definition.json +0 -336
  261. package/integrations/definitions/examples/phone-hubspot.definition.json +0 -633
  262. package/integrations/definitions/examples/pipedrive-hubspot.definition.json +0 -136
  263. package/integrations/definitions/examples/pipedrive-phone.definition.json +0 -340
  264. package/integrations/definitions/examples/records/phone-hubspot.definition-version.json +0 -652
  265. package/integrations/definitions/examples/records/phone-hubspot.integration.json +0 -86
  266. package/integrations/definitions/examples/records/phone-hubspot.mappings.json +0 -39
  267. package/integrations/definitions/examples/records/phone-hubspot.workflow-run.json +0 -62
  268. package/integrations/definitions/examples/shopify-klaviyo.definition.json +0 -488
  269. package/integrations/definitions/examples/shopify-netsuite.definition.json +0 -622
  270. package/integrations/definitions/examples/stripe-quickbooks.definition.json +0 -476
  271. package/integrations/definitions/examples/webflow-hubspot-slack.definition.json +0 -262
  272. package/integrations/definitions/examples/zendesk-jira.definition.json +0 -604
  273. package/integrations/definitions/expressions.js +0 -229
  274. package/integrations/definitions/index.js +0 -48
  275. package/integrations/definitions/integration-runtime.js +0 -779
  276. package/integrations/definitions/interpreter.js +0 -104
  277. package/integrations/definitions/manifests.js +0 -177
  278. package/integrations/definitions/renderers/common.js +0 -67
  279. package/integrations/definitions/renderers/html.js +0 -129
  280. package/integrations/definitions/renderers/hubspot.js +0 -59
  281. package/integrations/definitions/renderers/preview.js +0 -154
  282. package/integrations/definitions/renderers/slack.js +0 -146
  283. package/integrations/definitions/repositories/definition-version-repository.js +0 -67
  284. package/integrations/definitions/repositories/workflow-run-repository.js +0 -80
  285. package/integrations/definitions/router.js +0 -170
  286. package/integrations/definitions/runtime.js +0 -268
  287. package/integrations/definitions/schema/capability-manifest.v0.1.schema.json +0 -549
  288. package/integrations/definitions/schema/installation.v0.1.schema.json +0 -130
  289. package/integrations/definitions/schema/integration-definition.v0.1.schema.json +0 -909
  290. package/integrations/definitions/schema/records.md +0 -105
  291. package/integrations/definitions/schema-check.js +0 -58
  292. package/integrations/definitions/scripts/check-manifests.js +0 -220
  293. package/integrations/definitions/scripts/validate.js +0 -66
  294. package/integrations/definitions/steps.js +0 -123
  295. package/integrations/definitions/sync-engine.js +0 -297
  296. package/integrations/definitions/tests/helpers-fake-crm.js +0 -49
  297. package/integrations/definitions/transforms.js +0 -91
  298. package/integrations/definitions/use-cases/definition-use-cases.js +0 -245
  299. package/integrations/definitions/validate.js +0 -436
  300. package/integrations/definitions/versioning.js +0 -176
  301. package/integrations/definitions/webhooks.js +0 -119
  302. package/integrations/integration-types.js +0 -73
  303. package/integrations/triggers.js +0 -244
  304. package/integrations/use-cases/run-trigger-tick.js +0 -155
  305. package/integrations/use-cases/run-trigger.js +0 -77
  306. package/prisma-postgresql/migrations/20261018000000_add_data_defined_integrations/migration.sql +0 -66
  307. package/prisma-postgresql/migrations/20261019000000_workflow_run_waits/migration.sql +0 -7
  308. package/prisma-postgresql/migrations/20261019120000_definition_workspace/migration.sql +0 -5
@@ -1,822 +0,0 @@
1
- {
2
- "$schema": "https://friggframework.org/schemas/capability-manifest/v0.1.json",
3
- "module": "hubspot",
4
- "label": "HubSpot",
5
- "package": "@friggframework/api-module-hubspot",
6
- "version": "1.4.0",
7
- "auth": "oauth2",
8
- "account": {
9
- "description": "Values about the connected account, persisted by the module (apiPropertiesToPersist). Definitions read them as $.install.accounts.<module key>.<name>.",
10
- "fields": [
11
- {
12
- "name": "portalId",
13
- "type": "string",
14
- "description": "HubSpot portal (hub) id"
15
- }
16
- ]
17
- },
18
- "objects": {
19
- "contact": {
20
- "label": "Contact",
21
- "fields": [
22
- {
23
- "name": "id",
24
- "type": "id",
25
- "readOnly": true
26
- },
27
- {
28
- "name": "properties.email",
29
- "type": "email",
30
- "tag": "contact.email"
31
- },
32
- {
33
- "name": "properties.firstname",
34
- "type": "string",
35
- "tag": "person.givenName"
36
- },
37
- {
38
- "name": "properties.lastname",
39
- "type": "string",
40
- "tag": "person.familyName"
41
- },
42
- {
43
- "name": "properties.phone",
44
- "type": "phone",
45
- "tag": "contact.phone"
46
- },
47
- {
48
- "name": "properties.mobilephone",
49
- "type": "phone",
50
- "tag": "contact.phone"
51
- },
52
- {
53
- "name": "properties.company",
54
- "type": "string",
55
- "tag": "organization.name"
56
- },
57
- {
58
- "name": "properties.lifecyclestage",
59
- "type": "enum",
60
- "tag": "contact.lifecycleStage",
61
- "values": [
62
- "subscriber",
63
- "lead",
64
- "marketingqualifiedlead",
65
- "salesqualifiedlead",
66
- "opportunity",
67
- "customer"
68
- ]
69
- },
70
- {
71
- "name": "properties.hubspot_owner_id",
72
- "type": "string",
73
- "tag": "record.owner"
74
- },
75
- {
76
- "name": "properties.notes_last_contacted",
77
- "type": "datetime",
78
- "tag": "activity.lastContactedAt",
79
- "readOnly": true
80
- },
81
- {
82
- "name": "properties.phone_last_call",
83
- "type": "datetime",
84
- "custom": true
85
- },
86
- {
87
- "name": "properties.jobtitle",
88
- "type": "string",
89
- "tag": "person.jobTitle"
90
- },
91
- {
92
- "name": "properties.city",
93
- "type": "string",
94
- "tag": "address.locality"
95
- },
96
- {
97
- "name": "properties.hs_lead_status",
98
- "type": "enum",
99
- "tag": "contact.leadStatus",
100
- "values": [
101
- "NEW",
102
- "OPEN",
103
- "IN_PROGRESS",
104
- "OPEN_DEAL",
105
- "UNQUALIFIED",
106
- "ATTEMPTED_TO_CONTACT",
107
- "CONNECTED",
108
- "BAD_TIMING"
109
- ]
110
- },
111
- {
112
- "name": "properties.hs_email_optout",
113
- "type": "boolean",
114
- "tag": "contact.emailOptOut",
115
- "readOnly": true
116
- }
117
- ],
118
- "sync": {
119
- "id": "id",
120
- "updatedAt": "updatedAt",
121
- "list": {
122
- "capability": "contact.list",
123
- "cursor": "after",
124
- "limit": "limit",
125
- "since": "updatedSince",
126
- "items": "results",
127
- "next": "paging.next.after"
128
- },
129
- "get": {
130
- "capability": "contact.get",
131
- "id": "id"
132
- },
133
- "search": {
134
- "capability": "contact.search"
135
- },
136
- "create": {
137
- "capability": "contact.create"
138
- },
139
- "update": {
140
- "capability": "contact.update",
141
- "id": "id"
142
- }
143
- }
144
- },
145
- "deal": {
146
- "label": "Deal",
147
- "fields": [
148
- {
149
- "name": "id",
150
- "type": "id",
151
- "readOnly": true
152
- },
153
- {
154
- "name": "properties.dealname",
155
- "type": "string",
156
- "tag": "deal.name"
157
- },
158
- {
159
- "name": "properties.amount",
160
- "type": "number",
161
- "tag": "deal.amount"
162
- },
163
- {
164
- "name": "properties.dealstage",
165
- "type": "enum",
166
- "tag": "deal.stage",
167
- "values": "dealStage"
168
- },
169
- {
170
- "name": "properties.closedate",
171
- "type": "date",
172
- "tag": "deal.closeDate"
173
- },
174
- {
175
- "name": "properties.hubspot_owner_id",
176
- "type": "string",
177
- "tag": "record.owner"
178
- },
179
- {
180
- "name": "properties.pipeline",
181
- "type": "string",
182
- "tag": "deal.pipeline"
183
- },
184
- {
185
- "name": "properties.hs_next_step",
186
- "type": "text",
187
- "tag": "deal.nextStep"
188
- }
189
- ]
190
- },
191
- "company": {
192
- "label": "Company",
193
- "fields": [
194
- {
195
- "name": "id",
196
- "type": "id",
197
- "readOnly": true
198
- },
199
- {
200
- "name": "properties.name",
201
- "type": "string",
202
- "tag": "organization.name"
203
- },
204
- {
205
- "name": "properties.domain",
206
- "type": "string",
207
- "tag": "organization.domain"
208
- }
209
- ]
210
- },
211
- "task": {
212
- "label": "Task",
213
- "fields": [
214
- {
215
- "name": "id",
216
- "type": "id",
217
- "readOnly": true
218
- },
219
- {
220
- "name": "properties.hs_task_subject",
221
- "type": "string",
222
- "required": true
223
- },
224
- {
225
- "name": "properties.hs_task_body",
226
- "type": "text"
227
- },
228
- {
229
- "name": "properties.hs_timestamp",
230
- "type": "datetime",
231
- "required": true
232
- },
233
- {
234
- "name": "properties.hubspot_owner_id",
235
- "type": "string"
236
- },
237
- {
238
- "name": "properties.hs_task_status",
239
- "type": "enum",
240
- "tag": "task.status",
241
- "values": [
242
- "NOT_STARTED",
243
- "IN_PROGRESS",
244
- "WAITING",
245
- "COMPLETED",
246
- "DEFERRED"
247
- ]
248
- },
249
- {
250
- "name": "properties.hs_task_priority",
251
- "type": "enum",
252
- "tag": "task.priority",
253
- "values": [
254
- "LOW",
255
- "MEDIUM",
256
- "HIGH"
257
- ]
258
- }
259
- ]
260
- },
261
- "call": {
262
- "label": "Call engagement",
263
- "fields": [
264
- {
265
- "name": "id",
266
- "type": "id",
267
- "readOnly": true
268
- },
269
- {
270
- "name": "properties.hs_call_title",
271
- "type": "string"
272
- },
273
- {
274
- "name": "properties.hs_call_body",
275
- "type": "text"
276
- },
277
- {
278
- "name": "properties.hs_call_duration",
279
- "type": "number"
280
- },
281
- {
282
- "name": "properties.hs_call_direction",
283
- "type": "enum",
284
- "values": [
285
- "INBOUND",
286
- "OUTBOUND"
287
- ]
288
- },
289
- {
290
- "name": "properties.hs_call_recording_url",
291
- "type": "string"
292
- },
293
- {
294
- "name": "properties.hs_timestamp",
295
- "type": "datetime",
296
- "required": true
297
- }
298
- ]
299
- },
300
- "note": {
301
- "label": "Note",
302
- "fields": [
303
- {
304
- "name": "id",
305
- "type": "id",
306
- "readOnly": true
307
- },
308
- {
309
- "name": "properties.hs_note_body",
310
- "type": "text",
311
- "required": true
312
- },
313
- {
314
- "name": "properties.hs_timestamp",
315
- "type": "datetime",
316
- "required": true
317
- }
318
- ]
319
- }
320
- },
321
- "events": {
322
- "contact.created": {
323
- "delivery": "webhook",
324
- "object": "contact",
325
- "description": "App-level subscription; Frigg routes it to the installation by portalId.",
326
- "payload": [
327
- {
328
- "portalId": 12345678,
329
- "objectId": "51",
330
- "subscriptionType": "contact.creation",
331
- "occurredAt": 1760800000000,
332
- "eventId": 9001
333
- }
334
- ],
335
- "match": "contact.creation",
336
- "recordId": "objectId"
337
- },
338
- "contact.propertyChange": {
339
- "delivery": "webhook",
340
- "object": "contact",
341
- "payload": [
342
- {
343
- "portalId": 12345678,
344
- "objectId": "51",
345
- "propertyName": "phone",
346
- "propertyValue": "+15125550142",
347
- "occurredAt": 1760800000000,
348
- "eventId": 9002,
349
- "subscriptionType": "contact.propertyChange"
350
- }
351
- ],
352
- "recordId": "objectId"
353
- },
354
- "deal.propertyChange": {
355
- "delivery": "webhook",
356
- "object": "deal",
357
- "payload": [
358
- {
359
- "portalId": 12345678,
360
- "objectId": "880",
361
- "propertyName": "dealstage",
362
- "propertyValue": "closedwon",
363
- "occurredAt": 1760800000000,
364
- "eventId": 9003,
365
- "subscriptionType": "deal.propertyChange"
366
- }
367
- ]
368
- },
369
- "deal.created": {
370
- "delivery": "webhook",
371
- "object": "deal",
372
- "payload": [
373
- {
374
- "portalId": 12345678,
375
- "objectId": "881",
376
- "occurredAt": 1760800000000,
377
- "eventId": 9004,
378
- "subscriptionType": "deal.creation"
379
- }
380
- ],
381
- "match": "deal.creation"
382
- }
383
- },
384
- "webhook": {
385
- "scope": "app",
386
- "batch": "body",
387
- "topic": "{{item.subscriptionType}}",
388
- "eventId": "{{item.eventId}}",
389
- "account": "{{item.portalId}}",
390
- "verify": "verifyWebhookSignature",
391
- "note": "HubSpot v3: X-HubSpot-Signature-v3 over method + URL + raw body + timestamp, 5 minutes. Needs the public URL and method (the runtime passes them). Implemented in api-module-library 659b90d; needs the module release that includes it."
392
- },
393
- "capabilities": {
394
- "contact.get": {
395
- "kind": "read",
396
- "method": "getContactById",
397
- "input": {
398
- "id": {
399
- "type": "string",
400
- "required": true
401
- }
402
- },
403
- "output": "contact",
404
- "args": [
405
- "id"
406
- ],
407
- "note": "Api.getContactById(id) always requests the portal's full property list; a properties argument is not supported."
408
- },
409
- "contact.search": {
410
- "kind": "search",
411
- "method": "searchContacts",
412
- "input": {
413
- "email": {
414
- "type": "string"
415
- },
416
- "phone": {
417
- "type": "string"
418
- },
419
- "limit": {
420
- "type": "number"
421
- },
422
- "lastContactedBefore": {
423
- "type": "string"
424
- },
425
- "properties": {
426
- "type": "array"
427
- },
428
- "after": {
429
- "type": "string"
430
- }
431
- },
432
- "output": "{ total, results: contact[], paging }"
433
- },
434
- "contact.list": {
435
- "kind": "read",
436
- "method": "listContacts",
437
- "input": {
438
- "after": {
439
- "type": "string"
440
- },
441
- "limit": {
442
- "type": "number"
443
- },
444
- "updatedSince": {
445
- "type": "string"
446
- }
447
- },
448
- "output": "page<contact>",
449
- "note": "Api.listContacts({ after, limit, properties }) has no modified-since filter, so updatedSince is ignored and a poll re-lists every contact."
450
- },
451
- "contact.create": {
452
- "kind": "write",
453
- "method": "createContact",
454
- "input": {
455
- "properties": {
456
- "type": "object",
457
- "required": true
458
- }
459
- },
460
- "output": "contact",
461
- "args": [
462
- "properties"
463
- ]
464
- },
465
- "contact.update": {
466
- "kind": "write",
467
- "method": "updateContact",
468
- "input": {
469
- "id": {
470
- "type": "string",
471
- "required": true
472
- },
473
- "properties": {
474
- "type": "object",
475
- "required": true
476
- }
477
- },
478
- "output": "contact",
479
- "args": [
480
- "id",
481
- "properties"
482
- ]
483
- },
484
- "deal.get": {
485
- "kind": "read",
486
- "method": "getDealById",
487
- "input": {
488
- "id": {
489
- "type": "string",
490
- "required": true
491
- }
492
- },
493
- "output": "deal",
494
- "args": [
495
- "id"
496
- ]
497
- },
498
- "deal.listForContact": {
499
- "kind": "read",
500
- "method": "listDealsForContact",
501
- "input": {
502
- "contactId": {
503
- "type": "string",
504
- "required": true
505
- },
506
- "open": {
507
- "type": "boolean"
508
- }
509
- },
510
- "output": "deal[]",
511
- "args": [
512
- "contactId",
513
- "open"
514
- ]
515
- },
516
- "deal.contacts": {
517
- "kind": "read",
518
- "method": "listContactsForDeal",
519
- "input": {
520
- "dealId": {
521
- "type": "string",
522
- "required": true
523
- }
524
- },
525
- "output": "contact[]",
526
- "args": [
527
- "dealId"
528
- ]
529
- },
530
- "task.create": {
531
- "kind": "write",
532
- "method": "createTask",
533
- "input": {
534
- "properties": {
535
- "type": "object",
536
- "required": true
537
- },
538
- "contactId": {
539
- "type": "string"
540
- }
541
- },
542
- "output": "task",
543
- "args": [
544
- "properties",
545
- "contactId"
546
- ]
547
- },
548
- "call.create": {
549
- "kind": "write",
550
- "method": "createCallEngagement",
551
- "input": {
552
- "properties": {
553
- "type": "object",
554
- "required": true
555
- },
556
- "contactId": {
557
- "type": "string",
558
- "required": true
559
- }
560
- },
561
- "output": "call",
562
- "args": [
563
- "properties",
564
- "contactId"
565
- ]
566
- },
567
- "note.create": {
568
- "kind": "write",
569
- "method": "createNote",
570
- "input": {
571
- "properties": {
572
- "type": "object",
573
- "required": true
574
- },
575
- "contactId": {
576
- "type": "string"
577
- },
578
- "dealId": {
579
- "type": "string"
580
- }
581
- },
582
- "output": "note",
583
- "args": [
584
- "properties",
585
- "contactId",
586
- "dealId"
587
- ]
588
- },
589
- "owner.list": {
590
- "kind": "read",
591
- "method": "listOwners",
592
- "input": {},
593
- "output": "owner[]",
594
- "args": []
595
- },
596
- "pipeline.stages": {
597
- "kind": "read",
598
- "method": "listDealStages",
599
- "input": {
600
- "pipelineId": {
601
- "type": "string"
602
- }
603
- },
604
- "output": "stage[]",
605
- "args": [
606
- "pipelineId"
607
- ]
608
- },
609
- "contact.upsertByEmail": {
610
- "kind": "write",
611
- "method": "upsertContactByEmail",
612
- "label": "Batch upsert with idProperty=email",
613
- "input": {
614
- "email": {
615
- "type": "string",
616
- "required": true
617
- },
618
- "properties": {
619
- "type": "object",
620
- "required": true
621
- }
622
- },
623
- "output": "contact",
624
- "args": [
625
- "email",
626
- "properties"
627
- ]
628
- },
629
- "deal.update": {
630
- "kind": "write",
631
- "method": "updateDeal",
632
- "input": {
633
- "dealId": {
634
- "type": "string",
635
- "required": true
636
- },
637
- "properties": {
638
- "type": "object",
639
- "required": true
640
- }
641
- },
642
- "output": "deal",
643
- "note": "Api.updateDeal({ dealId, properties }) takes one object, so the input is dealId (it was id)."
644
- },
645
- "deal.search": {
646
- "kind": "search",
647
- "method": "searchDeals",
648
- "input": {
649
- "filterGroups": {
650
- "type": "array"
651
- },
652
- "sorts": {
653
- "type": "array"
654
- },
655
- "props": {
656
- "type": "array"
657
- },
658
- "limit": {
659
- "type": "number"
660
- },
661
- "after": {
662
- "type": "string"
663
- },
664
- "allProps": {
665
- "type": "boolean"
666
- }
667
- },
668
- "output": "{ total, results: deal[], paging }",
669
- "note": "Api.searchDeals takes HubSpot filterGroups ([{ filters: [{ propertyName, operator, value }] }]), sorts, props, limit, after and allProps (default true: every deal property when props is empty). The capability was reshaped from open/closeDateBefore/closeDateAfter/minAmount, which the Api never had; a definition expresses those as filterGroups."
670
- },
671
- "task.get": {
672
- "kind": "read",
673
- "method": "getTaskById",
674
- "input": {
675
- "id": {
676
- "type": "string",
677
- "required": true
678
- },
679
- "properties": {
680
- "type": "array"
681
- }
682
- },
683
- "output": "task",
684
- "args": [
685
- "id",
686
- "properties"
687
- ]
688
- },
689
- "task.update": {
690
- "kind": "write",
691
- "method": "updateTask",
692
- "input": {
693
- "id": {
694
- "type": "string",
695
- "required": true
696
- },
697
- "properties": {
698
- "type": "object",
699
- "required": true
700
- }
701
- },
702
- "output": "task",
703
- "args": [
704
- "id",
705
- "properties"
706
- ]
707
- },
708
- "task.search": {
709
- "kind": "search",
710
- "method": "searchTasks",
711
- "input": {
712
- "dueBefore": {
713
- "type": "string"
714
- },
715
- "status": {
716
- "type": "string"
717
- },
718
- "ownerId": {
719
- "type": "string"
720
- },
721
- "limit": {
722
- "type": "number"
723
- },
724
- "properties": {
725
- "type": "array"
726
- },
727
- "after": {
728
- "type": "string"
729
- }
730
- },
731
- "output": "{ total, results: task[], paging }"
732
- },
733
- "owner.get": {
734
- "kind": "read",
735
- "method": "getOwnerById",
736
- "input": {
737
- "id": {
738
- "type": "string",
739
- "required": true
740
- }
741
- },
742
- "output": "owner",
743
- "args": [
744
- "id"
745
- ]
746
- },
747
- "owner.findByEmail": {
748
- "kind": "search",
749
- "method": "getOwnerByEmail",
750
- "input": {
751
- "email": {
752
- "type": "string",
753
- "required": true
754
- }
755
- },
756
- "output": "owner",
757
- "args": [
758
- "email"
759
- ]
760
- },
761
- "subscription.definitions": {
762
- "kind": "read",
763
- "method": "listSubscriptionDefinitions",
764
- "input": {},
765
- "output": "subscriptionDefinition[]",
766
- "args": []
767
- },
768
- "subscription.unsubscribe": {
769
- "kind": "write",
770
- "method": "unsubscribeEmail",
771
- "label": "Communication preferences API; hs_email_optout itself is read-only",
772
- "input": {
773
- "emailAddress": {
774
- "type": "string",
775
- "required": true
776
- },
777
- "subscriptionId": {
778
- "type": "string",
779
- "required": true
780
- },
781
- "legalBasis": {
782
- "type": "string"
783
- },
784
- "legalBasisExplanation": {
785
- "type": "string"
786
- }
787
- },
788
- "output": "subscriptionStatus",
789
- "args": [
790
- "emailAddress",
791
- "subscriptionId",
792
- "legalBasis",
793
- "legalBasisExplanation"
794
- ]
795
- }
796
- },
797
- "options": {
798
- "owner": {
799
- "capability": "owner.list",
800
- "label": "{{item.firstName}} {{item.lastName}}",
801
- "value": "$.item.id"
802
- },
803
- "dealStage": {
804
- "capability": "pipeline.stages",
805
- "label": "$.item.label",
806
- "value": "$.item.id"
807
- },
808
- "subscriptionType": {
809
- "capability": "subscription.definitions",
810
- "label": "{{item.name}}",
811
- "value": "$.item.id"
812
- }
813
- },
814
- "ui": {
815
- "placements": [
816
- "crm.record.sidebar",
817
- "crm.record.tab",
818
- "crm.record.preview"
819
- ],
820
- "renderer": "left-hook-hubspot-app/frigg-card"
821
- }
822
- }