digital-tools 2.0.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.
- package/.turbo/turbo-build.log +5 -0
- package/CHANGELOG.md +9 -0
- package/README.md +1144 -0
- package/dist/define.d.ts +109 -0
- package/dist/define.d.ts.map +1 -0
- package/dist/define.js +268 -0
- package/dist/define.js.map +1 -0
- package/dist/entities/advertising.d.ts +79 -0
- package/dist/entities/advertising.d.ts.map +1 -0
- package/dist/entities/advertising.js +1000 -0
- package/dist/entities/advertising.js.map +1 -0
- package/dist/entities/ai.d.ts +69 -0
- package/dist/entities/ai.d.ts.map +1 -0
- package/dist/entities/ai.js +757 -0
- package/dist/entities/ai.js.map +1 -0
- package/dist/entities/analytics.d.ts +83 -0
- package/dist/entities/analytics.d.ts.map +1 -0
- package/dist/entities/analytics.js +1589 -0
- package/dist/entities/analytics.js.map +1 -0
- package/dist/entities/automation.d.ts +61 -0
- package/dist/entities/automation.d.ts.map +1 -0
- package/dist/entities/automation.js +602 -0
- package/dist/entities/automation.js.map +1 -0
- package/dist/entities/communication.d.ts +96 -0
- package/dist/entities/communication.d.ts.map +1 -0
- package/dist/entities/communication.js +1151 -0
- package/dist/entities/communication.js.map +1 -0
- package/dist/entities/crm.d.ts +91 -0
- package/dist/entities/crm.d.ts.map +1 -0
- package/dist/entities/crm.js +1387 -0
- package/dist/entities/crm.js.map +1 -0
- package/dist/entities/design.d.ts +61 -0
- package/dist/entities/design.d.ts.map +1 -0
- package/dist/entities/design.js +547 -0
- package/dist/entities/design.js.map +1 -0
- package/dist/entities/development.d.ts +145 -0
- package/dist/entities/development.d.ts.map +1 -0
- package/dist/entities/development.js +2213 -0
- package/dist/entities/development.js.map +1 -0
- package/dist/entities/document.d.ts +54 -0
- package/dist/entities/document.d.ts.map +1 -0
- package/dist/entities/document.js +875 -0
- package/dist/entities/document.js.map +1 -0
- package/dist/entities/ecommerce.d.ts +93 -0
- package/dist/entities/ecommerce.d.ts.map +1 -0
- package/dist/entities/ecommerce.js +1430 -0
- package/dist/entities/ecommerce.js.map +1 -0
- package/dist/entities/experiment.d.ts +89 -0
- package/dist/entities/experiment.d.ts.map +1 -0
- package/dist/entities/experiment.js +1040 -0
- package/dist/entities/experiment.js.map +1 -0
- package/dist/entities/finance.d.ts +272 -0
- package/dist/entities/finance.d.ts.map +1 -0
- package/dist/entities/finance.js +3479 -0
- package/dist/entities/finance.js.map +1 -0
- package/dist/entities/forms.d.ts +91 -0
- package/dist/entities/forms.d.ts.map +1 -0
- package/dist/entities/forms.js +1893 -0
- package/dist/entities/forms.js.map +1 -0
- package/dist/entities/hr.d.ts +62 -0
- package/dist/entities/hr.d.ts.map +1 -0
- package/dist/entities/hr.js +662 -0
- package/dist/entities/hr.js.map +1 -0
- package/dist/entities/identity.d.ts +90 -0
- package/dist/entities/identity.d.ts.map +1 -0
- package/dist/entities/identity.js +998 -0
- package/dist/entities/identity.js.map +1 -0
- package/dist/entities/index.d.ts +410 -0
- package/dist/entities/index.d.ts.map +1 -0
- package/dist/entities/index.js +283 -0
- package/dist/entities/index.js.map +1 -0
- package/dist/entities/infrastructure.d.ts +98 -0
- package/dist/entities/infrastructure.d.ts.map +1 -0
- package/dist/entities/infrastructure.js +1154 -0
- package/dist/entities/infrastructure.js.map +1 -0
- package/dist/entities/knowledge.d.ts +98 -0
- package/dist/entities/knowledge.d.ts.map +1 -0
- package/dist/entities/knowledge.js +1439 -0
- package/dist/entities/knowledge.js.map +1 -0
- package/dist/entities/marketing.d.ts +82 -0
- package/dist/entities/marketing.d.ts.map +1 -0
- package/dist/entities/marketing.js +1611 -0
- package/dist/entities/marketing.js.map +1 -0
- package/dist/entities/media.d.ts +83 -0
- package/dist/entities/media.d.ts.map +1 -0
- package/dist/entities/media.js +1635 -0
- package/dist/entities/media.js.map +1 -0
- package/dist/entities/notification.d.ts +76 -0
- package/dist/entities/notification.d.ts.map +1 -0
- package/dist/entities/notification.js +1200 -0
- package/dist/entities/notification.js.map +1 -0
- package/dist/entities/presentation.d.ts +61 -0
- package/dist/entities/presentation.d.ts.map +1 -0
- package/dist/entities/presentation.js +1275 -0
- package/dist/entities/presentation.js.map +1 -0
- package/dist/entities/productivity.d.ts +92 -0
- package/dist/entities/productivity.d.ts.map +1 -0
- package/dist/entities/productivity.js +1318 -0
- package/dist/entities/productivity.js.map +1 -0
- package/dist/entities/project-management.d.ts +89 -0
- package/dist/entities/project-management.d.ts.map +1 -0
- package/dist/entities/project-management.js +1137 -0
- package/dist/entities/project-management.js.map +1 -0
- package/dist/entities/recruiting.d.ts +54 -0
- package/dist/entities/recruiting.d.ts.map +1 -0
- package/dist/entities/recruiting.js +737 -0
- package/dist/entities/recruiting.js.map +1 -0
- package/dist/entities/shipping.d.ts +52 -0
- package/dist/entities/shipping.d.ts.map +1 -0
- package/dist/entities/shipping.js +510 -0
- package/dist/entities/shipping.js.map +1 -0
- package/dist/entities/signature.d.ts +83 -0
- package/dist/entities/signature.d.ts.map +1 -0
- package/dist/entities/signature.js +1103 -0
- package/dist/entities/signature.js.map +1 -0
- package/dist/entities/site.d.ts +33 -0
- package/dist/entities/site.d.ts.map +1 -0
- package/dist/entities/site.js +223 -0
- package/dist/entities/site.js.map +1 -0
- package/dist/entities/spreadsheet.d.ts +68 -0
- package/dist/entities/spreadsheet.d.ts.map +1 -0
- package/dist/entities/spreadsheet.js +1342 -0
- package/dist/entities/spreadsheet.js.map +1 -0
- package/dist/entities/storage.d.ts +74 -0
- package/dist/entities/storage.d.ts.map +1 -0
- package/dist/entities/storage.js +1199 -0
- package/dist/entities/storage.js.map +1 -0
- package/dist/entities/support.d.ts +83 -0
- package/dist/entities/support.d.ts.map +1 -0
- package/dist/entities/support.js +1167 -0
- package/dist/entities/support.js.map +1 -0
- package/dist/entities/video-conferencing.d.ts +129 -0
- package/dist/entities/video-conferencing.d.ts.map +1 -0
- package/dist/entities/video-conferencing.js +1751 -0
- package/dist/entities/video-conferencing.js.map +1 -0
- package/dist/entities/video.d.ts +76 -0
- package/dist/entities/video.d.ts.map +1 -0
- package/dist/entities/video.js +951 -0
- package/dist/entities/video.js.map +1 -0
- package/dist/entities.d.ts +147 -0
- package/dist/entities.d.ts.map +1 -0
- package/dist/entities.js +1664 -0
- package/dist/entities.js.map +1 -0
- package/dist/index.d.ts +29 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +75 -0
- package/dist/index.js.map +1 -0
- package/dist/providers/analytics/index.d.ts +19 -0
- package/dist/providers/analytics/index.d.ts.map +1 -0
- package/dist/providers/analytics/index.js +18 -0
- package/dist/providers/analytics/index.js.map +1 -0
- package/dist/providers/analytics/mixpanel.d.ts +25 -0
- package/dist/providers/analytics/mixpanel.d.ts.map +1 -0
- package/dist/providers/analytics/mixpanel.js +256 -0
- package/dist/providers/analytics/mixpanel.js.map +1 -0
- package/dist/providers/calendar/cal-com.d.ts +26 -0
- package/dist/providers/calendar/cal-com.d.ts.map +1 -0
- package/dist/providers/calendar/cal-com.js +304 -0
- package/dist/providers/calendar/cal-com.js.map +1 -0
- package/dist/providers/calendar/google-calendar.d.ts +25 -0
- package/dist/providers/calendar/google-calendar.d.ts.map +1 -0
- package/dist/providers/calendar/google-calendar.js +336 -0
- package/dist/providers/calendar/google-calendar.js.map +1 -0
- package/dist/providers/calendar/index.d.ts +20 -0
- package/dist/providers/calendar/index.d.ts.map +1 -0
- package/dist/providers/calendar/index.js +21 -0
- package/dist/providers/calendar/index.js.map +1 -0
- package/dist/providers/crm/hubspot.d.ts +25 -0
- package/dist/providers/crm/hubspot.d.ts.map +1 -0
- package/dist/providers/crm/hubspot.js +567 -0
- package/dist/providers/crm/hubspot.js.map +1 -0
- package/dist/providers/crm/index.d.ts +19 -0
- package/dist/providers/crm/index.d.ts.map +1 -0
- package/dist/providers/crm/index.js +18 -0
- package/dist/providers/crm/index.js.map +1 -0
- package/dist/providers/development/github.d.ts +25 -0
- package/dist/providers/development/github.d.ts.map +1 -0
- package/dist/providers/development/github.js +473 -0
- package/dist/providers/development/github.js.map +1 -0
- package/dist/providers/development/index.d.ts +19 -0
- package/dist/providers/development/index.d.ts.map +1 -0
- package/dist/providers/development/index.js +18 -0
- package/dist/providers/development/index.js.map +1 -0
- package/dist/providers/ecommerce/index.d.ts +19 -0
- package/dist/providers/ecommerce/index.d.ts.map +1 -0
- package/dist/providers/ecommerce/index.js +18 -0
- package/dist/providers/ecommerce/index.js.map +1 -0
- package/dist/providers/ecommerce/shopify.d.ts +25 -0
- package/dist/providers/ecommerce/shopify.d.ts.map +1 -0
- package/dist/providers/ecommerce/shopify.js +379 -0
- package/dist/providers/ecommerce/shopify.js.map +1 -0
- package/dist/providers/email/index.d.ts +20 -0
- package/dist/providers/email/index.d.ts.map +1 -0
- package/dist/providers/email/index.js +21 -0
- package/dist/providers/email/index.js.map +1 -0
- package/dist/providers/email/resend.d.ts +25 -0
- package/dist/providers/email/resend.d.ts.map +1 -0
- package/dist/providers/email/resend.js +259 -0
- package/dist/providers/email/resend.js.map +1 -0
- package/dist/providers/email/sendgrid.d.ts +25 -0
- package/dist/providers/email/sendgrid.d.ts.map +1 -0
- package/dist/providers/email/sendgrid.js +162 -0
- package/dist/providers/email/sendgrid.js.map +1 -0
- package/dist/providers/finance/index.d.ts +19 -0
- package/dist/providers/finance/index.d.ts.map +1 -0
- package/dist/providers/finance/index.js +18 -0
- package/dist/providers/finance/index.js.map +1 -0
- package/dist/providers/finance/stripe.d.ts +25 -0
- package/dist/providers/finance/stripe.d.ts.map +1 -0
- package/dist/providers/finance/stripe.js +550 -0
- package/dist/providers/finance/stripe.js.map +1 -0
- package/dist/providers/forms/index.d.ts +19 -0
- package/dist/providers/forms/index.d.ts.map +1 -0
- package/dist/providers/forms/index.js +18 -0
- package/dist/providers/forms/index.js.map +1 -0
- package/dist/providers/forms/typeform.d.ts +25 -0
- package/dist/providers/forms/typeform.d.ts.map +1 -0
- package/dist/providers/forms/typeform.js +501 -0
- package/dist/providers/forms/typeform.js.map +1 -0
- package/dist/providers/index.d.ts +56 -0
- package/dist/providers/index.d.ts.map +1 -0
- package/dist/providers/index.js +124 -0
- package/dist/providers/index.js.map +1 -0
- package/dist/providers/knowledge/index.d.ts +19 -0
- package/dist/providers/knowledge/index.d.ts.map +1 -0
- package/dist/providers/knowledge/index.js +18 -0
- package/dist/providers/knowledge/index.js.map +1 -0
- package/dist/providers/knowledge/notion.d.ts +25 -0
- package/dist/providers/knowledge/notion.d.ts.map +1 -0
- package/dist/providers/knowledge/notion.js +390 -0
- package/dist/providers/knowledge/notion.js.map +1 -0
- package/dist/providers/marketing/index.d.ts +19 -0
- package/dist/providers/marketing/index.d.ts.map +1 -0
- package/dist/providers/marketing/index.js +18 -0
- package/dist/providers/marketing/index.js.map +1 -0
- package/dist/providers/marketing/mailchimp.d.ts +25 -0
- package/dist/providers/marketing/mailchimp.d.ts.map +1 -0
- package/dist/providers/marketing/mailchimp.js +444 -0
- package/dist/providers/marketing/mailchimp.js.map +1 -0
- package/dist/providers/media/cloudinary.d.ts +25 -0
- package/dist/providers/media/cloudinary.d.ts.map +1 -0
- package/dist/providers/media/cloudinary.js +319 -0
- package/dist/providers/media/cloudinary.js.map +1 -0
- package/dist/providers/media/index.d.ts +19 -0
- package/dist/providers/media/index.d.ts.map +1 -0
- package/dist/providers/media/index.js +18 -0
- package/dist/providers/media/index.js.map +1 -0
- package/dist/providers/messaging/index.d.ts +24 -0
- package/dist/providers/messaging/index.d.ts.map +1 -0
- package/dist/providers/messaging/index.js +21 -0
- package/dist/providers/messaging/index.js.map +1 -0
- package/dist/providers/messaging/slack.d.ts +25 -0
- package/dist/providers/messaging/slack.d.ts.map +1 -0
- package/dist/providers/messaging/slack.js +394 -0
- package/dist/providers/messaging/slack.js.map +1 -0
- package/dist/providers/messaging/twilio-sms.d.ts +25 -0
- package/dist/providers/messaging/twilio-sms.d.ts.map +1 -0
- package/dist/providers/messaging/twilio-sms.js +250 -0
- package/dist/providers/messaging/twilio-sms.js.map +1 -0
- package/dist/providers/project-management/index.d.ts +19 -0
- package/dist/providers/project-management/index.d.ts.map +1 -0
- package/dist/providers/project-management/index.js +18 -0
- package/dist/providers/project-management/index.js.map +1 -0
- package/dist/providers/project-management/linear.d.ts +25 -0
- package/dist/providers/project-management/linear.d.ts.map +1 -0
- package/dist/providers/project-management/linear.js +576 -0
- package/dist/providers/project-management/linear.js.map +1 -0
- package/dist/providers/registry.d.ts +41 -0
- package/dist/providers/registry.d.ts.map +1 -0
- package/dist/providers/registry.js +87 -0
- package/dist/providers/registry.js.map +1 -0
- package/dist/providers/spreadsheet/google-sheets.d.ts +25 -0
- package/dist/providers/spreadsheet/google-sheets.d.ts.map +1 -0
- package/dist/providers/spreadsheet/google-sheets.js +376 -0
- package/dist/providers/spreadsheet/google-sheets.js.map +1 -0
- package/dist/providers/spreadsheet/index.d.ts +20 -0
- package/dist/providers/spreadsheet/index.d.ts.map +1 -0
- package/dist/providers/spreadsheet/index.js +21 -0
- package/dist/providers/spreadsheet/index.js.map +1 -0
- package/dist/providers/spreadsheet/xlsx.d.ts +26 -0
- package/dist/providers/spreadsheet/xlsx.d.ts.map +1 -0
- package/dist/providers/spreadsheet/xlsx.js +424 -0
- package/dist/providers/spreadsheet/xlsx.js.map +1 -0
- package/dist/providers/storage/index.d.ts +30 -0
- package/dist/providers/storage/index.d.ts.map +1 -0
- package/dist/providers/storage/index.js +25 -0
- package/dist/providers/storage/index.js.map +1 -0
- package/dist/providers/storage/s3.d.ts +25 -0
- package/dist/providers/storage/s3.d.ts.map +1 -0
- package/dist/providers/storage/s3.js +420 -0
- package/dist/providers/storage/s3.js.map +1 -0
- package/dist/providers/support/index.d.ts +19 -0
- package/dist/providers/support/index.d.ts.map +1 -0
- package/dist/providers/support/index.js +18 -0
- package/dist/providers/support/index.js.map +1 -0
- package/dist/providers/support/zendesk.d.ts +25 -0
- package/dist/providers/support/zendesk.d.ts.map +1 -0
- package/dist/providers/support/zendesk.js +374 -0
- package/dist/providers/support/zendesk.js.map +1 -0
- package/dist/providers/tasks/index.d.ts +19 -0
- package/dist/providers/tasks/index.d.ts.map +1 -0
- package/dist/providers/tasks/index.js +18 -0
- package/dist/providers/tasks/index.js.map +1 -0
- package/dist/providers/tasks/todoist.d.ts +25 -0
- package/dist/providers/tasks/todoist.d.ts.map +1 -0
- package/dist/providers/tasks/todoist.js +287 -0
- package/dist/providers/tasks/todoist.js.map +1 -0
- package/dist/providers/types.d.ts +1753 -0
- package/dist/providers/types.d.ts.map +1 -0
- package/dist/providers/types.js +10 -0
- package/dist/providers/types.js.map +1 -0
- package/dist/providers/video-conferencing/google-meet.d.ts +26 -0
- package/dist/providers/video-conferencing/google-meet.d.ts.map +1 -0
- package/dist/providers/video-conferencing/google-meet.js +287 -0
- package/dist/providers/video-conferencing/google-meet.js.map +1 -0
- package/dist/providers/video-conferencing/index.d.ts +22 -0
- package/dist/providers/video-conferencing/index.d.ts.map +1 -0
- package/dist/providers/video-conferencing/index.js +32 -0
- package/dist/providers/video-conferencing/index.js.map +1 -0
- package/dist/providers/video-conferencing/jitsi.d.ts +26 -0
- package/dist/providers/video-conferencing/jitsi.d.ts.map +1 -0
- package/dist/providers/video-conferencing/jitsi.js +255 -0
- package/dist/providers/video-conferencing/jitsi.js.map +1 -0
- package/dist/providers/video-conferencing/teams.d.ts +26 -0
- package/dist/providers/video-conferencing/teams.d.ts.map +1 -0
- package/dist/providers/video-conferencing/teams.js +271 -0
- package/dist/providers/video-conferencing/teams.js.map +1 -0
- package/dist/providers/video-conferencing/zoom.d.ts +25 -0
- package/dist/providers/video-conferencing/zoom.d.ts.map +1 -0
- package/dist/providers/video-conferencing/zoom.js +333 -0
- package/dist/providers/video-conferencing/zoom.js.map +1 -0
- package/dist/providers/voice/vapi.d.ts +27 -0
- package/dist/providers/voice/vapi.d.ts.map +1 -0
- package/dist/providers/voice/vapi.js +440 -0
- package/dist/providers/voice/vapi.js.map +1 -0
- package/dist/registry.d.ts +38 -0
- package/dist/registry.d.ts.map +1 -0
- package/dist/registry.js +129 -0
- package/dist/registry.js.map +1 -0
- package/dist/tools/communication.d.ts +94 -0
- package/dist/tools/communication.d.ts.map +1 -0
- package/dist/tools/communication.js +185 -0
- package/dist/tools/communication.js.map +1 -0
- package/dist/tools/data.d.ts +61 -0
- package/dist/tools/data.d.ts.map +1 -0
- package/dist/tools/data.js +206 -0
- package/dist/tools/data.js.map +1 -0
- package/dist/tools/index.d.ts +12 -0
- package/dist/tools/index.d.ts.map +1 -0
- package/dist/tools/index.js +12 -0
- package/dist/tools/index.js.map +1 -0
- package/dist/tools/web.d.ts +45 -0
- package/dist/tools/web.d.ts.map +1 -0
- package/dist/tools/web.js +138 -0
- package/dist/tools/web.js.map +1 -0
- package/dist/types.d.ts +330 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +11 -0
- package/dist/types.js.map +1 -0
- package/package.json +45 -0
- package/src/define.ts +321 -0
- package/src/entities/advertising.ts +1086 -0
- package/src/entities/ai.ts +835 -0
- package/src/entities/analytics.ts +1690 -0
- package/src/entities/automation.ts +669 -0
- package/src/entities/communication.ts +1255 -0
- package/src/entities/crm.ts +1481 -0
- package/src/entities/design.ts +606 -0
- package/src/entities/development.ts +2392 -0
- package/src/entities/document.ts +930 -0
- package/src/entities/ecommerce.ts +1539 -0
- package/src/entities/experiment.ts +1139 -0
- package/src/entities/finance.ts +3907 -0
- package/src/entities/forms.ts +2021 -0
- package/src/entities/hr.ts +725 -0
- package/src/entities/identity.ts +1093 -0
- package/src/entities/index.ts +731 -0
- package/src/entities/infrastructure.ts +1254 -0
- package/src/entities/knowledge.ts +1547 -0
- package/src/entities/marketing.ts +1718 -0
- package/src/entities/media.ts +1747 -0
- package/src/entities/notification.ts +1260 -0
- package/src/entities/presentation.ts +1360 -0
- package/src/entities/productivity.ts +1411 -0
- package/src/entities/project-management.ts +1222 -0
- package/src/entities/recruiting.ts +797 -0
- package/src/entities/shipping.ts +566 -0
- package/src/entities/signature.ts +1204 -0
- package/src/entities/site.ts +244 -0
- package/src/entities/spreadsheet.ts +1434 -0
- package/src/entities/storage.ts +1290 -0
- package/src/entities/support.ts +1267 -0
- package/src/entities/video-conferencing.ts +1874 -0
- package/src/entities/video.ts +1035 -0
- package/src/entities.ts +1795 -0
- package/src/index.ts +176 -0
- package/src/providers/analytics/index.ts +21 -0
- package/src/providers/analytics/mixpanel.ts +311 -0
- package/src/providers/calendar/cal-com.ts +435 -0
- package/src/providers/calendar/google-calendar.ts +412 -0
- package/src/providers/calendar/index.ts +24 -0
- package/src/providers/crm/hubspot.ts +667 -0
- package/src/providers/crm/index.ts +21 -0
- package/src/providers/development/github.ts +608 -0
- package/src/providers/development/index.ts +21 -0
- package/src/providers/ecommerce/index.ts +21 -0
- package/src/providers/ecommerce/shopify.ts +451 -0
- package/src/providers/email/index.ts +24 -0
- package/src/providers/email/resend.ts +301 -0
- package/src/providers/email/sendgrid.ts +196 -0
- package/src/providers/finance/index.ts +21 -0
- package/src/providers/finance/stripe.ts +665 -0
- package/src/providers/forms/index.ts +21 -0
- package/src/providers/forms/typeform.ts +598 -0
- package/src/providers/index.ts +281 -0
- package/src/providers/knowledge/index.ts +21 -0
- package/src/providers/knowledge/notion.ts +497 -0
- package/src/providers/marketing/index.ts +21 -0
- package/src/providers/marketing/mailchimp.ts +656 -0
- package/src/providers/media/cloudinary.ts +373 -0
- package/src/providers/media/index.ts +21 -0
- package/src/providers/messaging/index.ts +24 -0
- package/src/providers/messaging/slack.ts +487 -0
- package/src/providers/messaging/twilio-sms.ts +301 -0
- package/src/providers/project-management/index.ts +21 -0
- package/src/providers/project-management/linear.ts +693 -0
- package/src/providers/registry.ts +119 -0
- package/src/providers/spreadsheet/google-sheets.ts +464 -0
- package/src/providers/spreadsheet/index.ts +24 -0
- package/src/providers/spreadsheet/xlsx.ts +542 -0
- package/src/providers/storage/index.ts +35 -0
- package/src/providers/storage/s3.ts +513 -0
- package/src/providers/support/index.ts +21 -0
- package/src/providers/support/zendesk.ts +417 -0
- package/src/providers/tasks/index.ts +21 -0
- package/src/providers/tasks/todoist.ts +407 -0
- package/src/providers/types.ts +2113 -0
- package/src/providers/video-conferencing/google-meet.ts +412 -0
- package/src/providers/video-conferencing/index.ts +35 -0
- package/src/providers/video-conferencing/jitsi.ts +324 -0
- package/src/providers/video-conferencing/teams.ts +408 -0
- package/src/providers/video-conferencing/zoom.ts +451 -0
- package/src/registry.ts +172 -0
- package/src/tools/communication.ts +256 -0
- package/src/tools/data.ts +236 -0
- package/src/tools/index.ts +12 -0
- package/src/tools/web.ts +161 -0
- package/src/types.ts +539 -0
- package/test/define.test.ts +367 -0
- package/test/registry.test.ts +444 -0
- package/test/tools.test.ts +453 -0
- package/tsconfig.json +20 -0
package/README.md
ADDED
|
@@ -0,0 +1,1144 @@
|
|
|
1
|
+
# Digital Tools
|
|
2
|
+
|
|
3
|
+
Entity types (Nouns) and providers for digital tools usable by both humans and AI agents.
|
|
4
|
+
|
|
5
|
+
## Categories
|
|
6
|
+
|
|
7
|
+
All categories use **single-word identifiers** for use as JS/TS variables, components, and functions.
|
|
8
|
+
|
|
9
|
+
| Category | Description | Providers |
|
|
10
|
+
|----------|-------------|-----------|
|
|
11
|
+
| `site` | Deployed web presence with type enumeration | Vercel, Netlify, Cloudflare |
|
|
12
|
+
| `message` | Email, text, chat, voice, video | SendGrid, Resend, Slack, Twilio, Vapi |
|
|
13
|
+
| `productivity` | Calendar, tasks, notes, availability | Google Calendar, Cal.com |
|
|
14
|
+
| `project` | Projects, issues, sprints | Linear, Jira |
|
|
15
|
+
| `code` | Repositories, PRs, commits | GitHub, GitLab |
|
|
16
|
+
| `sales` | Leads, deals, accounts | HubSpot, Salesforce |
|
|
17
|
+
| `finance` | Payments, billing, treasury | Stripe |
|
|
18
|
+
| `support` | Tickets, conversations, help | Zendesk, Intercom |
|
|
19
|
+
| `media` | Images, videos, audio | Cloudinary |
|
|
20
|
+
| `marketing` | Campaigns, audiences | Mailchimp, ConvertKit |
|
|
21
|
+
| `knowledge` | Wiki, articles, glossary | Notion, Confluence |
|
|
22
|
+
| `commerce` | Products, orders, carts | Shopify, Stripe |
|
|
23
|
+
| `analytics` | Reports, dashboards, metrics | Mixpanel, Amplitude |
|
|
24
|
+
| `storage` | Files, folders, drives | AWS S3, Google Cloud Storage |
|
|
25
|
+
| `meeting` | Video conferencing, scheduling, resources | Zoom, Google Meet, Teams, Cal.com |
|
|
26
|
+
| `form` | Forms, surveys, quizzes | Typeform, Tally |
|
|
27
|
+
| `signature` | E-signatures, documents | DocuSign, DocuSeal |
|
|
28
|
+
| `document` | Word processing | Google Docs, Office365 |
|
|
29
|
+
| `spreadsheet` | Data tables, formulas | Google Sheets, Excel |
|
|
30
|
+
| `presentation` | Slides, decks | Google Slides, PowerPoint |
|
|
31
|
+
| `infrastructure` | Config, database, hosting, functions | Firebase, GCP, AWS |
|
|
32
|
+
| `experiment` | Analytics, A/B testing, feature flags | LaunchDarkly, Amplitude |
|
|
33
|
+
| `advertising` | Google Ads, Meta Ads, campaigns | Google Ads, Meta Ads |
|
|
34
|
+
| `video` | YouTube, Twitch, video platforms | YouTube, Twitch |
|
|
35
|
+
| `identity` | SSO, directory, secrets, audit | WorkOS, Auth0 |
|
|
36
|
+
| `notification` | Push, SMS, email, in-app | OneSignal, Twilio |
|
|
37
|
+
| `hr` | Employees, teams, time off | Gusto, Rippling |
|
|
38
|
+
| `recruiting` | Jobs, candidates, interviews | Lever, Greenhouse |
|
|
39
|
+
| `design` | Figma, Sketch, design systems | Figma, Sketch |
|
|
40
|
+
| `shipping` | Shipments, packages, carriers | EasyPost, ShipEngine |
|
|
41
|
+
| `automation` | Workflows, triggers, actions | Zapier, n8n, Make |
|
|
42
|
+
| `ai` | Models, prompts, agents | OpenAI, Anthropic |
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## Entity Abstractions
|
|
47
|
+
|
|
48
|
+
Each entity defines **Properties** (data fields), **Actions** (imperative verbs), and **Events** (past tense state changes).
|
|
49
|
+
|
|
50
|
+
### Site
|
|
51
|
+
|
|
52
|
+
Deployed web presence with type enumeration.
|
|
53
|
+
|
|
54
|
+
#### Properties
|
|
55
|
+
|
|
56
|
+
| Entity | Key Properties |
|
|
57
|
+
|--------|----------------|
|
|
58
|
+
| **Site** | `name`, `type` (website, app, api, admin, docs, blog, store, portal, landing, dashboard), `url`, `status`, `environment` |
|
|
59
|
+
|
|
60
|
+
#### Actions & Events
|
|
61
|
+
|
|
62
|
+
| Entity | Actions | Events |
|
|
63
|
+
|--------|---------|--------|
|
|
64
|
+
| **Site** | create, deploy, configure, publish, unpublish, archive | created, deployed, configured, published, unpublished, archived |
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
### Message
|
|
69
|
+
|
|
70
|
+
Unified communication entities using single-word nouns. The `type` property distinguishes variants.
|
|
71
|
+
|
|
72
|
+
#### Properties
|
|
73
|
+
|
|
74
|
+
| Entity | Key Properties |
|
|
75
|
+
|--------|----------------|
|
|
76
|
+
| **Message** | `type` (email, text, chat, direct, voicemail), `from`, `to`, `subject`, `body`, `status`, `threadId`, `read`, `starred` |
|
|
77
|
+
| **Thread** | `type`, `subject`, `snippet`, `messageCount`, `participants`, `read`, `archived`, `muted` |
|
|
78
|
+
| **Call** | `type` (phone, web, video), `direction`, `from`, `to`, `status`, `duration`, `recordingUrl`, `transcription` |
|
|
79
|
+
| **Channel** | `name`, `type` (public, private, shared), `topic`, `description`, `archived`, `memberCount` |
|
|
80
|
+
| **Workspace** | `name`, `domain`, `description`, `icon`, `memberCount`, `channelCount` |
|
|
81
|
+
| **Member** | `userId`, `name`, `email`, `role`, `status`, `lastActiveAt`, `joinedAt` |
|
|
82
|
+
| **Contact** | `name`, `firstName`, `lastName`, `email`, `phone`, `company`, `title`, `tags` |
|
|
83
|
+
| **Attachment** | `name`, `type`, `size`, `url`, `thumbnail` |
|
|
84
|
+
| **Reaction** | `emoji`, `name`, `count` |
|
|
85
|
+
|
|
86
|
+
#### Actions & Events
|
|
87
|
+
|
|
88
|
+
| Entity | Actions | Events |
|
|
89
|
+
|--------|---------|--------|
|
|
90
|
+
| **Message** | send, reply, forward, edit, delete, archive, star, read, label, pin, react, transcribe | sent, delivered, read, failed, bounced, opened, clicked, replied, forwarded, edited, deleted, archived, starred, labeled, pinned, reacted, transcribed |
|
|
91
|
+
| **Thread** | archive, unarchive, delete, read, unread, mute, unmute, star, pin, label, move | created, updated, archived, deleted, read, muted, unmuted, starred, pinned, labeled, moved |
|
|
92
|
+
| **Call** | initiate, answer, reject, hold, unhold, mute, unmute, transfer, merge, record, transcribe, end | initiated, ringing, answered, rejected, held, muted, transferred, merged, recorded, transcribed, ended, failed |
|
|
93
|
+
| **Channel** | create, rename, setTopic, archive, unarchive, delete, join, leave, invite, kick, mute, unmute, pin, unpin | created, renamed, topicSet, archived, unarchived, deleted, joined, left, invited, kicked, muted, unmuted, pinned, unpinned |
|
|
94
|
+
| **Workspace** | create, rename, invite, remove, archive, delete, transfer | created, renamed, invited, removed, archived, deleted, transferred |
|
|
95
|
+
| **Member** | invite, remove, promote, demote, activate, deactivate, setStatus | invited, joined, removed, promoted, demoted, activated, deactivated, statusChanged |
|
|
96
|
+
| **Contact** | create, update, delete, merge, tag, untag, block, unblock | created, updated, deleted, merged, tagged, blocked, unblocked |
|
|
97
|
+
| **Attachment** | upload, download, preview, delete | uploaded, downloaded, previewed, deleted |
|
|
98
|
+
| **Reaction** | add, remove | added, removed |
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
### Productivity
|
|
103
|
+
|
|
104
|
+
Calendar, tasks, note-taking, and availability entities.
|
|
105
|
+
|
|
106
|
+
#### Properties
|
|
107
|
+
|
|
108
|
+
| Entity | Key Properties |
|
|
109
|
+
|--------|----------------|
|
|
110
|
+
| **Calendar** | `name`, `description`, `color`, `timezone`, `visibility`, `accessRole`, `primary` |
|
|
111
|
+
| **Event** | `title`, `description`, `location`, `startTime`, `endTime`, `allDay`, `recurring`, `recurrenceRule`, `status`, `attendees`, `conferenceData` |
|
|
112
|
+
| **Availability** | `name`, `timezone`, `schedule`, `dateOverrides`, `bufferBefore`, `bufferAfter`, `minimumNotice`, `daysInAdvance`, `active` |
|
|
113
|
+
| **Task** | `title`, `description`, `status`, `completed`, `dueDate`, `priority`, `assignee`, `tags`, `progress`, `blockedBy` |
|
|
114
|
+
| **Checklist** | `title`, `description`, `itemCount`, `completedCount`, `progress`, `template` |
|
|
115
|
+
| **Note** | `title`, `content`, `format`, `folder`, `tags`, `pinned`, `archived`, `shared`, `wordCount` |
|
|
116
|
+
| **Notebook** | `name`, `description`, `color`, `icon`, `type`, `noteCount`, `shared` |
|
|
117
|
+
| **Reminder** | `title`, `description`, `dueDate`, `recurring`, `completed`, `snoozedUntil`, `priority`, `notificationMethod` |
|
|
118
|
+
| **Bookmark** | `title`, `url`, `description`, `favicon`, `screenshot`, `folder`, `tags`, `favorited`, `archived` |
|
|
119
|
+
|
|
120
|
+
#### Actions & Events
|
|
121
|
+
|
|
122
|
+
| Entity | Actions | Events |
|
|
123
|
+
|--------|---------|--------|
|
|
124
|
+
| **Calendar** | create, update, delete, share, unshare, subscribe, unsubscribe, export, import, sync, setColor, setTimezone | created, updated, deleted, shared, unshared, subscribed, unsubscribed, exported, imported, synced |
|
|
125
|
+
| **Event** | create, update, delete, cancel, reschedule, invite, respond, accept, decline, markTentative, addAttendee, removeAttendee, addReminder, removeReminder, duplicate, move | created, updated, deleted, cancelled, rescheduled, invitationSent, responseReceived, accepted, declined, tentative, attendeeAdded, attendeeRemoved, reminderTriggered, started, ended |
|
|
126
|
+
| **Availability** | create, update, delete, activate, deactivate, setDefault, addOverride, removeOverride, blockDate, unblockDate | created, updated, deleted, activated, deactivated, overrideAdded, overrideRemoved, dateBlocked, dateUnblocked |
|
|
127
|
+
| **Task** | create, update, delete, complete, uncomplete, start, pause, block, unblock, assign, unassign, setPriority, setDueDate, addSubtask, removeSubtask, addTag, removeTag, move, duplicate, archive | created, updated, deleted, completed, uncompleted, started, paused, blocked, unblocked, assigned, unassigned, priorityChanged, dueDateChanged, overdue, subtaskAdded, subtaskCompleted, commented, archived |
|
|
128
|
+
| **Checklist** | create, update, delete, addItem, removeItem, checkItem, uncheckItem, reorderItems, clear, reset, duplicate, convertToTemplate | created, updated, deleted, itemAdded, itemRemoved, itemChecked, itemUnchecked, itemsReordered, cleared, completed, duplicated |
|
|
129
|
+
| **Note** | create, update, delete, archive, unarchive, pin, unpin, favorite, unfavorite, lock, unlock, share, unshare, duplicate, export, print, addTag, removeTag, move, merge | created, updated, deleted, archived, unarchived, pinned, unpinned, favorited, unfavorited, locked, unlocked, shared, unshared, duplicated, exported, printed, moved, merged |
|
|
130
|
+
| **Notebook** | create, update, delete, rename, share, unshare, move, duplicate, export, import, merge, archive | created, updated, deleted, renamed, shared, unshared, moved, duplicated, exported, imported, merged, archived |
|
|
131
|
+
| **Reminder** | create, update, delete, complete, uncomplete, snooze, dismiss, trigger, reschedule, duplicate | created, updated, deleted, completed, uncompleted, snoozed, dismissed, triggered, rescheduled, duplicated |
|
|
132
|
+
| **Bookmark** | create, update, delete, visit, favorite, unfavorite, archive, unarchive, addTag, removeTag, move, share, export, import | created, updated, deleted, visited, favorited, unfavorited, archived, unarchived, moved, shared, exported, imported |
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
### Project
|
|
137
|
+
|
|
138
|
+
Project management entities for issues, sprints, and boards.
|
|
139
|
+
|
|
140
|
+
#### Properties
|
|
141
|
+
|
|
142
|
+
| Entity | Key Properties |
|
|
143
|
+
|--------|----------------|
|
|
144
|
+
| **Project** | `name`, `key`, `description`, `status`, `progress`, `health`, `startDate`, `endDate`, `visibility`, `archived` |
|
|
145
|
+
| **Issue** | `title`, `identifier`, `description`, `type`, `priority`, `severity`, `status`, `progress`, `dueDate`, `estimate`, `storyPoints` |
|
|
146
|
+
| **Sprint** | `name`, `number`, `goal`, `status`, `startDate`, `endDate`, `capacity`, `commitment`, `completed`, `velocity` |
|
|
147
|
+
| **Milestone** | `name`, `description`, `version`, `status`, `progress`, `targetDate`, `completedAt` |
|
|
148
|
+
| **Board** | `name`, `description`, `type` (kanban, scrum, list), `swimlanes`, `visibility`, `archived` |
|
|
149
|
+
| **Column** | `name`, `description`, `color`, `position`, `wipLimit`, `statusCategory` |
|
|
150
|
+
| **Epic** | `name`, `identifier`, `description`, `status`, `progress`, `startDate`, `targetDate`, `storyPoints` |
|
|
151
|
+
| **Label** | `name`, `description`, `color`, `icon`, `category` |
|
|
152
|
+
|
|
153
|
+
#### Actions & Events
|
|
154
|
+
|
|
155
|
+
| Entity | Actions | Events |
|
|
156
|
+
|--------|---------|--------|
|
|
157
|
+
| **Project** | create, update, delete, archive, restore, duplicate, setStatus, addMember, removeMember, setOwner, setDates, updateProgress, export | created, updated, deleted, archived, restored, duplicated, statusChanged, memberAdded, memberRemoved, ownerChanged, datesChanged, progressUpdated, completed, cancelled |
|
|
158
|
+
| **Issue** | create, update, delete, archive, restore, duplicate, assign, unassign, setStatus, setPriority, setType, addLabel, removeLabel, addSubtask, link, unlink, block, unblock, move, comment, estimate, logTime, watch, unwatch | created, updated, deleted, archived, restored, duplicated, assigned, unassigned, statusChanged, priorityChanged, typeChanged, labeled, unlabeled, subtaskAdded, linked, unlinked, blocked, unblocked, moved, commented, estimated, timeLogged, completed, reopened |
|
|
159
|
+
| **Sprint** | create, update, delete, start, complete, cancel, addIssue, removeIssue, setGoal, setCapacity, extend | created, updated, deleted, started, completed, cancelled, issueAdded, issueRemoved, goalChanged, capacityChanged, extended |
|
|
160
|
+
| **Milestone** | create, update, delete, archive, restore, complete, cancel, addIssue, removeIssue, setTargetDate | created, updated, deleted, archived, restored, completed, cancelled, issueAdded, issueRemoved, targetDateChanged, delayed |
|
|
161
|
+
| **Board** | create, update, delete, archive, restore, duplicate, addColumn, removeColumn, reorderColumns, addMember, removeMember, setSwimlanes | created, updated, deleted, archived, restored, duplicated, columnAdded, columnRemoved, columnsReordered, memberAdded, memberRemoved, swimlanesChanged |
|
|
162
|
+
| **Column** | create, update, delete, rename, move, setColor, setWipLimit | created, updated, deleted, renamed, moved, colorChanged, wipLimitChanged, wipLimitExceeded |
|
|
163
|
+
| **Epic** | create, update, delete, archive, restore, setStatus, addIssue, removeIssue, setDates, addLabel, removeLabel | created, updated, deleted, archived, restored, statusChanged, issueAdded, issueRemoved, datesChanged, labeled, unlabeled, completed, cancelled |
|
|
164
|
+
| **Label** | create, update, delete, rename, setColor, merge | created, updated, deleted, renamed, colorChanged, merged, applied, removed |
|
|
165
|
+
|
|
166
|
+
---
|
|
167
|
+
|
|
168
|
+
### Code
|
|
169
|
+
|
|
170
|
+
Software development entities for repositories and version control.
|
|
171
|
+
|
|
172
|
+
#### Properties
|
|
173
|
+
|
|
174
|
+
| Entity | Key Properties |
|
|
175
|
+
|--------|----------------|
|
|
176
|
+
| **Repository** | `name`, `description`, `visibility`, `defaultBranch`, `language`, `topics`, `archived`, `forksCount`, `starsCount` |
|
|
177
|
+
| **Branch** | `name`, `protected`, `isDefault`, `headCommit`, `behindBy`, `aheadBy` |
|
|
178
|
+
| **Commit** | `sha`, `message`, `author`, `committer`, `timestamp`, `parents`, `additions`, `deletions` |
|
|
179
|
+
| **PullRequest** | `number`, `title`, `description`, `status`, `sourceBranch`, `targetBranch`, `author`, `reviewers`, `merged` |
|
|
180
|
+
| **CodeReview** | `state`, `body`, `author`, `submittedAt`, `comments` |
|
|
181
|
+
| **CodeIssue** | `number`, `title`, `description`, `state`, `labels`, `assignees`, `milestone` |
|
|
182
|
+
| **Release** | `tagName`, `name`, `description`, `draft`, `prerelease`, `publishedAt`, `assets` |
|
|
183
|
+
| **Workflow** | `name`, `path`, `state`, `triggers`, `jobs` |
|
|
184
|
+
| **WorkflowRun** | `runNumber`, `status`, `conclusion`, `branch`, `commit`, `startedAt`, `completedAt` |
|
|
185
|
+
|
|
186
|
+
#### Actions & Events
|
|
187
|
+
|
|
188
|
+
| Entity | Actions | Events |
|
|
189
|
+
|--------|---------|--------|
|
|
190
|
+
| **Repository** | create, clone, fork, archive, unarchive, delete, rename, transfer, setVisibility, addTopic, removeTopic | created, cloned, forked, archived, unarchived, deleted, renamed, transferred, visibilityChanged |
|
|
191
|
+
| **Branch** | create, checkout, merge, delete, protect, unprotect, rename | created, checkedOut, merged, deleted, protected, unprotected, renamed |
|
|
192
|
+
| **Commit** | create, revert, cherryPick, amend | created, reverted, cherryPicked, amended |
|
|
193
|
+
| **PullRequest** | create, update, review, approve, requestChanges, merge, close, reopen, assignReviewer, removeReviewer | created, updated, reviewed, approved, changesRequested, merged, closed, reopened, reviewerAssigned, reviewerRemoved |
|
|
194
|
+
| **CodeReview** | submit, approve, requestChanges, comment, dismiss | submitted, approved, changesRequested, commented, dismissed |
|
|
195
|
+
| **CodeIssue** | create, update, close, reopen, assign, unassign, label, unlabel, setMilestone | created, updated, closed, reopened, assigned, unassigned, labeled, unlabeled, milestoneSet |
|
|
196
|
+
| **Release** | create, publish, draft, delete, update, uploadAsset | created, published, drafted, deleted, updated, assetUploaded |
|
|
197
|
+
| **Workflow** | create, update, delete, trigger, disable, enable | created, updated, deleted, triggered, disabled, enabled |
|
|
198
|
+
| **WorkflowRun** | trigger, cancel, retry, download, delete | triggered, cancelled, retried, completed, failed, downloaded |
|
|
199
|
+
|
|
200
|
+
---
|
|
201
|
+
|
|
202
|
+
### Sales
|
|
203
|
+
|
|
204
|
+
CRM entities for leads, deals, and customer relationships.
|
|
205
|
+
|
|
206
|
+
#### Properties
|
|
207
|
+
|
|
208
|
+
| Entity | Key Properties |
|
|
209
|
+
|--------|----------------|
|
|
210
|
+
| **Lead** | `firstName`, `lastName`, `email`, `phone`, `company`, `title`, `source`, `status`, `score`, `assignee` |
|
|
211
|
+
| **Deal** | `name`, `value`, `currency`, `stage`, `probability`, `expectedCloseDate`, `closedAt`, `status`, `lostReason` |
|
|
212
|
+
| **Account** | `name`, `domain`, `industry`, `size`, `type`, `owner`, `annualRevenue`, `status` |
|
|
213
|
+
| **Pipeline** | `name`, `description`, `stages`, `default`, `dealCount` |
|
|
214
|
+
| **Stage** | `name`, `probability`, `position`, `type`, `dealCount` |
|
|
215
|
+
| **Activity** | `type`, `subject`, `description`, `dueDate`, `completedAt`, `outcome` |
|
|
216
|
+
| **Quote** | `number`, `name`, `status`, `subtotal`, `discount`, `tax`, `total`, `validUntil`, `acceptedAt` |
|
|
217
|
+
| **QuoteLineItem** | `product`, `description`, `quantity`, `unitPrice`, `discount`, `total` |
|
|
218
|
+
| **Product** | `name`, `code`, `description`, `price`, `currency`, `category`, `active` |
|
|
219
|
+
|
|
220
|
+
#### Actions & Events
|
|
221
|
+
|
|
222
|
+
| Entity | Actions | Events |
|
|
223
|
+
|--------|---------|--------|
|
|
224
|
+
| **Lead** | create, update, delete, qualify, convert, disqualify, assign, unassign, merge, score | created, updated, deleted, qualified, converted, disqualified, assigned, unassigned, merged, scored |
|
|
225
|
+
| **Deal** | create, update, delete, win, lose, advance, setStage, setOwner, addProduct, removeProduct | created, updated, deleted, won, lost, stageChanged, ownerChanged, productAdded, productRemoved |
|
|
226
|
+
| **Account** | create, update, delete, merge, archive, unarchive, setOwner | created, updated, deleted, merged, archived, unarchived, ownerChanged |
|
|
227
|
+
| **Pipeline** | create, update, delete, addStage, removeStage, reorderStages, setDefault | created, updated, deleted, stageAdded, stageRemoved, stagesReordered, defaultSet |
|
|
228
|
+
| **Stage** | create, update, delete, reorder, setProbability | created, updated, deleted, reordered, probabilityChanged |
|
|
229
|
+
| **Activity** | log, schedule, complete, cancel, reschedule, assign | logged, scheduled, completed, cancelled, rescheduled, assigned |
|
|
230
|
+
| **Quote** | create, update, delete, send, accept, reject, expire, duplicate | created, updated, deleted, sent, accepted, rejected, expired, duplicated |
|
|
231
|
+
| **QuoteLineItem** | add, update, remove, reorder | added, updated, removed, reordered |
|
|
232
|
+
| **Product** | create, update, delete, archive, unarchive | created, updated, deleted, archived, unarchived |
|
|
233
|
+
|
|
234
|
+
---
|
|
235
|
+
|
|
236
|
+
### Finance (Stripe-based)
|
|
237
|
+
|
|
238
|
+
Comprehensive financial entities based on Stripe's API.
|
|
239
|
+
|
|
240
|
+
#### Properties
|
|
241
|
+
|
|
242
|
+
| Entity | Key Properties |
|
|
243
|
+
|--------|----------------|
|
|
244
|
+
| **Customer** | `email`, `name`, `phone`, `description`, `metadata`, `balance`, `currency`, `defaultPaymentMethod` |
|
|
245
|
+
| **Product** | `name`, `description`, `active`, `images`, `metadata`, `type`, `unitLabel` |
|
|
246
|
+
| **Price** | `currency`, `unitAmount`, `recurring`, `type`, `billingScheme`, `active` |
|
|
247
|
+
| **PaymentMethod** | `type`, `card`, `billingDetails`, `customer`, `created` |
|
|
248
|
+
| **PaymentIntent** | `amount`, `currency`, `status`, `paymentMethod`, `customer`, `metadata` |
|
|
249
|
+
| **Charge** | `amount`, `currency`, `status`, `paid`, `refunded`, `customer`, `paymentMethod` |
|
|
250
|
+
| **Refund** | `amount`, `currency`, `status`, `reason`, `charge`, `paymentIntent` |
|
|
251
|
+
| **Invoice** | `number`, `customer`, `status`, `total`, `amountDue`, `amountPaid`, `dueDate`, `paidAt` |
|
|
252
|
+
| **Subscription** | `status`, `customer`, `items`, `currentPeriodStart`, `currentPeriodEnd`, `canceledAt`, `trialEnd` |
|
|
253
|
+
|
|
254
|
+
#### Actions & Events
|
|
255
|
+
|
|
256
|
+
| Entity | Actions | Events |
|
|
257
|
+
|--------|---------|--------|
|
|
258
|
+
| **Customer** | create, update, delete, search | created, updated, deleted |
|
|
259
|
+
| **Product** | create, update, archive, unarchive | created, updated, archived |
|
|
260
|
+
| **Price** | create, update, archive | created, updated, archived |
|
|
261
|
+
| **PaymentMethod** | attach, detach, update, setDefault | attached, detached, updated |
|
|
262
|
+
| **PaymentIntent** | create, confirm, cancel, capture | created, succeeded, failed, cancelled |
|
|
263
|
+
| **Charge** | create, capture, refund | created, captured, refunded |
|
|
264
|
+
| **Refund** | create, update, cancel | created, updated, cancelled |
|
|
265
|
+
| **Invoice** | create, send, pay, void, finalize | created, sent, paid, voided, finalized |
|
|
266
|
+
| **Subscription** | create, update, cancel, resume, pause | created, updated, cancelled, resumed, paused |
|
|
267
|
+
|
|
268
|
+
**Connect (Platforms):**
|
|
269
|
+
|
|
270
|
+
| Entity | Key Properties | Actions | Events |
|
|
271
|
+
|--------|----------------|---------|--------|
|
|
272
|
+
| **Account** | `type`, `country`, `email`, `capabilities`, `payoutsEnabled`, `chargesEnabled` | create, update, delete, reject | created, updated, deleted |
|
|
273
|
+
| **AccountLink** | `url`, `expiresAt`, `type` | create | created |
|
|
274
|
+
| **ApplicationFee** | `amount`, `currency`, `account`, `charge` | list, retrieve, refund | created, refunded |
|
|
275
|
+
|
|
276
|
+
**Treasury (Embedded Banking):**
|
|
277
|
+
|
|
278
|
+
| Entity | Key Properties | Actions | Events |
|
|
279
|
+
|--------|----------------|---------|--------|
|
|
280
|
+
| **FinancialAccount** | `balance`, `currency`, `status`, `features` | create, update, close | created, updated, closed |
|
|
281
|
+
| **TreasuryTransaction** | `amount`, `currency`, `status`, `flowType` | list, retrieve | created |
|
|
282
|
+
| **InboundTransfer** | `amount`, `currency`, `status`, `origin` | create, cancel | created, succeeded, failed |
|
|
283
|
+
| **OutboundTransfer** | `amount`, `currency`, `status`, `destination` | create, cancel | created, posted, failed |
|
|
284
|
+
| **OutboundPayment** | `amount`, `currency`, `status`, `destination` | create, cancel | created, posted, failed |
|
|
285
|
+
| **ReceivedCredit** | `amount`, `currency`, `status`, `network` | list, retrieve | created |
|
|
286
|
+
| **ReceivedDebit** | `amount`, `currency`, `status`, `network` | list, retrieve | created |
|
|
287
|
+
|
|
288
|
+
**Issuing (Cards):**
|
|
289
|
+
|
|
290
|
+
| Entity | Key Properties | Actions | Events |
|
|
291
|
+
|--------|----------------|---------|--------|
|
|
292
|
+
| **IssuingCard** | `type`, `status`, `brand`, `last4`, `expMonth`, `expYear`, `spendingControls` | create, update, ship, cancel | created, shipped, activated |
|
|
293
|
+
| **IssuingCardholder** | `name`, `email`, `phone`, `status`, `type`, `billingAddress` | create, update | created, updated |
|
|
294
|
+
| **IssuingAuthorization** | `amount`, `currency`, `status`, `merchant`, `approved` | approve, decline | created, approved, declined |
|
|
295
|
+
| **IssuingTransaction** | `amount`, `currency`, `type`, `merchant`, `authorization` | list, retrieve | created |
|
|
296
|
+
| **IssuingDispute** | `amount`, `currency`, `status`, `reason`, `evidence` | create, submit | created, submitted, won, lost |
|
|
297
|
+
|
|
298
|
+
**Bank & Webhooks:**
|
|
299
|
+
|
|
300
|
+
| Entity | Key Properties | Actions | Events |
|
|
301
|
+
|--------|----------------|---------|--------|
|
|
302
|
+
| **BankAccount** | `bankName`, `accountHolderName`, `accountType`, `last4`, `status` | create, verify, delete | created, verified, deleted |
|
|
303
|
+
| **WebhookEndpoint** | `url`, `enabledEvents`, `status`, `secret` | create, update, delete, enable, disable | created, updated, deleted, enabled, disabled |
|
|
304
|
+
| **Event** | `type`, `data`, `created`, `livemode` | list, retrieve | created |
|
|
305
|
+
|
|
306
|
+
---
|
|
307
|
+
|
|
308
|
+
### Support
|
|
309
|
+
|
|
310
|
+
Customer support and help desk entities.
|
|
311
|
+
|
|
312
|
+
#### Properties
|
|
313
|
+
|
|
314
|
+
| Entity | Key Properties |
|
|
315
|
+
|--------|----------------|
|
|
316
|
+
| **SupportTicket** | `subject`, `description`, `status`, `priority`, `type`, `channel`, `assignee`, `requester`, `tags` |
|
|
317
|
+
| **TicketComment** | `body`, `author`, `public`, `attachments`, `createdAt` |
|
|
318
|
+
| **Conversation** | `subject`, `status`, `channel`, `assignee`, `participants`, `lastMessageAt` |
|
|
319
|
+
| **ConversationMessage** | `body`, `author`, `type`, `attachments`, `createdAt` |
|
|
320
|
+
| **HelpArticle** | `title`, `body`, `status`, `category`, `author`, `views`, `helpful`, `notHelpful` |
|
|
321
|
+
| **HelpCategory** | `name`, `description`, `slug`, `parent`, `position`, `articleCount` |
|
|
322
|
+
| **FAQ** | `question`, `answer`, `category`, `position`, `views` |
|
|
323
|
+
| **SatisfactionRating** | `score`, `comment`, `ticket`, `ratedBy`, `createdAt` |
|
|
324
|
+
|
|
325
|
+
#### Actions & Events
|
|
326
|
+
|
|
327
|
+
| Entity | Actions | Events |
|
|
328
|
+
|--------|---------|--------|
|
|
329
|
+
| **SupportTicket** | create, update, assign, resolve, close, reopen, escalate, merge, addTag, removeTag | created, updated, assigned, resolved, closed, reopened, escalated, merged, tagged |
|
|
330
|
+
| **TicketComment** | add, edit, delete | added, edited, deleted |
|
|
331
|
+
| **Conversation** | start, reply, close, reopen, transfer, snooze, unsnooze, assign | started, replied, closed, reopened, transferred, snoozed, unsnoozed, assigned |
|
|
332
|
+
| **ConversationMessage** | send, edit, delete | sent, edited, deleted |
|
|
333
|
+
| **HelpArticle** | create, update, publish, unpublish, archive, unarchive, translate | created, updated, published, unpublished, archived, unarchived, translated |
|
|
334
|
+
| **HelpCategory** | create, update, delete, reorder | created, updated, deleted, reordered |
|
|
335
|
+
| **FAQ** | create, update, delete, reorder | created, updated, deleted, reordered |
|
|
336
|
+
| **SatisfactionRating** | submit, update | submitted, updated |
|
|
337
|
+
|
|
338
|
+
---
|
|
339
|
+
|
|
340
|
+
### Media
|
|
341
|
+
|
|
342
|
+
Image, video, and audio content entities.
|
|
343
|
+
|
|
344
|
+
#### Properties
|
|
345
|
+
|
|
346
|
+
| Entity | Key Properties |
|
|
347
|
+
|--------|----------------|
|
|
348
|
+
| **Image** | `url`, `format`, `width`, `height`, `size`, `alt`, `caption`, `tags`, `metadata` |
|
|
349
|
+
| **Video** | `url`, `format`, `duration`, `width`, `height`, `size`, `thumbnail`, `captions` |
|
|
350
|
+
| **Audio** | `url`, `format`, `duration`, `size`, `waveform`, `transcript` |
|
|
351
|
+
| **Screenshot** | `url`, `format`, `width`, `height`, `annotations`, `capturedAt` |
|
|
352
|
+
| **Album** | `name`, `description`, `cover`, `mediaCount`, `visibility`, `createdAt` |
|
|
353
|
+
| **MediaLibrary** | `name`, `totalSize`, `mediaCount`, `folders`, `tags` |
|
|
354
|
+
| **Transcript** | `text`, `language`, `confidence`, `segments`, `speakers` |
|
|
355
|
+
| **Caption** | `text`, `language`, `format`, `startTime`, `endTime` |
|
|
356
|
+
|
|
357
|
+
#### Actions & Events
|
|
358
|
+
|
|
359
|
+
| Entity | Actions | Events |
|
|
360
|
+
|--------|---------|--------|
|
|
361
|
+
| **Image** | upload, transform, tag, untag, delete, optimize, crop, resize | uploaded, transformed, tagged, untagged, deleted, optimized, cropped, resized |
|
|
362
|
+
| **Video** | upload, transcode, trim, delete, generateThumbnail, addCaption | uploaded, transcoded, trimmed, deleted, thumbnailGenerated, captionAdded |
|
|
363
|
+
| **Audio** | upload, transcode, trim, delete, transcribe | uploaded, transcoded, trimmed, deleted, transcribed |
|
|
364
|
+
| **Screenshot** | capture, annotate, share, delete | captured, annotated, shared, deleted |
|
|
365
|
+
| **Album** | create, update, delete, addMedia, removeMedia, share, unshare | created, updated, deleted, mediaAdded, mediaRemoved, shared, unshared |
|
|
366
|
+
| **MediaLibrary** | create, organize, search, import, export | created, organized, searched, imported, exported |
|
|
367
|
+
| **Transcript** | generate, edit, export, translate | generated, edited, exported, translated |
|
|
368
|
+
| **Caption** | generate, edit, sync, export | generated, edited, synced, exported |
|
|
369
|
+
|
|
370
|
+
---
|
|
371
|
+
|
|
372
|
+
### Marketing
|
|
373
|
+
|
|
374
|
+
Campaign and audience management entities.
|
|
375
|
+
|
|
376
|
+
#### Properties
|
|
377
|
+
|
|
378
|
+
| Entity | Key Properties |
|
|
379
|
+
|--------|----------------|
|
|
380
|
+
| **Campaign** | `name`, `type`, `status`, `channel`, `budget`, `startDate`, `endDate`, `goals`, `metrics` |
|
|
381
|
+
| **Audience** | `name`, `description`, `size`, `criteria`, `type`, `source`, `lastUpdated` |
|
|
382
|
+
| **EmailTemplate** | `name`, `subject`, `body`, `format`, `category`, `variables`, `preview` |
|
|
383
|
+
| **LandingPage** | `name`, `url`, `status`, `template`, `title`, `description`, `conversionGoal` |
|
|
384
|
+
| **FormSubmission** | `form`, `data`, `source`, `submittedAt`, `processed` |
|
|
385
|
+
| **SocialPost** | `content`, `media`, `platform`, `status`, `scheduledAt`, `publishedAt`, `engagement` |
|
|
386
|
+
| **AdCreative** | `name`, `type`, `headline`, `body`, `media`, `callToAction`, `status` |
|
|
387
|
+
| **UTMLink** | `url`, `source`, `medium`, `campaign`, `term`, `content`, `shortUrl`, `clicks` |
|
|
388
|
+
|
|
389
|
+
#### Actions & Events
|
|
390
|
+
|
|
391
|
+
| Entity | Actions | Events |
|
|
392
|
+
|--------|---------|--------|
|
|
393
|
+
| **Campaign** | create, update, launch, pause, resume, end, duplicate, archive | created, updated, launched, paused, resumed, ended, duplicated, archived |
|
|
394
|
+
| **Audience** | create, update, delete, segment, sync, export | created, updated, deleted, segmented, synced, exported |
|
|
395
|
+
| **EmailTemplate** | create, edit, delete, test, publish, unpublish, duplicate | created, edited, deleted, tested, published, unpublished, duplicated |
|
|
396
|
+
| **LandingPage** | create, update, publish, unpublish, test, duplicate, delete | created, updated, published, unpublished, tested, duplicated, deleted |
|
|
397
|
+
| **FormSubmission** | submit, export, delete | submitted, exported, deleted |
|
|
398
|
+
| **SocialPost** | create, schedule, publish, delete, edit | created, scheduled, published, deleted, edited |
|
|
399
|
+
| **AdCreative** | create, update, delete, approve, reject, duplicate | created, updated, deleted, approved, rejected, duplicated |
|
|
400
|
+
| **UTMLink** | create, update, delete, shorten | created, updated, deleted, shortened, clicked |
|
|
401
|
+
|
|
402
|
+
---
|
|
403
|
+
|
|
404
|
+
### Knowledge
|
|
405
|
+
|
|
406
|
+
Wiki and knowledge management entities.
|
|
407
|
+
|
|
408
|
+
#### Properties
|
|
409
|
+
|
|
410
|
+
| Entity | Key Properties |
|
|
411
|
+
|--------|----------------|
|
|
412
|
+
| **WikiPage** | `title`, `content`, `slug`, `parent`, `author`, `status`, `version`, `lastEditedAt` |
|
|
413
|
+
| **WikiSpace** | `name`, `key`, `description`, `icon`, `visibility`, `pageCount` |
|
|
414
|
+
| **WikiRevision** | `content`, `author`, `message`, `version`, `createdAt` |
|
|
415
|
+
| **Article** | `title`, `body`, `slug`, `status`, `author`, `category`, `tags`, `views` |
|
|
416
|
+
| **KnowledgeBase** | `name`, `description`, `url`, `theme`, `articleCount`, `categoryCount` |
|
|
417
|
+
| **Glossary** | `name`, `description`, `termCount` |
|
|
418
|
+
| **GlossaryTerm** | `term`, `definition`, `aliases`, `category` |
|
|
419
|
+
| **SearchIndex** | `name`, `documents`, `lastIndexedAt`, `status` |
|
|
420
|
+
| **Tag** | `name`, `slug`, `color`, `usageCount` |
|
|
421
|
+
| **Category** | `name`, `slug`, `description`, `parent`, `position`, `articleCount` |
|
|
422
|
+
|
|
423
|
+
#### Actions & Events
|
|
424
|
+
|
|
425
|
+
| Entity | Actions | Events |
|
|
426
|
+
|--------|---------|--------|
|
|
427
|
+
| **WikiPage** | create, update, publish, unpublish, archive, move, delete, restore, addComment | created, updated, published, unpublished, archived, moved, deleted, restored, commented |
|
|
428
|
+
| **WikiSpace** | create, update, delete, archive, rename | created, updated, deleted, archived, renamed |
|
|
429
|
+
| **WikiRevision** | create, restore, compare | created, restored, compared |
|
|
430
|
+
| **Article** | create, update, publish, unpublish, archive, delete, translate | created, updated, published, unpublished, archived, deleted, translated |
|
|
431
|
+
| **KnowledgeBase** | create, update, delete, configure, publish | created, updated, deleted, configured, published |
|
|
432
|
+
| **Glossary** | create, update, delete | created, updated, deleted |
|
|
433
|
+
| **GlossaryTerm** | create, update, delete | created, updated, deleted |
|
|
434
|
+
| **SearchIndex** | create, update, delete, rebuild, optimize | created, updated, deleted, rebuilt, optimized |
|
|
435
|
+
| **Tag** | create, update, delete, apply, remove, merge | created, updated, deleted, applied, removed, merged |
|
|
436
|
+
| **Category** | create, update, delete, reorder, move | created, updated, deleted, reordered, moved |
|
|
437
|
+
|
|
438
|
+
---
|
|
439
|
+
|
|
440
|
+
### Commerce
|
|
441
|
+
|
|
442
|
+
E-commerce entities for products, orders, and customers.
|
|
443
|
+
|
|
444
|
+
#### Properties
|
|
445
|
+
|
|
446
|
+
| Entity | Key Properties |
|
|
447
|
+
|--------|----------------|
|
|
448
|
+
| **Product** | `name`, `description`, `sku`, `price`, `compareAtPrice`, `images`, `category`, `status`, `inventory` |
|
|
449
|
+
| **ProductVariant** | `name`, `sku`, `price`, `options`, `inventory`, `weight`, `dimensions` |
|
|
450
|
+
| **Order** | `number`, `status`, `customer`, `items`, `subtotal`, `tax`, `shipping`, `total`, `shippingAddress` |
|
|
451
|
+
| **OrderItem** | `product`, `variant`, `quantity`, `price`, `total` |
|
|
452
|
+
| **Cart** | `items`, `subtotal`, `currency`, `customer`, `expiresAt` |
|
|
453
|
+
| **Customer** | `email`, `firstName`, `lastName`, `phone`, `addresses`, `orders`, `totalSpent` |
|
|
454
|
+
| **Inventory** | `product`, `variant`, `location`, `quantity`, `reserved`, `available` |
|
|
455
|
+
| **Discount** | `code`, `type`, `value`, `minPurchase`, `maxUses`, `usageCount`, `startsAt`, `endsAt` |
|
|
456
|
+
| **Review** | `product`, `rating`, `title`, `body`, `author`, `verified`, `status` |
|
|
457
|
+
|
|
458
|
+
#### Actions & Events
|
|
459
|
+
|
|
460
|
+
| Entity | Actions | Events |
|
|
461
|
+
|--------|---------|--------|
|
|
462
|
+
| **Product** | create, update, delete, publish, unpublish, archive, duplicate | created, updated, deleted, published, unpublished, archived, duplicated |
|
|
463
|
+
| **ProductVariant** | create, update, delete | created, updated, deleted |
|
|
464
|
+
| **Order** | create, update, fulfill, cancel, refund, archive | created, updated, fulfilled, cancelled, refunded, archived |
|
|
465
|
+
| **OrderItem** | add, update, remove | added, updated, removed |
|
|
466
|
+
| **Cart** | create, addItem, updateItem, removeItem, checkout, abandon | created, itemAdded, itemUpdated, itemRemoved, checkedOut, abandoned |
|
|
467
|
+
| **Customer** | create, update, delete, merge | created, updated, deleted, merged |
|
|
468
|
+
| **Inventory** | update, reserve, release, transfer, adjust | updated, reserved, released, transferred, adjusted |
|
|
469
|
+
| **Discount** | create, update, delete, apply, expire | created, updated, deleted, applied, expired |
|
|
470
|
+
| **Review** | create, update, delete, publish, hide, respond | created, updated, deleted, published, hidden, responded |
|
|
471
|
+
|
|
472
|
+
---
|
|
473
|
+
|
|
474
|
+
### Analytics
|
|
475
|
+
|
|
476
|
+
Reporting and metrics entities.
|
|
477
|
+
|
|
478
|
+
#### Properties
|
|
479
|
+
|
|
480
|
+
| Entity | Key Properties |
|
|
481
|
+
|--------|----------------|
|
|
482
|
+
| **Report** | `name`, `description`, `type`, `dateRange`, `filters`, `dimensions`, `metrics`, `schedule` |
|
|
483
|
+
| **Dashboard** | `name`, `description`, `widgets`, `layout`, `shared`, `refreshInterval` |
|
|
484
|
+
| **Widget** | `name`, `type`, `dataSource`, `query`, `visualization`, `position`, `size` |
|
|
485
|
+
| **Metric** | `name`, `description`, `formula`, `unit`, `aggregation`, `currentValue`, `trend` |
|
|
486
|
+
| **Goal** | `name`, `metric`, `target`, `currentValue`, `progress`, `dueDate`, `status` |
|
|
487
|
+
| **DataSource** | `name`, `type`, `connectionString`, `credentials`, `status`, `lastSyncAt` |
|
|
488
|
+
| **Query** | `name`, `sql`, `dataSource`, `parameters`, `cached`, `lastRunAt` |
|
|
489
|
+
| **Alert** | `name`, `metric`, `condition`, `threshold`, `channels`, `enabled`, `lastTriggeredAt` |
|
|
490
|
+
|
|
491
|
+
#### Actions & Events
|
|
492
|
+
|
|
493
|
+
| Entity | Actions | Events |
|
|
494
|
+
|--------|---------|--------|
|
|
495
|
+
| **Report** | create, update, delete, generate, schedule, export, share | created, updated, deleted, generated, scheduled, exported, shared |
|
|
496
|
+
| **Dashboard** | create, update, delete, addWidget, removeWidget, share, duplicate | created, updated, deleted, widgetAdded, widgetRemoved, shared, duplicated |
|
|
497
|
+
| **Widget** | create, update, delete, configure, refresh, move, resize | created, updated, deleted, configured, refreshed, moved, resized |
|
|
498
|
+
| **Metric** | create, update, delete, define, track | created, updated, deleted, defined, tracked, alerted |
|
|
499
|
+
| **Goal** | create, update, delete, track, complete | created, updated, deleted, tracked, completed, missed |
|
|
500
|
+
| **DataSource** | create, update, delete, connect, disconnect, sync, test | created, updated, deleted, connected, disconnected, synced, tested |
|
|
501
|
+
| **Query** | create, update, delete, execute, save, share | created, updated, deleted, executed, saved, shared |
|
|
502
|
+
| **Alert** | create, update, delete, enable, disable, trigger, acknowledge | created, updated, deleted, enabled, disabled, triggered, acknowledged |
|
|
503
|
+
|
|
504
|
+
---
|
|
505
|
+
|
|
506
|
+
### Storage
|
|
507
|
+
|
|
508
|
+
File and cloud storage entities.
|
|
509
|
+
|
|
510
|
+
#### Properties
|
|
511
|
+
|
|
512
|
+
| Entity | Key Properties |
|
|
513
|
+
|--------|----------------|
|
|
514
|
+
| **File** | `name`, `path`, `size`, `mimeType`, `extension`, `url`, `metadata`, `createdAt`, `updatedAt` |
|
|
515
|
+
| **Folder** | `name`, `path`, `parent`, `fileCount`, `size`, `createdAt` |
|
|
516
|
+
| **Drive** | `name`, `type`, `capacity`, `used`, `available`, `mounted`, `path` |
|
|
517
|
+
| **SharedLink** | `url`, `file`, `permissions`, `password`, `expiresAt`, `downloads` |
|
|
518
|
+
| **FileVersion** | `version`, `size`, `author`, `comment`, `createdAt` |
|
|
519
|
+
| **StorageQuota** | `used`, `limit`, `available`, `percentUsed` |
|
|
520
|
+
| **Backup** | `name`, `source`, `destination`, `size`, `status`, `completedAt`, `schedule` |
|
|
521
|
+
|
|
522
|
+
#### Actions & Events
|
|
523
|
+
|
|
524
|
+
| Entity | Actions | Events |
|
|
525
|
+
|--------|---------|--------|
|
|
526
|
+
| **File** | upload, download, move, copy, rename, delete, restore, share | uploaded, downloaded, moved, copied, renamed, deleted, restored, shared |
|
|
527
|
+
| **Folder** | create, rename, move, copy, delete | created, renamed, moved, copied, deleted |
|
|
528
|
+
| **Drive** | mount, unmount, sync, format | mounted, unmounted, synced, formatted |
|
|
529
|
+
| **SharedLink** | create, update, revoke | created, updated, revoked, accessed |
|
|
530
|
+
| **FileVersion** | create, restore, delete | created, restored, deleted |
|
|
531
|
+
| **StorageQuota** | check, increase, decrease | checked, increased, decreased, exceeded |
|
|
532
|
+
| **Backup** | create, restore, delete, schedule | created, restored, deleted, scheduled, completed, failed |
|
|
533
|
+
|
|
534
|
+
---
|
|
535
|
+
|
|
536
|
+
### Meeting
|
|
537
|
+
|
|
538
|
+
Video conferencing, webinar, and scheduling entities.
|
|
539
|
+
|
|
540
|
+
#### Properties
|
|
541
|
+
|
|
542
|
+
| Entity | Key Properties |
|
|
543
|
+
|--------|----------------|
|
|
544
|
+
| **Meeting** | `title`, `description`, `type`, `startTime`, `endTime`, `duration`, `host`, `joinUrl`, `status`, `recording` |
|
|
545
|
+
| **MeetingParticipant** | `user`, `role`, `joinedAt`, `leftAt`, `muted`, `videoOn` |
|
|
546
|
+
| **MeetingRecording** | `url`, `duration`, `size`, `format`, `transcript`, `createdAt` |
|
|
547
|
+
| **Webinar** | `title`, `description`, `startTime`, `duration`, `host`, `panelists`, `capacity`, `registrationRequired` |
|
|
548
|
+
| **WebinarRegistrant** | `email`, `firstName`, `lastName`, `status`, `registeredAt`, `attendedAt` |
|
|
549
|
+
| **MeetingRoom** | `name`, `capacity`, `equipment`, `location`, `status` |
|
|
550
|
+
| **BreakoutRoom** | `name`, `participants`, `duration`, `status` |
|
|
551
|
+
| **MeetingPoll** | `question`, `options`, `anonymous`, `status`, `results` |
|
|
552
|
+
| **MeetingChat** | `sender`, `message`, `timestamp`, `type` |
|
|
553
|
+
| **MeetingType** | `name`, `duration`, `description`, `settings`, `default` |
|
|
554
|
+
| **Resource** | `name`, `type`, `location`, `capacity`, `amenities`, `availability` |
|
|
555
|
+
| **Reservation** | `resource`, `startTime`, `endTime`, `organizer`, `status`, `attendees` |
|
|
556
|
+
| **Waitlist** | `resource`, `user`, `requestedAt`, `position`, `notifiedAt` |
|
|
557
|
+
|
|
558
|
+
#### Actions & Events
|
|
559
|
+
|
|
560
|
+
| Entity | Actions | Events |
|
|
561
|
+
|--------|---------|--------|
|
|
562
|
+
| **Meeting** | schedule, start, end, join, leave, record, cancel, reschedule | scheduled, started, ended, joined, left, recorded, cancelled, rescheduled |
|
|
563
|
+
| **MeetingParticipant** | invite, admit, remove, mute, unmute, promote, demote | invited, admitted, removed, muted, unmuted, promoted, demoted |
|
|
564
|
+
| **MeetingRecording** | start, stop, pause, resume, download, delete, share | started, stopped, paused, resumed, downloaded, deleted, shared |
|
|
565
|
+
| **Webinar** | create, update, start, end, delete, register | created, updated, started, ended, deleted, registered |
|
|
566
|
+
| **WebinarRegistrant** | register, confirm, cancel, attend | registered, confirmed, cancelled, attended |
|
|
567
|
+
| **MeetingRoom** | create, update, delete, configure | created, updated, deleted, configured |
|
|
568
|
+
| **BreakoutRoom** | create, open, close, assign, broadcast | created, opened, closed, assigned, broadcasted |
|
|
569
|
+
| **MeetingPoll** | create, launch, end, share | created, launched, ended, shared |
|
|
570
|
+
| **MeetingChat** | send, delete, export | sent, deleted, exported |
|
|
571
|
+
| **MeetingType** | create, update, delete, setDefault | created, updated, deleted, defaultSet |
|
|
572
|
+
| **Resource** | create, update, delete, setAvailability | created, updated, deleted, availabilitySet |
|
|
573
|
+
| **Reservation** | create, confirm, cancel, reschedule, checkIn, checkOut | created, confirmed, cancelled, rescheduled, checkedIn, checkedOut |
|
|
574
|
+
| **Waitlist** | join, leave, notify, promote | joined, left, notified, promoted |
|
|
575
|
+
|
|
576
|
+
---
|
|
577
|
+
|
|
578
|
+
### Form
|
|
579
|
+
|
|
580
|
+
Forms, surveys, and quiz entities.
|
|
581
|
+
|
|
582
|
+
#### Properties
|
|
583
|
+
|
|
584
|
+
| Entity | Key Properties |
|
|
585
|
+
|--------|----------------|
|
|
586
|
+
| **Form** | `name`, `description`, `fields`, `status`, `submissions`, `settings`, `theme` |
|
|
587
|
+
| **FormField** | `type`, `label`, `required`, `placeholder`, `options`, `validation`, `position` |
|
|
588
|
+
| **FormResponse** | `form`, `data`, `submittedAt`, `submitter`, `completed` |
|
|
589
|
+
| **Survey** | `name`, `description`, `questions`, `status`, `responses`, `analytics` |
|
|
590
|
+
| **SurveyQuestion** | `type`, `text`, `required`, `options`, `logic`, `position` |
|
|
591
|
+
| **SurveyResponse** | `survey`, `answers`, `submittedAt`, `completed`, `duration` |
|
|
592
|
+
| **Quiz** | `name`, `description`, `questions`, `passingScore`, `timeLimit`, `shuffleQuestions` |
|
|
593
|
+
| **QuizQuestion** | `type`, `text`, `options`, `correctAnswer`, `points`, `explanation` |
|
|
594
|
+
| **QuizResult** | `quiz`, `user`, `score`, `passed`, `answers`, `completedAt`, `duration` |
|
|
595
|
+
|
|
596
|
+
#### Actions & Events
|
|
597
|
+
|
|
598
|
+
| Entity | Actions | Events |
|
|
599
|
+
|--------|---------|--------|
|
|
600
|
+
| **Form** | create, update, delete, publish, close, duplicate | created, updated, deleted, published, closed, duplicated |
|
|
601
|
+
| **FormField** | create, update, delete, reorder | created, updated, deleted, reordered |
|
|
602
|
+
| **FormResponse** | submit, update, delete, export | submitted, updated, deleted, exported |
|
|
603
|
+
| **Survey** | create, update, delete, publish, close, analyze | created, updated, deleted, published, closed, analyzed |
|
|
604
|
+
| **SurveyQuestion** | create, update, delete, reorder | created, updated, deleted, reordered |
|
|
605
|
+
| **SurveyResponse** | submit, update, delete, analyze | submitted, updated, deleted, analyzed |
|
|
606
|
+
| **Quiz** | create, update, delete, publish, close, grade | created, updated, deleted, published, closed, graded |
|
|
607
|
+
| **QuizQuestion** | create, update, delete, reorder | created, updated, deleted, reordered |
|
|
608
|
+
| **QuizResult** | submit, grade, review, retake | submitted, graded, reviewed, retaken |
|
|
609
|
+
|
|
610
|
+
---
|
|
611
|
+
|
|
612
|
+
### Signature
|
|
613
|
+
|
|
614
|
+
E-signature workflow entities.
|
|
615
|
+
|
|
616
|
+
#### Properties
|
|
617
|
+
|
|
618
|
+
| Entity | Key Properties |
|
|
619
|
+
|--------|----------------|
|
|
620
|
+
| **SignatureDocument** | `name`, `status`, `file`, `signers`, `template`, `expiresAt`, `completedAt` |
|
|
621
|
+
| **SignatureRequest** | `document`, `signer`, `status`, `sentAt`, `viewedAt`, `signedAt`, `declinedAt` |
|
|
622
|
+
| **Signer** | `name`, `email`, `role`, `order`, `status`, `signedAt` |
|
|
623
|
+
| **SignatureField** | `type`, `signer`, `page`, `x`, `y`, `width`, `height`, `required`, `value` |
|
|
624
|
+
| **Signature** | `type`, `data`, `timestamp`, `ipAddress`, `verified` |
|
|
625
|
+
| **SignatureTemplate** | `name`, `description`, `document`, `fields`, `signerRoles` |
|
|
626
|
+
| **AuditTrail** | `document`, `events`, `actors`, `timestamps`, `ipAddresses` |
|
|
627
|
+
|
|
628
|
+
#### Actions & Events
|
|
629
|
+
|
|
630
|
+
| Entity | Actions | Events |
|
|
631
|
+
|--------|---------|--------|
|
|
632
|
+
| **SignatureDocument** | create, send, void, download, delete, remind | created, sent, voided, completed, downloaded, deleted |
|
|
633
|
+
| **SignatureRequest** | send, resend, remind, cancel | sent, resent, viewed, signed, declined, reminded, cancelled |
|
|
634
|
+
| **Signer** | create, update, delete, invite, verify | created, updated, deleted, invitationSent, verified |
|
|
635
|
+
| **SignatureField** | create, update, delete, move, resize, setValue | created, updated, deleted, moved, resized, completed |
|
|
636
|
+
| **Signature** | create, validate, verify | created, validated, verified |
|
|
637
|
+
| **SignatureTemplate** | create, update, delete, use, share, duplicate | created, updated, deleted, used, shared, duplicated |
|
|
638
|
+
| **AuditTrail** | view, export, verify | created, viewed, exported, verified |
|
|
639
|
+
|
|
640
|
+
---
|
|
641
|
+
|
|
642
|
+
### Document
|
|
643
|
+
|
|
644
|
+
Word processing entities.
|
|
645
|
+
|
|
646
|
+
#### Properties
|
|
647
|
+
|
|
648
|
+
| Entity | Key Properties |
|
|
649
|
+
|--------|----------------|
|
|
650
|
+
| **Document** | `title`, `content`, `format`, `owner`, `collaborators`, `status`, `lastEditedAt`, `version` |
|
|
651
|
+
| **DocumentVersion** | `version`, `content`, `author`, `message`, `createdAt` |
|
|
652
|
+
| **DocumentComment** | `content`, `author`, `position`, `resolved`, `replies`, `createdAt` |
|
|
653
|
+
| **DocumentCollaborator** | `user`, `permission`, `addedAt`, `lastAccessedAt` |
|
|
654
|
+
|
|
655
|
+
#### Actions & Events
|
|
656
|
+
|
|
657
|
+
| Entity | Actions | Events |
|
|
658
|
+
|--------|---------|--------|
|
|
659
|
+
| **Document** | create, update, delete, save, export, share, duplicate, restore, lock, unlock | created, updated, deleted, saved, exported, shared, duplicated, restored, locked, unlocked |
|
|
660
|
+
| **DocumentVersion** | create, restore, compare, delete | created, restored, compared, deleted |
|
|
661
|
+
| **DocumentComment** | create, update, delete, reply, resolve, reopen | created, updated, deleted, replied, resolved, reopened |
|
|
662
|
+
| **DocumentCollaborator** | invite, remove, updatePermissions | invited, removed, permissionsUpdated |
|
|
663
|
+
|
|
664
|
+
---
|
|
665
|
+
|
|
666
|
+
### Spreadsheet
|
|
667
|
+
|
|
668
|
+
Spreadsheet and data table entities.
|
|
669
|
+
|
|
670
|
+
#### Properties
|
|
671
|
+
|
|
672
|
+
| Entity | Key Properties |
|
|
673
|
+
|--------|----------------|
|
|
674
|
+
| **Spreadsheet** | `name`, `sheets`, `owner`, `collaborators`, `lastEditedAt` |
|
|
675
|
+
| **Sheet** | `name`, `index`, `rows`, `columns`, `frozen`, `hidden` |
|
|
676
|
+
| **Cell** | `row`, `column`, `value`, `formula`, `format`, `comment` |
|
|
677
|
+
| **Range** | `sheet`, `startRow`, `startColumn`, `endRow`, `endColumn`, `values` |
|
|
678
|
+
| **Chart** | `type`, `title`, `dataRange`, `options`, `position`, `size` |
|
|
679
|
+
| **PivotTable** | `name`, `sourceRange`, `rows`, `columns`, `values`, `filters` |
|
|
680
|
+
|
|
681
|
+
#### Actions & Events
|
|
682
|
+
|
|
683
|
+
| Entity | Actions | Events |
|
|
684
|
+
|--------|---------|--------|
|
|
685
|
+
| **Spreadsheet** | create, open, save, export, share, duplicate, delete | created, opened, saved, exported, shared, duplicated, deleted |
|
|
686
|
+
| **Sheet** | create, rename, delete, duplicate, hide, show, move | created, renamed, deleted, duplicated, hidden, shown, moved |
|
|
687
|
+
| **Cell** | setValue, setFormula, format, clear, merge, unmerge | valueChanged, formulaSet, formatted, cleared, merged, unmerged |
|
|
688
|
+
| **Range** | select, setValue, format, sort, filter, copy, paste | selected, valuesChanged, formatted, sorted, filtered, copied, pasted |
|
|
689
|
+
| **Chart** | create, update, delete, export, move, resize | created, updated, deleted, exported, moved, resized |
|
|
690
|
+
| **PivotTable** | create, update, delete, refresh, addField, removeField, filter | created, updated, deleted, refreshed, fieldAdded, fieldRemoved, filtered |
|
|
691
|
+
|
|
692
|
+
---
|
|
693
|
+
|
|
694
|
+
### Presentation
|
|
695
|
+
|
|
696
|
+
Slide presentation entities.
|
|
697
|
+
|
|
698
|
+
#### Properties
|
|
699
|
+
|
|
700
|
+
| Entity | Key Properties |
|
|
701
|
+
|--------|----------------|
|
|
702
|
+
| **Presentation** | `name`, `slides`, `theme`, `owner`, `collaborators`, `lastEditedAt` |
|
|
703
|
+
| **Slide** | `index`, `layout`, `elements`, `notes`, `animations`, `transition` |
|
|
704
|
+
| **SlideElement** | `type`, `content`, `position`, `size`, `style`, `animation` |
|
|
705
|
+
| **SpeakerNotes** | `slide`, `content`, `format` |
|
|
706
|
+
| **Animation** | `element`, `type`, `trigger`, `duration`, `delay`, `order` |
|
|
707
|
+
|
|
708
|
+
#### Actions & Events
|
|
709
|
+
|
|
710
|
+
| Entity | Actions | Events |
|
|
711
|
+
|--------|---------|--------|
|
|
712
|
+
| **Presentation** | create, open, save, export, present, share, duplicate, delete | created, opened, saved, exported, presented, shared, duplicated, deleted |
|
|
713
|
+
| **Slide** | create, duplicate, delete, move, setLayout, setTransition | created, duplicated, deleted, moved, layoutSet, transitionSet |
|
|
714
|
+
| **SlideElement** | create, update, delete, move, resize, animate, lock, unlock | created, updated, deleted, moved, resized, animated, locked, unlocked |
|
|
715
|
+
| **SpeakerNotes** | create, update, delete | created, updated, deleted |
|
|
716
|
+
| **Animation** | create, update, delete, reorder | created, updated, deleted, reordered |
|
|
717
|
+
|
|
718
|
+
---
|
|
719
|
+
|
|
720
|
+
### Infrastructure
|
|
721
|
+
|
|
722
|
+
Cloud infrastructure entities (Firebase, GCP, AWS).
|
|
723
|
+
|
|
724
|
+
#### Properties
|
|
725
|
+
|
|
726
|
+
| Entity | Key Properties |
|
|
727
|
+
|--------|----------------|
|
|
728
|
+
| **Config** | `name`, `environment`, `values`, `version`, `deployedAt` |
|
|
729
|
+
| **ConfigVersion** | `version`, `values`, `author`, `message`, `createdAt` |
|
|
730
|
+
| **Database** | `name`, `type`, `status`, `region`, `size`, `connections` |
|
|
731
|
+
| **Collection** | `name`, `database`, `documentCount`, `size`, `indexes` |
|
|
732
|
+
| **Index** | `name`, `collection`, `fields`, `unique`, `status` |
|
|
733
|
+
| **Hosting** | `domain`, `ssl`, `status`, `deployments`, `currentVersion` |
|
|
734
|
+
| **Deployment** | `version`, `status`, `environment`, `startedAt`, `completedAt` |
|
|
735
|
+
| **Function** | `name`, `runtime`, `trigger`, `memory`, `timeout`, `status` |
|
|
736
|
+
| **FunctionLog** | `function`, `level`, `message`, `timestamp`, `executionId` |
|
|
737
|
+
| **Identity** | `uid`, `email`, `displayName`, `provider`, `disabled`, `lastSignInAt` |
|
|
738
|
+
| **Bucket** | `name`, `region`, `size`, `objects`, `versioning`, `lifecycle` |
|
|
739
|
+
| **StorageObject** | `name`, `bucket`, `size`, `contentType`, `metadata`, `url` |
|
|
740
|
+
|
|
741
|
+
#### Actions & Events
|
|
742
|
+
|
|
743
|
+
| Entity | Actions | Events |
|
|
744
|
+
|--------|---------|--------|
|
|
745
|
+
| **Config** | create, update, delete, deploy, rollback | created, updated, deleted, deployed, rolledBack |
|
|
746
|
+
| **ConfigVersion** | create, restore, compare | created, restored, compared |
|
|
747
|
+
| **Database** | create, update, delete, backup, restore, scale | created, updated, deleted, backedUp, restored, scaled |
|
|
748
|
+
| **Collection** | create, update, delete, index | created, updated, deleted, indexed |
|
|
749
|
+
| **Index** | create, delete, rebuild | created, deleted, rebuilt |
|
|
750
|
+
| **Hosting** | deploy, rollback, configure, setDomain | deployed, rolledBack, configured, domainSet |
|
|
751
|
+
| **Deployment** | create, promote, rollback, delete | created, promoted, rolledBack, deleted |
|
|
752
|
+
| **Function** | create, deploy, invoke, delete, update | created, deployed, invoked, deleted, updated |
|
|
753
|
+
| **FunctionLog** | list, stream, filter, export | created |
|
|
754
|
+
| **Identity** | create, update, delete, disable, enable, sendVerification | created, updated, deleted, disabled, enabled, verificationSent |
|
|
755
|
+
| **Bucket** | create, update, delete, setPolicy, setCors | created, updated, deleted, policySet, corsSet |
|
|
756
|
+
| **StorageObject** | upload, download, delete, copy, move | uploaded, downloaded, deleted, copied, moved |
|
|
757
|
+
|
|
758
|
+
---
|
|
759
|
+
|
|
760
|
+
### Experiment
|
|
761
|
+
|
|
762
|
+
Analytics, A/B testing, and feature flag entities.
|
|
763
|
+
|
|
764
|
+
#### Properties
|
|
765
|
+
|
|
766
|
+
| Entity | Key Properties |
|
|
767
|
+
|--------|----------------|
|
|
768
|
+
| **Session** | `id`, `userId`, `startedAt`, `endedAt`, `duration`, `device`, `location`, `events` |
|
|
769
|
+
| **AnalyticsEvent** | `name`, `properties`, `userId`, `sessionId`, `timestamp` |
|
|
770
|
+
| **Pageview** | `path`, `title`, `referrer`, `duration`, `userId`, `sessionId`, `timestamp` |
|
|
771
|
+
| **Segment** | `name`, `description`, `criteria`, `userCount`, `dynamic` |
|
|
772
|
+
| **FeatureFlag** | `key`, `name`, `description`, `enabled`, `targeting`, `defaultValue`, `variants` |
|
|
773
|
+
| **Experiment** | `name`, `hypothesis`, `status`, `variants`, `metrics`, `traffic`, `startedAt`, `endedAt` |
|
|
774
|
+
| **ExperimentResult** | `experiment`, `variant`, `metric`, `value`, `confidence`, `significant` |
|
|
775
|
+
| **Funnel** | `name`, `steps`, `conversionRate`, `dropoffRate` |
|
|
776
|
+
| **FunnelStep** | `name`, `event`, `order`, `conversionRate`, `dropoffRate` |
|
|
777
|
+
| **Cohort** | `name`, `criteria`, `userCount`, `createdAt`, `behavior` |
|
|
778
|
+
|
|
779
|
+
#### Actions & Events
|
|
780
|
+
|
|
781
|
+
| Entity | Actions | Events |
|
|
782
|
+
|--------|---------|--------|
|
|
783
|
+
| **Session** | create, update, end | created, updated, ended |
|
|
784
|
+
| **AnalyticsEvent** | track, aggregate | tracked, aggregated |
|
|
785
|
+
| **Pageview** | track, aggregate | tracked, aggregated |
|
|
786
|
+
| **Segment** | create, update, delete, sync | created, updated, deleted, synced |
|
|
787
|
+
| **FeatureFlag** | create, update, delete, enable, disable, target | created, updated, deleted, enabled, disabled, targeted |
|
|
788
|
+
| **Experiment** | create, update, start, stop, analyze, archive | created, updated, started, stopped, analyzed, archived |
|
|
789
|
+
| **ExperimentResult** | calculate, export | calculated, exported |
|
|
790
|
+
| **Funnel** | create, update, delete, analyze | created, updated, deleted, analyzed |
|
|
791
|
+
| **FunnelStep** | create, update, delete | created, updated, deleted |
|
|
792
|
+
| **Cohort** | create, update, delete, analyze, export | created, updated, deleted, analyzed, exported |
|
|
793
|
+
|
|
794
|
+
---
|
|
795
|
+
|
|
796
|
+
### Advertising
|
|
797
|
+
|
|
798
|
+
Digital advertising entities.
|
|
799
|
+
|
|
800
|
+
#### Properties
|
|
801
|
+
|
|
802
|
+
| Entity | Key Properties |
|
|
803
|
+
|--------|----------------|
|
|
804
|
+
| **Ad** | `name`, `headline`, `description`, `displayUrl`, `finalUrl`, `status`, `type` |
|
|
805
|
+
| **AdGroup** | `name`, `status`, `campaign`, `defaultBid`, `ads`, `keywords` |
|
|
806
|
+
| **AdCampaign** | `name`, `status`, `budget`, `startDate`, `endDate`, `objective`, `targeting` |
|
|
807
|
+
| **Keyword** | `text`, `matchType`, `bid`, `qualityScore`, `status` |
|
|
808
|
+
| **NegativeKeyword** | `text`, `matchType`, `level` |
|
|
809
|
+
| **Conversion** | `name`, `category`, `value`, `count`, `source`, `timestamp` |
|
|
810
|
+
| **Budget** | `amount`, `currency`, `period`, `spent`, `remaining` |
|
|
811
|
+
| **AdAudience** | `name`, `type`, `size`, `criteria`, `source` |
|
|
812
|
+
|
|
813
|
+
#### Actions & Events
|
|
814
|
+
|
|
815
|
+
| Entity | Actions | Events |
|
|
816
|
+
|--------|---------|--------|
|
|
817
|
+
| **Ad** | create, update, delete, pause, resume, approve, reject | created, updated, deleted, paused, resumed, approved, rejected |
|
|
818
|
+
| **AdGroup** | create, update, delete, pause, resume | created, updated, deleted, paused, resumed |
|
|
819
|
+
| **AdCampaign** | create, update, delete, launch, pause, resume, end | created, updated, deleted, launched, paused, resumed, ended |
|
|
820
|
+
| **Keyword** | create, update, delete, pause | created, updated, deleted, paused |
|
|
821
|
+
| **NegativeKeyword** | create, delete | created, deleted |
|
|
822
|
+
| **Conversion** | track, attribute, export | tracked, attributed, exported |
|
|
823
|
+
| **Budget** | create, update, pause, resume | created, updated, paused, resumed |
|
|
824
|
+
| **AdAudience** | create, update, delete, sync | created, updated, deleted, synced |
|
|
825
|
+
|
|
826
|
+
---
|
|
827
|
+
|
|
828
|
+
### Video
|
|
829
|
+
|
|
830
|
+
Video platform entities (YouTube, Twitch).
|
|
831
|
+
|
|
832
|
+
#### Properties
|
|
833
|
+
|
|
834
|
+
| Entity | Key Properties |
|
|
835
|
+
|--------|----------------|
|
|
836
|
+
| **VideoChannel** | `name`, `handle`, `description`, `subscriberCount`, `videoCount`, `verified` |
|
|
837
|
+
| **StreamingVideo** | `title`, `description`, `url`, `duration`, `thumbnail`, `status`, `views`, `likes` |
|
|
838
|
+
| **Playlist** | `title`, `description`, `privacy`, `itemCount`, `thumbnail` |
|
|
839
|
+
| **PlaylistItem** | `video`, `position`, `addedAt` |
|
|
840
|
+
| **LiveStream** | `title`, `description`, `status`, `scheduledAt`, `startedAt`, `viewers`, `chatEnabled` |
|
|
841
|
+
| **ChatMessage** | `content`, `author`, `timestamp`, `type`, `highlighted` |
|
|
842
|
+
| **VideoComment** | `content`, `author`, `likes`, `replies`, `timestamp`, `pinned` |
|
|
843
|
+
| **ChannelSubscription** | `channel`, `subscriber`, `subscribedAt`, `notifications` |
|
|
844
|
+
|
|
845
|
+
#### Actions & Events
|
|
846
|
+
|
|
847
|
+
| Entity | Actions | Events |
|
|
848
|
+
|--------|---------|--------|
|
|
849
|
+
| **VideoChannel** | create, update, customize, delete, verify | created, updated, customized, deleted, verified |
|
|
850
|
+
| **StreamingVideo** | upload, update, publish, unpublish, delete, monetize | uploaded, updated, published, unpublished, deleted, monetized |
|
|
851
|
+
| **Playlist** | create, update, delete, addVideo, removeVideo, reorder | created, updated, deleted, videoAdded, videoRemoved, reordered |
|
|
852
|
+
| **PlaylistItem** | add, remove, reorder | added, removed, reordered |
|
|
853
|
+
| **LiveStream** | create, update, start, end, configure, delete | created, updated, started, ended, configured, deleted |
|
|
854
|
+
| **ChatMessage** | send, delete, pin, timeout, ban | sent, deleted, pinned, timedOut, banned |
|
|
855
|
+
| **VideoComment** | create, update, delete, reply, pin, heart | created, updated, deleted, replied, pinned, hearted |
|
|
856
|
+
| **ChannelSubscription** | subscribe, unsubscribe, setNotifications | subscribed, unsubscribed, notificationsSet |
|
|
857
|
+
|
|
858
|
+
---
|
|
859
|
+
|
|
860
|
+
### Identity
|
|
861
|
+
|
|
862
|
+
Identity, SSO, directory, and secrets management entities.
|
|
863
|
+
|
|
864
|
+
#### Properties
|
|
865
|
+
|
|
866
|
+
| Entity | Key Properties |
|
|
867
|
+
|--------|----------------|
|
|
868
|
+
| **Vault** | `name`, `status`, `sealed`, `version`, `policies` |
|
|
869
|
+
| **VaultSecret** | `path`, `version`, `metadata`, `createdAt`, `expiresAt` |
|
|
870
|
+
| **SecretVersion** | `version`, `createdAt`, `deletedAt`, `destroyed` |
|
|
871
|
+
| **VaultPolicy** | `name`, `rules`, `paths` |
|
|
872
|
+
| **SSOConnection** | `name`, `type`, `domain`, `status`, `idpUrl`, `certificate` |
|
|
873
|
+
| **Directory** | `name`, `type`, `domain`, `status`, `userCount`, `groupCount` |
|
|
874
|
+
| **DirectoryUser** | `email`, `firstName`, `lastName`, `status`, `groups`, `lastSyncAt` |
|
|
875
|
+
| **DirectoryGroup** | `name`, `description`, `members`, `type` |
|
|
876
|
+
| **AuditLog** | `action`, `actor`, `target`, `timestamp`, `ipAddress`, `details` |
|
|
877
|
+
| **Organization** | `name`, `slug`, `plan`, `memberCount`, `createdAt` |
|
|
878
|
+
| **OrganizationMember** | `user`, `role`, `invitedAt`, `joinedAt` |
|
|
879
|
+
|
|
880
|
+
#### Actions & Events
|
|
881
|
+
|
|
882
|
+
| Entity | Actions | Events |
|
|
883
|
+
|--------|---------|--------|
|
|
884
|
+
| **Vault** | create, update, delete, seal, unseal | created, updated, deleted, sealed, unsealed |
|
|
885
|
+
| **VaultSecret** | create, update, delete, rotate | created, updated, deleted, rotated, accessed |
|
|
886
|
+
| **SecretVersion** | create, access, delete, destroy | created, accessed, deleted, destroyed |
|
|
887
|
+
| **VaultPolicy** | create, update, delete, attach, detach | created, updated, deleted, attached, detached |
|
|
888
|
+
| **SSOConnection** | create, update, delete, test, enable, disable | created, updated, deleted, tested, enabled, disabled |
|
|
889
|
+
| **Directory** | create, update, delete, sync | created, updated, deleted, synced |
|
|
890
|
+
| **DirectoryUser** | create, update, delete, suspend, unsuspend | created, updated, deleted, suspended, unsuspended |
|
|
891
|
+
| **DirectoryGroup** | create, update, delete, addMember, removeMember | created, updated, deleted, memberAdded, memberRemoved |
|
|
892
|
+
| **AuditLog** | create, export, search | created, exported, searched |
|
|
893
|
+
| **Organization** | create, update, delete | created, updated, deleted |
|
|
894
|
+
| **OrganizationMember** | invite, remove, updateRole | invited, joined, removed, roleUpdated |
|
|
895
|
+
|
|
896
|
+
---
|
|
897
|
+
|
|
898
|
+
### Notification
|
|
899
|
+
|
|
900
|
+
Push, SMS, email, and in-app notification entities.
|
|
901
|
+
|
|
902
|
+
#### Properties
|
|
903
|
+
|
|
904
|
+
| Entity | Key Properties |
|
|
905
|
+
|--------|----------------|
|
|
906
|
+
| **Notification** | `title`, `body`, `type`, `channel`, `status`, `sentAt`, `readAt` |
|
|
907
|
+
| **NotificationTemplate** | `name`, `channel`, `subject`, `body`, `variables` |
|
|
908
|
+
| **NotificationCampaign** | `name`, `template`, `audience`, `status`, `scheduledAt`, `sentCount` |
|
|
909
|
+
| **SMS** | `to`, `from`, `body`, `status`, `segments`, `sentAt`, `deliveredAt` |
|
|
910
|
+
| **SMSConversation** | `participants`, `lastMessageAt`, `status`, `messageCount` |
|
|
911
|
+
| **PushNotification** | `title`, `body`, `data`, `badge`, `sound`, `status`, `sentAt` |
|
|
912
|
+
| **Device** | `token`, `platform`, `model`, `osVersion`, `appVersion`, `pushEnabled` |
|
|
913
|
+
| **NotificationPreference** | `channel`, `enabled`, `frequency`, `quietHours` |
|
|
914
|
+
| **InAppNotification** | `title`, `body`, `type`, `read`, `actionUrl`, `createdAt` |
|
|
915
|
+
|
|
916
|
+
#### Actions & Events
|
|
917
|
+
|
|
918
|
+
| Entity | Actions | Events |
|
|
919
|
+
|--------|---------|--------|
|
|
920
|
+
| **Notification** | create, send, schedule, cancel, markRead | created, sent, scheduled, cancelled, read |
|
|
921
|
+
| **NotificationTemplate** | create, update, delete, test | created, updated, deleted, tested |
|
|
922
|
+
| **NotificationCampaign** | create, update, launch, pause, resume, end | created, updated, launched, paused, resumed, ended |
|
|
923
|
+
| **SMS** | send, schedule, cancel | sent, delivered, failed, scheduled, cancelled |
|
|
924
|
+
| **SMSConversation** | create, reply, close | created, replied, closed |
|
|
925
|
+
| **PushNotification** | send, schedule, cancel | sent, delivered, opened, dismissed, scheduled, cancelled |
|
|
926
|
+
| **Device** | register, update, unregister | registered, updated, unregistered |
|
|
927
|
+
| **NotificationPreference** | update, reset | updated, reset |
|
|
928
|
+
| **InAppNotification** | create, markRead, archive, delete | created, read, archived, deleted |
|
|
929
|
+
|
|
930
|
+
---
|
|
931
|
+
|
|
932
|
+
### HR
|
|
933
|
+
|
|
934
|
+
Human resources entities.
|
|
935
|
+
|
|
936
|
+
#### Properties
|
|
937
|
+
|
|
938
|
+
| Entity | Key Properties |
|
|
939
|
+
|--------|----------------|
|
|
940
|
+
| **Employee** | `firstName`, `lastName`, `email`, `status`, `type`, `title`, `department`, `startDate`, `salary` |
|
|
941
|
+
| **Team** | `name`, `description`, `type`, `status`, `lead`, `members` |
|
|
942
|
+
| **TimeOff** | `type`, `status`, `startDate`, `endDate`, `hours`, `reason` |
|
|
943
|
+
| **PerformanceReview** | `type`, `status`, `periodStart`, `periodEnd`, `overallRating`, `goals` |
|
|
944
|
+
| **Benefit** | `type`, `plan`, `status`, `coverageLevel`, `effectiveDate` |
|
|
945
|
+
| **Payroll** | `payPeriodStart`, `payPeriodEnd`, `payDate`, `status`, `grossPay`, `netPay` |
|
|
946
|
+
|
|
947
|
+
#### Actions & Events
|
|
948
|
+
|
|
949
|
+
| Entity | Actions | Events |
|
|
950
|
+
|--------|---------|--------|
|
|
951
|
+
| **Employee** | create, update, onboard, offboard, terminate, promote, transfer, updateCompensation | created, updated, onboarded, offboarded, terminated, promoted, transferred, compensationUpdated |
|
|
952
|
+
| **Team** | create, update, delete, archive, addMember, removeMember, setLead | created, updated, deleted, archived, memberAdded, memberRemoved, leadChanged |
|
|
953
|
+
| **TimeOff** | request, approve, deny, cancel, modify | requested, approved, denied, cancelled, modified |
|
|
954
|
+
| **PerformanceReview** | create, submitSelfAssessment, submitManagerReview, complete, acknowledge, reopen | created, selfAssessmentSubmitted, managerReviewSubmitted, completed, acknowledged, reopened |
|
|
955
|
+
| **Benefit** | enroll, update, cancel, renew | enrolled, updated, cancelled, renewed, expired |
|
|
956
|
+
| **Payroll** | create, process, approve, cancel | created, processed, approved, paid, cancelled |
|
|
957
|
+
|
|
958
|
+
---
|
|
959
|
+
|
|
960
|
+
### Recruiting
|
|
961
|
+
|
|
962
|
+
Recruiting and applicant tracking entities.
|
|
963
|
+
|
|
964
|
+
#### Properties
|
|
965
|
+
|
|
966
|
+
| Entity | Key Properties |
|
|
967
|
+
|--------|----------------|
|
|
968
|
+
| **Job** | `title`, `description`, `department`, `location`, `workType`, `status`, `salaryMin`, `salaryMax` |
|
|
969
|
+
| **Candidate** | `firstName`, `lastName`, `email`, `phone`, `resumeUrl`, `source`, `currentTitle` |
|
|
970
|
+
| **Application** | `status`, `stage`, `rating`, `appliedAt`, `rejectionReason` |
|
|
971
|
+
| **Interview** | `type`, `status`, `scheduledAt`, `duration`, `feedback`, `rating`, `recommendation` |
|
|
972
|
+
| **Offer** | `status`, `title`, `salary`, `bonus`, `equity`, `startDate`, `expiresAt` |
|
|
973
|
+
|
|
974
|
+
#### Actions & Events
|
|
975
|
+
|
|
976
|
+
| Entity | Actions | Events |
|
|
977
|
+
|--------|---------|--------|
|
|
978
|
+
| **Job** | create, update, publish, pause, close, reopen, duplicate | created, updated, published, paused, closed, reopened, filled |
|
|
979
|
+
| **Candidate** | create, update, merge, archive, addTag, removeTag | created, updated, merged, archived, tagAdded, tagRemoved |
|
|
980
|
+
| **Application** | submit, review, advance, reject, withdraw, restore | submitted, reviewed, advanced, rejected, withdrawn, restored, hired |
|
|
981
|
+
| **Interview** | schedule, confirm, reschedule, cancel, complete, submitFeedback | scheduled, confirmed, rescheduled, cancelled, started, completed, feedbackSubmitted |
|
|
982
|
+
| **Offer** | create, update, submitForApproval, approve, send, accept, decline, rescind, negotiate | created, updated, submittedForApproval, approved, sent, accepted, declined, rescinded, negotiated, expired |
|
|
983
|
+
|
|
984
|
+
---
|
|
985
|
+
|
|
986
|
+
### Design
|
|
987
|
+
|
|
988
|
+
Design tool entities.
|
|
989
|
+
|
|
990
|
+
#### Properties
|
|
991
|
+
|
|
992
|
+
| Entity | Key Properties |
|
|
993
|
+
|--------|----------------|
|
|
994
|
+
| **DesignFile** | `name`, `key`, `type`, `version`, `thumbnailUrl`, `pageCount`, `componentCount` |
|
|
995
|
+
| **Component** | `name`, `key`, `description`, `category`, `properties`, `status`, `isPublished` |
|
|
996
|
+
| **DesignSystem** | `name`, `description`, `version`, `componentCount`, `styleCount`, `status` |
|
|
997
|
+
| **Style** | `name`, `key`, `type`, `value`, `category` |
|
|
998
|
+
| **Prototype** | `name`, `description`, `startingFrame`, `device`, `previewUrl` |
|
|
999
|
+
| **DesignComment** | `message`, `x`, `y`, `frameId`, `status`, `resolvedAt` |
|
|
1000
|
+
|
|
1001
|
+
#### Actions & Events
|
|
1002
|
+
|
|
1003
|
+
| Entity | Actions | Events |
|
|
1004
|
+
|--------|---------|--------|
|
|
1005
|
+
| **DesignFile** | create, update, rename, duplicate, delete, share, export, version | created, updated, renamed, duplicated, deleted, shared, exported, versioned |
|
|
1006
|
+
| **Component** | create, update, publish, unpublish, deprecate, delete | created, updated, published, unpublished, deprecated, deleted |
|
|
1007
|
+
| **DesignSystem** | create, update, publish, deprecate | created, updated, published, versionReleased, deprecated |
|
|
1008
|
+
| **Style** | create, update, delete, publish | created, updated, deleted, published |
|
|
1009
|
+
| **Prototype** | create, update, share, present | created, updated, shared, presented, viewed |
|
|
1010
|
+
| **DesignComment** | create, update, delete, resolve, reopen, reply | created, updated, deleted, resolved, reopened, replied |
|
|
1011
|
+
|
|
1012
|
+
---
|
|
1013
|
+
|
|
1014
|
+
### Shipping
|
|
1015
|
+
|
|
1016
|
+
Shipping and logistics entities.
|
|
1017
|
+
|
|
1018
|
+
#### Properties
|
|
1019
|
+
|
|
1020
|
+
| Entity | Key Properties |
|
|
1021
|
+
|--------|----------------|
|
|
1022
|
+
| **Shipment** | `trackingNumber`, `status`, `carrier`, `service`, `originAddress`, `destinationAddress`, `estimatedDelivery` |
|
|
1023
|
+
| **Package** | `trackingNumber`, `weight`, `dimensions`, `packageType`, `contents`, `declaredValue` |
|
|
1024
|
+
| **TrackingEvent** | `status`, `message`, `location`, `timestamp`, `signedBy` |
|
|
1025
|
+
| **Carrier** | `name`, `code`, `isActive`, `services`, `accountNumber` |
|
|
1026
|
+
| **Rate** | `carrier`, `service`, `rate`, `currency`, `deliveryDays`, `guaranteed` |
|
|
1027
|
+
|
|
1028
|
+
#### Actions & Events
|
|
1029
|
+
|
|
1030
|
+
| Entity | Actions | Events |
|
|
1031
|
+
|--------|---------|--------|
|
|
1032
|
+
| **Shipment** | create, update, ship, cancel, track, requestReturn | created, shipped, inTransit, outForDelivery, delivered, failed, returned, cancelled |
|
|
1033
|
+
| **Package** | create, update, weigh, measure | created, updated, weighed, measured |
|
|
1034
|
+
| **TrackingEvent** | create | created |
|
|
1035
|
+
| **Carrier** | create, update, activate, deactivate, getRates | created, updated, activated, deactivated |
|
|
1036
|
+
| **Rate** | get, select | retrieved, selected |
|
|
1037
|
+
|
|
1038
|
+
---
|
|
1039
|
+
|
|
1040
|
+
### Automation
|
|
1041
|
+
|
|
1042
|
+
Workflow automation entities.
|
|
1043
|
+
|
|
1044
|
+
#### Properties
|
|
1045
|
+
|
|
1046
|
+
| Entity | Key Properties |
|
|
1047
|
+
|--------|----------------|
|
|
1048
|
+
| **AutomationWorkflow** | `name`, `description`, `status`, `triggerType`, `isActive`, `runCount`, `lastRunAt` |
|
|
1049
|
+
| **Trigger** | `type`, `config`, `schedule`, `webhookUrl`, `eventType`, `filters`, `isActive` |
|
|
1050
|
+
| **Action** | `name`, `type`, `app`, `operation`, `config`, `order`, `continueOnError` |
|
|
1051
|
+
| **AutomationRun** | `status`, `startedAt`, `completedAt`, `duration`, `triggerData`, `output`, `error` |
|
|
1052
|
+
| **StepResult** | `status`, `stepNumber`, `actionType`, `startedAt`, `completedAt`, `input`, `output`, `error` |
|
|
1053
|
+
| **Integration** | `name`, `app`, `status`, `authType`, `accountName`, `expiresAt` |
|
|
1054
|
+
|
|
1055
|
+
#### Actions & Events
|
|
1056
|
+
|
|
1057
|
+
| Entity | Actions | Events |
|
|
1058
|
+
|--------|---------|--------|
|
|
1059
|
+
| **AutomationWorkflow** | create, update, activate, pause, archive, duplicate, run, test | created, updated, activated, paused, archived, duplicated, runStarted, runCompleted, runFailed |
|
|
1060
|
+
| **Trigger** | create, update, activate, deactivate, test | created, updated, activated, deactivated, fired |
|
|
1061
|
+
| **Action** | create, update, delete, test, reorder | created, updated, deleted, executed, failed |
|
|
1062
|
+
| **AutomationRun** | start, cancel, retry, resume | started, stepCompleted, stepFailed, completed, failed, cancelled, retried |
|
|
1063
|
+
| **StepResult** | — | started, completed, failed |
|
|
1064
|
+
| **Integration** | connect, disconnect, refresh, test | connected, disconnected, refreshed, expired, error |
|
|
1065
|
+
|
|
1066
|
+
---
|
|
1067
|
+
|
|
1068
|
+
### AI
|
|
1069
|
+
|
|
1070
|
+
AI and machine learning entities.
|
|
1071
|
+
|
|
1072
|
+
#### Properties
|
|
1073
|
+
|
|
1074
|
+
| Entity | Key Properties |
|
|
1075
|
+
|--------|----------------|
|
|
1076
|
+
| **Model** | `name`, `provider`, `modelId`, `type`, `contextWindow`, `maxOutputTokens`, `supportsTools`, `status` |
|
|
1077
|
+
| **Prompt** | `name`, `template`, `systemPrompt`, `variables`, `defaultModel`, `temperature`, `version` |
|
|
1078
|
+
| **Completion** | `input`, `output`, `modelId`, `inputTokens`, `outputTokens`, `cost`, `latency`, `status` |
|
|
1079
|
+
| **AIConversation** | `title`, `systemPrompt`, `modelId`, `messageCount`, `totalTokens`, `lastMessageAt` |
|
|
1080
|
+
| **Agent** | `name`, `description`, `systemPrompt`, `modelId`, `tools`, `maxIterations`, `status` |
|
|
1081
|
+
| **Embedding** | `text`, `vector`, `dimensions`, `sourceType`, `modelId`, `namespace` |
|
|
1082
|
+
| **FineTune** | `name`, `baseModel`, `fineTunedModel`, `status`, `trainingFile`, `epochs` |
|
|
1083
|
+
|
|
1084
|
+
#### Actions & Events
|
|
1085
|
+
|
|
1086
|
+
| Entity | Actions | Events |
|
|
1087
|
+
|--------|---------|--------|
|
|
1088
|
+
| **Model** | create, update, activate, deactivate, test | created, updated, activated, deactivated, deprecated |
|
|
1089
|
+
| **Prompt** | create, update, publish, unpublish, duplicate, version, test | created, updated, published, unpublished, versioned |
|
|
1090
|
+
| **Completion** | create, cancel, retry | started, streamed, completed, failed, cancelled |
|
|
1091
|
+
| **AIConversation** | create, update, archive, delete, fork | created, updated, messageAdded, archived, deleted |
|
|
1092
|
+
| **Agent** | create, update, activate, pause, archive, duplicate, invoke | created, updated, activated, paused, archived, invoked |
|
|
1093
|
+
| **Embedding** | create, delete, search | created, deleted |
|
|
1094
|
+
| **FineTune** | create, cancel | created, started, progressed, succeeded, failed, cancelled |
|
|
1095
|
+
|
|
1096
|
+
---
|
|
1097
|
+
|
|
1098
|
+
## Usage
|
|
1099
|
+
|
|
1100
|
+
```typescript
|
|
1101
|
+
import { AllEntities, EntityCategories } from 'digital-tools'
|
|
1102
|
+
|
|
1103
|
+
// Access all entities by category
|
|
1104
|
+
const messageEntities = AllEntities.message
|
|
1105
|
+
const financeEntities = AllEntities.finance
|
|
1106
|
+
const aiEntities = AllEntities.ai
|
|
1107
|
+
|
|
1108
|
+
// List all categories
|
|
1109
|
+
console.log(EntityCategories)
|
|
1110
|
+
// ['site', 'message', 'productivity', 'project', 'code', 'sales', 'finance', ...]
|
|
1111
|
+
|
|
1112
|
+
// 32 total categories:
|
|
1113
|
+
// site, message, productivity, project, code, sales, finance, support, media,
|
|
1114
|
+
// marketing, knowledge, commerce, analytics, storage, meeting, form, signature,
|
|
1115
|
+
// document, spreadsheet, presentation, infrastructure, experiment, advertising,
|
|
1116
|
+
// video, identity, notification, hr, recruiting, design, shipping, automation, ai
|
|
1117
|
+
```
|
|
1118
|
+
|
|
1119
|
+
## Providers
|
|
1120
|
+
|
|
1121
|
+
```typescript
|
|
1122
|
+
import {
|
|
1123
|
+
registerAllProviders,
|
|
1124
|
+
createProvider,
|
|
1125
|
+
getProvider
|
|
1126
|
+
} from 'digital-tools'
|
|
1127
|
+
|
|
1128
|
+
// Register all built-in providers
|
|
1129
|
+
registerAllProviders()
|
|
1130
|
+
|
|
1131
|
+
// Create a provider instance
|
|
1132
|
+
const stripe = await createProvider('finance.stripe', {
|
|
1133
|
+
apiKey: process.env.STRIPE_API_KEY
|
|
1134
|
+
})
|
|
1135
|
+
|
|
1136
|
+
// Use the provider
|
|
1137
|
+
const customer = await stripe.createCustomer({
|
|
1138
|
+
email: 'user@example.com'
|
|
1139
|
+
})
|
|
1140
|
+
```
|
|
1141
|
+
|
|
1142
|
+
## License
|
|
1143
|
+
|
|
1144
|
+
MIT
|