@nemphi/sdk 0.2.5092 → 0.2.5124
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/dist/generated/_/codec.d.ts +94 -0
- package/dist/generated/_/codec.d.ts.map +1 -0
- package/dist/generated/_/codec.js +299 -0
- package/dist/generated/_/codec.js.map +1 -0
- package/dist/generated/_/error.d.ts +28 -0
- package/dist/generated/_/error.d.ts.map +1 -0
- package/dist/generated/_/error.js +69 -0
- package/dist/generated/_/error.js.map +1 -0
- package/dist/generated/_/hooks/envelope.d.ts +12 -0
- package/dist/generated/_/hooks/envelope.d.ts.map +1 -0
- package/dist/generated/_/hooks/envelope.js +16 -0
- package/dist/generated/_/hooks/envelope.js.map +1 -0
- package/dist/generated/_/index.d.ts +4 -0
- package/dist/generated/_/index.d.ts.map +1 -0
- package/dist/generated/_/index.js +6 -0
- package/dist/generated/_/index.js.map +1 -0
- package/dist/generated/_/transport.d.ts +147 -0
- package/dist/generated/_/transport.d.ts.map +1 -0
- package/dist/generated/_/transport.js +221 -0
- package/dist/generated/_/transport.js.map +1 -0
- package/dist/generated/agents/client.d.ts +242 -0
- package/dist/generated/agents/client.d.ts.map +1 -0
- package/dist/generated/agents/client.js +48 -0
- package/dist/generated/agents/client.js.map +1 -0
- package/dist/generated/agents/index.d.ts +6 -0
- package/dist/generated/agents/index.d.ts.map +1 -0
- package/dist/generated/agents/index.js +5 -0
- package/dist/generated/agents/index.js.map +1 -0
- package/dist/generated/agents/models.d.ts +7 -0
- package/dist/generated/agents/models.d.ts.map +1 -0
- package/dist/generated/agents/models.js +7 -0
- package/dist/generated/agents/models.js.map +1 -0
- package/dist/generated/analytics/client.d.ts +249 -0
- package/dist/generated/analytics/client.d.ts.map +1 -0
- package/dist/generated/analytics/client.js +53 -0
- package/dist/generated/analytics/client.js.map +1 -0
- package/dist/generated/analytics/index.d.ts +6 -0
- package/dist/generated/analytics/index.d.ts.map +1 -0
- package/dist/generated/analytics/index.js +5 -0
- package/dist/generated/analytics/index.js.map +1 -0
- package/dist/generated/analytics/models.d.ts +28 -0
- package/dist/generated/analytics/models.d.ts.map +1 -0
- package/dist/generated/analytics/models.js +8 -0
- package/dist/generated/analytics/models.js.map +1 -0
- package/dist/generated/ap/client.d.ts +42 -0
- package/dist/generated/ap/client.d.ts.map +1 -0
- package/dist/generated/ap/client.js +21 -0
- package/dist/generated/ap/client.js.map +1 -0
- package/dist/generated/ap/index.d.ts +5 -0
- package/dist/generated/ap/index.d.ts.map +1 -0
- package/dist/generated/ap/index.js +5 -0
- package/dist/generated/ap/index.js.map +1 -0
- package/dist/generated/appdata/client.d.ts +145 -0
- package/dist/generated/appdata/client.d.ts.map +1 -0
- package/dist/generated/appdata/client.js +45 -0
- package/dist/generated/appdata/client.js.map +1 -0
- package/dist/generated/appdata/index.d.ts +6 -0
- package/dist/generated/appdata/index.d.ts.map +1 -0
- package/dist/generated/appdata/index.js +5 -0
- package/dist/generated/appdata/index.js.map +1 -0
- package/dist/generated/appdata/models.d.ts +14 -0
- package/dist/generated/appdata/models.d.ts.map +1 -0
- package/dist/generated/appdata/models.js +10 -0
- package/dist/generated/appdata/models.js.map +1 -0
- package/dist/generated/approvals/client.d.ts +58 -0
- package/dist/generated/approvals/client.d.ts.map +1 -0
- package/dist/generated/approvals/client.js +28 -0
- package/dist/generated/approvals/client.js.map +1 -0
- package/dist/generated/approvals/index.d.ts +6 -0
- package/dist/generated/approvals/index.d.ts.map +1 -0
- package/dist/generated/approvals/index.js +5 -0
- package/dist/generated/approvals/index.js.map +1 -0
- package/dist/generated/approvals/models.d.ts +21 -0
- package/dist/generated/approvals/models.d.ts.map +1 -0
- package/dist/generated/approvals/models.js +14 -0
- package/dist/generated/approvals/models.js.map +1 -0
- package/dist/generated/apps/client.d.ts +639 -0
- package/dist/generated/apps/client.d.ts.map +1 -0
- package/dist/generated/apps/client.js +190 -0
- package/dist/generated/apps/client.js.map +1 -0
- package/dist/generated/apps/index.d.ts +6 -0
- package/dist/generated/apps/index.d.ts.map +1 -0
- package/dist/generated/apps/index.js +5 -0
- package/dist/generated/apps/index.js.map +1 -0
- package/dist/generated/apps/models.d.ts +157 -0
- package/dist/generated/apps/models.d.ts.map +1 -0
- package/dist/generated/apps/models.js +73 -0
- package/dist/generated/apps/models.js.map +1 -0
- package/dist/generated/ar/client.d.ts +41 -0
- package/dist/generated/ar/client.d.ts.map +1 -0
- package/dist/generated/ar/client.js +21 -0
- package/dist/generated/ar/client.js.map +1 -0
- package/dist/generated/ar/index.d.ts +5 -0
- package/dist/generated/ar/index.d.ts.map +1 -0
- package/dist/generated/ar/index.js +5 -0
- package/dist/generated/ar/index.js.map +1 -0
- package/dist/generated/assets/client.d.ts +404 -0
- package/dist/generated/assets/client.d.ts.map +1 -0
- package/dist/generated/assets/client.js +92 -0
- package/dist/generated/assets/client.js.map +1 -0
- package/dist/generated/assets/index.d.ts +6 -0
- package/dist/generated/assets/index.d.ts.map +1 -0
- package/dist/generated/assets/index.js +5 -0
- package/dist/generated/assets/index.js.map +1 -0
- package/dist/generated/assets/models.d.ts +143 -0
- package/dist/generated/assets/models.d.ts.map +1 -0
- package/dist/generated/assets/models.js +108 -0
- package/dist/generated/assets/models.js.map +1 -0
- package/dist/generated/bank/client.d.ts +559 -0
- package/dist/generated/bank/client.d.ts.map +1 -0
- package/dist/generated/bank/client.js +144 -0
- package/dist/generated/bank/client.js.map +1 -0
- package/dist/generated/bank/index.d.ts +6 -0
- package/dist/generated/bank/index.d.ts.map +1 -0
- package/dist/generated/bank/index.js +5 -0
- package/dist/generated/bank/index.js.map +1 -0
- package/dist/generated/bank/models.d.ts +284 -0
- package/dist/generated/bank/models.d.ts.map +1 -0
- package/dist/generated/bank/models.js +191 -0
- package/dist/generated/bank/models.js.map +1 -0
- package/dist/generated/banks/client.d.ts +35 -0
- package/dist/generated/banks/client.d.ts.map +1 -0
- package/dist/generated/banks/client.js +19 -0
- package/dist/generated/banks/client.js.map +1 -0
- package/dist/generated/banks/index.d.ts +6 -0
- package/dist/generated/banks/index.d.ts.map +1 -0
- package/dist/generated/banks/index.js +5 -0
- package/dist/generated/banks/index.js.map +1 -0
- package/dist/generated/banks/models.d.ts +5 -0
- package/dist/generated/banks/models.d.ts.map +1 -0
- package/dist/generated/banks/models.js +4 -0
- package/dist/generated/banks/models.js.map +1 -0
- package/dist/generated/bills/client.d.ts +472 -0
- package/dist/generated/bills/client.d.ts.map +1 -0
- package/dist/generated/bills/client.js +92 -0
- package/dist/generated/bills/client.js.map +1 -0
- package/dist/generated/bills/index.d.ts +6 -0
- package/dist/generated/bills/index.d.ts.map +1 -0
- package/dist/generated/bills/index.js +5 -0
- package/dist/generated/bills/index.js.map +1 -0
- package/dist/generated/bills/models.d.ts +167 -0
- package/dist/generated/bills/models.d.ts.map +1 -0
- package/dist/generated/bills/models.js +139 -0
- package/dist/generated/bills/models.js.map +1 -0
- package/dist/generated/bookings/client.d.ts +436 -0
- package/dist/generated/bookings/client.d.ts.map +1 -0
- package/dist/generated/bookings/client.js +92 -0
- package/dist/generated/bookings/client.js.map +1 -0
- package/dist/generated/bookings/index.d.ts +6 -0
- package/dist/generated/bookings/index.d.ts.map +1 -0
- package/dist/generated/bookings/index.js +5 -0
- package/dist/generated/bookings/index.js.map +1 -0
- package/dist/generated/bookings/models.d.ts +96 -0
- package/dist/generated/bookings/models.d.ts.map +1 -0
- package/dist/generated/bookings/models.js +67 -0
- package/dist/generated/bookings/models.js.map +1 -0
- package/dist/generated/budget/client.d.ts +205 -0
- package/dist/generated/budget/client.d.ts.map +1 -0
- package/dist/generated/budget/client.js +56 -0
- package/dist/generated/budget/client.js.map +1 -0
- package/dist/generated/budget/index.d.ts +6 -0
- package/dist/generated/budget/index.d.ts.map +1 -0
- package/dist/generated/budget/index.js +5 -0
- package/dist/generated/budget/index.js.map +1 -0
- package/dist/generated/budget/models.d.ts +45 -0
- package/dist/generated/budget/models.d.ts.map +1 -0
- package/dist/generated/budget/models.js +33 -0
- package/dist/generated/budget/models.js.map +1 -0
- package/dist/generated/calendar/client.d.ts +551 -0
- package/dist/generated/calendar/client.d.ts.map +1 -0
- package/dist/generated/calendar/client.js +152 -0
- package/dist/generated/calendar/client.js.map +1 -0
- package/dist/generated/calendar/index.d.ts +6 -0
- package/dist/generated/calendar/index.d.ts.map +1 -0
- package/dist/generated/calendar/index.js +5 -0
- package/dist/generated/calendar/index.js.map +1 -0
- package/dist/generated/calendar/models.d.ts +127 -0
- package/dist/generated/calendar/models.d.ts.map +1 -0
- package/dist/generated/calendar/models.js +56 -0
- package/dist/generated/calendar/models.js.map +1 -0
- package/dist/generated/callcenter/client.d.ts +432 -0
- package/dist/generated/callcenter/client.d.ts.map +1 -0
- package/dist/generated/callcenter/client.js +152 -0
- package/dist/generated/callcenter/client.js.map +1 -0
- package/dist/generated/callcenter/index.d.ts +6 -0
- package/dist/generated/callcenter/index.d.ts.map +1 -0
- package/dist/generated/callcenter/index.js +5 -0
- package/dist/generated/callcenter/index.js.map +1 -0
- package/dist/generated/callcenter/models.d.ts +143 -0
- package/dist/generated/callcenter/models.d.ts.map +1 -0
- package/dist/generated/callcenter/models.js +98 -0
- package/dist/generated/callcenter/models.js.map +1 -0
- package/dist/generated/calls/client.d.ts +538 -0
- package/dist/generated/calls/client.d.ts.map +1 -0
- package/dist/generated/calls/client.js +182 -0
- package/dist/generated/calls/client.js.map +1 -0
- package/dist/generated/calls/index.d.ts +6 -0
- package/dist/generated/calls/index.d.ts.map +1 -0
- package/dist/generated/calls/index.js +5 -0
- package/dist/generated/calls/index.js.map +1 -0
- package/dist/generated/calls/models.d.ts +219 -0
- package/dist/generated/calls/models.d.ts.map +1 -0
- package/dist/generated/calls/models.js +150 -0
- package/dist/generated/calls/models.js.map +1 -0
- package/dist/generated/categories/client.d.ts +302 -0
- package/dist/generated/categories/client.d.ts.map +1 -0
- package/dist/generated/categories/client.js +73 -0
- package/dist/generated/categories/client.js.map +1 -0
- package/dist/generated/categories/index.d.ts +6 -0
- package/dist/generated/categories/index.d.ts.map +1 -0
- package/dist/generated/categories/index.js +5 -0
- package/dist/generated/categories/index.js.map +1 -0
- package/dist/generated/categories/models.d.ts +119 -0
- package/dist/generated/categories/models.d.ts.map +1 -0
- package/dist/generated/categories/models.js +81 -0
- package/dist/generated/categories/models.js.map +1 -0
- package/dist/generated/client.d.ts +160 -0
- package/dist/generated/client.d.ts.map +1 -0
- package/dist/generated/client.js +381 -0
- package/dist/generated/client.js.map +1 -0
- package/dist/generated/company/client.d.ts +116 -0
- package/dist/generated/company/client.d.ts.map +1 -0
- package/dist/generated/company/client.js +29 -0
- package/dist/generated/company/client.js.map +1 -0
- package/dist/generated/company/index.d.ts +6 -0
- package/dist/generated/company/index.d.ts.map +1 -0
- package/dist/generated/company/index.js +5 -0
- package/dist/generated/company/index.js.map +1 -0
- package/dist/generated/company/models.d.ts +36 -0
- package/dist/generated/company/models.d.ts.map +1 -0
- package/dist/generated/company/models.js +24 -0
- package/dist/generated/company/models.js.map +1 -0
- package/dist/generated/connections/client.d.ts +161 -0
- package/dist/generated/connections/client.d.ts.map +1 -0
- package/dist/generated/connections/client.js +38 -0
- package/dist/generated/connections/client.js.map +1 -0
- package/dist/generated/connections/index.d.ts +6 -0
- package/dist/generated/connections/index.d.ts.map +1 -0
- package/dist/generated/connections/index.js +5 -0
- package/dist/generated/connections/index.js.map +1 -0
- package/dist/generated/connections/models.d.ts +26 -0
- package/dist/generated/connections/models.d.ts.map +1 -0
- package/dist/generated/connections/models.js +18 -0
- package/dist/generated/connections/models.js.map +1 -0
- package/dist/generated/context/client.d.ts +161 -0
- package/dist/generated/context/client.d.ts.map +1 -0
- package/dist/generated/context/client.js +54 -0
- package/dist/generated/context/client.js.map +1 -0
- package/dist/generated/context/index.d.ts +6 -0
- package/dist/generated/context/index.d.ts.map +1 -0
- package/dist/generated/context/index.js +5 -0
- package/dist/generated/context/index.js.map +1 -0
- package/dist/generated/context/models.d.ts +43 -0
- package/dist/generated/context/models.d.ts.map +1 -0
- package/dist/generated/context/models.js +15 -0
- package/dist/generated/context/models.js.map +1 -0
- package/dist/generated/crew/client.d.ts +94 -0
- package/dist/generated/crew/client.d.ts.map +1 -0
- package/dist/generated/crew/client.js +36 -0
- package/dist/generated/crew/client.js.map +1 -0
- package/dist/generated/crew/index.d.ts +6 -0
- package/dist/generated/crew/index.d.ts.map +1 -0
- package/dist/generated/crew/index.js +5 -0
- package/dist/generated/crew/index.js.map +1 -0
- package/dist/generated/crew/models.d.ts +35 -0
- package/dist/generated/crew/models.d.ts.map +1 -0
- package/dist/generated/crew/models.js +19 -0
- package/dist/generated/crew/models.js.map +1 -0
- package/dist/generated/crm/client.d.ts +1143 -0
- package/dist/generated/crm/client.d.ts.map +1 -0
- package/dist/generated/crm/client.js +315 -0
- package/dist/generated/crm/client.js.map +1 -0
- package/dist/generated/crm/index.d.ts +6 -0
- package/dist/generated/crm/index.d.ts.map +1 -0
- package/dist/generated/crm/index.js +5 -0
- package/dist/generated/crm/index.js.map +1 -0
- package/dist/generated/crm/models.d.ts +301 -0
- package/dist/generated/crm/models.d.ts.map +1 -0
- package/dist/generated/crm/models.js +130 -0
- package/dist/generated/crm/models.js.map +1 -0
- package/dist/generated/dashboards/client.d.ts +260 -0
- package/dist/generated/dashboards/client.d.ts.map +1 -0
- package/dist/generated/dashboards/client.js +88 -0
- package/dist/generated/dashboards/client.js.map +1 -0
- package/dist/generated/dashboards/index.d.ts +6 -0
- package/dist/generated/dashboards/index.d.ts.map +1 -0
- package/dist/generated/dashboards/index.js +5 -0
- package/dist/generated/dashboards/index.js.map +1 -0
- package/dist/generated/dashboards/models.d.ts +731 -0
- package/dist/generated/dashboards/models.d.ts.map +1 -0
- package/dist/generated/dashboards/models.js +63 -0
- package/dist/generated/dashboards/models.js.map +1 -0
- package/dist/generated/documents/client.d.ts +71 -0
- package/dist/generated/documents/client.d.ts.map +1 -0
- package/dist/generated/documents/client.js +40 -0
- package/dist/generated/documents/client.js.map +1 -0
- package/dist/generated/documents/index.d.ts +6 -0
- package/dist/generated/documents/index.d.ts.map +1 -0
- package/dist/generated/documents/index.js +5 -0
- package/dist/generated/documents/index.js.map +1 -0
- package/dist/generated/documents/models.d.ts +39 -0
- package/dist/generated/documents/models.d.ts.map +1 -0
- package/dist/generated/documents/models.js +23 -0
- package/dist/generated/documents/models.js.map +1 -0
- package/dist/generated/drives/client.d.ts +100 -0
- package/dist/generated/drives/client.d.ts.map +1 -0
- package/dist/generated/drives/client.js +47 -0
- package/dist/generated/drives/client.js.map +1 -0
- package/dist/generated/drives/index.d.ts +6 -0
- package/dist/generated/drives/index.d.ts.map +1 -0
- package/dist/generated/drives/index.js +5 -0
- package/dist/generated/drives/index.js.map +1 -0
- package/dist/generated/drives/models.d.ts +29 -0
- package/dist/generated/drives/models.d.ts.map +1 -0
- package/dist/generated/drives/models.js +16 -0
- package/dist/generated/drives/models.js.map +1 -0
- package/dist/generated/einvoice/client.d.ts +192 -0
- package/dist/generated/einvoice/client.d.ts.map +1 -0
- package/dist/generated/einvoice/client.js +65 -0
- package/dist/generated/einvoice/client.js.map +1 -0
- package/dist/generated/einvoice/index.d.ts +6 -0
- package/dist/generated/einvoice/index.d.ts.map +1 -0
- package/dist/generated/einvoice/index.js +5 -0
- package/dist/generated/einvoice/index.js.map +1 -0
- package/dist/generated/einvoice/models.d.ts +82 -0
- package/dist/generated/einvoice/models.d.ts.map +1 -0
- package/dist/generated/einvoice/models.js +54 -0
- package/dist/generated/einvoice/models.js.map +1 -0
- package/dist/generated/email/client.d.ts +393 -0
- package/dist/generated/email/client.d.ts.map +1 -0
- package/dist/generated/email/client.js +126 -0
- package/dist/generated/email/client.js.map +1 -0
- package/dist/generated/email/index.d.ts +6 -0
- package/dist/generated/email/index.d.ts.map +1 -0
- package/dist/generated/email/index.js +5 -0
- package/dist/generated/email/index.js.map +1 -0
- package/dist/generated/email/models.d.ts +100 -0
- package/dist/generated/email/models.d.ts.map +1 -0
- package/dist/generated/email/models.js +43 -0
- package/dist/generated/email/models.js.map +1 -0
- package/dist/generated/employees/client.d.ts +280 -0
- package/dist/generated/employees/client.d.ts.map +1 -0
- package/dist/generated/employees/client.js +57 -0
- package/dist/generated/employees/client.js.map +1 -0
- package/dist/generated/employees/index.d.ts +6 -0
- package/dist/generated/employees/index.d.ts.map +1 -0
- package/dist/generated/employees/index.js +5 -0
- package/dist/generated/employees/index.js.map +1 -0
- package/dist/generated/employees/models.d.ts +14 -0
- package/dist/generated/employees/models.d.ts.map +1 -0
- package/dist/generated/employees/models.js +13 -0
- package/dist/generated/employees/models.js.map +1 -0
- package/dist/generated/feedback/client.d.ts +82 -0
- package/dist/generated/feedback/client.d.ts.map +1 -0
- package/dist/generated/feedback/client.js +29 -0
- package/dist/generated/feedback/client.js.map +1 -0
- package/dist/generated/feedback/index.d.ts +6 -0
- package/dist/generated/feedback/index.d.ts.map +1 -0
- package/dist/generated/feedback/index.js +5 -0
- package/dist/generated/feedback/index.js.map +1 -0
- package/dist/generated/feedback/models.d.ts +29 -0
- package/dist/generated/feedback/models.d.ts.map +1 -0
- package/dist/generated/feedback/models.js +14 -0
- package/dist/generated/feedback/models.js.map +1 -0
- package/dist/generated/fx/client.d.ts +106 -0
- package/dist/generated/fx/client.d.ts.map +1 -0
- package/dist/generated/fx/client.js +36 -0
- package/dist/generated/fx/client.js.map +1 -0
- package/dist/generated/fx/index.d.ts +6 -0
- package/dist/generated/fx/index.d.ts.map +1 -0
- package/dist/generated/fx/index.js +5 -0
- package/dist/generated/fx/index.js.map +1 -0
- package/dist/generated/fx/models.d.ts +41 -0
- package/dist/generated/fx/models.d.ts.map +1 -0
- package/dist/generated/fx/models.js +20 -0
- package/dist/generated/fx/models.js.map +1 -0
- package/dist/generated/imports/client.d.ts +279 -0
- package/dist/generated/imports/client.d.ts.map +1 -0
- package/dist/generated/imports/client.js +56 -0
- package/dist/generated/imports/client.js.map +1 -0
- package/dist/generated/imports/index.d.ts +5 -0
- package/dist/generated/imports/index.d.ts.map +1 -0
- package/dist/generated/imports/index.js +5 -0
- package/dist/generated/imports/index.js.map +1 -0
- package/dist/generated/index.d.ts +6 -0
- package/dist/generated/index.d.ts.map +1 -0
- package/dist/generated/index.js +5 -0
- package/dist/generated/index.js.map +1 -0
- package/dist/generated/inventory/client.d.ts +483 -0
- package/dist/generated/inventory/client.d.ts.map +1 -0
- package/dist/generated/inventory/client.js +145 -0
- package/dist/generated/inventory/client.js.map +1 -0
- package/dist/generated/inventory/index.d.ts +6 -0
- package/dist/generated/inventory/index.d.ts.map +1 -0
- package/dist/generated/inventory/index.js +5 -0
- package/dist/generated/inventory/index.js.map +1 -0
- package/dist/generated/inventory/models.d.ts +241 -0
- package/dist/generated/inventory/models.d.ts.map +1 -0
- package/dist/generated/inventory/models.js +197 -0
- package/dist/generated/inventory/models.js.map +1 -0
- package/dist/generated/invoices/client.d.ts +413 -0
- package/dist/generated/invoices/client.d.ts.map +1 -0
- package/dist/generated/invoices/client.js +84 -0
- package/dist/generated/invoices/client.js.map +1 -0
- package/dist/generated/invoices/index.d.ts +6 -0
- package/dist/generated/invoices/index.d.ts.map +1 -0
- package/dist/generated/invoices/index.js +5 -0
- package/dist/generated/invoices/index.js.map +1 -0
- package/dist/generated/invoices/models.d.ts +190 -0
- package/dist/generated/invoices/models.d.ts.map +1 -0
- package/dist/generated/invoices/models.js +142 -0
- package/dist/generated/invoices/models.js.map +1 -0
- package/dist/generated/items/client.d.ts +342 -0
- package/dist/generated/items/client.d.ts.map +1 -0
- package/dist/generated/items/client.js +56 -0
- package/dist/generated/items/client.js.map +1 -0
- package/dist/generated/items/index.d.ts +6 -0
- package/dist/generated/items/index.d.ts.map +1 -0
- package/dist/generated/items/index.js +5 -0
- package/dist/generated/items/index.js.map +1 -0
- package/dist/generated/items/models.d.ts +57 -0
- package/dist/generated/items/models.d.ts.map +1 -0
- package/dist/generated/items/models.js +36 -0
- package/dist/generated/items/models.js.map +1 -0
- package/dist/generated/knowledge/client.d.ts +608 -0
- package/dist/generated/knowledge/client.d.ts.map +1 -0
- package/dist/generated/knowledge/client.js +250 -0
- package/dist/generated/knowledge/client.js.map +1 -0
- package/dist/generated/knowledge/index.d.ts +6 -0
- package/dist/generated/knowledge/index.d.ts.map +1 -0
- package/dist/generated/knowledge/index.js +5 -0
- package/dist/generated/knowledge/index.js.map +1 -0
- package/dist/generated/knowledge/models.d.ts +100 -0
- package/dist/generated/knowledge/models.d.ts.map +1 -0
- package/dist/generated/knowledge/models.js +45 -0
- package/dist/generated/knowledge/models.js.map +1 -0
- package/dist/generated/ledger/client.d.ts +371 -0
- package/dist/generated/ledger/client.d.ts.map +1 -0
- package/dist/generated/ledger/client.js +126 -0
- package/dist/generated/ledger/client.js.map +1 -0
- package/dist/generated/ledger/index.d.ts +6 -0
- package/dist/generated/ledger/index.d.ts.map +1 -0
- package/dist/generated/ledger/index.js +5 -0
- package/dist/generated/ledger/index.js.map +1 -0
- package/dist/generated/ledger/models.d.ts +139 -0
- package/dist/generated/ledger/models.d.ts.map +1 -0
- package/dist/generated/ledger/models.js +99 -0
- package/dist/generated/ledger/models.js.map +1 -0
- package/dist/generated/marketing/client.d.ts +2509 -0
- package/dist/generated/marketing/client.d.ts.map +1 -0
- package/dist/generated/marketing/client.js +819 -0
- package/dist/generated/marketing/client.js.map +1 -0
- package/dist/generated/marketing/index.d.ts +6 -0
- package/dist/generated/marketing/index.d.ts.map +1 -0
- package/dist/generated/marketing/index.js +5 -0
- package/dist/generated/marketing/index.js.map +1 -0
- package/dist/generated/marketing/models.d.ts +586 -0
- package/dist/generated/marketing/models.d.ts.map +1 -0
- package/dist/generated/marketing/models.js +312 -0
- package/dist/generated/marketing/models.js.map +1 -0
- package/dist/generated/mcp/client.d.ts +293 -0
- package/dist/generated/mcp/client.d.ts.map +1 -0
- package/dist/generated/mcp/client.js +91 -0
- package/dist/generated/mcp/client.js.map +1 -0
- package/dist/generated/mcp/index.d.ts +6 -0
- package/dist/generated/mcp/index.d.ts.map +1 -0
- package/dist/generated/mcp/index.js +5 -0
- package/dist/generated/mcp/index.js.map +1 -0
- package/dist/generated/mcp/models.d.ts +81 -0
- package/dist/generated/mcp/models.d.ts.map +1 -0
- package/dist/generated/mcp/models.js +37 -0
- package/dist/generated/mcp/models.js.map +1 -0
- package/dist/generated/memory/client.d.ts +141 -0
- package/dist/generated/memory/client.d.ts.map +1 -0
- package/dist/generated/memory/client.js +38 -0
- package/dist/generated/memory/client.js.map +1 -0
- package/dist/generated/memory/index.d.ts +6 -0
- package/dist/generated/memory/index.d.ts.map +1 -0
- package/dist/generated/memory/index.js +5 -0
- package/dist/generated/memory/index.js.map +1 -0
- package/dist/generated/memory/models.d.ts +18 -0
- package/dist/generated/memory/models.d.ts.map +1 -0
- package/dist/generated/memory/models.js +11 -0
- package/dist/generated/memory/models.js.map +1 -0
- package/dist/generated/messages/client.d.ts +747 -0
- package/dist/generated/messages/client.d.ts.map +1 -0
- package/dist/generated/messages/client.js +227 -0
- package/dist/generated/messages/client.js.map +1 -0
- package/dist/generated/messages/index.d.ts +6 -0
- package/dist/generated/messages/index.d.ts.map +1 -0
- package/dist/generated/messages/index.js +5 -0
- package/dist/generated/messages/index.js.map +1 -0
- package/dist/generated/messages/models.d.ts +264 -0
- package/dist/generated/messages/models.d.ts.map +1 -0
- package/dist/generated/messages/models.js +174 -0
- package/dist/generated/messages/models.js.map +1 -0
- package/dist/generated/metrics/client.d.ts +265 -0
- package/dist/generated/metrics/client.d.ts.map +1 -0
- package/dist/generated/metrics/client.js +55 -0
- package/dist/generated/metrics/client.js.map +1 -0
- package/dist/generated/metrics/index.d.ts +6 -0
- package/dist/generated/metrics/index.d.ts.map +1 -0
- package/dist/generated/metrics/index.js +5 -0
- package/dist/generated/metrics/index.js.map +1 -0
- package/dist/generated/metrics/models.d.ts +57 -0
- package/dist/generated/metrics/models.d.ts.map +1 -0
- package/dist/generated/metrics/models.js +26 -0
- package/dist/generated/metrics/models.js.map +1 -0
- package/dist/generated/models.d.ts +590 -0
- package/dist/generated/models.d.ts.map +1 -0
- package/dist/generated/models.js +386 -0
- package/dist/generated/models.js.map +1 -0
- package/dist/generated/numbering/client.d.ts +85 -0
- package/dist/generated/numbering/client.d.ts.map +1 -0
- package/dist/generated/numbering/client.js +29 -0
- package/dist/generated/numbering/client.js.map +1 -0
- package/dist/generated/numbering/index.d.ts +6 -0
- package/dist/generated/numbering/index.d.ts.map +1 -0
- package/dist/generated/numbering/index.js +5 -0
- package/dist/generated/numbering/index.js.map +1 -0
- package/dist/generated/numbering/models.d.ts +45 -0
- package/dist/generated/numbering/models.d.ts.map +1 -0
- package/dist/generated/numbering/models.js +35 -0
- package/dist/generated/numbering/models.js.map +1 -0
- package/dist/generated/onboarding/client.d.ts +96 -0
- package/dist/generated/onboarding/client.d.ts.map +1 -0
- package/dist/generated/onboarding/client.js +36 -0
- package/dist/generated/onboarding/client.js.map +1 -0
- package/dist/generated/onboarding/index.d.ts +6 -0
- package/dist/generated/onboarding/index.d.ts.map +1 -0
- package/dist/generated/onboarding/index.js +5 -0
- package/dist/generated/onboarding/index.js.map +1 -0
- package/dist/generated/onboarding/models.d.ts +70 -0
- package/dist/generated/onboarding/models.d.ts.map +1 -0
- package/dist/generated/onboarding/models.js +14 -0
- package/dist/generated/onboarding/models.js.map +1 -0
- package/dist/generated/parties/client.d.ts +344 -0
- package/dist/generated/parties/client.d.ts.map +1 -0
- package/dist/generated/parties/client.js +84 -0
- package/dist/generated/parties/client.js.map +1 -0
- package/dist/generated/parties/index.d.ts +6 -0
- package/dist/generated/parties/index.d.ts.map +1 -0
- package/dist/generated/parties/index.js +5 -0
- package/dist/generated/parties/index.js.map +1 -0
- package/dist/generated/parties/models.d.ts +82 -0
- package/dist/generated/parties/models.d.ts.map +1 -0
- package/dist/generated/parties/models.js +50 -0
- package/dist/generated/parties/models.js.map +1 -0
- package/dist/generated/paymentLinks/client.d.ts +219 -0
- package/dist/generated/paymentLinks/client.d.ts.map +1 -0
- package/dist/generated/paymentLinks/client.js +65 -0
- package/dist/generated/paymentLinks/client.js.map +1 -0
- package/dist/generated/paymentLinks/index.d.ts +6 -0
- package/dist/generated/paymentLinks/index.d.ts.map +1 -0
- package/dist/generated/paymentLinks/index.js +5 -0
- package/dist/generated/paymentLinks/index.js.map +1 -0
- package/dist/generated/paymentLinks/models.d.ts +32 -0
- package/dist/generated/paymentLinks/models.d.ts.map +1 -0
- package/dist/generated/paymentLinks/models.js +21 -0
- package/dist/generated/paymentLinks/models.js.map +1 -0
- package/dist/generated/payments/client.d.ts +66 -0
- package/dist/generated/payments/client.d.ts.map +1 -0
- package/dist/generated/payments/client.js +21 -0
- package/dist/generated/payments/client.js.map +1 -0
- package/dist/generated/payments/index.d.ts +6 -0
- package/dist/generated/payments/index.d.ts.map +1 -0
- package/dist/generated/payments/index.js +5 -0
- package/dist/generated/payments/index.js.map +1 -0
- package/dist/generated/payments/models.d.ts +7 -0
- package/dist/generated/payments/models.d.ts.map +1 -0
- package/dist/generated/payments/models.js +9 -0
- package/dist/generated/payments/models.js.map +1 -0
- package/dist/generated/payroll/client.d.ts +402 -0
- package/dist/generated/payroll/client.d.ts.map +1 -0
- package/dist/generated/payroll/client.js +125 -0
- package/dist/generated/payroll/client.js.map +1 -0
- package/dist/generated/payroll/index.d.ts +6 -0
- package/dist/generated/payroll/index.d.ts.map +1 -0
- package/dist/generated/payroll/index.js +5 -0
- package/dist/generated/payroll/index.js.map +1 -0
- package/dist/generated/payroll/models.d.ts +323 -0
- package/dist/generated/payroll/models.d.ts.map +1 -0
- package/dist/generated/payroll/models.js +233 -0
- package/dist/generated/payroll/models.js.map +1 -0
- package/dist/generated/periods/client.d.ts +102 -0
- package/dist/generated/periods/client.d.ts.map +1 -0
- package/dist/generated/periods/client.js +37 -0
- package/dist/generated/periods/client.js.map +1 -0
- package/dist/generated/periods/index.d.ts +6 -0
- package/dist/generated/periods/index.d.ts.map +1 -0
- package/dist/generated/periods/index.js +5 -0
- package/dist/generated/periods/index.js.map +1 -0
- package/dist/generated/periods/models.d.ts +59 -0
- package/dist/generated/periods/models.d.ts.map +1 -0
- package/dist/generated/periods/models.js +47 -0
- package/dist/generated/periods/models.js.map +1 -0
- package/dist/generated/policies/client.d.ts +126 -0
- package/dist/generated/policies/client.d.ts.map +1 -0
- package/dist/generated/policies/client.js +46 -0
- package/dist/generated/policies/client.js.map +1 -0
- package/dist/generated/policies/index.d.ts +6 -0
- package/dist/generated/policies/index.d.ts.map +1 -0
- package/dist/generated/policies/index.js +5 -0
- package/dist/generated/policies/index.js.map +1 -0
- package/dist/generated/policies/models.d.ts +34 -0
- package/dist/generated/policies/models.d.ts.map +1 -0
- package/dist/generated/policies/models.js +21 -0
- package/dist/generated/policies/models.js.map +1 -0
- package/dist/generated/projects/client.d.ts +835 -0
- package/dist/generated/projects/client.d.ts.map +1 -0
- package/dist/generated/projects/client.js +251 -0
- package/dist/generated/projects/client.js.map +1 -0
- package/dist/generated/projects/index.d.ts +6 -0
- package/dist/generated/projects/index.d.ts.map +1 -0
- package/dist/generated/projects/index.js +5 -0
- package/dist/generated/projects/index.js.map +1 -0
- package/dist/generated/projects/models.d.ts +243 -0
- package/dist/generated/projects/models.d.ts.map +1 -0
- package/dist/generated/projects/models.js +135 -0
- package/dist/generated/projects/models.js.map +1 -0
- package/dist/generated/purchaseOrders/client.d.ts +347 -0
- package/dist/generated/purchaseOrders/client.d.ts.map +1 -0
- package/dist/generated/purchaseOrders/client.js +102 -0
- package/dist/generated/purchaseOrders/client.js.map +1 -0
- package/dist/generated/purchaseOrders/index.d.ts +6 -0
- package/dist/generated/purchaseOrders/index.d.ts.map +1 -0
- package/dist/generated/purchaseOrders/index.js +5 -0
- package/dist/generated/purchaseOrders/index.js.map +1 -0
- package/dist/generated/purchaseOrders/models.d.ts +141 -0
- package/dist/generated/purchaseOrders/models.d.ts.map +1 -0
- package/dist/generated/purchaseOrders/models.js +101 -0
- package/dist/generated/purchaseOrders/models.js.map +1 -0
- package/dist/generated/quotes/client.d.ts +279 -0
- package/dist/generated/quotes/client.d.ts.map +1 -0
- package/dist/generated/quotes/client.js +85 -0
- package/dist/generated/quotes/client.js.map +1 -0
- package/dist/generated/quotes/index.d.ts +6 -0
- package/dist/generated/quotes/index.d.ts.map +1 -0
- package/dist/generated/quotes/index.js +5 -0
- package/dist/generated/quotes/index.js.map +1 -0
- package/dist/generated/quotes/models.d.ts +26 -0
- package/dist/generated/quotes/models.d.ts.map +1 -0
- package/dist/generated/quotes/models.js +21 -0
- package/dist/generated/quotes/models.js.map +1 -0
- package/dist/generated/records/client.d.ts +100 -0
- package/dist/generated/records/client.d.ts.map +1 -0
- package/dist/generated/records/client.js +20 -0
- package/dist/generated/records/client.js.map +1 -0
- package/dist/generated/records/index.d.ts +6 -0
- package/dist/generated/records/index.d.ts.map +1 -0
- package/dist/generated/records/index.js +5 -0
- package/dist/generated/records/index.js.map +1 -0
- package/dist/generated/records/models.d.ts +32 -0
- package/dist/generated/records/models.d.ts.map +1 -0
- package/dist/generated/records/models.js +12 -0
- package/dist/generated/records/models.js.map +1 -0
- package/dist/generated/recurring/client.d.ts +118 -0
- package/dist/generated/recurring/client.d.ts.map +1 -0
- package/dist/generated/recurring/client.js +47 -0
- package/dist/generated/recurring/client.js.map +1 -0
- package/dist/generated/recurring/index.d.ts +6 -0
- package/dist/generated/recurring/index.d.ts.map +1 -0
- package/dist/generated/recurring/index.js +5 -0
- package/dist/generated/recurring/index.js.map +1 -0
- package/dist/generated/recurring/models.d.ts +23 -0
- package/dist/generated/recurring/models.d.ts.map +1 -0
- package/dist/generated/recurring/models.js +14 -0
- package/dist/generated/recurring/models.js.map +1 -0
- package/dist/generated/rentals/client.d.ts +420 -0
- package/dist/generated/rentals/client.d.ts.map +1 -0
- package/dist/generated/rentals/client.js +112 -0
- package/dist/generated/rentals/client.js.map +1 -0
- package/dist/generated/rentals/index.d.ts +6 -0
- package/dist/generated/rentals/index.d.ts.map +1 -0
- package/dist/generated/rentals/index.js +5 -0
- package/dist/generated/rentals/index.js.map +1 -0
- package/dist/generated/rentals/models.d.ts +81 -0
- package/dist/generated/rentals/models.d.ts.map +1 -0
- package/dist/generated/rentals/models.js +63 -0
- package/dist/generated/rentals/models.js.map +1 -0
- package/dist/generated/roles/client.d.ts +131 -0
- package/dist/generated/roles/client.d.ts.map +1 -0
- package/dist/generated/roles/client.js +56 -0
- package/dist/generated/roles/client.js.map +1 -0
- package/dist/generated/roles/index.d.ts +6 -0
- package/dist/generated/roles/index.d.ts.map +1 -0
- package/dist/generated/roles/index.js +5 -0
- package/dist/generated/roles/index.js.map +1 -0
- package/dist/generated/roles/models.d.ts +38 -0
- package/dist/generated/roles/models.d.ts.map +1 -0
- package/dist/generated/roles/models.js +20 -0
- package/dist/generated/roles/models.js.map +1 -0
- package/dist/generated/routines/client.d.ts +188 -0
- package/dist/generated/routines/client.d.ts.map +1 -0
- package/dist/generated/routines/client.js +61 -0
- package/dist/generated/routines/client.js.map +1 -0
- package/dist/generated/routines/index.d.ts +6 -0
- package/dist/generated/routines/index.d.ts.map +1 -0
- package/dist/generated/routines/index.js +5 -0
- package/dist/generated/routines/index.js.map +1 -0
- package/dist/generated/routines/models.d.ts +49 -0
- package/dist/generated/routines/models.d.ts.map +1 -0
- package/dist/generated/routines/models.js +26 -0
- package/dist/generated/routines/models.js.map +1 -0
- package/dist/generated/salesOrders/client.d.ts +244 -0
- package/dist/generated/salesOrders/client.d.ts.map +1 -0
- package/dist/generated/salesOrders/client.js +76 -0
- package/dist/generated/salesOrders/client.js.map +1 -0
- package/dist/generated/salesOrders/index.d.ts +6 -0
- package/dist/generated/salesOrders/index.d.ts.map +1 -0
- package/dist/generated/salesOrders/index.js +5 -0
- package/dist/generated/salesOrders/index.js.map +1 -0
- package/dist/generated/salesOrders/models.d.ts +11 -0
- package/dist/generated/salesOrders/models.d.ts.map +1 -0
- package/dist/generated/salesOrders/models.js +12 -0
- package/dist/generated/salesOrders/models.js.map +1 -0
- package/dist/generated/security/client.d.ts +320 -0
- package/dist/generated/security/client.d.ts.map +1 -0
- package/dist/generated/security/client.js +99 -0
- package/dist/generated/security/client.js.map +1 -0
- package/dist/generated/security/index.d.ts +6 -0
- package/dist/generated/security/index.d.ts.map +1 -0
- package/dist/generated/security/index.js +5 -0
- package/dist/generated/security/index.js.map +1 -0
- package/dist/generated/security/models.d.ts +71 -0
- package/dist/generated/security/models.d.ts.map +1 -0
- package/dist/generated/security/models.js +42 -0
- package/dist/generated/security/models.js.map +1 -0
- package/dist/generated/sessions/client.d.ts +242 -0
- package/dist/generated/sessions/client.d.ts.map +1 -0
- package/dist/generated/sessions/client.js +75 -0
- package/dist/generated/sessions/client.js.map +1 -0
- package/dist/generated/sessions/index.d.ts +6 -0
- package/dist/generated/sessions/index.d.ts.map +1 -0
- package/dist/generated/sessions/index.js +5 -0
- package/dist/generated/sessions/index.js.map +1 -0
- package/dist/generated/sessions/models.d.ts +86 -0
- package/dist/generated/sessions/models.d.ts.map +1 -0
- package/dist/generated/sessions/models.js +56 -0
- package/dist/generated/sessions/models.js.map +1 -0
- package/dist/generated/sidebar/client.d.ts +91 -0
- package/dist/generated/sidebar/client.d.ts.map +1 -0
- package/dist/generated/sidebar/client.js +35 -0
- package/dist/generated/sidebar/client.js.map +1 -0
- package/dist/generated/sidebar/index.d.ts +6 -0
- package/dist/generated/sidebar/index.d.ts.map +1 -0
- package/dist/generated/sidebar/index.js +5 -0
- package/dist/generated/sidebar/index.js.map +1 -0
- package/dist/generated/sidebar/models.d.ts +11 -0
- package/dist/generated/sidebar/models.d.ts.map +1 -0
- package/dist/generated/sidebar/models.js +4 -0
- package/dist/generated/sidebar/models.js.map +1 -0
- package/dist/generated/sites/client.d.ts +765 -0
- package/dist/generated/sites/client.d.ts.map +1 -0
- package/dist/generated/sites/client.js +261 -0
- package/dist/generated/sites/client.js.map +1 -0
- package/dist/generated/sites/index.d.ts +6 -0
- package/dist/generated/sites/index.d.ts.map +1 -0
- package/dist/generated/sites/index.js +5 -0
- package/dist/generated/sites/index.js.map +1 -0
- package/dist/generated/sites/models.d.ts +360 -0
- package/dist/generated/sites/models.d.ts.map +1 -0
- package/dist/generated/sites/models.js +224 -0
- package/dist/generated/sites/models.js.map +1 -0
- package/dist/generated/skills/client.d.ts +120 -0
- package/dist/generated/skills/client.d.ts.map +1 -0
- package/dist/generated/skills/client.js +44 -0
- package/dist/generated/skills/client.js.map +1 -0
- package/dist/generated/skills/index.d.ts +6 -0
- package/dist/generated/skills/index.d.ts.map +1 -0
- package/dist/generated/skills/index.js +5 -0
- package/dist/generated/skills/index.js.map +1 -0
- package/dist/generated/skills/models.d.ts +19 -0
- package/dist/generated/skills/models.d.ts.map +1 -0
- package/dist/generated/skills/models.js +10 -0
- package/dist/generated/skills/models.js.map +1 -0
- package/dist/generated/support/client.d.ts +149 -0
- package/dist/generated/support/client.d.ts.map +1 -0
- package/dist/generated/support/client.js +56 -0
- package/dist/generated/support/client.js.map +1 -0
- package/dist/generated/support/index.d.ts +6 -0
- package/dist/generated/support/index.d.ts.map +1 -0
- package/dist/generated/support/index.js +5 -0
- package/dist/generated/support/index.js.map +1 -0
- package/dist/generated/support/models.d.ts +119 -0
- package/dist/generated/support/models.d.ts.map +1 -0
- package/dist/generated/support/models.js +87 -0
- package/dist/generated/support/models.js.map +1 -0
- package/dist/generated/system/client.d.ts +33 -0
- package/dist/generated/system/client.d.ts.map +1 -0
- package/dist/generated/system/client.js +19 -0
- package/dist/generated/system/client.js.map +1 -0
- package/dist/generated/system/index.d.ts +6 -0
- package/dist/generated/system/index.d.ts.map +1 -0
- package/dist/generated/system/index.js +5 -0
- package/dist/generated/system/index.js.map +1 -0
- package/dist/generated/system/models.d.ts +16 -0
- package/dist/generated/system/models.d.ts.map +1 -0
- package/dist/generated/system/models.js +4 -0
- package/dist/generated/system/models.js.map +1 -0
- package/dist/generated/tags/client.d.ts +93 -0
- package/dist/generated/tags/client.d.ts.map +1 -0
- package/dist/generated/tags/client.js +47 -0
- package/dist/generated/tags/client.js.map +1 -0
- package/dist/generated/tags/index.d.ts +6 -0
- package/dist/generated/tags/index.d.ts.map +1 -0
- package/dist/generated/tags/index.js +5 -0
- package/dist/generated/tags/index.js.map +1 -0
- package/dist/generated/tags/models.d.ts +32 -0
- package/dist/generated/tags/models.d.ts.map +1 -0
- package/dist/generated/tags/models.js +21 -0
- package/dist/generated/tags/models.js.map +1 -0
- package/dist/generated/tax/client.d.ts +440 -0
- package/dist/generated/tax/client.d.ts.map +1 -0
- package/dist/generated/tax/client.js +109 -0
- package/dist/generated/tax/client.js.map +1 -0
- package/dist/generated/tax/index.d.ts +6 -0
- package/dist/generated/tax/index.d.ts.map +1 -0
- package/dist/generated/tax/index.js +5 -0
- package/dist/generated/tax/index.js.map +1 -0
- package/dist/generated/tax/models.d.ts +372 -0
- package/dist/generated/tax/models.d.ts.map +1 -0
- package/dist/generated/tax/models.js +256 -0
- package/dist/generated/tax/models.js.map +1 -0
- package/dist/generated/tenants/client.d.ts +301 -0
- package/dist/generated/tenants/client.d.ts.map +1 -0
- package/dist/generated/tenants/client.js +103 -0
- package/dist/generated/tenants/client.js.map +1 -0
- package/dist/generated/tenants/index.d.ts +6 -0
- package/dist/generated/tenants/index.d.ts.map +1 -0
- package/dist/generated/tenants/index.js +5 -0
- package/dist/generated/tenants/index.js.map +1 -0
- package/dist/generated/tenants/models.d.ts +158 -0
- package/dist/generated/tenants/models.d.ts.map +1 -0
- package/dist/generated/tenants/models.js +95 -0
- package/dist/generated/tenants/models.js.map +1 -0
- package/dist/generated/transfers/client.d.ts +99 -0
- package/dist/generated/transfers/client.d.ts.map +1 -0
- package/dist/generated/transfers/client.js +38 -0
- package/dist/generated/transfers/client.js.map +1 -0
- package/dist/generated/transfers/index.d.ts +6 -0
- package/dist/generated/transfers/index.d.ts.map +1 -0
- package/dist/generated/transfers/index.js +5 -0
- package/dist/generated/transfers/index.js.map +1 -0
- package/dist/generated/transfers/models.d.ts +41 -0
- package/dist/generated/transfers/models.d.ts.map +1 -0
- package/dist/generated/transfers/models.js +23 -0
- package/dist/generated/transfers/models.js.map +1 -0
- package/dist/generated/usage/client.d.ts +94 -0
- package/dist/generated/usage/client.d.ts.map +1 -0
- package/dist/generated/usage/client.js +37 -0
- package/dist/generated/usage/client.js.map +1 -0
- package/dist/generated/usage/index.d.ts +6 -0
- package/dist/generated/usage/index.d.ts.map +1 -0
- package/dist/generated/usage/index.js +5 -0
- package/dist/generated/usage/index.js.map +1 -0
- package/dist/generated/usage/models.d.ts +86 -0
- package/dist/generated/usage/models.d.ts.map +1 -0
- package/dist/generated/usage/models.js +48 -0
- package/dist/generated/usage/models.js.map +1 -0
- package/dist/generated/user/client.d.ts +46 -0
- package/dist/generated/user/client.d.ts.map +1 -0
- package/dist/generated/user/client.js +19 -0
- package/dist/generated/user/client.js.map +1 -0
- package/dist/generated/user/index.d.ts +5 -0
- package/dist/generated/user/index.d.ts.map +1 -0
- package/dist/generated/user/index.js +5 -0
- package/dist/generated/user/index.js.map +1 -0
- package/dist/generated/warehouses/client.d.ts +101 -0
- package/dist/generated/warehouses/client.d.ts.map +1 -0
- package/dist/generated/warehouses/client.js +38 -0
- package/dist/generated/warehouses/client.js.map +1 -0
- package/dist/generated/warehouses/index.d.ts +6 -0
- package/dist/generated/warehouses/index.d.ts.map +1 -0
- package/dist/generated/warehouses/index.js +5 -0
- package/dist/generated/warehouses/index.js.map +1 -0
- package/dist/generated/warehouses/models.d.ts +20 -0
- package/dist/generated/warehouses/models.d.ts.map +1 -0
- package/dist/generated/warehouses/models.js +15 -0
- package/dist/generated/warehouses/models.js.map +1 -0
- package/dist/generated/web/client.d.ts +80 -0
- package/dist/generated/web/client.d.ts.map +1 -0
- package/dist/generated/web/client.js +28 -0
- package/dist/generated/web/client.js.map +1 -0
- package/dist/generated/web/index.d.ts +6 -0
- package/dist/generated/web/index.d.ts.map +1 -0
- package/dist/generated/web/index.js +5 -0
- package/dist/generated/web/index.js.map +1 -0
- package/dist/generated/web/models.d.ts +28 -0
- package/dist/generated/web/models.d.ts.map +1 -0
- package/dist/generated/web/models.js +15 -0
- package/dist/generated/web/models.js.map +1 -0
- package/dist/generated/workflows/client.d.ts +268 -0
- package/dist/generated/workflows/client.d.ts.map +1 -0
- package/dist/generated/workflows/client.js +78 -0
- package/dist/generated/workflows/client.js.map +1 -0
- package/dist/generated/workflows/index.d.ts +6 -0
- package/dist/generated/workflows/index.d.ts.map +1 -0
- package/dist/generated/workflows/index.js +5 -0
- package/dist/generated/workflows/index.js.map +1 -0
- package/dist/generated/workflows/models.d.ts +96 -0
- package/dist/generated/workflows/models.d.ts.map +1 -0
- package/dist/generated/workflows/models.js +46 -0
- package/dist/generated/workflows/models.js.map +1 -0
- package/package.json +6 -1
|
@@ -0,0 +1,2509 @@
|
|
|
1
|
+
import { type BaseClientOptions, type RequestOptions, Transport } from "../_/index.js";
|
|
2
|
+
import type { Pending } from "../models.js";
|
|
3
|
+
import { type MarketingActionAnswer, type MarketingAskAnswer, type MarketingCallAnswer, type MarketingCallMediaView, type MarketingCallsAnswer, type MarketingCampaignAnswer, type MarketingCampaignDetail, type MarketingCampaignList, type MarketingCampaignReport, type MarketingCampaignsAnswer, type MarketingConversationAnswer, type MarketingConversationDetail, type MarketingConversationsAnswer, type MarketingCreatedCampaign, type MarketingCreatorInfoOutput, type MarketingDealAnswer, type MarketingDeletedAnswer, type MarketingDeletedTopic, type MarketingDetachedAnswer, type MarketingEmailStatusAnswer, type MarketingEnabledEmail, type MarketingEscalateAnswer, type MarketingHitsAnswer, type MarketingLinkAnswer, type MarketingMediaRequest, type MarketingOpenedRevision, type MarketingPermissionAnswer, type MarketingQueuedAnswer, type MarketingQueuedTest, type MarketingReputationAnswer, type MarketingResponderAnswer, type MarketingResponderDetail, type MarketingRespondersAnswer, type MarketingRestoredRevision, type MarketingResumeAnswer, type MarketingRevisionPage, type MarketingRowList, type MarketingSavedRow, type MarketingSavedTemplate, type MarketingSendTemplateAnswer, type MarketingSentCampaign, type MarketingSpamCheck, type MarketingSuggestedFixes, type MarketingTemplateList, type MarketingTopicAnswer, type MarketingTopicsAnswer, type MarketingUnsubscribeList, type MarketingUnsubscribed, type MarketingUpdatedSettings, type MarketinginboxDeletedAnswer, type MarketinginboxTemplateList } from "./models.js";
|
|
4
|
+
export interface ClientOptions extends BaseClientOptions {
|
|
5
|
+
/**
|
|
6
|
+
* The URL the paths of the API are relative to.
|
|
7
|
+
*/
|
|
8
|
+
baseUrl: string;
|
|
9
|
+
}
|
|
10
|
+
export interface Client {
|
|
11
|
+
/**
|
|
12
|
+
* Daily advertising results per ad account over one window, from the
|
|
13
|
+
* platform's stored provider metrics: spend in cents…
|
|
14
|
+
*
|
|
15
|
+
* Daily advertising results per ad account over one window, from the
|
|
16
|
+
* platform's stored provider metrics: spend in cents of the account's own
|
|
17
|
+
* currency, impressions, clicks, link clicks, conversions and conversion
|
|
18
|
+
* value. Account-level rows only, so nothing double counts the same day.
|
|
19
|
+
* Spend from two accounts is comparable only when their currency matches, and
|
|
20
|
+
* conversions follow each provider's own attribution — Meta counts purchases,
|
|
21
|
+
* Google the account's configured conversion actions.
|
|
22
|
+
*
|
|
23
|
+
* Risk: `read`.
|
|
24
|
+
*/
|
|
25
|
+
adTrend(request?: AdTrendRequest, options?: RequestOptions): Promise<AdTrendResponse>;
|
|
26
|
+
/**
|
|
27
|
+
* Answer an inbound WhatsApp voice call with a WebRTC SDP answer
|
|
28
|
+
*
|
|
29
|
+
* Answer an inbound WhatsApp voice call with a WebRTC SDP answer. A browser
|
|
30
|
+
* or agent media path must build the PeerConnection from marketing.get_call's
|
|
31
|
+
* session_sdp (Meta's offer), produce an answer, then call this. Set
|
|
32
|
+
* pre_accept=true to only pre-accept (faster connect, less clipping); call
|
|
33
|
+
* again with pre_accept=false to accept and start media. Parks for approval
|
|
34
|
+
* when an agent proposes it.
|
|
35
|
+
*
|
|
36
|
+
* Risk: `external_effect`.
|
|
37
|
+
*/
|
|
38
|
+
answerCall(request: AnswerCallRequest, options?: RequestOptions): Promise<AnswerCallResponse>;
|
|
39
|
+
/**
|
|
40
|
+
* Ask the consumer a clarifying question on the WhatsApp conversation and
|
|
41
|
+
* wait for their next reply
|
|
42
|
+
*
|
|
43
|
+
* Ask the consumer a clarifying question on the WhatsApp conversation and
|
|
44
|
+
* wait for their next reply. Only available when this response agent has
|
|
45
|
+
* allow_user_query enabled. Sends the question as a WhatsApp session message;
|
|
46
|
+
* the next inbound message continues this run's session.
|
|
47
|
+
*
|
|
48
|
+
* Risk: `external_effect`.
|
|
49
|
+
*/
|
|
50
|
+
askConsumer(request: AskConsumerRequest, options?: RequestOptions): Promise<AskConsumerResponse>;
|
|
51
|
+
/**
|
|
52
|
+
* Attach a workspace document to a marketing response agent's knowledge base
|
|
53
|
+
*
|
|
54
|
+
* Attach a workspace document to a marketing response agent's knowledge base.
|
|
55
|
+
* The agent searches only these documents when answering consumers.
|
|
56
|
+
*
|
|
57
|
+
* Risk: `write`.
|
|
58
|
+
*/
|
|
59
|
+
attachResponderDocument(request: AttachResponderDocumentRequest, options?: RequestOptions): Promise<AttachResponderDocumentResponse>;
|
|
60
|
+
/**
|
|
61
|
+
* Cancel a scheduled campaign before it goes out, or stop one that is sending
|
|
62
|
+
* (recipients already sent stay sent)
|
|
63
|
+
*
|
|
64
|
+
* Cancel a scheduled campaign before it goes out, or stop one that is sending
|
|
65
|
+
* (recipients already sent stay sent). The campaign can be edited and sent
|
|
66
|
+
* again later.
|
|
67
|
+
*
|
|
68
|
+
* Risk: `write`.
|
|
69
|
+
*/
|
|
70
|
+
cancelEmailCampaign(request: CancelEmailCampaignRequest, options?: RequestOptions): Promise<CancelEmailCampaignResponse>;
|
|
71
|
+
/**
|
|
72
|
+
* Cancel a scheduled Instagram / Facebook / LinkedIn / TikTok post before it
|
|
73
|
+
* publishes
|
|
74
|
+
*
|
|
75
|
+
* Cancel a scheduled Instagram / Facebook / LinkedIn / TikTok post before it
|
|
76
|
+
* publishes. Only status=scheduled can be cancelled; once publishing or
|
|
77
|
+
* published, cancel is refused.
|
|
78
|
+
*
|
|
79
|
+
* Risk: `write`.
|
|
80
|
+
*/
|
|
81
|
+
cancelPost(request: CancelPostRequest, options?: RequestOptions): Promise<CancelPostResponse>;
|
|
82
|
+
/**
|
|
83
|
+
* One organic measure per day for every connected social channel, from the
|
|
84
|
+
* platform's stored provider metrics — the…
|
|
85
|
+
*
|
|
86
|
+
* One organic measure per day for every connected social channel, from the
|
|
87
|
+
* platform's stored provider metrics — the series behind an
|
|
88
|
+
* account-versus-account chart. Name the metric as marketing.compare_accounts
|
|
89
|
+
* reports it (reach, impressions, profile_views, followers, …); a metric a
|
|
90
|
+
* provider reports on both bases comes back as one series per basis, daily
|
|
91
|
+
* being that day's value and account the counter as it stood. A channel with
|
|
92
|
+
* no observation for a day has no point for it.
|
|
93
|
+
*
|
|
94
|
+
* Risk: `read`.
|
|
95
|
+
*/
|
|
96
|
+
channelTrend(request: ChannelTrendRequest, options?: RequestOptions): Promise<ChannelTrendResponse>;
|
|
97
|
+
/**
|
|
98
|
+
* Review a subject line and design for deliverability before saving or
|
|
99
|
+
* sending: spam-trigger words, all-caps subjects…
|
|
100
|
+
*
|
|
101
|
+
* Review a subject line and design for deliverability before saving or
|
|
102
|
+
* sending: spam-trigger words, all-caps subjects, image-only bodies, link
|
|
103
|
+
* shorteners, a missing unsubscribe footer or postal address. Returns a 0–100
|
|
104
|
+
* score (100 is clean), the findings, and the rendered HTML and text.
|
|
105
|
+
*
|
|
106
|
+
* Risk: `read`.
|
|
107
|
+
*/
|
|
108
|
+
checkEmailSpam(request: CheckEmailSpamRequest, options?: RequestOptions): Promise<CheckEmailSpamResponse>;
|
|
109
|
+
/**
|
|
110
|
+
* Compare every connected marketing account over one window, from the
|
|
111
|
+
* platform's stored provider metrics: each social…
|
|
112
|
+
*
|
|
113
|
+
* Compare every connected marketing account over one window, from the
|
|
114
|
+
* platform's stored provider metrics: each social channel with its audience
|
|
115
|
+
* counter and how it moved, the posts it published, and every organic measure
|
|
116
|
+
* the provider reported (total, peak day and latest, with additive saying
|
|
117
|
+
* whether the total means anything — reach and audience counters must never
|
|
118
|
+
* be summed); each advertising account with its spend in cents of its own
|
|
119
|
+
* currency, impressions, clicks, link clicks, conversions and conversion
|
|
120
|
+
* value; and publications, every post published inside the window with the
|
|
121
|
+
* UTC day it went out, so a measure can be read against what was posted that
|
|
122
|
+
* day. Answers 'which account is working', 'where is the budget going' and
|
|
123
|
+
* 'what changed'. Freshness: the provider snapshots are stored by the sync
|
|
124
|
+
* jobs, so the last day or two can still be filling in.
|
|
125
|
+
*
|
|
126
|
+
* Risk: `read`.
|
|
127
|
+
*/
|
|
128
|
+
compareAccounts(request?: CompareAccountsRequest, options?: RequestOptions): Promise<CompareAccountsResponse>;
|
|
129
|
+
/**
|
|
130
|
+
* Start connecting Facebook Page(s) the member administers: returns an
|
|
131
|
+
* auth_url for browser consent (Page posting +…
|
|
132
|
+
*
|
|
133
|
+
* Start connecting Facebook Page(s) the member administers: returns an
|
|
134
|
+
* auth_url for browser consent (Page posting + linked Instagram). After
|
|
135
|
+
* consent, Facebook Page channels (and any linked Instagram professional
|
|
136
|
+
* accounts) appear in marketing.list_channels for marketing.create_post and
|
|
137
|
+
* metrics. The link expires in 15 minutes.
|
|
138
|
+
*
|
|
139
|
+
* Risk: `write`. Changes the workspace's governance: a machine-made call
|
|
140
|
+
* always waits for an owner or admin.
|
|
141
|
+
*/
|
|
142
|
+
connectFacebook(request?: ConnectFacebookRequest, options?: RequestOptions): Promise<ConnectFacebookResponse>;
|
|
143
|
+
/**
|
|
144
|
+
* Start Google Ads consent and discover direct and manager client accounts
|
|
145
|
+
*
|
|
146
|
+
* Start Google Ads consent and discover direct and manager client accounts.
|
|
147
|
+
* An owner or admin must select each account with marketing.enable_ad_account
|
|
148
|
+
* before read-only tracking starts. Does not create ads or change budgets.
|
|
149
|
+
*
|
|
150
|
+
* Risk: `write`. Changes the workspace's governance: a machine-made call
|
|
151
|
+
* always waits for an owner or admin.
|
|
152
|
+
*/
|
|
153
|
+
connectGoogleAds(request: ConnectGoogleAdsRequest, options?: RequestOptions): Promise<ConnectGoogleAdsResponse>;
|
|
154
|
+
/**
|
|
155
|
+
* Start connecting Instagram professional account(s) linked to Facebook Pages
|
|
156
|
+
* the member administers: returns an…
|
|
157
|
+
*
|
|
158
|
+
* Start connecting Instagram professional account(s) linked to Facebook Pages
|
|
159
|
+
* the member administers: returns an auth_url for browser consent (insights +
|
|
160
|
+
* content publishing). After consent, Instagram channels AND their Facebook
|
|
161
|
+
* Pages appear in marketing.list_channels — ready for metrics and
|
|
162
|
+
* marketing.create_post. The link expires in 15 minutes. Reconnect if an
|
|
163
|
+
* older grant lacks publishing scopes.
|
|
164
|
+
*
|
|
165
|
+
* Risk: `write`. Changes the workspace's governance: a machine-made call
|
|
166
|
+
* always waits for an owner or admin.
|
|
167
|
+
*/
|
|
168
|
+
connectInstagram(request?: ConnectInstagramRequest, options?: RequestOptions): Promise<ConnectInstagramResponse>;
|
|
169
|
+
/**
|
|
170
|
+
* Start connecting LinkedIn organization Page(s) the member administers:
|
|
171
|
+
* returns an auth_url for browser consent
|
|
172
|
+
*
|
|
173
|
+
* Start connecting LinkedIn organization Page(s) the member administers:
|
|
174
|
+
* returns an auth_url for browser consent. After consent, linkedin channels
|
|
175
|
+
* appear in marketing.list_channels for marketing.create_post (text and
|
|
176
|
+
* image). Requires LINKEDIN_CLIENT_ID / LINKEDIN_CLIENT_SECRET on the
|
|
177
|
+
* deployment. The link expires in 15 minutes.
|
|
178
|
+
*
|
|
179
|
+
* Risk: `write`. Changes the workspace's governance: a machine-made call
|
|
180
|
+
* always waits for an owner or admin.
|
|
181
|
+
*/
|
|
182
|
+
connectLinkedin(request?: ConnectLinkedinRequest, options?: RequestOptions): Promise<ConnectLinkedinResponse>;
|
|
183
|
+
/**
|
|
184
|
+
* Start connecting the member's TikTok account (Business or personal) via
|
|
185
|
+
* TikTok Login Kit: returns an auth_url for…
|
|
186
|
+
*
|
|
187
|
+
* Start connecting the member's TikTok account (Business or personal) via
|
|
188
|
+
* TikTok Login Kit: returns an auth_url for browser consent (profile, video
|
|
189
|
+
* publishing and video list). After consent, a tiktok channel appears in
|
|
190
|
+
* marketing.list_channels for marketing.create_post (video) and metrics.
|
|
191
|
+
* Requires TIKTOK_CLIENT_KEY / TIKTOK_CLIENT_SECRET on the deployment, and
|
|
192
|
+
* the account must have switched to a Business account for Content Posting.
|
|
193
|
+
* The link expires in 15 minutes.
|
|
194
|
+
*
|
|
195
|
+
* Risk: `write`. Changes the workspace's governance: a machine-made call
|
|
196
|
+
* always waits for an owner or admin.
|
|
197
|
+
*/
|
|
198
|
+
connectTiktok(request?: ConnectTiktokRequest, options?: RequestOptions): Promise<ConnectTiktokResponse>;
|
|
199
|
+
/**
|
|
200
|
+
* Start connecting the workspace's WhatsApp Business account via Meta
|
|
201
|
+
* Embedded Signup (Nemphi is the Tech Provider)
|
|
202
|
+
*
|
|
203
|
+
* Start connecting the workspace's WhatsApp Business account via Meta
|
|
204
|
+
* Embedded Signup (Nemphi is the Tech Provider). mode=coexistence: the
|
|
205
|
+
* business keeps using WhatsApp Business app on the same number while Cloud
|
|
206
|
+
* API messages at scale. mode=dedicated: they verify a phone number used only
|
|
207
|
+
* with the API. Returns a connect_url the member opens in the browser (and
|
|
208
|
+
* the Embedded Signup launch config). The link expires in 15 minutes and is
|
|
209
|
+
* bound to this member and workspace. Credentials are never returned.
|
|
210
|
+
*
|
|
211
|
+
* Risk: `write`. Changes the workspace's governance: a machine-made call
|
|
212
|
+
* always waits for an owner or admin.
|
|
213
|
+
*/
|
|
214
|
+
connectWhatsapp(request: ConnectWhatsappRequest, options?: RequestOptions): Promise<ConnectWhatsappResponse>;
|
|
215
|
+
/**
|
|
216
|
+
* Open a CRM deal for an inbox conversation's customer, in the first stage of
|
|
217
|
+
* the default pipeline
|
|
218
|
+
*
|
|
219
|
+
* Open a CRM deal for an inbox conversation's customer, in the first stage of
|
|
220
|
+
* the default pipeline. Creates the customer contact when the thread has none
|
|
221
|
+
* and links it. A conversation that already has a deal answers with that one.
|
|
222
|
+
* The platform does this by itself when a customer reads ready to buy.
|
|
223
|
+
*
|
|
224
|
+
* Risk: `write`.
|
|
225
|
+
*/
|
|
226
|
+
createConversationDeal(request: CreateConversationDealRequest, options?: RequestOptions): Promise<CreateConversationDealResponse>;
|
|
227
|
+
/**
|
|
228
|
+
* Create a draft email campaign from a template: name it, choose the audience
|
|
229
|
+
* (a CRM party tag, explicit parties, or…
|
|
230
|
+
*
|
|
231
|
+
* Create a draft email campaign from a template: name it, choose the audience
|
|
232
|
+
* (a CRM party tag, explicit parties, or both) and optionally override the
|
|
233
|
+
* subject. Nothing is sent until marketing.send_email_campaign. Returns the
|
|
234
|
+
* estimated audience size.
|
|
235
|
+
*
|
|
236
|
+
* Risk: `write`.
|
|
237
|
+
*/
|
|
238
|
+
createEmailCampaign(request: CreateEmailCampaignRequest, options?: RequestOptions): Promise<CreateEmailCampaignResponse>;
|
|
239
|
+
/**
|
|
240
|
+
* Schedule or publish a social post to one or more connected Instagram
|
|
241
|
+
* professional accounts, Facebook Pages, LinkedIn…
|
|
242
|
+
*
|
|
243
|
+
* Schedule or publish a social post to one or more connected Instagram
|
|
244
|
+
* professional accounts, Facebook Pages, LinkedIn organization Pages, and/or
|
|
245
|
+
* TikTok accounts. Pass channel_ids from marketing.list_channels (providers
|
|
246
|
+
* instagram, facebook, linkedin, tiktok). media_type=image needs media_urls;
|
|
247
|
+
* video/reels/story need one media URL; carousel needs 2–10 URLs
|
|
248
|
+
* (Instagram/Facebook); media_type=text is Facebook or LinkedIn only (caption
|
|
249
|
+
* required). media_type=story publishes a 24-hour Instagram or Facebook story
|
|
250
|
+
* and takes no caption. TikTok accepts media_type=video only and needs
|
|
251
|
+
* tiktok_privacy_level chosen by the person from
|
|
252
|
+
* marketing.tiktok_creator_info; the tiktok_* interaction and disclosure
|
|
253
|
+
* fields are theirs to set too. Upload files via POST /v1/marketing/media to
|
|
254
|
+
* get a public https URL Meta/LinkedIn/TikTok can fetch, or pass any public
|
|
255
|
+
* https URL. Omit scheduled_at (or set it in the past) to publish as soon as
|
|
256
|
+
* the outbox delivers; a future RFC3339 time schedules the post. Externally
|
|
257
|
+
* visible — gated by policy (approval by default for agents).
|
|
258
|
+
*
|
|
259
|
+
* Risk: `external_effect`.
|
|
260
|
+
*/
|
|
261
|
+
createPost(request: CreatePostRequest, options?: RequestOptions): Promise<CreatePostResponse>;
|
|
262
|
+
/**
|
|
263
|
+
* Create a marketing response agent that can automatically reply to consumer
|
|
264
|
+
* messages
|
|
265
|
+
*
|
|
266
|
+
* Create a marketing response agent that can automatically reply to consumer
|
|
267
|
+
* messages. Configure name, scope, the accounts it answers (any network; none
|
|
268
|
+
* means every connected account), whether it may ask the consumer clarifying
|
|
269
|
+
* questions, and handoff targets (human and/or specialist agents). Starts as
|
|
270
|
+
* draft unless status=active. Attach knowledge-base documents with
|
|
271
|
+
* marketing.attach_responder_document.
|
|
272
|
+
*
|
|
273
|
+
* Risk: `write`.
|
|
274
|
+
*/
|
|
275
|
+
createResponder(request: CreateResponderRequest, options?: RequestOptions): Promise<CreateResponderResponse>;
|
|
276
|
+
/**
|
|
277
|
+
* Delete a reusable email row
|
|
278
|
+
*
|
|
279
|
+
* Delete a reusable email row. Templates that already used it keep their own
|
|
280
|
+
* copy of the blocks.
|
|
281
|
+
*
|
|
282
|
+
* Risk: `write`.
|
|
283
|
+
*/
|
|
284
|
+
deleteEmailRow(request: DeleteEmailRowRequest, options?: RequestOptions): Promise<DeleteEmailRowResponse>;
|
|
285
|
+
/**
|
|
286
|
+
* Delete an email template
|
|
287
|
+
*
|
|
288
|
+
* Delete an email template. Campaigns already sent from it keep their own
|
|
289
|
+
* copy of the content.
|
|
290
|
+
*
|
|
291
|
+
* Risk: `write`.
|
|
292
|
+
*/
|
|
293
|
+
deleteEmailTemplate(request: DeleteEmailTemplateRequest, options?: RequestOptions): Promise<DeleteEmailTemplateResponse>;
|
|
294
|
+
/**
|
|
295
|
+
* Delete one of the workspace's inbox topics
|
|
296
|
+
*
|
|
297
|
+
* Delete one of the workspace's inbox topics. Conversations filed under it
|
|
298
|
+
* keep their built-in category and lose the topic.
|
|
299
|
+
*
|
|
300
|
+
* Risk: `write`.
|
|
301
|
+
*/
|
|
302
|
+
deleteInboxTopic(request: DeleteInboxTopicRequest, options?: RequestOptions): Promise<DeleteInboxTopicResponse>;
|
|
303
|
+
/**
|
|
304
|
+
* Delete a marketing response agent
|
|
305
|
+
*
|
|
306
|
+
* Delete a marketing response agent. Active conversations keep their history;
|
|
307
|
+
* auto-reply for this agent stops.
|
|
308
|
+
*
|
|
309
|
+
* Risk: `write`.
|
|
310
|
+
*/
|
|
311
|
+
deleteResponder(request: DeleteResponderRequest, options?: RequestOptions): Promise<DeleteResponderResponse>;
|
|
312
|
+
/**
|
|
313
|
+
* Remove a document from a marketing response agent's knowledge base
|
|
314
|
+
*
|
|
315
|
+
* Remove a document from a marketing response agent's knowledge base.
|
|
316
|
+
*
|
|
317
|
+
* Risk: `write`.
|
|
318
|
+
*/
|
|
319
|
+
detachResponderDocument(request: DetachResponderDocumentRequest, options?: RequestOptions): Promise<DetachResponderDocumentResponse>;
|
|
320
|
+
/**
|
|
321
|
+
* Disconnect an ad account from this workspace and remove its stored
|
|
322
|
+
* performance reports
|
|
323
|
+
*
|
|
324
|
+
* Disconnect an ad account from this workspace and remove its stored
|
|
325
|
+
* performance reports. Does not change provider ads.
|
|
326
|
+
*
|
|
327
|
+
* Risk: `write`. Changes the workspace's governance: a machine-made call
|
|
328
|
+
* always waits for an owner or admin.
|
|
329
|
+
*/
|
|
330
|
+
disconnectAdAccount(request: DisconnectAdAccountRequest, options?: RequestOptions): Promise<DisconnectAdAccountResponse>;
|
|
331
|
+
/**
|
|
332
|
+
* Disconnect a marketing channel: deletes the sealed credentials and stops
|
|
333
|
+
* metric snapshots
|
|
334
|
+
*
|
|
335
|
+
* Disconnect a marketing channel: deletes the sealed credentials and stops
|
|
336
|
+
* metric snapshots. Historical metric rows for the channel are removed with
|
|
337
|
+
* it.
|
|
338
|
+
*
|
|
339
|
+
* Risk: `write`. Changes the workspace's governance: a machine-made call
|
|
340
|
+
* always waits for an owner or admin.
|
|
341
|
+
*/
|
|
342
|
+
disconnectChannel(request: DisconnectChannelRequest, options?: RequestOptions): Promise<DisconnectChannelResponse>;
|
|
343
|
+
/**
|
|
344
|
+
* How the workspace's email sending looks to SES: hard-bounce and complaint
|
|
345
|
+
* rates of the campaign messages sent in the…
|
|
346
|
+
*
|
|
347
|
+
* How the workspace's email sending looks to SES: hard-bounce and complaint
|
|
348
|
+
* rates of the campaign messages sent in the last 90 days, each graded
|
|
349
|
+
* healthy, review (SES puts a sender under review at 5% bounces or 0.1%
|
|
350
|
+
* complaints) or pause (SES may pause it at 10% or 0.5%), and the SES
|
|
351
|
+
* tenant's live reputation: impact, enforcement policy, sending status and
|
|
352
|
+
* open findings.
|
|
353
|
+
*
|
|
354
|
+
* Risk: `read`.
|
|
355
|
+
*/
|
|
356
|
+
emailReputation(request: EmailReputationRequest, options?: RequestOptions): Promise<EmailReputationResponse>;
|
|
357
|
+
/**
|
|
358
|
+
* Whether email marketing is enabled for this workspace, its sender identity,
|
|
359
|
+
* the SES tenant's sending status, and…
|
|
360
|
+
*
|
|
361
|
+
* Whether email marketing is enabled for this workspace, its sender identity,
|
|
362
|
+
* the SES tenant's sending status, and template / campaign counts.
|
|
363
|
+
*
|
|
364
|
+
* Risk: `read`.
|
|
365
|
+
*/
|
|
366
|
+
emailStatus(request: EmailStatusRequest, options?: RequestOptions): Promise<EmailStatusResponse>;
|
|
367
|
+
/**
|
|
368
|
+
* Select a discovered ad account for this workspace and start read-only
|
|
369
|
+
* performance tracking
|
|
370
|
+
*
|
|
371
|
+
* Select a discovered ad account for this workspace and start read-only
|
|
372
|
+
* performance tracking. This does not create ads or change spending.
|
|
373
|
+
*
|
|
374
|
+
* Risk: `write`. Changes the workspace's governance: a machine-made call
|
|
375
|
+
* always waits for an owner or admin.
|
|
376
|
+
*/
|
|
377
|
+
enableAdAccount(request: EnableAdAccountRequest, options?: RequestOptions): Promise<EnableAdAccountResponse>;
|
|
378
|
+
/**
|
|
379
|
+
* Turn email marketing on for this workspace: creates its own SES tenant
|
|
380
|
+
* (reputation isolated from every other…
|
|
381
|
+
*
|
|
382
|
+
* Turn email marketing on for this workspace: creates its own SES tenant
|
|
383
|
+
* (reputation isolated from every other workspace) and its sender address on
|
|
384
|
+
* the platform's marketing domain. Owner or admin only. Provisioning runs in
|
|
385
|
+
* the background; marketing.email_status reports when it is active.
|
|
386
|
+
*
|
|
387
|
+
* Risk: `write`. Changes the workspace's governance: a machine-made call
|
|
388
|
+
* always waits for an owner or admin.
|
|
389
|
+
*/
|
|
390
|
+
enableEmail(request?: EnableEmailRequest, options?: RequestOptions): Promise<EnableEmailResponse>;
|
|
391
|
+
/**
|
|
392
|
+
* Hand the consumer conversation to a human teammate
|
|
393
|
+
*
|
|
394
|
+
* Hand the consumer conversation to a human teammate. Only available when
|
|
395
|
+
* handoff_to_human is enabled. Stops auto-replies on this conversation and
|
|
396
|
+
* notifies owners/admins in the inbox. Use when the scope ends, the consumer
|
|
397
|
+
* asks for a person, or the handoff_human_when guidance says so.
|
|
398
|
+
*
|
|
399
|
+
* Risk: `write`.
|
|
400
|
+
*/
|
|
401
|
+
escalateToHuman(request: EscalateToHumanRequest, options?: RequestOptions): Promise<EscalateToHumanResponse>;
|
|
402
|
+
/**
|
|
403
|
+
* Generate a marketing picture from a prompt (OpenAI's newest image model by
|
|
404
|
+
* default)
|
|
405
|
+
*
|
|
406
|
+
* Generate a marketing picture from a prompt (OpenAI's newest image model by
|
|
407
|
+
* default). It renders in the background, usually within a minute, and lands
|
|
408
|
+
* in the media library; read it with marketing.list_generations, which gives
|
|
409
|
+
* its public URL to show in the conversation or use in a social post. Spends
|
|
410
|
+
* the workspace's daily AI allowance.
|
|
411
|
+
*
|
|
412
|
+
* Risk: `write`.
|
|
413
|
+
*/
|
|
414
|
+
generateImage(request: GenerateImageRequest, options?: RequestOptions): Promise<GenerateImageResponse>;
|
|
415
|
+
/**
|
|
416
|
+
* Generate a short marketing video from a prompt (xAI's Grok Imagine by
|
|
417
|
+
* default; Claude Opus for motion graphics built…
|
|
418
|
+
*
|
|
419
|
+
* Generate a short marketing video from a prompt (xAI's Grok Imagine by
|
|
420
|
+
* default; Claude Opus for motion graphics built from text and the library's
|
|
421
|
+
* pictures). It renders in the background for a minute or more and lands in
|
|
422
|
+
* the media library; read it with marketing.list_generations, which gives its
|
|
423
|
+
* public URL to show in the conversation or use in a social post. Spends the
|
|
424
|
+
* workspace's daily AI allowance.
|
|
425
|
+
*
|
|
426
|
+
* Risk: `write`.
|
|
427
|
+
*/
|
|
428
|
+
generateVideo(request: GenerateVideoRequest, options?: RequestOptions): Promise<GenerateVideoResponse>;
|
|
429
|
+
/**
|
|
430
|
+
* Read one WhatsApp call session: status, peer phone, linked CRM party, and
|
|
431
|
+
* the latest SDP offer/answer Meta delivered…
|
|
432
|
+
*
|
|
433
|
+
* Read one WhatsApp call session: status, peer phone, linked CRM party, and
|
|
434
|
+
* the latest SDP offer/answer Meta delivered (needed to answer with WebRTC).
|
|
435
|
+
*
|
|
436
|
+
* Risk: `read`.
|
|
437
|
+
*/
|
|
438
|
+
getCall(request: GetCallRequest, options?: RequestOptions): Promise<GetCallResponse>;
|
|
439
|
+
/**
|
|
440
|
+
* Read the status of a previously authorized WhatsApp call media request and
|
|
441
|
+
* return its short-lived ICE servers when ready
|
|
442
|
+
*
|
|
443
|
+
* Read the status of a previously authorized WhatsApp call media request and
|
|
444
|
+
* return its short-lived ICE servers when ready.
|
|
445
|
+
*
|
|
446
|
+
* Risk: `read`.
|
|
447
|
+
*/
|
|
448
|
+
getCallMedia(request: GetCallMediaRequest, options?: RequestOptions): Promise<GetCallMediaResponse>;
|
|
449
|
+
/**
|
|
450
|
+
* Open one WhatsApp template campaign: header + delivery stats + estimated
|
|
451
|
+
* Meta cost (cost_micros, billable_count) + up…
|
|
452
|
+
*
|
|
453
|
+
* Open one WhatsApp template campaign: header + delivery stats + estimated
|
|
454
|
+
* Meta cost (cost_micros, billable_count) + up to 50 recent recipient
|
|
455
|
+
* messages.
|
|
456
|
+
*
|
|
457
|
+
* Risk: `read`.
|
|
458
|
+
*/
|
|
459
|
+
getCampaign(request: GetCampaignRequest, options?: RequestOptions): Promise<GetCampaignResponse>;
|
|
460
|
+
/**
|
|
461
|
+
* Open one inbox conversation: header (channel, peer, linked party) plus
|
|
462
|
+
* messages oldest-first
|
|
463
|
+
*
|
|
464
|
+
* Open one inbox conversation: header (channel, peer, linked party) plus
|
|
465
|
+
* messages oldest-first.
|
|
466
|
+
*
|
|
467
|
+
* Risk: `read`.
|
|
468
|
+
*/
|
|
469
|
+
getConversation(request: GetConversationRequest, options?: RequestOptions): Promise<GetConversationResponse>;
|
|
470
|
+
/**
|
|
471
|
+
* Open one email campaign: header and stats, the hourly open/click timeline,
|
|
472
|
+
* the most clicked links, and the recipients…
|
|
473
|
+
*
|
|
474
|
+
* Open one email campaign: header and stats, the hourly open/click timeline,
|
|
475
|
+
* the most clicked links, and the recipients with their per-address status
|
|
476
|
+
* (delivered, opened, clicked, bounced, complained, unsubscribed, failed,
|
|
477
|
+
* skipped).
|
|
478
|
+
*
|
|
479
|
+
* Risk: `read`.
|
|
480
|
+
*/
|
|
481
|
+
getEmailCampaign(request: GetEmailCampaignRequest, options?: RequestOptions): Promise<GetEmailCampaignResponse>;
|
|
482
|
+
/**
|
|
483
|
+
* Open one email template: its builder design, rendered HTML and text, and
|
|
484
|
+
* deliverability findings
|
|
485
|
+
*
|
|
486
|
+
* Open one email template: its builder design, rendered HTML and text, and
|
|
487
|
+
* deliverability findings.
|
|
488
|
+
*
|
|
489
|
+
* Risk: `read`.
|
|
490
|
+
*/
|
|
491
|
+
getEmailTemplate(request: GetEmailTemplateRequest, options?: RequestOptions): Promise<GetEmailTemplateResponse>;
|
|
492
|
+
/**
|
|
493
|
+
* Open one saved version of an email template: the builder design it held and
|
|
494
|
+
* the HTML and text it rendered to, exactly…
|
|
495
|
+
*
|
|
496
|
+
* Open one saved version of an email template: the builder design it held and
|
|
497
|
+
* the HTML and text it rendered to, exactly as they stood.
|
|
498
|
+
*
|
|
499
|
+
* Risk: `read`.
|
|
500
|
+
*/
|
|
501
|
+
getEmailTemplateRevision(request: GetEmailTemplateRevisionRequest, options?: RequestOptions): Promise<GetEmailTemplateRevisionResponse>;
|
|
502
|
+
/**
|
|
503
|
+
* Fetch one Instagram / Facebook / LinkedIn / TikTok post by id (caption,
|
|
504
|
+
* media, status, schedule, external id/url when…
|
|
505
|
+
*
|
|
506
|
+
* Fetch one Instagram / Facebook / LinkedIn / TikTok post by id (caption,
|
|
507
|
+
* media, status, schedule, external id/url when published).
|
|
508
|
+
*
|
|
509
|
+
* Risk: `read`.
|
|
510
|
+
*/
|
|
511
|
+
getPost(request: GetPostRequest, options?: RequestOptions): Promise<GetPostResponse>;
|
|
512
|
+
/**
|
|
513
|
+
* Get one marketing response agent with its delegate allowlist and attached
|
|
514
|
+
* knowledge-base document ids
|
|
515
|
+
*
|
|
516
|
+
* Get one marketing response agent with its delegate allowlist and attached
|
|
517
|
+
* knowledge-base document ids.
|
|
518
|
+
*
|
|
519
|
+
* Risk: `read`.
|
|
520
|
+
*/
|
|
521
|
+
getResponder(request: GetResponderRequest, options?: RequestOptions): Promise<GetResponderResponse>;
|
|
522
|
+
/**
|
|
523
|
+
* Attach a WhatsApp inbox conversation to an existing CRM party
|
|
524
|
+
* (customer/contact)
|
|
525
|
+
*
|
|
526
|
+
* Attach a WhatsApp inbox conversation to an existing CRM party
|
|
527
|
+
* (customer/contact). Use when auto-match by phone was wrong or the chat was
|
|
528
|
+
* unmatched. Updates the conversation and future CRM timeline rows still use
|
|
529
|
+
* the conversation id as thread.
|
|
530
|
+
*
|
|
531
|
+
* Risk: `write`.
|
|
532
|
+
*/
|
|
533
|
+
linkConversationParty(request: LinkConversationPartyRequest, options?: RequestOptions): Promise<LinkConversationPartyResponse>;
|
|
534
|
+
/**
|
|
535
|
+
* List this workspace's Meta and Google ad accounts
|
|
536
|
+
*
|
|
537
|
+
* List this workspace's Meta and Google ad accounts. Pending accounts require
|
|
538
|
+
* an owner or admin to select them before data collection starts. Credentials
|
|
539
|
+
* are never returned.
|
|
540
|
+
*
|
|
541
|
+
* Risk: `read`.
|
|
542
|
+
*/
|
|
543
|
+
listAdAccounts(request: ListAdAccountsRequest, options?: RequestOptions): Promise<ListAdAccountsResponse>;
|
|
544
|
+
/**
|
|
545
|
+
* Read one stored provider advertising report for a workspace ad account
|
|
546
|
+
*
|
|
547
|
+
* Read one stored provider advertising report for a workspace ad account.
|
|
548
|
+
* Results retain source IDs, currency, account timezone and provider
|
|
549
|
+
* attribution semantics. Meta uses conversion dates and ad-set windows.
|
|
550
|
+
* Google includes both interaction-date and conversion-date metrics. Actions
|
|
551
|
+
* may overlap and must not be added together. Paid and organic measures must
|
|
552
|
+
* not be added. Reach is not additive. Missing post links remain unmatched.
|
|
553
|
+
*
|
|
554
|
+
* Risk: `read`.
|
|
555
|
+
*/
|
|
556
|
+
listAdInsights(request: ListAdInsightsRequest, options?: RequestOptions): Promise<ListAdInsightsResponse>;
|
|
557
|
+
/**
|
|
558
|
+
* List WhatsApp voice call sessions on connected marketing channels (inbound
|
|
559
|
+
* customer calls and business-initiated…
|
|
560
|
+
*
|
|
561
|
+
* List WhatsApp voice call sessions on connected marketing channels (inbound
|
|
562
|
+
* customer calls and business-initiated callbacks). Newest first. Includes
|
|
563
|
+
* SDP when Meta sent a connect offer so a WebRTC client can answer.
|
|
564
|
+
*
|
|
565
|
+
* Risk: `read`.
|
|
566
|
+
*/
|
|
567
|
+
listCalls(request?: ListCallsRequest, options?: RequestOptions): Promise<ListCallsResponse>;
|
|
568
|
+
/**
|
|
569
|
+
* List WhatsApp template campaigns for the workspace (newest first)
|
|
570
|
+
*
|
|
571
|
+
* List WhatsApp template campaigns for the workspace (newest first). Each row
|
|
572
|
+
* includes aggregated delivery stats (pending/sent/delivered/read/failed),
|
|
573
|
+
* template_category, and estimated Meta cost_micros (micro-USD) for billable
|
|
574
|
+
* deliveries.
|
|
575
|
+
*
|
|
576
|
+
* Risk: `read`.
|
|
577
|
+
*/
|
|
578
|
+
listCampaigns(request?: ListCampaignsRequest, options?: RequestOptions): Promise<ListCampaignsResponse>;
|
|
579
|
+
/**
|
|
580
|
+
* List the workspace's connected marketing channels (WhatsApp Business,
|
|
581
|
+
* Instagram, Facebook, LinkedIn, TikTok) with…
|
|
582
|
+
*
|
|
583
|
+
* List the workspace's connected marketing channels (WhatsApp Business,
|
|
584
|
+
* Instagram, Facebook, LinkedIn, TikTok) with status and last sync time.
|
|
585
|
+
* Credentials are never included.
|
|
586
|
+
*
|
|
587
|
+
* Risk: `read`.
|
|
588
|
+
*/
|
|
589
|
+
listChannels(request: ListChannelsRequest, options?: RequestOptions): Promise<ListChannelsResponse>;
|
|
590
|
+
/**
|
|
591
|
+
* List inbox conversations for the workspace (customer threads on connected
|
|
592
|
+
* marketing channels; WhatsApp Business…
|
|
593
|
+
*
|
|
594
|
+
* List inbox conversations for the workspace (customer threads on connected
|
|
595
|
+
* marketing channels; WhatsApp Business threads today). Newest activity
|
|
596
|
+
* first. Each row names its channel and provider, and may include a linked
|
|
597
|
+
* CRM party_id when the phone matched or was auto-created as a customer
|
|
598
|
+
* contact. Once a customer has written, a row also carries what was read
|
|
599
|
+
* automatically from its recent messages: the customer's sentiment, the
|
|
600
|
+
* thread's category and workspace topic, whether a person should step in
|
|
601
|
+
* (needs_person), how ready the customer is to buy (purchase_intent, 0-100)
|
|
602
|
+
* and a one-line summary.
|
|
603
|
+
*
|
|
604
|
+
* Risk: `read`.
|
|
605
|
+
*/
|
|
606
|
+
listConversations(request?: ListConversationsRequest, options?: RequestOptions): Promise<ListConversationsResponse>;
|
|
607
|
+
/**
|
|
608
|
+
* List email campaigns (newest first) with their delivery and engagement
|
|
609
|
+
* stats: recipients, sent, delivered, opened…
|
|
610
|
+
*
|
|
611
|
+
* List email campaigns (newest first) with their delivery and engagement
|
|
612
|
+
* stats: recipients, sent, delivered, opened, clicked, bounced, complained,
|
|
613
|
+
* unsubscribed, failed, and the rates over sent.
|
|
614
|
+
*
|
|
615
|
+
* Risk: `read`.
|
|
616
|
+
*/
|
|
617
|
+
listEmailCampaigns(request?: ListEmailCampaignsRequest, options?: RequestOptions): Promise<ListEmailCampaignsResponse>;
|
|
618
|
+
/**
|
|
619
|
+
* List this workspace's reusable email rows with the blocks each one holds,
|
|
620
|
+
* newest first
|
|
621
|
+
*
|
|
622
|
+
* List this workspace's reusable email rows with the blocks each one holds,
|
|
623
|
+
* newest first.
|
|
624
|
+
*
|
|
625
|
+
* Risk: `read`.
|
|
626
|
+
*/
|
|
627
|
+
listEmailRows(request: ListEmailRowsRequest, options?: RequestOptions): Promise<ListEmailRowsResponse>;
|
|
628
|
+
/**
|
|
629
|
+
* Read an email template's saved versions, newest first
|
|
630
|
+
*
|
|
631
|
+
* Read an email template's saved versions, newest first. Each version keeps
|
|
632
|
+
* the subject, the design, who saved it and when. A baseline is the content a
|
|
633
|
+
* template carried before its first recorded save.
|
|
634
|
+
*
|
|
635
|
+
* Risk: `read`.
|
|
636
|
+
*/
|
|
637
|
+
listEmailTemplateRevisions(request: ListEmailTemplateRevisionsRequest, options?: RequestOptions): Promise<ListEmailTemplateRevisionsResponse>;
|
|
638
|
+
/**
|
|
639
|
+
* List this workspace's email templates (newest first) with their
|
|
640
|
+
* deliverability score
|
|
641
|
+
*
|
|
642
|
+
* List this workspace's email templates (newest first) with their
|
|
643
|
+
* deliverability score.
|
|
644
|
+
*
|
|
645
|
+
* Risk: `read`.
|
|
646
|
+
*/
|
|
647
|
+
listEmailTemplates(request?: ListEmailTemplatesRequest, options?: RequestOptions): Promise<ListEmailTemplatesResponse>;
|
|
648
|
+
/**
|
|
649
|
+
* The workspace's do-not-email list: addresses that unsubscribed, complained,
|
|
650
|
+
* bounced, or were added by hand
|
|
651
|
+
*
|
|
652
|
+
* The workspace's do-not-email list: addresses that unsubscribed, complained,
|
|
653
|
+
* bounced, or were added by hand. Campaigns skip them automatically.
|
|
654
|
+
*
|
|
655
|
+
* Risk: `read`.
|
|
656
|
+
*/
|
|
657
|
+
listEmailUnsubscribes(request?: ListEmailUnsubscribesRequest, options?: RequestOptions): Promise<ListEmailUnsubscribesResponse>;
|
|
658
|
+
/**
|
|
659
|
+
* The workspace's recent generated pictures and videos, newest first: each
|
|
660
|
+
* request's status and, once done, the public…
|
|
661
|
+
*
|
|
662
|
+
* The workspace's recent generated pictures and videos, newest first: each
|
|
663
|
+
* request's status and, once done, the public URL of the media it made.
|
|
664
|
+
*
|
|
665
|
+
* Risk: `read`.
|
|
666
|
+
*/
|
|
667
|
+
listGenerations(request?: ListGenerationsRequest, options?: RequestOptions): Promise<ListGenerationsResponse>;
|
|
668
|
+
/**
|
|
669
|
+
* Read the latest automatic historical import for a connected social account,
|
|
670
|
+
* including past posts, provider statistics…
|
|
671
|
+
*
|
|
672
|
+
* Read the latest automatic historical import for a connected social account,
|
|
673
|
+
* including past posts, provider statistics and collection limits. Sources
|
|
674
|
+
* report collecting, complete, partial or failed independently. Pages arrive
|
|
675
|
+
* oldest first by collection time. Pass next_cursor as after for more pages;
|
|
676
|
+
* while collecting, resume from the last page id to check for new arrivals.
|
|
677
|
+
* Reconnecting starts a new import and invalidates old cursors. Imported
|
|
678
|
+
* content statistics are cumulative observations, not historical daily
|
|
679
|
+
* deltas.
|
|
680
|
+
*
|
|
681
|
+
* Risk: `read`.
|
|
682
|
+
*/
|
|
683
|
+
listHistory(request: ListHistoryRequest, options?: RequestOptions): Promise<ListHistoryResponse>;
|
|
684
|
+
/**
|
|
685
|
+
* The workspace's own inbox topics: names the business chose for what its
|
|
686
|
+
* customer conversations are about (e.g
|
|
687
|
+
*
|
|
688
|
+
* The workspace's own inbox topics: names the business chose for what its
|
|
689
|
+
* customer conversations are about (e.g. Wholesale, Events). Each new
|
|
690
|
+
* customer message files its thread under the topic that fits, beside the
|
|
691
|
+
* built-in category, using the topic's description.
|
|
692
|
+
*
|
|
693
|
+
* Risk: `read`.
|
|
694
|
+
*/
|
|
695
|
+
listInboxTopics(request: ListInboxTopicsRequest, options?: RequestOptions): Promise<ListInboxTopicsResponse>;
|
|
696
|
+
/**
|
|
697
|
+
* Browse previously uploaded media in this workspace
|
|
698
|
+
*
|
|
699
|
+
* Browse previously uploaded media in this workspace. Reuse the returned
|
|
700
|
+
* public URLs when composing social posts.
|
|
701
|
+
*
|
|
702
|
+
* Risk: `read`.
|
|
703
|
+
*/
|
|
704
|
+
listMedia(request?: ListMediaRequest, options?: RequestOptions): Promise<ListMediaResponse>;
|
|
705
|
+
/**
|
|
706
|
+
* Daily observations for connected marketing channels
|
|
707
|
+
*
|
|
708
|
+
* Daily observations for connected marketing channels. Account counters are
|
|
709
|
+
* observed_at values; daily contains the preceding three complete UTC request
|
|
710
|
+
* windows, with provider series, unavailable and rejected metrics. Content
|
|
711
|
+
* metrics are cumulative at observation time, not daily deltas. Reach must
|
|
712
|
+
* not be summed across days. Newest observations first.
|
|
713
|
+
*
|
|
714
|
+
* Risk: `read`.
|
|
715
|
+
*/
|
|
716
|
+
listMetrics(request?: ListMetricsRequest, options?: RequestOptions): Promise<ListMetricsResponse>;
|
|
717
|
+
/**
|
|
718
|
+
* Read saved draft versions, newest first
|
|
719
|
+
*
|
|
720
|
+
* Read saved draft versions, newest first. Each version preserves content,
|
|
721
|
+
* account identity, editor and save time. A baseline is the pre-edit content
|
|
722
|
+
* of a draft created before version history was available; its original
|
|
723
|
+
* editor is unknown.
|
|
724
|
+
*
|
|
725
|
+
* Risk: `read`.
|
|
726
|
+
*/
|
|
727
|
+
listPostRevisions(request: ListPostRevisionsRequest, options?: RequestOptions): Promise<ListPostRevisionsResponse>;
|
|
728
|
+
/**
|
|
729
|
+
* List scheduled and published Instagram / Facebook / LinkedIn / TikTok posts
|
|
730
|
+
* for the workspace, newest schedule first
|
|
731
|
+
*
|
|
732
|
+
* List scheduled and published Instagram / Facebook / LinkedIn / TikTok posts
|
|
733
|
+
* for the workspace, newest schedule first. Optionally filter by channel_id
|
|
734
|
+
* or status.
|
|
735
|
+
*
|
|
736
|
+
* Risk: `read`.
|
|
737
|
+
*/
|
|
738
|
+
listPosts(request?: ListPostsRequest, options?: RequestOptions): Promise<ListPostsResponse>;
|
|
739
|
+
/**
|
|
740
|
+
* List marketing response agents in this workspace (name, scope, status,
|
|
741
|
+
* handoff dials)
|
|
742
|
+
*
|
|
743
|
+
* List marketing response agents in this workspace (name, scope, status,
|
|
744
|
+
* handoff dials).
|
|
745
|
+
*
|
|
746
|
+
* Risk: `read`.
|
|
747
|
+
*/
|
|
748
|
+
listResponders(request?: ListRespondersRequest, options?: RequestOptions): Promise<ListRespondersResponse>;
|
|
749
|
+
/**
|
|
750
|
+
* List the APPROVED WhatsApp message templates on a marketing channel's
|
|
751
|
+
* business account, read live from Meta: name…
|
|
752
|
+
*
|
|
753
|
+
* List the APPROVED WhatsApp message templates on a marketing channel's
|
|
754
|
+
* business account, read live from Meta: name, language, category and the
|
|
755
|
+
* body text with how many {{n}} placeholders it carries. Read it before
|
|
756
|
+
* marketing.send_template, which takes the name, the language, the category
|
|
757
|
+
* as template_category and one body_params entry per placeholder. A template
|
|
758
|
+
* is the only way to message a customer outside the 24-hour window after
|
|
759
|
+
* their last message.
|
|
760
|
+
*
|
|
761
|
+
* Risk: `read`.
|
|
762
|
+
*/
|
|
763
|
+
listTemplates(request: ListTemplatesRequest, options?: RequestOptions): Promise<ListTemplatesResponse>;
|
|
764
|
+
/**
|
|
765
|
+
* Clear the unread count on an inbox conversation after the member has opened
|
|
766
|
+
* it
|
|
767
|
+
*
|
|
768
|
+
* Clear the unread count on an inbox conversation after the member has opened
|
|
769
|
+
* it.
|
|
770
|
+
*
|
|
771
|
+
* Risk: `write`.
|
|
772
|
+
*/
|
|
773
|
+
markConversationRead(request: MarkConversationReadRequest, options?: RequestOptions): Promise<MarkConversationReadResponse>;
|
|
774
|
+
/**
|
|
775
|
+
* Place a business-initiated WhatsApp voice call
|
|
776
|
+
*
|
|
777
|
+
* Place a business-initiated WhatsApp voice call. Requires prior call
|
|
778
|
+
* permission from the customer (marketing.request_call_permission). Pass a
|
|
779
|
+
* WebRTC SDP offer; Meta returns an answer on the calls webhook (stored on
|
|
780
|
+
* the call row). Parks for approval when an agent proposes it.
|
|
781
|
+
*
|
|
782
|
+
* Risk: `external_effect`.
|
|
783
|
+
*/
|
|
784
|
+
placeCall(request: PlaceCallRequest, options?: RequestOptions): Promise<PlaceCallResponse>;
|
|
785
|
+
/**
|
|
786
|
+
* Prepare short-lived Cloudflare TURN ICE credentials for a WhatsApp Business
|
|
787
|
+
* call
|
|
788
|
+
*
|
|
789
|
+
* Prepare short-lived Cloudflare TURN ICE credentials for a WhatsApp Business
|
|
790
|
+
* call. The request is scoped to the authorized person, workspace, and
|
|
791
|
+
* channel; retrieve it with marketing.get_call_media.
|
|
792
|
+
*
|
|
793
|
+
* Risk: `write`. Acts as one person: a machine-made call always waits for
|
|
794
|
+
* that person's approval.
|
|
795
|
+
*/
|
|
796
|
+
prepareCallMedia(request: PrepareCallMediaRequest, options?: RequestOptions): Promise<PrepareCallMediaResponse>;
|
|
797
|
+
/**
|
|
798
|
+
* Reject an inbound WhatsApp voice call (customer hears decline; no media
|
|
799
|
+
* path needed)
|
|
800
|
+
*
|
|
801
|
+
* Reject an inbound WhatsApp voice call (customer hears decline; no media
|
|
802
|
+
* path needed). Use when the business will not answer. Parks for approval
|
|
803
|
+
* when an agent proposes it.
|
|
804
|
+
*
|
|
805
|
+
* Risk: `external_effect`.
|
|
806
|
+
*/
|
|
807
|
+
rejectCall(request: RejectCallRequest, options?: RequestOptions): Promise<RejectCallResponse>;
|
|
808
|
+
/**
|
|
809
|
+
* Send a WhatsApp call-permission request to a customer so the business may
|
|
810
|
+
* later place a voice call…
|
|
811
|
+
*
|
|
812
|
+
* Send a WhatsApp call-permission request to a customer so the business may
|
|
813
|
+
* later place a voice call (marketing.place_call). Visible outside the
|
|
814
|
+
* platform — parks for approval when an agent proposes it.
|
|
815
|
+
*
|
|
816
|
+
* Risk: `external_effect`.
|
|
817
|
+
*/
|
|
818
|
+
requestCallPermission(request: RequestCallPermissionRequest, options?: RequestOptions): Promise<RequestCallPermissionResponse>;
|
|
819
|
+
/**
|
|
820
|
+
* Put a saved version back: the template returns to that content and the
|
|
821
|
+
* restore itself is recorded as the newest…
|
|
822
|
+
*
|
|
823
|
+
* Put a saved version back: the template returns to that content and the
|
|
824
|
+
* restore itself is recorded as the newest version, so nothing is lost.
|
|
825
|
+
* Campaigns already sent keep their own copy either way.
|
|
826
|
+
*
|
|
827
|
+
* Risk: `write`.
|
|
828
|
+
*/
|
|
829
|
+
restoreEmailTemplateRevision(request: RestoreEmailTemplateRevisionRequest, options?: RequestOptions): Promise<RestoreEmailTemplateRevisionResponse>;
|
|
830
|
+
/**
|
|
831
|
+
* Clear a human handoff on a WhatsApp conversation so the marketing response
|
|
832
|
+
* agent can auto-reply again
|
|
833
|
+
*
|
|
834
|
+
* Clear a human handoff on a WhatsApp conversation so the marketing response
|
|
835
|
+
* agent can auto-reply again.
|
|
836
|
+
*
|
|
837
|
+
* Risk: `write`.
|
|
838
|
+
*/
|
|
839
|
+
resumeResponder(request: ResumeResponderRequest, options?: RequestOptions): Promise<ResumeResponderResponse>;
|
|
840
|
+
/**
|
|
841
|
+
* Review a submitted social post as a person
|
|
842
|
+
*
|
|
843
|
+
* Review a submitted social post as a person. Approve its current content or
|
|
844
|
+
* request changes with a note. Approval does not publish the post; a
|
|
845
|
+
* publisher must schedule it.
|
|
846
|
+
*
|
|
847
|
+
* Risk: `write`. Acts as one person: a machine-made call always waits for
|
|
848
|
+
* that person's approval.
|
|
849
|
+
*/
|
|
850
|
+
reviewPost(request: ReviewPostRequest, options?: RequestOptions): Promise<ReviewPostResponse>;
|
|
851
|
+
/**
|
|
852
|
+
* Save a group of email blocks as a reusable row (a header, a signature, a
|
|
853
|
+
* promotion) so other templates can drop it in
|
|
854
|
+
*
|
|
855
|
+
* Save a group of email blocks as a reusable row (a header, a signature, a
|
|
856
|
+
* promotion) so other templates can drop it in. Pass row_id to rename or
|
|
857
|
+
* replace one.
|
|
858
|
+
*
|
|
859
|
+
* Risk: `write`.
|
|
860
|
+
*/
|
|
861
|
+
saveEmailRow(request: SaveEmailRowRequest, options?: RequestOptions): Promise<SaveEmailRowResponse>;
|
|
862
|
+
/**
|
|
863
|
+
* Create or update a reusable email template from the visual builder's design
|
|
864
|
+
*
|
|
865
|
+
* Create or update a reusable email template from the visual builder's
|
|
866
|
+
* design. The HTML and plain-text bodies are rendered and stored with it,
|
|
867
|
+
* along with a deliverability review (spam_score, spam_findings). Pass
|
|
868
|
+
* template_id to update. Every save is kept in the template's version history
|
|
869
|
+
* unless it is an autosave.
|
|
870
|
+
*
|
|
871
|
+
* Risk: `write`.
|
|
872
|
+
*/
|
|
873
|
+
saveEmailTemplate(request: SaveEmailTemplateRequest, options?: RequestOptions): Promise<SaveEmailTemplateResponse>;
|
|
874
|
+
/**
|
|
875
|
+
* Create or edit one of the workspace's inbox topics
|
|
876
|
+
*
|
|
877
|
+
* Create or edit one of the workspace's inbox topics. New customer messages
|
|
878
|
+
* file their thread under the topic whose description fits; existing threads
|
|
879
|
+
* are filed again with their next message.
|
|
880
|
+
*
|
|
881
|
+
* Risk: `write`.
|
|
882
|
+
*/
|
|
883
|
+
saveInboxTopic(request: SaveInboxTopicRequest, options?: RequestOptions): Promise<SaveInboxTopicResponse>;
|
|
884
|
+
/**
|
|
885
|
+
* Create or edit a social post draft for one connected channel
|
|
886
|
+
*
|
|
887
|
+
* Create or edit a social post draft for one connected channel. Drafts never
|
|
888
|
+
* publish. Only draft posts can be edited. Submit the finished draft for
|
|
889
|
+
* review.
|
|
890
|
+
*
|
|
891
|
+
* Risk: `write`.
|
|
892
|
+
*/
|
|
893
|
+
savePostDraft(request: SavePostDraftRequest, options?: RequestOptions): Promise<SavePostDraftResponse>;
|
|
894
|
+
/**
|
|
895
|
+
* Schedule an approved post, change the time of a scheduled post, or restore
|
|
896
|
+
* a cancelled post
|
|
897
|
+
*
|
|
898
|
+
* Schedule an approved post, change the time of a scheduled post, or restore
|
|
899
|
+
* a cancelled post. Content cannot change after review. Requires an RFC3339
|
|
900
|
+
* future time. The old delivery job cannot publish a rescheduled post.
|
|
901
|
+
*
|
|
902
|
+
* Risk: `external_effect`.
|
|
903
|
+
*/
|
|
904
|
+
schedulePost(request: SchedulePostRequest, options?: RequestOptions): Promise<SchedulePostResponse>;
|
|
905
|
+
/**
|
|
906
|
+
* Search this marketing response agent's attached document knowledge base
|
|
907
|
+
*
|
|
908
|
+
* Search this marketing response agent's attached document knowledge base.
|
|
909
|
+
* Only documents attached via marketing.attach_responder_document are
|
|
910
|
+
* searchable. Returns ranked text chunks.
|
|
911
|
+
*
|
|
912
|
+
* Risk: `read`.
|
|
913
|
+
*/
|
|
914
|
+
searchKnowledge(request: SearchKnowledgeRequest, options?: RequestOptions): Promise<SearchKnowledgeResponse>;
|
|
915
|
+
/**
|
|
916
|
+
* Reply in an Instagram or Facebook direct-message conversation of the inbox
|
|
917
|
+
*
|
|
918
|
+
* Reply in an Instagram or Facebook direct-message conversation of the inbox.
|
|
919
|
+
* Only works inside Meta's 24-hour window after the customer last wrote. The
|
|
920
|
+
* send rides the outbox through the account's Facebook Page; the message
|
|
921
|
+
* appears in the thread as pending then sent. WhatsApp conversations use
|
|
922
|
+
* marketing.send_whatsapp.
|
|
923
|
+
*
|
|
924
|
+
* Risk: `external_effect`.
|
|
925
|
+
*/
|
|
926
|
+
sendDirectMessage(request: SendDirectMessageRequest, options?: RequestOptions): Promise<SendDirectMessageResponse>;
|
|
927
|
+
/**
|
|
928
|
+
* Send (or schedule) an email campaign to its audience through the
|
|
929
|
+
* workspace's SES tenant
|
|
930
|
+
*
|
|
931
|
+
* Send (or schedule) an email campaign to its audience through the
|
|
932
|
+
* workspace's SES tenant. Snapshots the template's rendered content and the
|
|
933
|
+
* sender identity, then queues delivery: omit scheduled_at to send as soon as
|
|
934
|
+
* approved, or pass a future RFC3339 time. Every recipient gets a one-click
|
|
935
|
+
* unsubscribe link; unsubscribed, bounced and complained addresses are
|
|
936
|
+
* skipped. Externally visible — approval-gated for agents. A failed or
|
|
937
|
+
* cancelled campaign can be sent again; only recipients still pending receive
|
|
938
|
+
* it.
|
|
939
|
+
*
|
|
940
|
+
* Risk: `external_effect`.
|
|
941
|
+
*/
|
|
942
|
+
sendEmailCampaign(request: SendEmailCampaignRequest, options?: RequestOptions): Promise<SendEmailCampaignResponse>;
|
|
943
|
+
/**
|
|
944
|
+
* Send a template to one address (yours, typically) to check how it renders
|
|
945
|
+
* in a real inbox
|
|
946
|
+
*
|
|
947
|
+
* Send a template to one address (yours, typically) to check how it renders
|
|
948
|
+
* in a real inbox. Marked [TEST] in the subject; not part of any campaign and
|
|
949
|
+
* not tracked.
|
|
950
|
+
*
|
|
951
|
+
* Risk: `external_effect`.
|
|
952
|
+
*/
|
|
953
|
+
sendEmailTest(request: SendEmailTestRequest, options?: RequestOptions): Promise<SendEmailTestResponse>;
|
|
954
|
+
/**
|
|
955
|
+
* Send an approved WhatsApp message template to CRM contacts: either everyone
|
|
956
|
+
* with a given crm party tag (who have a…
|
|
957
|
+
*
|
|
958
|
+
* Send an approved WhatsApp message template to CRM contacts: either everyone
|
|
959
|
+
* with a given crm party tag (who have a phone), or an explicit party_ids
|
|
960
|
+
* list. Creates a marketing campaign and queues each recipient as its own
|
|
961
|
+
* outbox job (at-least-once; delivery receipts roll up into campaign stats
|
|
962
|
+
* and estimated Meta cost). Use for business-initiated outreach outside the
|
|
963
|
+
* 24h session window. Requires an APPROVED template on the channel's WABA.
|
|
964
|
+
* Returns estimated_cost_micros (list-rate preview) immediately; cost_micros
|
|
965
|
+
* / billable_count update as deliveries land. Track progress with
|
|
966
|
+
* marketing.list_campaigns / marketing.get_campaign.
|
|
967
|
+
*
|
|
968
|
+
* Risk: `external_effect`.
|
|
969
|
+
*/
|
|
970
|
+
sendTemplate(request: SendTemplateRequest, options?: RequestOptions): Promise<SendTemplateResponse>;
|
|
971
|
+
/**
|
|
972
|
+
* Reply in a WhatsApp Business inbox conversation with a free-form session
|
|
973
|
+
* message
|
|
974
|
+
*
|
|
975
|
+
* Reply in a WhatsApp Business inbox conversation with a free-form session
|
|
976
|
+
* message. Only works inside Meta's 24-hour customer-service window after the
|
|
977
|
+
* customer last wrote. The send rides the outbox; the message appears in the
|
|
978
|
+
* thread as pending then sent. Also logs a CRM whatsapp interaction on the
|
|
979
|
+
* linked party.
|
|
980
|
+
*
|
|
981
|
+
* Risk: `external_effect`.
|
|
982
|
+
*/
|
|
983
|
+
sendWhatsapp(request: SendWhatsappRequest, options?: RequestOptions): Promise<SendWhatsappResponse>;
|
|
984
|
+
/**
|
|
985
|
+
* Submit a draft for review
|
|
986
|
+
*
|
|
987
|
+
* Submit a draft for review. The content is locked until a reviewer approves
|
|
988
|
+
* it or requests changes. This does not schedule or publish the post.
|
|
989
|
+
*
|
|
990
|
+
* Risk: `write`.
|
|
991
|
+
*/
|
|
992
|
+
submitPost(request: SubmitPostRequest, options?: RequestOptions): Promise<SubmitPostResponse>;
|
|
993
|
+
/**
|
|
994
|
+
* Fix a message's deliverability without saving anything
|
|
995
|
+
*
|
|
996
|
+
* Fix a message's deliverability without saving anything. Applies the
|
|
997
|
+
* mechanical corrections (a shouting subject, a fake Re:, runs of
|
|
998
|
+
* punctuation, extra emoji, exclamation marks, insecure links, a missing
|
|
999
|
+
* preheader) and asks the language model for what needs words: alt text for a
|
|
1000
|
+
* picture nobody described, a shorter subject, a button label that says what
|
|
1001
|
+
* it does. Returns the corrected subject, preheader and design, what was
|
|
1002
|
+
* corrected, what is still wrong, and the model's suggestions for the caller
|
|
1003
|
+
* to apply and save.
|
|
1004
|
+
*
|
|
1005
|
+
* Risk: `read`.
|
|
1006
|
+
*/
|
|
1007
|
+
suggestEmailFixes(request: SuggestEmailFixesRequest, options?: RequestOptions): Promise<SuggestEmailFixesResponse>;
|
|
1008
|
+
/**
|
|
1009
|
+
* Queue an immediate metrics snapshot for one connected channel (followers,
|
|
1010
|
+
* likes, reach, conversations, …)
|
|
1011
|
+
*
|
|
1012
|
+
* Queue an immediate metrics snapshot for one connected channel (followers,
|
|
1013
|
+
* likes, reach, conversations, …). Also clears an error state. Use after
|
|
1014
|
+
* connecting or when status is error after fixing the cause.
|
|
1015
|
+
*
|
|
1016
|
+
* Risk: `write`.
|
|
1017
|
+
*/
|
|
1018
|
+
syncMetrics(request: SyncMetricsRequest, options?: RequestOptions): Promise<SyncMetricsResponse>;
|
|
1019
|
+
/**
|
|
1020
|
+
* Hang up an active WhatsApp voice call from the business side
|
|
1021
|
+
*
|
|
1022
|
+
* Hang up an active WhatsApp voice call from the business side. Safe when the
|
|
1023
|
+
* customer already left (Meta is idempotent). Parks for approval when an
|
|
1024
|
+
* agent proposes it.
|
|
1025
|
+
*
|
|
1026
|
+
* Risk: `external_effect`.
|
|
1027
|
+
*/
|
|
1028
|
+
terminateCall(request: TerminateCallRequest, options?: RequestOptions): Promise<TerminateCallResponse>;
|
|
1029
|
+
/**
|
|
1030
|
+
* Read live what a connected TikTok account may post right now: its nickname
|
|
1031
|
+
* and avatar, the privacy levels it can…
|
|
1032
|
+
*
|
|
1033
|
+
* Read live what a connected TikTok account may post right now: its nickname
|
|
1034
|
+
* and avatar, the privacy levels it can choose from (tiktok_privacy_level),
|
|
1035
|
+
* whether comments, Duet or Stitch are turned off for it, and the longest
|
|
1036
|
+
* video it can post. Read it before marketing.create_post to a TikTok channel
|
|
1037
|
+
* and let the person choose from these options.
|
|
1038
|
+
*
|
|
1039
|
+
* Risk: `read`.
|
|
1040
|
+
*/
|
|
1041
|
+
tiktokCreatorInfo(request: TiktokCreatorInfoRequest, options?: RequestOptions): Promise<TiktokCreatorInfoResponse>;
|
|
1042
|
+
/**
|
|
1043
|
+
* The posts that earned the most engagement in one window, across every
|
|
1044
|
+
* connected channel, from the platform's stored…
|
|
1045
|
+
*
|
|
1046
|
+
* The posts that earned the most engagement in one window, across every
|
|
1047
|
+
* connected channel, from the platform's stored provider metrics. Engagement
|
|
1048
|
+
* adds the interactions a person chose to make (likes, comments, shares,
|
|
1049
|
+
* saves, reactions); views and reach come back beside it but are not added
|
|
1050
|
+
* in, because reach counts an audience rather than an action. Post measures
|
|
1051
|
+
* are cumulative, so these are each post's standing totals at the end of the
|
|
1052
|
+
* window, not what it gained inside it.
|
|
1053
|
+
*
|
|
1054
|
+
* Risk: `read`.
|
|
1055
|
+
*/
|
|
1056
|
+
topPosts(request?: TopPostsRequest, options?: RequestOptions): Promise<TopPostsResponse>;
|
|
1057
|
+
/**
|
|
1058
|
+
* Add an address to the workspace's do-not-email list by hand (a contact who
|
|
1059
|
+
* asked in person, a partner's address)
|
|
1060
|
+
*
|
|
1061
|
+
* Add an address to the workspace's do-not-email list by hand (a contact who
|
|
1062
|
+
* asked in person, a partner's address). Future campaigns skip it.
|
|
1063
|
+
*
|
|
1064
|
+
* Risk: `write`.
|
|
1065
|
+
*/
|
|
1066
|
+
unsubscribeEmail(request: UnsubscribeEmailRequest, options?: RequestOptions): Promise<UnsubscribeEmailResponse>;
|
|
1067
|
+
/**
|
|
1068
|
+
* Change a draft (or cancelled / failed) campaign's name, subject, template
|
|
1069
|
+
* or audience
|
|
1070
|
+
*
|
|
1071
|
+
* Change a draft (or cancelled / failed) campaign's name, subject, template
|
|
1072
|
+
* or audience. A scheduled campaign must be cancelled first; a sent one is
|
|
1073
|
+
* immutable.
|
|
1074
|
+
*
|
|
1075
|
+
* Risk: `write`.
|
|
1076
|
+
*/
|
|
1077
|
+
updateEmailCampaign(request: UpdateEmailCampaignRequest, options?: RequestOptions): Promise<UpdateEmailCampaignResponse>;
|
|
1078
|
+
/**
|
|
1079
|
+
* Change the sender name, reply-to address or the footer's postal address for
|
|
1080
|
+
* email campaigns
|
|
1081
|
+
*
|
|
1082
|
+
* Change the sender name, reply-to address or the footer's postal address for
|
|
1083
|
+
* email campaigns. Owner or admin only.
|
|
1084
|
+
*
|
|
1085
|
+
* Risk: `write`. Changes the workspace's governance: a machine-made call
|
|
1086
|
+
* always waits for an owner or admin.
|
|
1087
|
+
*/
|
|
1088
|
+
updateEmailSettings(request?: UpdateEmailSettingsRequest, options?: RequestOptions): Promise<UpdateEmailSettingsResponse>;
|
|
1089
|
+
/**
|
|
1090
|
+
* Update a marketing response agent's name, scope, instructions, status,
|
|
1091
|
+
* user-query / human-handoff dials, the accounts…
|
|
1092
|
+
*
|
|
1093
|
+
* Update a marketing response agent's name, scope, instructions, status,
|
|
1094
|
+
* user-query / human-handoff dials, the accounts it answers, or delegate
|
|
1095
|
+
* targets.
|
|
1096
|
+
*
|
|
1097
|
+
* Risk: `write`.
|
|
1098
|
+
*/
|
|
1099
|
+
updateResponder(request: UpdateResponderRequest, options?: RequestOptions): Promise<UpdateResponderResponse>;
|
|
1100
|
+
}
|
|
1101
|
+
export declare function createClient(options: ClientOptions): Client;
|
|
1102
|
+
export declare function bind(transport: Transport): Client;
|
|
1103
|
+
export interface AdTrendRequest {
|
|
1104
|
+
/**
|
|
1105
|
+
* First day of the window, YYYY-MM-DD (default: 27 days before until)
|
|
1106
|
+
*/
|
|
1107
|
+
since?: string;
|
|
1108
|
+
/**
|
|
1109
|
+
* Last day of the window, YYYY-MM-DD (default: today)
|
|
1110
|
+
*/
|
|
1111
|
+
until?: string;
|
|
1112
|
+
}
|
|
1113
|
+
export type AdTrendResponse = {
|
|
1114
|
+
output: unknown;
|
|
1115
|
+
tool: "marketing.ad_trend";
|
|
1116
|
+
} | Pending;
|
|
1117
|
+
export interface AnswerCallRequest {
|
|
1118
|
+
/**
|
|
1119
|
+
* Inbound ringing call to answer
|
|
1120
|
+
*/
|
|
1121
|
+
callId: string;
|
|
1122
|
+
/**
|
|
1123
|
+
* When true, send pre_accept first (recommended: establishes media early,
|
|
1124
|
+
* then call marketing.answer_call without pre_accept to finalize). When false
|
|
1125
|
+
* (default), sends accept.
|
|
1126
|
+
*/
|
|
1127
|
+
preAccept?: boolean;
|
|
1128
|
+
/**
|
|
1129
|
+
* RFC 8866 SDP answer from the WebRTC peer connection
|
|
1130
|
+
*/
|
|
1131
|
+
sdp: string;
|
|
1132
|
+
/**
|
|
1133
|
+
* SDP type; defaults to answer
|
|
1134
|
+
*/
|
|
1135
|
+
sdpType?: "answer";
|
|
1136
|
+
}
|
|
1137
|
+
export type AnswerCallResponse = {
|
|
1138
|
+
output: MarketingActionAnswer;
|
|
1139
|
+
tool: "marketing.answer_call";
|
|
1140
|
+
} | Pending;
|
|
1141
|
+
export interface AskConsumerRequest {
|
|
1142
|
+
conversationId: string;
|
|
1143
|
+
/**
|
|
1144
|
+
* Clarifying question for the consumer, written in their language
|
|
1145
|
+
*/
|
|
1146
|
+
question: string;
|
|
1147
|
+
}
|
|
1148
|
+
export type AskConsumerResponse = {
|
|
1149
|
+
output: MarketingAskAnswer;
|
|
1150
|
+
tool: "marketing.ask_consumer";
|
|
1151
|
+
} | Pending;
|
|
1152
|
+
export interface AttachResponderDocumentRequest {
|
|
1153
|
+
/**
|
|
1154
|
+
* Document id from documents.upload / the Documents page
|
|
1155
|
+
*/
|
|
1156
|
+
documentId: string;
|
|
1157
|
+
responderId: string;
|
|
1158
|
+
}
|
|
1159
|
+
export type AttachResponderDocumentResponse = {
|
|
1160
|
+
output: unknown;
|
|
1161
|
+
tool: "marketing.attach_responder_document";
|
|
1162
|
+
} | Pending;
|
|
1163
|
+
export interface CancelEmailCampaignRequest {
|
|
1164
|
+
campaignId: string;
|
|
1165
|
+
}
|
|
1166
|
+
export type CancelEmailCampaignResponse = {
|
|
1167
|
+
output: MarketingCampaignAnswer;
|
|
1168
|
+
tool: "marketing.cancel_email_campaign";
|
|
1169
|
+
} | Pending;
|
|
1170
|
+
export interface CancelPostRequest {
|
|
1171
|
+
/**
|
|
1172
|
+
* marketing_posts id
|
|
1173
|
+
*/
|
|
1174
|
+
postId: string;
|
|
1175
|
+
}
|
|
1176
|
+
export type CancelPostResponse = {
|
|
1177
|
+
output: unknown;
|
|
1178
|
+
tool: "marketing.cancel_post";
|
|
1179
|
+
} | Pending;
|
|
1180
|
+
export interface ChannelTrendRequest {
|
|
1181
|
+
/**
|
|
1182
|
+
* Provider metric name, as marketing.compare_accounts reports it
|
|
1183
|
+
*/
|
|
1184
|
+
metric: string;
|
|
1185
|
+
/**
|
|
1186
|
+
* First day of the window, YYYY-MM-DD (default: 27 days before until)
|
|
1187
|
+
*/
|
|
1188
|
+
since?: string;
|
|
1189
|
+
/**
|
|
1190
|
+
* Last day of the window, YYYY-MM-DD (default: today)
|
|
1191
|
+
*/
|
|
1192
|
+
until?: string;
|
|
1193
|
+
}
|
|
1194
|
+
export type ChannelTrendResponse = {
|
|
1195
|
+
output: unknown;
|
|
1196
|
+
tool: "marketing.channel_trend";
|
|
1197
|
+
} | Pending;
|
|
1198
|
+
export interface CheckEmailSpamRequest {
|
|
1199
|
+
/**
|
|
1200
|
+
* The visual builder's document: { version: 1, settings: { backgroundColor,
|
|
1201
|
+
* contentColor, textColor, linkColor, fontFamily }, blocks: [...] } where a
|
|
1202
|
+
* block is one of heading {text, level 1|2|3, align left|center|right},
|
|
1203
|
+
* paragraph {text, align; [label](https://url) makes a link}, image {src,
|
|
1204
|
+
* alt, href, width 10-100, align}, button {text, href, color, textColor,
|
|
1205
|
+
* align, corners square|rounded|pill, size small|medium|large, fullWidth},
|
|
1206
|
+
* divider {color, thickness 1-8, style solid|dashed|dotted}, spacer {height},
|
|
1207
|
+
* footer {text}. Text may use {{name}}, {{email}}, {{company}},
|
|
1208
|
+
* {{physical_address}}; the footer always ends with the unsubscribe link.
|
|
1209
|
+
*/
|
|
1210
|
+
design: {
|
|
1211
|
+
[key: string]: unknown;
|
|
1212
|
+
};
|
|
1213
|
+
preheader?: string;
|
|
1214
|
+
subject: string;
|
|
1215
|
+
}
|
|
1216
|
+
export type CheckEmailSpamResponse = {
|
|
1217
|
+
output: MarketingSpamCheck;
|
|
1218
|
+
tool: "marketing.check_email_spam";
|
|
1219
|
+
} | Pending;
|
|
1220
|
+
export interface CompareAccountsRequest {
|
|
1221
|
+
/**
|
|
1222
|
+
* First day of the window, YYYY-MM-DD (default: 27 days before until)
|
|
1223
|
+
*/
|
|
1224
|
+
since?: string;
|
|
1225
|
+
/**
|
|
1226
|
+
* Last day of the window, YYYY-MM-DD (default: today)
|
|
1227
|
+
*/
|
|
1228
|
+
until?: string;
|
|
1229
|
+
}
|
|
1230
|
+
export type CompareAccountsResponse = {
|
|
1231
|
+
output: unknown;
|
|
1232
|
+
tool: "marketing.compare_accounts";
|
|
1233
|
+
} | Pending;
|
|
1234
|
+
export interface ConnectFacebookRequest {
|
|
1235
|
+
/**
|
|
1236
|
+
* Discover Meta ad accounts for selection, instead of connecting social
|
|
1237
|
+
* publishing accounts.
|
|
1238
|
+
*/
|
|
1239
|
+
adsOnly?: boolean;
|
|
1240
|
+
/**
|
|
1241
|
+
* Optional in-app dashboard path after consent (defaults to
|
|
1242
|
+
* /dashboard/marketing)
|
|
1243
|
+
*/
|
|
1244
|
+
returnTo?: string;
|
|
1245
|
+
}
|
|
1246
|
+
export type ConnectFacebookResponse = {
|
|
1247
|
+
output: unknown;
|
|
1248
|
+
tool: "marketing.connect_facebook";
|
|
1249
|
+
} | Pending;
|
|
1250
|
+
export interface ConnectGoogleAdsRequest {
|
|
1251
|
+
body: {
|
|
1252
|
+
[key: string]: unknown;
|
|
1253
|
+
};
|
|
1254
|
+
}
|
|
1255
|
+
export type ConnectGoogleAdsResponse = {
|
|
1256
|
+
output: unknown;
|
|
1257
|
+
tool: "marketing.connect_google_ads";
|
|
1258
|
+
} | Pending;
|
|
1259
|
+
export interface ConnectInstagramRequest {
|
|
1260
|
+
/**
|
|
1261
|
+
* Optional in-app dashboard path after consent (defaults to
|
|
1262
|
+
* /dashboard/marketing)
|
|
1263
|
+
*/
|
|
1264
|
+
returnTo?: string;
|
|
1265
|
+
}
|
|
1266
|
+
export type ConnectInstagramResponse = {
|
|
1267
|
+
output: unknown;
|
|
1268
|
+
tool: "marketing.connect_instagram";
|
|
1269
|
+
} | Pending;
|
|
1270
|
+
export interface ConnectLinkedinRequest {
|
|
1271
|
+
/**
|
|
1272
|
+
* Optional in-app dashboard path after consent (defaults to
|
|
1273
|
+
* /dashboard/marketing/linkedin)
|
|
1274
|
+
*/
|
|
1275
|
+
returnTo?: string;
|
|
1276
|
+
}
|
|
1277
|
+
export type ConnectLinkedinResponse = {
|
|
1278
|
+
output: unknown;
|
|
1279
|
+
tool: "marketing.connect_linkedin";
|
|
1280
|
+
} | Pending;
|
|
1281
|
+
export interface ConnectTiktokRequest {
|
|
1282
|
+
/**
|
|
1283
|
+
* Optional in-app dashboard path after consent (defaults to
|
|
1284
|
+
* /dashboard/marketing/tiktok)
|
|
1285
|
+
*/
|
|
1286
|
+
returnTo?: string;
|
|
1287
|
+
}
|
|
1288
|
+
export type ConnectTiktokResponse = {
|
|
1289
|
+
output: unknown;
|
|
1290
|
+
tool: "marketing.connect_tiktok";
|
|
1291
|
+
} | Pending;
|
|
1292
|
+
export interface ConnectWhatsappRequest {
|
|
1293
|
+
/**
|
|
1294
|
+
* coexistence keeps the existing WhatsApp Business app number live alongside
|
|
1295
|
+
* Cloud API; dedicated is an API-only phone number
|
|
1296
|
+
*/
|
|
1297
|
+
mode: "coexistence" | "dedicated";
|
|
1298
|
+
/**
|
|
1299
|
+
* Optional in-app dashboard path the browser returns to after connecting
|
|
1300
|
+
* (defaults to /dashboard/marketing)
|
|
1301
|
+
*/
|
|
1302
|
+
returnTo?: string;
|
|
1303
|
+
}
|
|
1304
|
+
export type ConnectWhatsappResponse = {
|
|
1305
|
+
output: unknown;
|
|
1306
|
+
tool: "marketing.connect_whatsapp";
|
|
1307
|
+
} | Pending;
|
|
1308
|
+
export interface CreateConversationDealRequest {
|
|
1309
|
+
conversationId: string;
|
|
1310
|
+
}
|
|
1311
|
+
export type CreateConversationDealResponse = {
|
|
1312
|
+
output: MarketingDealAnswer;
|
|
1313
|
+
tool: "marketing.create_conversation_deal";
|
|
1314
|
+
} | Pending;
|
|
1315
|
+
export interface CreateEmailCampaignRequest {
|
|
1316
|
+
name: string;
|
|
1317
|
+
/**
|
|
1318
|
+
* Explicit parties to send to (with or instead of tag_id); parties without an
|
|
1319
|
+
* email are skipped
|
|
1320
|
+
*/
|
|
1321
|
+
partyIds?: string[];
|
|
1322
|
+
/**
|
|
1323
|
+
* Overrides the template subject
|
|
1324
|
+
*/
|
|
1325
|
+
subject?: string;
|
|
1326
|
+
/**
|
|
1327
|
+
* Send to every CRM party carrying this tag that has an email address
|
|
1328
|
+
*/
|
|
1329
|
+
tagId?: string;
|
|
1330
|
+
templateId: string;
|
|
1331
|
+
}
|
|
1332
|
+
export type CreateEmailCampaignResponse = {
|
|
1333
|
+
output: MarketingCreatedCampaign;
|
|
1334
|
+
tool: "marketing.create_email_campaign";
|
|
1335
|
+
} | Pending;
|
|
1336
|
+
export interface CreatePostRequest {
|
|
1337
|
+
/**
|
|
1338
|
+
* Post caption / Facebook or LinkedIn message text (stories take no caption)
|
|
1339
|
+
*/
|
|
1340
|
+
caption?: string;
|
|
1341
|
+
/**
|
|
1342
|
+
* One or more Instagram / Facebook / LinkedIn / TikTok channel ids from
|
|
1343
|
+
* marketing.list_channels
|
|
1344
|
+
*/
|
|
1345
|
+
channelIds: string[];
|
|
1346
|
+
/**
|
|
1347
|
+
* image (default), video, carousel (2–10 URLs), reels (video), story (24-hour
|
|
1348
|
+
* Instagram/Facebook story), or text (Facebook/LinkedIn feed only)
|
|
1349
|
+
*/
|
|
1350
|
+
mediaType?: "image" | "video" | "carousel" | "reels" | "story" | "text";
|
|
1351
|
+
/**
|
|
1352
|
+
* Public https:// media URLs (or URLs from POST /v1/marketing/media).
|
|
1353
|
+
* Required for image/video/carousel/reels/story
|
|
1354
|
+
*/
|
|
1355
|
+
mediaUrls?: string[];
|
|
1356
|
+
/**
|
|
1357
|
+
* When to publish as RFC3339 UTC (omit or past = publish as soon as approved
|
|
1358
|
+
* / queued)
|
|
1359
|
+
*/
|
|
1360
|
+
scheduledAt?: string;
|
|
1361
|
+
/**
|
|
1362
|
+
* TikTok only: let viewers comment (off unless set)
|
|
1363
|
+
*/
|
|
1364
|
+
tiktokAllowComment?: boolean;
|
|
1365
|
+
/**
|
|
1366
|
+
* TikTok only: let viewers Duet the video (off unless set)
|
|
1367
|
+
*/
|
|
1368
|
+
tiktokAllowDuet?: boolean;
|
|
1369
|
+
/**
|
|
1370
|
+
* TikTok only: let viewers Stitch the video (off unless set)
|
|
1371
|
+
*/
|
|
1372
|
+
tiktokAllowStitch?: boolean;
|
|
1373
|
+
/**
|
|
1374
|
+
* TikTok only: the video promotes the creator's own business (labelled
|
|
1375
|
+
* Promotional content)
|
|
1376
|
+
*/
|
|
1377
|
+
tiktokBrandOrganic?: boolean;
|
|
1378
|
+
/**
|
|
1379
|
+
* TikTok only: the video promotes a third party (labelled Paid partnership;
|
|
1380
|
+
* cannot be private)
|
|
1381
|
+
*/
|
|
1382
|
+
tiktokBrandedContent?: boolean;
|
|
1383
|
+
/**
|
|
1384
|
+
* TikTok only: who can view the video, one of the options
|
|
1385
|
+
* marketing.tiktok_creator_info returns. Required to publish to TikTok
|
|
1386
|
+
*/
|
|
1387
|
+
tiktokPrivacyLevel?: "PUBLIC_TO_EVERYONE" | "MUTUAL_FOLLOW_FRIENDS" | "FOLLOWER_OF_CREATOR" | "SELF_ONLY";
|
|
1388
|
+
}
|
|
1389
|
+
export type CreatePostResponse = {
|
|
1390
|
+
output: unknown;
|
|
1391
|
+
tool: "marketing.create_post";
|
|
1392
|
+
} | Pending;
|
|
1393
|
+
export interface CreateResponderRequest {
|
|
1394
|
+
/**
|
|
1395
|
+
* When true (default), the agent may ask the consumer a clarifying question
|
|
1396
|
+
* before answering
|
|
1397
|
+
*/
|
|
1398
|
+
allowUserQuery?: boolean;
|
|
1399
|
+
/**
|
|
1400
|
+
* Connected marketing accounts this agent answers, on any network; omit to
|
|
1401
|
+
* cover every connected account
|
|
1402
|
+
*/
|
|
1403
|
+
channelIds?: string[];
|
|
1404
|
+
/**
|
|
1405
|
+
* Specialist definition slugs this agent may hand work to (sales, bookkeeper,
|
|
1406
|
+
* …)
|
|
1407
|
+
*/
|
|
1408
|
+
delegateTargets?: string[];
|
|
1409
|
+
/**
|
|
1410
|
+
* Guidance for when to escalate to a human (complaints, refunds, etc.)
|
|
1411
|
+
*/
|
|
1412
|
+
handoffHumanWhen?: string;
|
|
1413
|
+
/**
|
|
1414
|
+
* When true (default), the agent may escalate the conversation to a human
|
|
1415
|
+
* teammate
|
|
1416
|
+
*/
|
|
1417
|
+
handoffToHuman?: boolean;
|
|
1418
|
+
/**
|
|
1419
|
+
* Optional standing instructions (tone, policies, language)
|
|
1420
|
+
*/
|
|
1421
|
+
instructions?: string;
|
|
1422
|
+
/**
|
|
1423
|
+
* Display name for this response agent
|
|
1424
|
+
*/
|
|
1425
|
+
name: string;
|
|
1426
|
+
/**
|
|
1427
|
+
* What this agent covers — topics, products, brands, or channel intent. The
|
|
1428
|
+
* agent stays inside this scope.
|
|
1429
|
+
*/
|
|
1430
|
+
scope: string;
|
|
1431
|
+
/**
|
|
1432
|
+
* Defaults to draft; activate when ready to auto-reply
|
|
1433
|
+
*/
|
|
1434
|
+
status?: "draft" | "active" | "paused";
|
|
1435
|
+
}
|
|
1436
|
+
export type CreateResponderResponse = {
|
|
1437
|
+
output: MarketingResponderAnswer;
|
|
1438
|
+
tool: "marketing.create_responder";
|
|
1439
|
+
} | Pending;
|
|
1440
|
+
export interface DeleteEmailRowRequest {
|
|
1441
|
+
rowId: string;
|
|
1442
|
+
}
|
|
1443
|
+
export type DeleteEmailRowResponse = {
|
|
1444
|
+
output: MarketingDeletedAnswer;
|
|
1445
|
+
tool: "marketing.delete_email_row";
|
|
1446
|
+
} | Pending;
|
|
1447
|
+
export interface DeleteEmailTemplateRequest {
|
|
1448
|
+
templateId: string;
|
|
1449
|
+
}
|
|
1450
|
+
export type DeleteEmailTemplateResponse = {
|
|
1451
|
+
output: MarketingDeletedAnswer;
|
|
1452
|
+
tool: "marketing.delete_email_template";
|
|
1453
|
+
} | Pending;
|
|
1454
|
+
export interface DeleteInboxTopicRequest {
|
|
1455
|
+
/**
|
|
1456
|
+
* Topic from marketing.list_inbox_topics
|
|
1457
|
+
*/
|
|
1458
|
+
topicId: string;
|
|
1459
|
+
}
|
|
1460
|
+
export type DeleteInboxTopicResponse = {
|
|
1461
|
+
output: MarketingDeletedTopic;
|
|
1462
|
+
tool: "marketing.delete_inbox_topic";
|
|
1463
|
+
} | Pending;
|
|
1464
|
+
export interface DeleteResponderRequest {
|
|
1465
|
+
responderId: string;
|
|
1466
|
+
}
|
|
1467
|
+
export type DeleteResponderResponse = {
|
|
1468
|
+
output: MarketinginboxDeletedAnswer;
|
|
1469
|
+
tool: "marketing.delete_responder";
|
|
1470
|
+
} | Pending;
|
|
1471
|
+
export interface DetachResponderDocumentRequest {
|
|
1472
|
+
documentId: string;
|
|
1473
|
+
responderId: string;
|
|
1474
|
+
}
|
|
1475
|
+
export type DetachResponderDocumentResponse = {
|
|
1476
|
+
output: MarketingDetachedAnswer;
|
|
1477
|
+
tool: "marketing.detach_responder_document";
|
|
1478
|
+
} | Pending;
|
|
1479
|
+
export interface DisconnectAdAccountRequest {
|
|
1480
|
+
/**
|
|
1481
|
+
* Ad account to disconnect (see marketing.list_ad_accounts)
|
|
1482
|
+
*/
|
|
1483
|
+
adAccountId: string;
|
|
1484
|
+
}
|
|
1485
|
+
export type DisconnectAdAccountResponse = {
|
|
1486
|
+
output: unknown;
|
|
1487
|
+
tool: "marketing.disconnect_ad_account";
|
|
1488
|
+
} | Pending;
|
|
1489
|
+
export interface DisconnectChannelRequest {
|
|
1490
|
+
/**
|
|
1491
|
+
* Marketing channel id (see marketing.list_channels)
|
|
1492
|
+
*/
|
|
1493
|
+
channelId: string;
|
|
1494
|
+
}
|
|
1495
|
+
export type DisconnectChannelResponse = {
|
|
1496
|
+
output: unknown;
|
|
1497
|
+
tool: "marketing.disconnect_channel";
|
|
1498
|
+
} | Pending;
|
|
1499
|
+
export interface EmailReputationRequest {
|
|
1500
|
+
body: {
|
|
1501
|
+
[key: string]: unknown;
|
|
1502
|
+
};
|
|
1503
|
+
}
|
|
1504
|
+
export type EmailReputationResponse = {
|
|
1505
|
+
output: MarketingReputationAnswer;
|
|
1506
|
+
tool: "marketing.email_reputation";
|
|
1507
|
+
} | Pending;
|
|
1508
|
+
export interface EmailStatusRequest {
|
|
1509
|
+
body: {
|
|
1510
|
+
[key: string]: unknown;
|
|
1511
|
+
};
|
|
1512
|
+
}
|
|
1513
|
+
export type EmailStatusResponse = {
|
|
1514
|
+
output: MarketingEmailStatusAnswer;
|
|
1515
|
+
tool: "marketing.email_status";
|
|
1516
|
+
} | Pending;
|
|
1517
|
+
export interface EnableAdAccountRequest {
|
|
1518
|
+
/**
|
|
1519
|
+
* Ad account to select (see marketing.list_ad_accounts)
|
|
1520
|
+
*/
|
|
1521
|
+
adAccountId: string;
|
|
1522
|
+
}
|
|
1523
|
+
export type EnableAdAccountResponse = {
|
|
1524
|
+
output: unknown;
|
|
1525
|
+
tool: "marketing.enable_ad_account";
|
|
1526
|
+
} | Pending;
|
|
1527
|
+
export interface EnableEmailRequest {
|
|
1528
|
+
/**
|
|
1529
|
+
* The sender name recipients see (defaults to the workspace name)
|
|
1530
|
+
*/
|
|
1531
|
+
fromName?: string;
|
|
1532
|
+
/**
|
|
1533
|
+
* The postal address every campaign footer shows (anti-spam law requires one)
|
|
1534
|
+
*/
|
|
1535
|
+
physicalAddress?: string;
|
|
1536
|
+
/**
|
|
1537
|
+
* Where replies go (optional)
|
|
1538
|
+
*/
|
|
1539
|
+
replyTo?: string;
|
|
1540
|
+
}
|
|
1541
|
+
export type EnableEmailResponse = {
|
|
1542
|
+
output: MarketingEnabledEmail;
|
|
1543
|
+
tool: "marketing.enable_email";
|
|
1544
|
+
} | Pending;
|
|
1545
|
+
export interface EscalateToHumanRequest {
|
|
1546
|
+
conversationId: string;
|
|
1547
|
+
/**
|
|
1548
|
+
* Why a human should take over
|
|
1549
|
+
*/
|
|
1550
|
+
reason: string;
|
|
1551
|
+
/**
|
|
1552
|
+
* Short context for the teammate
|
|
1553
|
+
*/
|
|
1554
|
+
summary?: string;
|
|
1555
|
+
}
|
|
1556
|
+
export type EscalateToHumanResponse = {
|
|
1557
|
+
output: MarketingEscalateAnswer;
|
|
1558
|
+
tool: "marketing.escalate_to_human";
|
|
1559
|
+
} | Pending;
|
|
1560
|
+
export interface GenerateImageRequest {
|
|
1561
|
+
/**
|
|
1562
|
+
* The image model; the platform's default when omitted
|
|
1563
|
+
*/
|
|
1564
|
+
model?: "openai/gpt-image-2.5-flare";
|
|
1565
|
+
/**
|
|
1566
|
+
* square (feed posts, default), portrait (stories, reels) or landscape
|
|
1567
|
+
*/
|
|
1568
|
+
orientation?: "square" | "portrait" | "landscape";
|
|
1569
|
+
/**
|
|
1570
|
+
* What the picture shows: subject, setting, style, light, and any text that
|
|
1571
|
+
* must appear in it, word for word
|
|
1572
|
+
*/
|
|
1573
|
+
prompt: string;
|
|
1574
|
+
/**
|
|
1575
|
+
* low for drafts, medium (default), high for a final picture
|
|
1576
|
+
*/
|
|
1577
|
+
quality?: "low" | "medium" | "high";
|
|
1578
|
+
}
|
|
1579
|
+
export type GenerateImageResponse = {
|
|
1580
|
+
output: unknown;
|
|
1581
|
+
tool: "marketing.generate_image";
|
|
1582
|
+
} | Pending;
|
|
1583
|
+
export interface GenerateVideoRequest {
|
|
1584
|
+
/**
|
|
1585
|
+
* 9:16 for reels and stories (default), 16:9 for landscape, 1:1 for feeds
|
|
1586
|
+
*/
|
|
1587
|
+
aspectRatio?: "9:16" | "16:9" | "1:1";
|
|
1588
|
+
/**
|
|
1589
|
+
* Length in seconds; 8 by default
|
|
1590
|
+
*/
|
|
1591
|
+
duration?: 5 | 8 | 10 | 15;
|
|
1592
|
+
/**
|
|
1593
|
+
* The video model; the platform's default when omitted.
|
|
1594
|
+
* anthropic/claude-opus-5-5 makes motion graphics (animated text, colour and
|
|
1595
|
+
* the media library's pictures) instead of generated footage
|
|
1596
|
+
*/
|
|
1597
|
+
model?: "xai/grok-imagine-video-1.5" | "anthropic/claude-opus-5-5";
|
|
1598
|
+
/**
|
|
1599
|
+
* What happens in the clip: subject, action, setting, camera movement and
|
|
1600
|
+
* style
|
|
1601
|
+
*/
|
|
1602
|
+
prompt: string;
|
|
1603
|
+
/**
|
|
1604
|
+
* 720p (default) or 480p
|
|
1605
|
+
*/
|
|
1606
|
+
resolution?: "480p" | "720p";
|
|
1607
|
+
}
|
|
1608
|
+
export type GenerateVideoResponse = {
|
|
1609
|
+
output: unknown;
|
|
1610
|
+
tool: "marketing.generate_video";
|
|
1611
|
+
} | Pending;
|
|
1612
|
+
export interface GetCallRequest {
|
|
1613
|
+
/**
|
|
1614
|
+
* The marketing call id from marketing.list_calls
|
|
1615
|
+
*/
|
|
1616
|
+
callId: string;
|
|
1617
|
+
}
|
|
1618
|
+
export type GetCallResponse = {
|
|
1619
|
+
output: MarketingCallAnswer;
|
|
1620
|
+
tool: "marketing.get_call";
|
|
1621
|
+
} | Pending;
|
|
1622
|
+
export interface GetCallMediaRequest {
|
|
1623
|
+
/**
|
|
1624
|
+
* The request id marketing.prepare_call_media returned
|
|
1625
|
+
*/
|
|
1626
|
+
requestId: string;
|
|
1627
|
+
}
|
|
1628
|
+
export type GetCallMediaResponse = {
|
|
1629
|
+
output: MarketingCallMediaView;
|
|
1630
|
+
tool: "marketing.get_call_media";
|
|
1631
|
+
} | Pending;
|
|
1632
|
+
export interface GetCampaignRequest {
|
|
1633
|
+
/**
|
|
1634
|
+
* Campaign id from marketing.list_campaigns or marketing.send_template
|
|
1635
|
+
*/
|
|
1636
|
+
campaignId: string;
|
|
1637
|
+
}
|
|
1638
|
+
export type GetCampaignResponse = {
|
|
1639
|
+
output: MarketingCampaignDetail;
|
|
1640
|
+
tool: "marketing.get_campaign";
|
|
1641
|
+
} | Pending;
|
|
1642
|
+
export interface GetConversationRequest {
|
|
1643
|
+
/**
|
|
1644
|
+
* Conversation id from marketing.list_conversations
|
|
1645
|
+
*/
|
|
1646
|
+
conversationId: string;
|
|
1647
|
+
/**
|
|
1648
|
+
* Max messages to return (default 100, max 500)
|
|
1649
|
+
*/
|
|
1650
|
+
limit?: number;
|
|
1651
|
+
}
|
|
1652
|
+
export type GetConversationResponse = {
|
|
1653
|
+
output: MarketingConversationDetail;
|
|
1654
|
+
tool: "marketing.get_conversation";
|
|
1655
|
+
} | Pending;
|
|
1656
|
+
export interface GetEmailCampaignRequest {
|
|
1657
|
+
campaignId: string;
|
|
1658
|
+
/**
|
|
1659
|
+
* Max recipients returned (default 100, max 500)
|
|
1660
|
+
*/
|
|
1661
|
+
recipientsLimit?: number;
|
|
1662
|
+
}
|
|
1663
|
+
export type GetEmailCampaignResponse = {
|
|
1664
|
+
output: MarketingCampaignReport;
|
|
1665
|
+
tool: "marketing.get_email_campaign";
|
|
1666
|
+
} | Pending;
|
|
1667
|
+
export interface GetEmailTemplateRequest {
|
|
1668
|
+
templateId: string;
|
|
1669
|
+
}
|
|
1670
|
+
export type GetEmailTemplateResponse = {
|
|
1671
|
+
output: MarketingSavedTemplate;
|
|
1672
|
+
tool: "marketing.get_email_template";
|
|
1673
|
+
} | Pending;
|
|
1674
|
+
export interface GetEmailTemplateRevisionRequest {
|
|
1675
|
+
templateId: string;
|
|
1676
|
+
version: number;
|
|
1677
|
+
}
|
|
1678
|
+
export type GetEmailTemplateRevisionResponse = {
|
|
1679
|
+
output: MarketingOpenedRevision;
|
|
1680
|
+
tool: "marketing.get_email_template_revision";
|
|
1681
|
+
} | Pending;
|
|
1682
|
+
export interface GetPostRequest {
|
|
1683
|
+
/**
|
|
1684
|
+
* marketing_posts id
|
|
1685
|
+
*/
|
|
1686
|
+
postId: string;
|
|
1687
|
+
}
|
|
1688
|
+
export type GetPostResponse = {
|
|
1689
|
+
output: unknown;
|
|
1690
|
+
tool: "marketing.get_post";
|
|
1691
|
+
} | Pending;
|
|
1692
|
+
export interface GetResponderRequest {
|
|
1693
|
+
responderId: string;
|
|
1694
|
+
}
|
|
1695
|
+
export type GetResponderResponse = {
|
|
1696
|
+
output: MarketingResponderDetail;
|
|
1697
|
+
tool: "marketing.get_responder";
|
|
1698
|
+
} | Pending;
|
|
1699
|
+
export interface LinkConversationPartyRequest {
|
|
1700
|
+
conversationId: string;
|
|
1701
|
+
/**
|
|
1702
|
+
* CRM party (customer/vendor/contact) to attach
|
|
1703
|
+
*/
|
|
1704
|
+
partyId: string;
|
|
1705
|
+
}
|
|
1706
|
+
export type LinkConversationPartyResponse = {
|
|
1707
|
+
output: MarketingLinkAnswer;
|
|
1708
|
+
tool: "marketing.link_conversation_party";
|
|
1709
|
+
} | Pending;
|
|
1710
|
+
export interface ListAdAccountsRequest {
|
|
1711
|
+
body: {
|
|
1712
|
+
[key: string]: unknown;
|
|
1713
|
+
};
|
|
1714
|
+
}
|
|
1715
|
+
export type ListAdAccountsResponse = {
|
|
1716
|
+
output: unknown;
|
|
1717
|
+
tool: "marketing.list_ad_accounts";
|
|
1718
|
+
} | Pending;
|
|
1719
|
+
export interface ListAdInsightsRequest {
|
|
1720
|
+
/**
|
|
1721
|
+
* Ad account to read the report for (see marketing.list_ad_accounts)
|
|
1722
|
+
*/
|
|
1723
|
+
adAccountId: string;
|
|
1724
|
+
/**
|
|
1725
|
+
* Optional observation date YYYY-MM-DD; omit for the latest report.
|
|
1726
|
+
*/
|
|
1727
|
+
observedOn?: string;
|
|
1728
|
+
}
|
|
1729
|
+
export type ListAdInsightsResponse = {
|
|
1730
|
+
output: unknown;
|
|
1731
|
+
tool: "marketing.list_ad_insights";
|
|
1732
|
+
} | Pending;
|
|
1733
|
+
export interface ListCallsRequest {
|
|
1734
|
+
/**
|
|
1735
|
+
* Narrow to one WhatsApp Business channel
|
|
1736
|
+
*/
|
|
1737
|
+
channelId?: string;
|
|
1738
|
+
/**
|
|
1739
|
+
* Max calls (default 50, max 200)
|
|
1740
|
+
*/
|
|
1741
|
+
limit?: number;
|
|
1742
|
+
/**
|
|
1743
|
+
* Only calls linked to this CRM contact
|
|
1744
|
+
*/
|
|
1745
|
+
partyId?: string;
|
|
1746
|
+
/**
|
|
1747
|
+
* Filter by call lifecycle status
|
|
1748
|
+
*/
|
|
1749
|
+
status?: "ringing" | "connecting" | "active" | "rejected" | "missed" | "completed" | "failed" | "terminated";
|
|
1750
|
+
}
|
|
1751
|
+
export type ListCallsResponse = {
|
|
1752
|
+
output: MarketingCallsAnswer;
|
|
1753
|
+
tool: "marketing.list_calls";
|
|
1754
|
+
} | Pending;
|
|
1755
|
+
export interface ListCampaignsRequest {
|
|
1756
|
+
/**
|
|
1757
|
+
* Narrow to one WhatsApp channel
|
|
1758
|
+
*/
|
|
1759
|
+
channelId?: string;
|
|
1760
|
+
/**
|
|
1761
|
+
* Max campaigns (default 50, max 200)
|
|
1762
|
+
*/
|
|
1763
|
+
limit?: number;
|
|
1764
|
+
}
|
|
1765
|
+
export type ListCampaignsResponse = {
|
|
1766
|
+
output: MarketingCampaignsAnswer;
|
|
1767
|
+
tool: "marketing.list_campaigns";
|
|
1768
|
+
} | Pending;
|
|
1769
|
+
export interface ListChannelsRequest {
|
|
1770
|
+
body: {
|
|
1771
|
+
[key: string]: unknown;
|
|
1772
|
+
};
|
|
1773
|
+
}
|
|
1774
|
+
export type ListChannelsResponse = {
|
|
1775
|
+
output: unknown;
|
|
1776
|
+
tool: "marketing.list_channels";
|
|
1777
|
+
} | Pending;
|
|
1778
|
+
export interface ListConversationsRequest {
|
|
1779
|
+
/**
|
|
1780
|
+
* Only conversations in this built-in category
|
|
1781
|
+
*/
|
|
1782
|
+
category?: "sales_inquiry" | "order" | "support" | "complaint" | "appointment" | "payment" | "feedback" | "spam" | "other";
|
|
1783
|
+
/**
|
|
1784
|
+
* Narrow to one connected channel
|
|
1785
|
+
*/
|
|
1786
|
+
channelId?: string;
|
|
1787
|
+
/**
|
|
1788
|
+
* Only conversations where the customer reads ready to buy
|
|
1789
|
+
*/
|
|
1790
|
+
hotLeadsOnly?: boolean;
|
|
1791
|
+
/**
|
|
1792
|
+
* Max conversations (default 50, max 200)
|
|
1793
|
+
*/
|
|
1794
|
+
limit?: number;
|
|
1795
|
+
/**
|
|
1796
|
+
* Only conversations where a person from the business should step in
|
|
1797
|
+
*/
|
|
1798
|
+
needsPersonOnly?: boolean;
|
|
1799
|
+
/**
|
|
1800
|
+
* Narrow to every channel of one provider
|
|
1801
|
+
*/
|
|
1802
|
+
provider?: "whatsapp" | "instagram" | "facebook" | "linkedin";
|
|
1803
|
+
/**
|
|
1804
|
+
* Only conversations where the customer currently reads this way
|
|
1805
|
+
*/
|
|
1806
|
+
sentiment?: "positive" | "neutral" | "negative";
|
|
1807
|
+
/**
|
|
1808
|
+
* Only conversations filed under this workspace topic (see
|
|
1809
|
+
* marketing.list_inbox_topics)
|
|
1810
|
+
*/
|
|
1811
|
+
topicId?: string;
|
|
1812
|
+
/**
|
|
1813
|
+
* Only conversations with unread messages
|
|
1814
|
+
*/
|
|
1815
|
+
unreadOnly?: boolean;
|
|
1816
|
+
}
|
|
1817
|
+
export type ListConversationsResponse = {
|
|
1818
|
+
output: MarketingConversationsAnswer;
|
|
1819
|
+
tool: "marketing.list_conversations";
|
|
1820
|
+
} | Pending;
|
|
1821
|
+
export interface ListEmailCampaignsRequest {
|
|
1822
|
+
/**
|
|
1823
|
+
* Max campaigns (default 50, max 200)
|
|
1824
|
+
*/
|
|
1825
|
+
limit?: number;
|
|
1826
|
+
status?: "draft" | "scheduled" | "sending" | "sent" | "cancelled" | "failed";
|
|
1827
|
+
}
|
|
1828
|
+
export type ListEmailCampaignsResponse = {
|
|
1829
|
+
output: MarketingCampaignList;
|
|
1830
|
+
tool: "marketing.list_email_campaigns";
|
|
1831
|
+
} | Pending;
|
|
1832
|
+
export interface ListEmailRowsRequest {
|
|
1833
|
+
body: {
|
|
1834
|
+
[key: string]: unknown;
|
|
1835
|
+
};
|
|
1836
|
+
}
|
|
1837
|
+
export type ListEmailRowsResponse = {
|
|
1838
|
+
output: MarketingRowList;
|
|
1839
|
+
tool: "marketing.list_email_rows";
|
|
1840
|
+
} | Pending;
|
|
1841
|
+
export interface ListEmailTemplateRevisionsRequest {
|
|
1842
|
+
/**
|
|
1843
|
+
* Read the page of versions older than this one
|
|
1844
|
+
*/
|
|
1845
|
+
beforeVersion?: number;
|
|
1846
|
+
templateId: string;
|
|
1847
|
+
}
|
|
1848
|
+
export type ListEmailTemplateRevisionsResponse = {
|
|
1849
|
+
output: MarketingRevisionPage;
|
|
1850
|
+
tool: "marketing.list_email_template_revisions";
|
|
1851
|
+
} | Pending;
|
|
1852
|
+
export interface ListEmailTemplatesRequest {
|
|
1853
|
+
/**
|
|
1854
|
+
* Max templates (default 50, max 200)
|
|
1855
|
+
*/
|
|
1856
|
+
limit?: number;
|
|
1857
|
+
}
|
|
1858
|
+
export type ListEmailTemplatesResponse = {
|
|
1859
|
+
output: MarketingTemplateList;
|
|
1860
|
+
tool: "marketing.list_email_templates";
|
|
1861
|
+
} | Pending;
|
|
1862
|
+
export interface ListEmailUnsubscribesRequest {
|
|
1863
|
+
/**
|
|
1864
|
+
* Max rows (default 100, max 500)
|
|
1865
|
+
*/
|
|
1866
|
+
limit?: number;
|
|
1867
|
+
}
|
|
1868
|
+
export type ListEmailUnsubscribesResponse = {
|
|
1869
|
+
output: MarketingUnsubscribeList;
|
|
1870
|
+
tool: "marketing.list_email_unsubscribes";
|
|
1871
|
+
} | Pending;
|
|
1872
|
+
export interface ListGenerationsRequest {
|
|
1873
|
+
/**
|
|
1874
|
+
* Only pictures or only videos
|
|
1875
|
+
*/
|
|
1876
|
+
kind?: "image" | "video";
|
|
1877
|
+
/**
|
|
1878
|
+
* Only requests in this state
|
|
1879
|
+
*/
|
|
1880
|
+
status?: "queued" | "rendering" | "done" | "failed";
|
|
1881
|
+
}
|
|
1882
|
+
export type ListGenerationsResponse = {
|
|
1883
|
+
output: unknown;
|
|
1884
|
+
tool: "marketing.list_generations";
|
|
1885
|
+
} | Pending;
|
|
1886
|
+
export interface ListHistoryRequest {
|
|
1887
|
+
/**
|
|
1888
|
+
* Opaque page cursor from this import
|
|
1889
|
+
*/
|
|
1890
|
+
after?: string;
|
|
1891
|
+
/**
|
|
1892
|
+
* Marketing channel id (see marketing.list_channels)
|
|
1893
|
+
*/
|
|
1894
|
+
channelId: string;
|
|
1895
|
+
/**
|
|
1896
|
+
* Max pages to return (default 10, max 25)
|
|
1897
|
+
*/
|
|
1898
|
+
limit?: number;
|
|
1899
|
+
}
|
|
1900
|
+
export type ListHistoryResponse = {
|
|
1901
|
+
output: unknown;
|
|
1902
|
+
tool: "marketing.list_history";
|
|
1903
|
+
} | Pending;
|
|
1904
|
+
export interface ListInboxTopicsRequest {
|
|
1905
|
+
body: {
|
|
1906
|
+
[key: string]: unknown;
|
|
1907
|
+
};
|
|
1908
|
+
}
|
|
1909
|
+
export type ListInboxTopicsResponse = {
|
|
1910
|
+
output: MarketingTopicsAnswer;
|
|
1911
|
+
tool: "marketing.list_inbox_topics";
|
|
1912
|
+
} | Pending;
|
|
1913
|
+
export interface ListMediaRequest {
|
|
1914
|
+
/**
|
|
1915
|
+
* Only images within 1% of this aspect ratio. Images only.
|
|
1916
|
+
*/
|
|
1917
|
+
aspectRatio?: "1:1" | "4:5" | "3:4" | "2:3" | "9:16" | "16:9" | "4:3" | "3:2" | "1.91:1";
|
|
1918
|
+
/**
|
|
1919
|
+
* Only images or only videos
|
|
1920
|
+
*/
|
|
1921
|
+
kind?: "image" | "video";
|
|
1922
|
+
/**
|
|
1923
|
+
* Skip this many rows (page size is 48)
|
|
1924
|
+
*/
|
|
1925
|
+
offset?: number;
|
|
1926
|
+
/**
|
|
1927
|
+
* Only media of this orientation; unknown is media whose dimensions were
|
|
1928
|
+
* never probed. Images only.
|
|
1929
|
+
*/
|
|
1930
|
+
orientation?: "portrait" | "landscape" | "square" | "unknown";
|
|
1931
|
+
/**
|
|
1932
|
+
* Match against the file name, case-insensitively
|
|
1933
|
+
*/
|
|
1934
|
+
search?: string;
|
|
1935
|
+
/**
|
|
1936
|
+
* Newest first (default), or by aspect ratio. Ratio sorts are images only.
|
|
1937
|
+
*/
|
|
1938
|
+
sort?: "newest" | "ratio_ascending" | "ratio_descending";
|
|
1939
|
+
}
|
|
1940
|
+
export type ListMediaResponse = {
|
|
1941
|
+
output: unknown;
|
|
1942
|
+
tool: "marketing.list_media";
|
|
1943
|
+
} | Pending;
|
|
1944
|
+
export interface ListMetricsRequest {
|
|
1945
|
+
/**
|
|
1946
|
+
* Narrow to one channel; empty spans all channels in the workspace
|
|
1947
|
+
*/
|
|
1948
|
+
channelId?: string;
|
|
1949
|
+
/**
|
|
1950
|
+
* Inclusive start date YYYY-MM-DD
|
|
1951
|
+
*/
|
|
1952
|
+
from?: string;
|
|
1953
|
+
/**
|
|
1954
|
+
* Include per-post and story metrics and collection coverage. Limits the
|
|
1955
|
+
* response to seven observations.
|
|
1956
|
+
*/
|
|
1957
|
+
includeContent?: boolean;
|
|
1958
|
+
/**
|
|
1959
|
+
* Max snapshots to return (default 90, max 366)
|
|
1960
|
+
*/
|
|
1961
|
+
limit?: number;
|
|
1962
|
+
/**
|
|
1963
|
+
* Provider post ID selected from content metrics. Returns only that post
|
|
1964
|
+
* across up to 366 observations; requires channel_id.
|
|
1965
|
+
*/
|
|
1966
|
+
postReference?: string;
|
|
1967
|
+
/**
|
|
1968
|
+
* Inclusive end date YYYY-MM-DD
|
|
1969
|
+
*/
|
|
1970
|
+
to?: string;
|
|
1971
|
+
/**
|
|
1972
|
+
* Return compact counters and daily values for charts, without audience
|
|
1973
|
+
* breakdowns.
|
|
1974
|
+
*/
|
|
1975
|
+
trend?: boolean;
|
|
1976
|
+
}
|
|
1977
|
+
export type ListMetricsResponse = {
|
|
1978
|
+
output: unknown;
|
|
1979
|
+
tool: "marketing.list_metrics";
|
|
1980
|
+
} | Pending;
|
|
1981
|
+
export interface ListPostRevisionsRequest {
|
|
1982
|
+
/**
|
|
1983
|
+
* Only versions older than this one, for paging
|
|
1984
|
+
*/
|
|
1985
|
+
beforeVersion?: number;
|
|
1986
|
+
/**
|
|
1987
|
+
* marketing_posts id
|
|
1988
|
+
*/
|
|
1989
|
+
postId: string;
|
|
1990
|
+
}
|
|
1991
|
+
export type ListPostRevisionsResponse = {
|
|
1992
|
+
output: unknown;
|
|
1993
|
+
tool: "marketing.list_post_revisions";
|
|
1994
|
+
} | Pending;
|
|
1995
|
+
export interface ListPostsRequest {
|
|
1996
|
+
/**
|
|
1997
|
+
* Narrow to one channel
|
|
1998
|
+
*/
|
|
1999
|
+
channelId?: string;
|
|
2000
|
+
/**
|
|
2001
|
+
* Inclusive RFC3339 publication or schedule start
|
|
2002
|
+
*/
|
|
2003
|
+
from?: string;
|
|
2004
|
+
/**
|
|
2005
|
+
* Max posts (default 50, max 200)
|
|
2006
|
+
*/
|
|
2007
|
+
limit?: number;
|
|
2008
|
+
/**
|
|
2009
|
+
* Filter by status
|
|
2010
|
+
*/
|
|
2011
|
+
status?: "draft" | "in_review" | "approved" | "scheduled" | "publishing" | "published" | "failed" | "cancelled";
|
|
2012
|
+
/**
|
|
2013
|
+
* Exclusive RFC3339 publication or schedule end
|
|
2014
|
+
*/
|
|
2015
|
+
until?: string;
|
|
2016
|
+
}
|
|
2017
|
+
export type ListPostsResponse = {
|
|
2018
|
+
output: unknown;
|
|
2019
|
+
tool: "marketing.list_posts";
|
|
2020
|
+
} | Pending;
|
|
2021
|
+
export interface ListRespondersRequest {
|
|
2022
|
+
/**
|
|
2023
|
+
* Optional status filter
|
|
2024
|
+
*/
|
|
2025
|
+
status?: "draft" | "active" | "paused";
|
|
2026
|
+
}
|
|
2027
|
+
export type ListRespondersResponse = {
|
|
2028
|
+
output: MarketingRespondersAnswer;
|
|
2029
|
+
tool: "marketing.list_responders";
|
|
2030
|
+
} | Pending;
|
|
2031
|
+
export interface ListTemplatesRequest {
|
|
2032
|
+
/**
|
|
2033
|
+
* WhatsApp marketing channel id (see marketing.list_channels)
|
|
2034
|
+
*/
|
|
2035
|
+
channelId: string;
|
|
2036
|
+
}
|
|
2037
|
+
export type ListTemplatesResponse = {
|
|
2038
|
+
output: MarketinginboxTemplateList;
|
|
2039
|
+
tool: "marketing.list_templates";
|
|
2040
|
+
} | Pending;
|
|
2041
|
+
export interface MarkConversationReadRequest {
|
|
2042
|
+
conversationId: string;
|
|
2043
|
+
}
|
|
2044
|
+
export type MarkConversationReadResponse = {
|
|
2045
|
+
output: MarketingConversationAnswer;
|
|
2046
|
+
tool: "marketing.mark_conversation_read";
|
|
2047
|
+
} | Pending;
|
|
2048
|
+
export interface PlaceCallRequest {
|
|
2049
|
+
/**
|
|
2050
|
+
* Optional tracking string echoed on terminate webhooks (max 512 chars)
|
|
2051
|
+
*/
|
|
2052
|
+
bizOpaqueCallbackData?: string;
|
|
2053
|
+
/**
|
|
2054
|
+
* WhatsApp Business marketing channel to place the call from
|
|
2055
|
+
*/
|
|
2056
|
+
channelId: string;
|
|
2057
|
+
/**
|
|
2058
|
+
* Optional CRM contact to attach to the call row
|
|
2059
|
+
*/
|
|
2060
|
+
partyId?: string;
|
|
2061
|
+
/**
|
|
2062
|
+
* RFC 8866 SDP offer from the business WebRTC peer connection
|
|
2063
|
+
*/
|
|
2064
|
+
sdp: string;
|
|
2065
|
+
/**
|
|
2066
|
+
* SDP type; defaults to offer
|
|
2067
|
+
*/
|
|
2068
|
+
sdpType?: "offer";
|
|
2069
|
+
/**
|
|
2070
|
+
* Customer phone (E.164 or digits) — must have granted call permission
|
|
2071
|
+
*/
|
|
2072
|
+
to: string;
|
|
2073
|
+
}
|
|
2074
|
+
export type PlaceCallResponse = {
|
|
2075
|
+
output: MarketingActionAnswer;
|
|
2076
|
+
tool: "marketing.place_call";
|
|
2077
|
+
} | Pending;
|
|
2078
|
+
export interface PrepareCallMediaRequest {
|
|
2079
|
+
/**
|
|
2080
|
+
* WhatsApp Business channel for this call
|
|
2081
|
+
*/
|
|
2082
|
+
channelId: string;
|
|
2083
|
+
}
|
|
2084
|
+
export type PrepareCallMediaResponse = {
|
|
2085
|
+
output: MarketingMediaRequest;
|
|
2086
|
+
tool: "marketing.prepare_call_media";
|
|
2087
|
+
} | Pending;
|
|
2088
|
+
export interface RejectCallRequest {
|
|
2089
|
+
/**
|
|
2090
|
+
* Inbound call to decline
|
|
2091
|
+
*/
|
|
2092
|
+
callId: string;
|
|
2093
|
+
}
|
|
2094
|
+
export type RejectCallResponse = {
|
|
2095
|
+
output: MarketingActionAnswer;
|
|
2096
|
+
tool: "marketing.reject_call";
|
|
2097
|
+
} | Pending;
|
|
2098
|
+
export interface RequestCallPermissionRequest {
|
|
2099
|
+
/**
|
|
2100
|
+
* WhatsApp Business channel to send from
|
|
2101
|
+
*/
|
|
2102
|
+
channelId: string;
|
|
2103
|
+
/**
|
|
2104
|
+
* Customer phone to ask for call permission
|
|
2105
|
+
*/
|
|
2106
|
+
to: string;
|
|
2107
|
+
}
|
|
2108
|
+
export type RequestCallPermissionResponse = {
|
|
2109
|
+
output: MarketingPermissionAnswer;
|
|
2110
|
+
tool: "marketing.request_call_permission";
|
|
2111
|
+
} | Pending;
|
|
2112
|
+
export interface RestoreEmailTemplateRevisionRequest {
|
|
2113
|
+
templateId: string;
|
|
2114
|
+
version: number;
|
|
2115
|
+
}
|
|
2116
|
+
export type RestoreEmailTemplateRevisionResponse = {
|
|
2117
|
+
output: MarketingRestoredRevision;
|
|
2118
|
+
tool: "marketing.restore_email_template_revision";
|
|
2119
|
+
} | Pending;
|
|
2120
|
+
export interface ResumeResponderRequest {
|
|
2121
|
+
conversationId: string;
|
|
2122
|
+
}
|
|
2123
|
+
export type ResumeResponderResponse = {
|
|
2124
|
+
output: MarketingResumeAnswer;
|
|
2125
|
+
tool: "marketing.resume_responder";
|
|
2126
|
+
} | Pending;
|
|
2127
|
+
export interface ReviewPostRequest {
|
|
2128
|
+
decision: "approve" | "request_changes";
|
|
2129
|
+
/**
|
|
2130
|
+
* updated_at from the post being reviewed; rejects a stale review
|
|
2131
|
+
*/
|
|
2132
|
+
expectedUpdatedAt: string;
|
|
2133
|
+
/**
|
|
2134
|
+
* Why changes are requested (required for request_changes)
|
|
2135
|
+
*/
|
|
2136
|
+
note?: string;
|
|
2137
|
+
/**
|
|
2138
|
+
* marketing_posts id
|
|
2139
|
+
*/
|
|
2140
|
+
postId: string;
|
|
2141
|
+
}
|
|
2142
|
+
export type ReviewPostResponse = {
|
|
2143
|
+
output: unknown;
|
|
2144
|
+
tool: "marketing.review_post";
|
|
2145
|
+
} | Pending;
|
|
2146
|
+
export interface SaveEmailRowRequest {
|
|
2147
|
+
/**
|
|
2148
|
+
* The blocks the row holds, in order — the same shape a template's
|
|
2149
|
+
* design.blocks carries. A footer is dropped: every design gets its own.
|
|
2150
|
+
*/
|
|
2151
|
+
blocks: {
|
|
2152
|
+
[key: string]: unknown;
|
|
2153
|
+
}[];
|
|
2154
|
+
name: string;
|
|
2155
|
+
rowId?: string;
|
|
2156
|
+
}
|
|
2157
|
+
export type SaveEmailRowResponse = {
|
|
2158
|
+
output: MarketingSavedRow;
|
|
2159
|
+
tool: "marketing.save_email_row";
|
|
2160
|
+
} | Pending;
|
|
2161
|
+
export interface SaveEmailTemplateRequest {
|
|
2162
|
+
/**
|
|
2163
|
+
* The editor saving work in the background: the template is updated but no
|
|
2164
|
+
* version is recorded. Leave it off for a save a person asked for.
|
|
2165
|
+
*/
|
|
2166
|
+
autosave?: boolean;
|
|
2167
|
+
/**
|
|
2168
|
+
* The visual builder's document: { version: 1, settings: { backgroundColor,
|
|
2169
|
+
* contentColor, textColor, linkColor, fontFamily }, blocks: [...] } where a
|
|
2170
|
+
* block is one of heading {text, level 1|2|3, align left|center|right},
|
|
2171
|
+
* paragraph {text, align; [label](https://url) makes a link}, image {src,
|
|
2172
|
+
* alt, href, width 10-100, align}, button {text, href, color, textColor,
|
|
2173
|
+
* align, corners square|rounded|pill, size small|medium|large, fullWidth},
|
|
2174
|
+
* divider {color, thickness 1-8, style solid|dashed|dotted}, spacer {height},
|
|
2175
|
+
* footer {text}. Text may use {{name}}, {{email}}, {{company}},
|
|
2176
|
+
* {{physical_address}}; the footer always ends with the unsubscribe link.
|
|
2177
|
+
*/
|
|
2178
|
+
design: {
|
|
2179
|
+
[key: string]: unknown;
|
|
2180
|
+
};
|
|
2181
|
+
name: string;
|
|
2182
|
+
preheader?: string;
|
|
2183
|
+
subject?: string;
|
|
2184
|
+
templateId?: string;
|
|
2185
|
+
}
|
|
2186
|
+
export type SaveEmailTemplateResponse = {
|
|
2187
|
+
output: MarketingSavedTemplate;
|
|
2188
|
+
tool: "marketing.save_email_template";
|
|
2189
|
+
} | Pending;
|
|
2190
|
+
export interface SaveInboxTopicRequest {
|
|
2191
|
+
/**
|
|
2192
|
+
* When a conversation belongs here, written for the automatic reader (e.g.
|
|
2193
|
+
* 'stores asking for wholesale prices or bulk orders')
|
|
2194
|
+
*/
|
|
2195
|
+
description?: string;
|
|
2196
|
+
/**
|
|
2197
|
+
* Topic name shown on conversations (e.g. Mayoristas)
|
|
2198
|
+
*/
|
|
2199
|
+
name: string;
|
|
2200
|
+
/**
|
|
2201
|
+
* Existing topic to rename or re-describe; empty creates one
|
|
2202
|
+
*/
|
|
2203
|
+
topicId?: string;
|
|
2204
|
+
}
|
|
2205
|
+
export type SaveInboxTopicResponse = {
|
|
2206
|
+
output: MarketingTopicAnswer;
|
|
2207
|
+
tool: "marketing.save_inbox_topic";
|
|
2208
|
+
} | Pending;
|
|
2209
|
+
export interface SavePostDraftRequest {
|
|
2210
|
+
/**
|
|
2211
|
+
* Post caption / message text
|
|
2212
|
+
*/
|
|
2213
|
+
caption?: string;
|
|
2214
|
+
/**
|
|
2215
|
+
* The channel the post will go out on (see marketing.list_channels)
|
|
2216
|
+
*/
|
|
2217
|
+
channelId: string;
|
|
2218
|
+
/**
|
|
2219
|
+
* image (default), video, carousel (2–10 URLs), reels (video), story (24-hour
|
|
2220
|
+
* Instagram/Facebook story), or text (Facebook/LinkedIn feed only)
|
|
2221
|
+
*/
|
|
2222
|
+
mediaType?: "image" | "video" | "carousel" | "reels" | "story" | "text";
|
|
2223
|
+
/**
|
|
2224
|
+
* Public https:// media URLs; required for image/video/carousel/reels/story
|
|
2225
|
+
*/
|
|
2226
|
+
mediaUrls?: string[];
|
|
2227
|
+
/**
|
|
2228
|
+
* Draft id to edit; omit to create a new draft
|
|
2229
|
+
*/
|
|
2230
|
+
postId?: string;
|
|
2231
|
+
/**
|
|
2232
|
+
* TikTok only: let viewers comment (off unless set)
|
|
2233
|
+
*/
|
|
2234
|
+
tiktokAllowComment?: boolean;
|
|
2235
|
+
/**
|
|
2236
|
+
* TikTok only: let viewers Duet the video (off unless set)
|
|
2237
|
+
*/
|
|
2238
|
+
tiktokAllowDuet?: boolean;
|
|
2239
|
+
/**
|
|
2240
|
+
* TikTok only: let viewers Stitch the video (off unless set)
|
|
2241
|
+
*/
|
|
2242
|
+
tiktokAllowStitch?: boolean;
|
|
2243
|
+
/**
|
|
2244
|
+
* TikTok only: the video promotes the creator's own business (labelled
|
|
2245
|
+
* Promotional content)
|
|
2246
|
+
*/
|
|
2247
|
+
tiktokBrandOrganic?: boolean;
|
|
2248
|
+
/**
|
|
2249
|
+
* TikTok only: the video promotes a third party (labelled Paid partnership;
|
|
2250
|
+
* cannot be private)
|
|
2251
|
+
*/
|
|
2252
|
+
tiktokBrandedContent?: boolean;
|
|
2253
|
+
/**
|
|
2254
|
+
* TikTok only: who can view the video, one of the options
|
|
2255
|
+
* marketing.tiktok_creator_info returns. Required to publish to TikTok
|
|
2256
|
+
*/
|
|
2257
|
+
tiktokPrivacyLevel?: "PUBLIC_TO_EVERYONE" | "MUTUAL_FOLLOW_FRIENDS" | "FOLLOWER_OF_CREATOR" | "SELF_ONLY";
|
|
2258
|
+
}
|
|
2259
|
+
export type SavePostDraftResponse = {
|
|
2260
|
+
output: unknown;
|
|
2261
|
+
tool: "marketing.save_post_draft";
|
|
2262
|
+
} | Pending;
|
|
2263
|
+
export interface SchedulePostRequest {
|
|
2264
|
+
/**
|
|
2265
|
+
* marketing_posts id
|
|
2266
|
+
*/
|
|
2267
|
+
postId: string;
|
|
2268
|
+
/**
|
|
2269
|
+
* When to publish as RFC3339 UTC
|
|
2270
|
+
*/
|
|
2271
|
+
scheduledAt: string;
|
|
2272
|
+
}
|
|
2273
|
+
export type SchedulePostResponse = {
|
|
2274
|
+
output: unknown;
|
|
2275
|
+
tool: "marketing.schedule_post";
|
|
2276
|
+
} | Pending;
|
|
2277
|
+
export interface SearchKnowledgeRequest {
|
|
2278
|
+
/**
|
|
2279
|
+
* Max results (default 8)
|
|
2280
|
+
*/
|
|
2281
|
+
limit?: number;
|
|
2282
|
+
/**
|
|
2283
|
+
* What to look up in this agent's knowledge base
|
|
2284
|
+
*/
|
|
2285
|
+
query: string;
|
|
2286
|
+
}
|
|
2287
|
+
export type SearchKnowledgeResponse = {
|
|
2288
|
+
output: MarketingHitsAnswer;
|
|
2289
|
+
tool: "marketing.search_knowledge";
|
|
2290
|
+
} | Pending;
|
|
2291
|
+
export interface SendDirectMessageRequest {
|
|
2292
|
+
/**
|
|
2293
|
+
* Plain text reply (requires the customer to have written in the last 24h)
|
|
2294
|
+
*/
|
|
2295
|
+
body: string;
|
|
2296
|
+
/**
|
|
2297
|
+
* Conversation to reply in
|
|
2298
|
+
*/
|
|
2299
|
+
conversationId: string;
|
|
2300
|
+
}
|
|
2301
|
+
export type SendDirectMessageResponse = {
|
|
2302
|
+
output: MarketingQueuedAnswer;
|
|
2303
|
+
tool: "marketing.send_direct_message";
|
|
2304
|
+
} | Pending;
|
|
2305
|
+
export interface SendEmailCampaignRequest {
|
|
2306
|
+
campaignId: string;
|
|
2307
|
+
/**
|
|
2308
|
+
* When to send, RFC3339 (omit for now)
|
|
2309
|
+
*/
|
|
2310
|
+
scheduledAt?: string;
|
|
2311
|
+
}
|
|
2312
|
+
export type SendEmailCampaignResponse = {
|
|
2313
|
+
output: MarketingSentCampaign;
|
|
2314
|
+
tool: "marketing.send_email_campaign";
|
|
2315
|
+
} | Pending;
|
|
2316
|
+
export interface SendEmailTestRequest {
|
|
2317
|
+
templateId: string;
|
|
2318
|
+
/**
|
|
2319
|
+
* The address to send the test to
|
|
2320
|
+
*/
|
|
2321
|
+
to: string;
|
|
2322
|
+
}
|
|
2323
|
+
export type SendEmailTestResponse = {
|
|
2324
|
+
output: MarketingQueuedTest;
|
|
2325
|
+
tool: "marketing.send_email_test";
|
|
2326
|
+
} | Pending;
|
|
2327
|
+
export interface SendTemplateRequest {
|
|
2328
|
+
/**
|
|
2329
|
+
* Ordered body parameters for the template ({{1}}, {{2}}, …)
|
|
2330
|
+
*/
|
|
2331
|
+
bodyParams?: string[];
|
|
2332
|
+
/**
|
|
2333
|
+
* WhatsApp marketing channel to send from
|
|
2334
|
+
*/
|
|
2335
|
+
channelId: string;
|
|
2336
|
+
/**
|
|
2337
|
+
* Template language code (e.g. es, en_US)
|
|
2338
|
+
*/
|
|
2339
|
+
language: string;
|
|
2340
|
+
/**
|
|
2341
|
+
* Optional campaign label (defaults to the template name)
|
|
2342
|
+
*/
|
|
2343
|
+
name?: string;
|
|
2344
|
+
/**
|
|
2345
|
+
* Explicit party ids to send to (alternative to tag_id); parties without a
|
|
2346
|
+
* phone are skipped
|
|
2347
|
+
*/
|
|
2348
|
+
partyIds?: string[];
|
|
2349
|
+
/**
|
|
2350
|
+
* Send to every CRM party carrying this tag that has a phone (see
|
|
2351
|
+
* crm.list_party_tags)
|
|
2352
|
+
*/
|
|
2353
|
+
tagId?: string;
|
|
2354
|
+
/**
|
|
2355
|
+
* Meta template category from marketing.list_templates
|
|
2356
|
+
* (marketing|utility|authentication); used for cost estimates
|
|
2357
|
+
*/
|
|
2358
|
+
templateCategory?: string;
|
|
2359
|
+
/**
|
|
2360
|
+
* Approved template name (see marketing.list_templates)
|
|
2361
|
+
*/
|
|
2362
|
+
templateName: string;
|
|
2363
|
+
}
|
|
2364
|
+
export type SendTemplateResponse = {
|
|
2365
|
+
output: MarketingSendTemplateAnswer;
|
|
2366
|
+
tool: "marketing.send_template";
|
|
2367
|
+
} | Pending;
|
|
2368
|
+
export interface SendWhatsappRequest {
|
|
2369
|
+
/**
|
|
2370
|
+
* Plain text reply (session message; requires open 24h customer window)
|
|
2371
|
+
*/
|
|
2372
|
+
body: string;
|
|
2373
|
+
/**
|
|
2374
|
+
* Conversation to reply in
|
|
2375
|
+
*/
|
|
2376
|
+
conversationId: string;
|
|
2377
|
+
}
|
|
2378
|
+
export type SendWhatsappResponse = {
|
|
2379
|
+
output: MarketingQueuedAnswer;
|
|
2380
|
+
tool: "marketing.send_whatsapp";
|
|
2381
|
+
} | Pending;
|
|
2382
|
+
export interface SubmitPostRequest {
|
|
2383
|
+
/**
|
|
2384
|
+
* marketing_posts id
|
|
2385
|
+
*/
|
|
2386
|
+
postId: string;
|
|
2387
|
+
}
|
|
2388
|
+
export type SubmitPostResponse = {
|
|
2389
|
+
output: unknown;
|
|
2390
|
+
tool: "marketing.submit_post";
|
|
2391
|
+
} | Pending;
|
|
2392
|
+
export interface SuggestEmailFixesRequest {
|
|
2393
|
+
/**
|
|
2394
|
+
* The visual builder's document, the same shape marketing.save_email_template
|
|
2395
|
+
* takes.
|
|
2396
|
+
*/
|
|
2397
|
+
design: {
|
|
2398
|
+
[key: string]: unknown;
|
|
2399
|
+
};
|
|
2400
|
+
preheader?: string;
|
|
2401
|
+
subject: string;
|
|
2402
|
+
}
|
|
2403
|
+
export type SuggestEmailFixesResponse = {
|
|
2404
|
+
output: MarketingSuggestedFixes;
|
|
2405
|
+
tool: "marketing.suggest_email_fixes";
|
|
2406
|
+
} | Pending;
|
|
2407
|
+
export interface SyncMetricsRequest {
|
|
2408
|
+
/**
|
|
2409
|
+
* Marketing channel id (see marketing.list_channels)
|
|
2410
|
+
*/
|
|
2411
|
+
channelId: string;
|
|
2412
|
+
}
|
|
2413
|
+
export type SyncMetricsResponse = {
|
|
2414
|
+
output: unknown;
|
|
2415
|
+
tool: "marketing.sync_metrics";
|
|
2416
|
+
} | Pending;
|
|
2417
|
+
export interface TerminateCallRequest {
|
|
2418
|
+
/**
|
|
2419
|
+
* Active call to hang up
|
|
2420
|
+
*/
|
|
2421
|
+
callId: string;
|
|
2422
|
+
}
|
|
2423
|
+
export type TerminateCallResponse = {
|
|
2424
|
+
output: MarketingActionAnswer;
|
|
2425
|
+
tool: "marketing.terminate_call";
|
|
2426
|
+
} | Pending;
|
|
2427
|
+
export interface TiktokCreatorInfoRequest {
|
|
2428
|
+
/**
|
|
2429
|
+
* A TikTok channel id from marketing.list_channels
|
|
2430
|
+
*/
|
|
2431
|
+
channelId: string;
|
|
2432
|
+
}
|
|
2433
|
+
export type TiktokCreatorInfoResponse = {
|
|
2434
|
+
output: MarketingCreatorInfoOutput;
|
|
2435
|
+
tool: "marketing.tiktok_creator_info";
|
|
2436
|
+
} | Pending;
|
|
2437
|
+
export interface TopPostsRequest {
|
|
2438
|
+
/**
|
|
2439
|
+
* How many posts to return (default 10; max 50)
|
|
2440
|
+
*/
|
|
2441
|
+
limit?: number;
|
|
2442
|
+
/**
|
|
2443
|
+
* First day of the window, YYYY-MM-DD (default: 27 days before until)
|
|
2444
|
+
*/
|
|
2445
|
+
since?: string;
|
|
2446
|
+
/**
|
|
2447
|
+
* Last day of the window, YYYY-MM-DD (default: today)
|
|
2448
|
+
*/
|
|
2449
|
+
until?: string;
|
|
2450
|
+
}
|
|
2451
|
+
export type TopPostsResponse = {
|
|
2452
|
+
output: unknown;
|
|
2453
|
+
tool: "marketing.top_posts";
|
|
2454
|
+
} | Pending;
|
|
2455
|
+
export interface UnsubscribeEmailRequest {
|
|
2456
|
+
email: string;
|
|
2457
|
+
}
|
|
2458
|
+
export type UnsubscribeEmailResponse = {
|
|
2459
|
+
output: MarketingUnsubscribed;
|
|
2460
|
+
tool: "marketing.unsubscribe_email";
|
|
2461
|
+
} | Pending;
|
|
2462
|
+
export interface UpdateEmailCampaignRequest {
|
|
2463
|
+
campaignId: string;
|
|
2464
|
+
name?: string;
|
|
2465
|
+
partyIds?: string[];
|
|
2466
|
+
subject?: string;
|
|
2467
|
+
tagId?: string;
|
|
2468
|
+
templateId?: string;
|
|
2469
|
+
}
|
|
2470
|
+
export type UpdateEmailCampaignResponse = {
|
|
2471
|
+
output: MarketingCampaignAnswer;
|
|
2472
|
+
tool: "marketing.update_email_campaign";
|
|
2473
|
+
} | Pending;
|
|
2474
|
+
export interface UpdateEmailSettingsRequest {
|
|
2475
|
+
fromName?: string;
|
|
2476
|
+
physicalAddress?: string;
|
|
2477
|
+
replyTo?: string;
|
|
2478
|
+
}
|
|
2479
|
+
export type UpdateEmailSettingsResponse = {
|
|
2480
|
+
output: MarketingUpdatedSettings;
|
|
2481
|
+
tool: "marketing.update_email_settings";
|
|
2482
|
+
} | Pending;
|
|
2483
|
+
export interface UpdateResponderRequest {
|
|
2484
|
+
allowUserQuery?: boolean;
|
|
2485
|
+
/**
|
|
2486
|
+
* Replace the accounts this agent answers when provided; an empty list covers
|
|
2487
|
+
* every connected account
|
|
2488
|
+
*/
|
|
2489
|
+
channelIds?: string[];
|
|
2490
|
+
/**
|
|
2491
|
+
* Replace the full delegate allowlist when provided
|
|
2492
|
+
*/
|
|
2493
|
+
delegateTargets?: string[];
|
|
2494
|
+
handoffHumanWhen?: string;
|
|
2495
|
+
handoffToHuman?: boolean;
|
|
2496
|
+
instructions?: string;
|
|
2497
|
+
/**
|
|
2498
|
+
* New display name
|
|
2499
|
+
*/
|
|
2500
|
+
name?: string;
|
|
2501
|
+
responderId: string;
|
|
2502
|
+
scope?: string;
|
|
2503
|
+
status?: "draft" | "active" | "paused";
|
|
2504
|
+
}
|
|
2505
|
+
export type UpdateResponderResponse = {
|
|
2506
|
+
output: MarketingResponderAnswer;
|
|
2507
|
+
tool: "marketing.update_responder";
|
|
2508
|
+
} | Pending;
|
|
2509
|
+
//# sourceMappingURL=client.d.ts.map
|