@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,535 +0,0 @@
1
- {
2
- "$schema": "https://friggframework.org/schemas/capability-manifest/v0.1.json",
3
- "module": "netsuite",
4
- "label": "NetSuite",
5
- "package": "@friggframework/api-module-netsuite",
6
- "version": "1.2.0",
7
- "auth": "oauth2",
8
- "objects": {
9
- "customer": {
10
- "label": "Customer",
11
- "fields": [
12
- {
13
- "name": "id",
14
- "type": "id",
15
- "readOnly": true
16
- },
17
- {
18
- "name": "entityId",
19
- "type": "string",
20
- "tag": "record.displayId",
21
- "readOnly": true
22
- },
23
- {
24
- "name": "externalId",
25
- "type": "string",
26
- "tag": "record.externalId"
27
- },
28
- {
29
- "name": "isPerson",
30
- "type": "boolean"
31
- },
32
- {
33
- "name": "firstName",
34
- "type": "string",
35
- "tag": "person.givenName"
36
- },
37
- {
38
- "name": "lastName",
39
- "type": "string",
40
- "tag": "person.familyName"
41
- },
42
- {
43
- "name": "companyName",
44
- "type": "string",
45
- "tag": "organization.name"
46
- },
47
- {
48
- "name": "email",
49
- "type": "email",
50
- "tag": "contact.email"
51
- },
52
- {
53
- "name": "phone",
54
- "type": "phone",
55
- "tag": "contact.phone"
56
- },
57
- {
58
- "name": "subsidiary.id",
59
- "type": "string"
60
- },
61
- {
62
- "name": "dateCreated",
63
- "type": "datetime",
64
- "tag": "record.createdAt",
65
- "readOnly": true
66
- },
67
- {
68
- "name": "lastModifiedDate",
69
- "type": "datetime",
70
- "tag": "record.updatedAt",
71
- "readOnly": true
72
- }
73
- ],
74
- "sync": {
75
- "id": "id",
76
- "updatedAt": "lastModifiedDate",
77
- "list": {
78
- "capability": "customer.list",
79
- "cursor": "offset",
80
- "limit": "limit",
81
- "since": "lastModifiedAfter",
82
- "items": "items",
83
- "paging": "offset"
84
- },
85
- "get": {
86
- "capability": "customer.get",
87
- "id": "id"
88
- },
89
- "search": {
90
- "capability": "customer.search"
91
- },
92
- "create": {
93
- "capability": "customer.create",
94
- "body": "record"
95
- },
96
- "update": {
97
- "capability": "customer.update",
98
- "id": "id",
99
- "body": "record"
100
- }
101
- }
102
- },
103
- "salesOrder": {
104
- "label": "Sales order",
105
- "fields": [
106
- {
107
- "name": "id",
108
- "type": "id",
109
- "readOnly": true
110
- },
111
- {
112
- "name": "tranId",
113
- "type": "string",
114
- "tag": "record.displayId",
115
- "readOnly": true
116
- },
117
- {
118
- "name": "externalId",
119
- "type": "string",
120
- "tag": "record.externalId"
121
- },
122
- {
123
- "name": "otherRefNum",
124
- "type": "string",
125
- "tag": "order.number"
126
- },
127
- {
128
- "name": "entity.id",
129
- "type": "string"
130
- },
131
- {
132
- "name": "subsidiary.id",
133
- "type": "string"
134
- },
135
- {
136
- "name": "location.id",
137
- "type": "string"
138
- },
139
- {
140
- "name": "tranDate",
141
- "type": "date",
142
- "tag": "order.createdAt"
143
- },
144
- {
145
- "name": "memo",
146
- "type": "text"
147
- },
148
- {
149
- "name": "email",
150
- "type": "email",
151
- "tag": "contact.email"
152
- },
153
- {
154
- "name": "currency.refName",
155
- "type": "string",
156
- "tag": "order.currency"
157
- },
158
- {
159
- "name": "subtotal",
160
- "type": "number",
161
- "tag": "order.subtotal",
162
- "readOnly": true
163
- },
164
- {
165
- "name": "taxTotal",
166
- "type": "number",
167
- "tag": "order.tax",
168
- "readOnly": true
169
- },
170
- {
171
- "name": "total",
172
- "type": "number",
173
- "tag": "order.total",
174
- "readOnly": true
175
- },
176
- {
177
- "name": "orderStatus",
178
- "type": "enum",
179
- "tag": "order.status",
180
- "values": [
181
- "A",
182
- "B",
183
- "C",
184
- "D",
185
- "E",
186
- "F",
187
- "G",
188
- "H"
189
- ]
190
- },
191
- {
192
- "name": "item.items",
193
- "type": "lineItem[]",
194
- "tag": "order.lineItems"
195
- }
196
- ],
197
- "sync": {
198
- "id": "id",
199
- "get": {
200
- "capability": "salesOrder.get",
201
- "id": "id"
202
- },
203
- "create": {
204
- "capability": "salesOrder.create",
205
- "body": "record"
206
- },
207
- "update": {
208
- "capability": "salesOrder.update",
209
- "id": "id",
210
- "body": "record"
211
- }
212
- }
213
- },
214
- "itemFulfillment": {
215
- "label": "Item fulfillment",
216
- "fields": [
217
- {
218
- "name": "id",
219
- "type": "id",
220
- "readOnly": true
221
- },
222
- {
223
- "name": "tranId",
224
- "type": "string",
225
- "tag": "record.displayId",
226
- "readOnly": true
227
- },
228
- {
229
- "name": "createdFrom.id",
230
- "type": "string"
231
- },
232
- {
233
- "name": "tranDate",
234
- "type": "date"
235
- },
236
- {
237
- "name": "shipStatus",
238
- "type": "enum",
239
- "values": [
240
- "_picked",
241
- "_packed",
242
- "_shipped"
243
- ]
244
- },
245
- {
246
- "name": "package.packages",
247
- "type": "json",
248
- "tag": "shipment.packages"
249
- },
250
- {
251
- "name": "memo",
252
- "type": "text"
253
- }
254
- ]
255
- },
256
- "creditMemo": {
257
- "label": "Credit memo",
258
- "fields": [
259
- {
260
- "name": "id",
261
- "type": "id",
262
- "readOnly": true
263
- },
264
- {
265
- "name": "tranId",
266
- "type": "string",
267
- "tag": "record.displayId",
268
- "readOnly": true
269
- },
270
- {
271
- "name": "externalId",
272
- "type": "string",
273
- "tag": "record.externalId"
274
- },
275
- {
276
- "name": "entity.id",
277
- "type": "string"
278
- },
279
- {
280
- "name": "createdFrom.id",
281
- "type": "string"
282
- },
283
- {
284
- "name": "tranDate",
285
- "type": "date"
286
- },
287
- {
288
- "name": "memo",
289
- "type": "text"
290
- },
291
- {
292
- "name": "total",
293
- "type": "number",
294
- "readOnly": true
295
- },
296
- {
297
- "name": "item.items",
298
- "type": "lineItem[]"
299
- }
300
- ]
301
- }
302
- },
303
- "events": {
304
- "itemFulfillment.created": {
305
- "delivery": "poll",
306
- "object": "itemFulfillment",
307
- "description": "Polled with SuiteQL on transaction.lastModifiedDate. NetSuite has no outbound webhooks without a deployed SuiteScript.",
308
- "payload": {
309
- "id": "88120",
310
- "tranId": "IF-10391",
311
- "createdFrom": {
312
- "id": "87904",
313
- "refName": "Sales Order #SO-20455"
314
- },
315
- "tranDate": "2026-10-19",
316
- "shipStatus": "_shipped",
317
- "package": {
318
- "packages": [
319
- {
320
- "packageTrackingNumber": "1Z999AA10123456784",
321
- "packageWeight": 2.1,
322
- "packageDescr": "Box 1 of 1"
323
- }
324
- ]
325
- },
326
- "lastModifiedDate": "2026-10-19T19:02:11Z"
327
- }
328
- },
329
- "customer.updated": {
330
- "delivery": "poll",
331
- "object": "customer",
332
- "description": "Polled with SuiteQL on customer.lastModifiedDate.",
333
- "payload": {
334
- "id": "40211",
335
- "entityId": "CUST-40211",
336
- "email": "dana.reyes@example.com",
337
- "firstName": "Dana",
338
- "lastName": "Reyes",
339
- "companyName": "Reyes Coffee Co",
340
- "lastModifiedDate": "2026-10-18T15:00:00Z"
341
- }
342
- }
343
- },
344
- "capabilities": {
345
- "customer.get": {
346
- "kind": "read",
347
- "method": "getCustomer",
348
- "input": {
349
- "id": {
350
- "type": "string",
351
- "required": true
352
- }
353
- },
354
- "output": "customer"
355
- },
356
- "customer.search": {
357
- "kind": "search",
358
- "method": "searchCustomers",
359
- "input": {
360
- "email": {
361
- "type": "string"
362
- },
363
- "externalId": {
364
- "type": "string"
365
- }
366
- },
367
- "output": "customer[]"
368
- },
369
- "customer.list": {
370
- "kind": "read",
371
- "method": "listCustomers",
372
- "input": {
373
- "lastModifiedAfter": {
374
- "type": "string"
375
- },
376
- "limit": {
377
- "type": "number"
378
- },
379
- "offset": {
380
- "type": "number"
381
- }
382
- },
383
- "output": "page<customer>"
384
- },
385
- "customer.create": {
386
- "kind": "write",
387
- "method": "createCustomer",
388
- "input": {
389
- "record": {
390
- "type": "object",
391
- "required": true
392
- }
393
- },
394
- "output": "customer"
395
- },
396
- "customer.update": {
397
- "kind": "write",
398
- "method": "updateCustomer",
399
- "input": {
400
- "id": {
401
- "type": "string",
402
- "required": true
403
- },
404
- "record": {
405
- "type": "object",
406
- "required": true
407
- }
408
- },
409
- "output": "customer"
410
- },
411
- "salesOrder.create": {
412
- "kind": "write",
413
- "method": "createSalesOrder",
414
- "input": {
415
- "record": {
416
- "type": "object",
417
- "required": true
418
- }
419
- },
420
- "output": "salesOrder"
421
- },
422
- "salesOrder.get": {
423
- "kind": "read",
424
- "method": "getSalesOrder",
425
- "input": {
426
- "id": {
427
- "type": "string",
428
- "required": true
429
- },
430
- "expandSubResources": {
431
- "type": "boolean"
432
- }
433
- },
434
- "output": "salesOrder"
435
- },
436
- "salesOrder.update": {
437
- "kind": "write",
438
- "method": "updateSalesOrder",
439
- "input": {
440
- "id": {
441
- "type": "string",
442
- "required": true
443
- },
444
- "record": {
445
- "type": "object",
446
- "required": true
447
- }
448
- },
449
- "output": "salesOrder"
450
- },
451
- "salesOrder.search": {
452
- "kind": "search",
453
- "method": "searchSalesOrders",
454
- "input": {
455
- "otherRefNum": {
456
- "type": "string"
457
- },
458
- "externalId": {
459
- "type": "string"
460
- }
461
- },
462
- "output": "salesOrder[]"
463
- },
464
- "creditMemo.create": {
465
- "kind": "write",
466
- "method": "createCreditMemo",
467
- "input": {
468
- "record": {
469
- "type": "object",
470
- "required": true
471
- }
472
- },
473
- "output": "creditMemo"
474
- },
475
- "itemFulfillment.get": {
476
- "kind": "read",
477
- "method": "getItemFulfillment",
478
- "input": {
479
- "id": {
480
- "type": "string",
481
- "required": true
482
- }
483
- },
484
- "output": "itemFulfillment"
485
- },
486
- "itemFulfillment.list": {
487
- "kind": "read",
488
- "method": "listItemFulfillments",
489
- "input": {
490
- "modifiedAfter": {
491
- "type": "string"
492
- },
493
- "limit": {
494
- "type": "number"
495
- }
496
- },
497
- "output": "itemFulfillment[]"
498
- },
499
- "item.search": {
500
- "kind": "search",
501
- "method": "searchItems",
502
- "input": {
503
- "sku": {
504
- "type": "string",
505
- "required": true
506
- }
507
- },
508
- "output": "item[]"
509
- },
510
- "subsidiary.list": {
511
- "kind": "read",
512
- "method": "listSubsidiaries",
513
- "input": {},
514
- "output": "subsidiary[]"
515
- },
516
- "location.list": {
517
- "kind": "read",
518
- "method": "listLocations",
519
- "input": {},
520
- "output": "location[]"
521
- }
522
- },
523
- "options": {
524
- "subsidiary": {
525
- "capability": "subsidiary.list",
526
- "label": "{{item.name}}",
527
- "value": "$.item.id"
528
- },
529
- "location": {
530
- "capability": "location.list",
531
- "label": "{{item.name}}",
532
- "value": "$.item.id"
533
- }
534
- }
535
- }