@augno/sdk 0.7.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +2 -2
- package/client.d.mts +11 -2
- package/client.d.mts.map +1 -1
- package/client.d.ts +11 -2
- package/client.d.ts.map +1 -1
- package/client.js +9 -0
- package/client.js.map +1 -1
- package/client.mjs +9 -0
- package/client.mjs.map +1 -1
- package/package.json +15 -9
- package/resources/auth/api-keys/actions.d.mts +2 -0
- package/resources/auth/api-keys/actions.d.mts.map +1 -1
- package/resources/auth/api-keys/actions.d.ts +2 -0
- package/resources/auth/api-keys/actions.d.ts.map +1 -1
- package/resources/auth/api-keys/actions.js +2 -0
- package/resources/auth/api-keys/actions.js.map +1 -1
- package/resources/auth/api-keys/actions.mjs +2 -0
- package/resources/auth/api-keys/actions.mjs.map +1 -1
- package/resources/auth/api-keys/api-keys.d.mts +12 -3
- package/resources/auth/api-keys/api-keys.d.mts.map +1 -1
- package/resources/auth/api-keys/api-keys.d.ts +12 -3
- package/resources/auth/api-keys/api-keys.d.ts.map +1 -1
- package/resources/auth/api-keys/api-keys.js +9 -0
- package/resources/auth/api-keys/api-keys.js.map +1 -1
- package/resources/auth/api-keys/api-keys.mjs +9 -0
- package/resources/auth/api-keys/api-keys.mjs.map +1 -1
- package/resources/catalog/item-categories/item-categories.d.mts +17 -1
- package/resources/catalog/item-categories/item-categories.d.mts.map +1 -1
- package/resources/catalog/item-categories/item-categories.d.ts +17 -1
- package/resources/catalog/item-categories/item-categories.d.ts.map +1 -1
- package/resources/catalog/item-categories/item-categories.js +17 -1
- package/resources/catalog/item-categories/item-categories.js.map +1 -1
- package/resources/catalog/item-categories/item-categories.mjs +17 -1
- package/resources/catalog/item-categories/item-categories.mjs.map +1 -1
- package/resources/catalog/item-categories/properties.d.mts +4 -0
- package/resources/catalog/item-categories/properties.d.mts.map +1 -1
- package/resources/catalog/item-categories/properties.d.ts +4 -0
- package/resources/catalog/item-categories/properties.d.ts.map +1 -1
- package/resources/catalog/item-categories/properties.js +4 -0
- package/resources/catalog/item-categories/properties.js.map +1 -1
- package/resources/catalog/item-categories/properties.mjs +4 -0
- package/resources/catalog/item-categories/properties.mjs.map +1 -1
- package/resources/catalog/items/attributes.d.mts +4 -0
- package/resources/catalog/items/attributes.d.mts.map +1 -1
- package/resources/catalog/items/attributes.d.ts +4 -0
- package/resources/catalog/items/attributes.d.ts.map +1 -1
- package/resources/catalog/items/attributes.js +4 -0
- package/resources/catalog/items/attributes.js.map +1 -1
- package/resources/catalog/items/attributes.mjs +4 -0
- package/resources/catalog/items/attributes.mjs.map +1 -1
- package/resources/catalog/items/items.d.mts +8 -0
- package/resources/catalog/items/items.d.mts.map +1 -1
- package/resources/catalog/items/items.d.ts +8 -0
- package/resources/catalog/items/items.d.ts.map +1 -1
- package/resources/catalog/items/items.js +8 -0
- package/resources/catalog/items/items.js.map +1 -1
- package/resources/catalog/items/items.mjs +8 -0
- package/resources/catalog/items/items.mjs.map +1 -1
- package/resources/catalog/materials.d.mts +66 -10
- package/resources/catalog/materials.d.mts.map +1 -1
- package/resources/catalog/materials.d.ts +66 -10
- package/resources/catalog/materials.d.ts.map +1 -1
- package/resources/catalog/materials.js +57 -1
- package/resources/catalog/materials.js.map +1 -1
- package/resources/catalog/materials.mjs +57 -1
- package/resources/catalog/materials.mjs.map +1 -1
- package/resources/catalog/parts.d.mts +30 -0
- package/resources/catalog/parts.d.mts.map +1 -1
- package/resources/catalog/parts.d.ts +30 -0
- package/resources/catalog/parts.d.ts.map +1 -1
- package/resources/catalog/parts.js +30 -0
- package/resources/catalog/parts.js.map +1 -1
- package/resources/catalog/parts.mjs +30 -0
- package/resources/catalog/parts.mjs.map +1 -1
- package/resources/catalog/product-lines.d.mts +18 -1
- package/resources/catalog/product-lines.d.mts.map +1 -1
- package/resources/catalog/product-lines.d.ts +18 -1
- package/resources/catalog/product-lines.d.ts.map +1 -1
- package/resources/catalog/product-lines.js +18 -1
- package/resources/catalog/product-lines.js.map +1 -1
- package/resources/catalog/product-lines.mjs +18 -1
- package/resources/catalog/product-lines.mjs.map +1 -1
- package/resources/catalog/products.d.mts +52 -9
- package/resources/catalog/products.d.mts.map +1 -1
- package/resources/catalog/products.d.ts +52 -9
- package/resources/catalog/products.d.ts.map +1 -1
- package/resources/catalog/products.js +44 -1
- package/resources/catalog/products.js.map +1 -1
- package/resources/catalog/products.mjs +44 -1
- package/resources/catalog/products.mjs.map +1 -1
- package/resources/catalog/properties/attributes.d.mts +12 -0
- package/resources/catalog/properties/attributes.d.mts.map +1 -1
- package/resources/catalog/properties/attributes.d.ts +12 -0
- package/resources/catalog/properties/attributes.d.ts.map +1 -1
- package/resources/catalog/properties/attributes.js +12 -0
- package/resources/catalog/properties/attributes.js.map +1 -1
- package/resources/catalog/properties/attributes.mjs +12 -0
- package/resources/catalog/properties/attributes.mjs.map +1 -1
- package/resources/catalog/properties/properties.d.mts +10 -0
- package/resources/catalog/properties/properties.d.mts.map +1 -1
- package/resources/catalog/properties/properties.d.ts +10 -0
- package/resources/catalog/properties/properties.d.ts.map +1 -1
- package/resources/catalog/properties/properties.js +10 -0
- package/resources/catalog/properties/properties.js.map +1 -1
- package/resources/catalog/properties/properties.mjs +10 -0
- package/resources/catalog/properties/properties.mjs.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.d.mts +29 -7
- package/resources/catalog/unit-groups/unit-groups.d.mts.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.d.ts +29 -7
- package/resources/catalog/unit-groups/unit-groups.d.ts.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.js +23 -2
- package/resources/catalog/unit-groups/unit-groups.js.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.mjs +23 -2
- package/resources/catalog/unit-groups/unit-groups.mjs.map +1 -1
- package/resources/catalog/unit-groups/units.d.mts +12 -0
- package/resources/catalog/unit-groups/units.d.mts.map +1 -1
- package/resources/catalog/unit-groups/units.d.ts +12 -0
- package/resources/catalog/unit-groups/units.d.ts.map +1 -1
- package/resources/catalog/unit-groups/units.js +12 -0
- package/resources/catalog/unit-groups/units.js.map +1 -1
- package/resources/catalog/unit-groups/units.mjs +12 -0
- package/resources/catalog/unit-groups/units.mjs.map +1 -1
- package/resources/catalog/units.d.mts +56 -26
- package/resources/catalog/units.d.mts.map +1 -1
- package/resources/catalog/units.d.ts +56 -26
- package/resources/catalog/units.d.ts.map +1 -1
- package/resources/catalog/units.js +22 -3
- package/resources/catalog/units.js.map +1 -1
- package/resources/catalog/units.mjs +22 -3
- package/resources/catalog/units.mjs.map +1 -1
- package/resources/core/addresses/actions.d.mts +1 -0
- package/resources/core/addresses/actions.d.mts.map +1 -1
- package/resources/core/addresses/actions.d.ts +1 -0
- package/resources/core/addresses/actions.d.ts.map +1 -1
- package/resources/core/addresses/actions.js +1 -0
- package/resources/core/addresses/actions.js.map +1 -1
- package/resources/core/addresses/actions.mjs +1 -0
- package/resources/core/addresses/actions.mjs.map +1 -1
- package/resources/core/audit-events.d.mts +22 -7
- package/resources/core/audit-events.d.mts.map +1 -1
- package/resources/core/audit-events.d.ts +22 -7
- package/resources/core/audit-events.d.ts.map +1 -1
- package/resources/core/audit-events.js +6 -0
- package/resources/core/audit-events.js.map +1 -1
- package/resources/core/audit-events.mjs +6 -0
- package/resources/core/audit-events.mjs.map +1 -1
- package/resources/core/core.d.mts +103 -0
- package/resources/core/core.d.mts.map +1 -1
- package/resources/core/core.d.ts +103 -0
- package/resources/core/core.d.ts.map +1 -1
- package/resources/core/core.js +19 -0
- package/resources/core/core.js.map +1 -1
- package/resources/core/core.mjs +19 -0
- package/resources/core/core.mjs.map +1 -1
- package/resources/core/email-logs.d.mts +6 -1
- package/resources/core/email-logs.d.mts.map +1 -1
- package/resources/core/email-logs.d.ts +6 -1
- package/resources/core/email-logs.d.ts.map +1 -1
- package/resources/core/email-logs.js +4 -0
- package/resources/core/email-logs.js.map +1 -1
- package/resources/core/email-logs.mjs +4 -0
- package/resources/core/email-logs.mjs.map +1 -1
- package/resources/core/index.d.mts +1 -1
- package/resources/core/index.d.mts.map +1 -1
- package/resources/core/index.d.ts +1 -1
- package/resources/core/index.d.ts.map +1 -1
- package/resources/core/index.js.map +1 -1
- package/resources/core/index.mjs.map +1 -1
- package/resources/core/request-logs.d.mts +21 -7
- package/resources/core/request-logs.d.mts.map +1 -1
- package/resources/core/request-logs.d.ts +21 -7
- package/resources/core/request-logs.d.ts.map +1 -1
- package/resources/core/request-logs.js +4 -0
- package/resources/core/request-logs.js.map +1 -1
- package/resources/core/request-logs.mjs +4 -0
- package/resources/core/request-logs.mjs.map +1 -1
- package/resources/core/sandboxes.d.mts +11 -3
- package/resources/core/sandboxes.d.mts.map +1 -1
- package/resources/core/sandboxes.d.ts +11 -3
- package/resources/core/sandboxes.d.ts.map +1 -1
- package/resources/core/sandboxes.js +8 -0
- package/resources/core/sandboxes.js.map +1 -1
- package/resources/core/sandboxes.mjs +8 -0
- package/resources/core/sandboxes.mjs.map +1 -1
- package/resources/finance/payment-terms.d.mts +10 -0
- package/resources/finance/payment-terms.d.mts.map +1 -1
- package/resources/finance/payment-terms.d.ts +10 -0
- package/resources/finance/payment-terms.d.ts.map +1 -1
- package/resources/finance/payment-terms.js +10 -0
- package/resources/finance/payment-terms.js.map +1 -1
- package/resources/finance/payment-terms.mjs +10 -0
- package/resources/finance/payment-terms.mjs.map +1 -1
- package/resources/identity/account-users/account-users.d.mts +26 -5
- package/resources/identity/account-users/account-users.d.mts.map +1 -1
- package/resources/identity/account-users/account-users.d.ts +26 -5
- package/resources/identity/account-users/account-users.d.ts.map +1 -1
- package/resources/identity/account-users/account-users.js +21 -0
- package/resources/identity/account-users/account-users.js.map +1 -1
- package/resources/identity/account-users/account-users.mjs +21 -0
- package/resources/identity/account-users/account-users.mjs.map +1 -1
- package/resources/identity/account-users/actions.d.mts +9 -0
- package/resources/identity/account-users/actions.d.mts.map +1 -1
- package/resources/identity/account-users/actions.d.ts +9 -0
- package/resources/identity/account-users/actions.d.ts.map +1 -1
- package/resources/identity/account-users/actions.js +9 -0
- package/resources/identity/account-users/actions.js.map +1 -1
- package/resources/identity/account-users/actions.mjs +9 -0
- package/resources/identity/account-users/actions.mjs.map +1 -1
- package/resources/identity/roles.d.mts +33 -17
- package/resources/identity/roles.d.mts.map +1 -1
- package/resources/identity/roles.d.ts +33 -17
- package/resources/identity/roles.d.ts.map +1 -1
- package/resources/identity/roles.js +20 -6
- package/resources/identity/roles.js.map +1 -1
- package/resources/identity/roles.mjs +20 -6
- package/resources/identity/roles.mjs.map +1 -1
- package/resources/index.d.mts +2 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/messaging/announcements/actions.d.mts +76 -0
- package/resources/messaging/announcements/actions.d.mts.map +1 -0
- package/resources/messaging/announcements/actions.d.ts +76 -0
- package/resources/messaging/announcements/actions.d.ts.map +1 -0
- package/resources/messaging/announcements/actions.js +73 -0
- package/resources/messaging/announcements/actions.js.map +1 -0
- package/resources/messaging/announcements/actions.mjs +69 -0
- package/resources/messaging/announcements/actions.mjs.map +1 -0
- package/resources/messaging/announcements/announcements.d.mts +173 -0
- package/resources/messaging/announcements/announcements.d.mts.map +1 -0
- package/resources/messaging/announcements/announcements.d.ts +173 -0
- package/resources/messaging/announcements/announcements.d.ts.map +1 -0
- package/resources/messaging/announcements/announcements.js +52 -0
- package/resources/messaging/announcements/announcements.js.map +1 -0
- package/resources/messaging/announcements/announcements.mjs +47 -0
- package/resources/messaging/announcements/announcements.mjs.map +1 -0
- package/resources/messaging/announcements/index.d.mts +3 -0
- package/resources/messaging/announcements/index.d.mts.map +1 -0
- package/resources/messaging/announcements/index.d.ts +3 -0
- package/resources/messaging/announcements/index.d.ts.map +1 -0
- package/resources/messaging/announcements/index.js +9 -0
- package/resources/messaging/announcements/index.js.map +1 -0
- package/resources/messaging/announcements/index.mjs +4 -0
- package/resources/messaging/announcements/index.mjs.map +1 -0
- package/resources/messaging/announcements.d.mts +2 -0
- package/resources/messaging/announcements.d.mts.map +1 -0
- package/resources/messaging/announcements.d.ts +2 -0
- package/resources/messaging/announcements.d.ts.map +1 -0
- package/resources/messaging/announcements.js +6 -0
- package/resources/messaging/announcements.js.map +1 -0
- package/resources/messaging/announcements.mjs +3 -0
- package/resources/messaging/announcements.mjs.map +1 -0
- package/resources/messaging/blocks.d.mts +674 -0
- package/resources/messaging/blocks.d.mts.map +1 -0
- package/resources/messaging/blocks.d.ts +674 -0
- package/resources/messaging/blocks.d.ts.map +1 -0
- package/resources/messaging/blocks.js +61 -0
- package/resources/messaging/blocks.js.map +1 -0
- package/resources/messaging/blocks.mjs +57 -0
- package/resources/messaging/blocks.mjs.map +1 -0
- package/resources/messaging/conversations/actions.d.mts +422 -0
- package/resources/messaging/conversations/actions.d.mts.map +1 -0
- package/resources/messaging/conversations/actions.d.ts +422 -0
- package/resources/messaging/conversations/actions.d.ts.map +1 -0
- package/resources/messaging/conversations/actions.js +299 -0
- package/resources/messaging/conversations/actions.js.map +1 -0
- package/resources/messaging/conversations/actions.mjs +295 -0
- package/resources/messaging/conversations/actions.mjs.map +1 -0
- package/resources/messaging/conversations/attachments/actions.d.mts +87 -0
- package/resources/messaging/conversations/attachments/actions.d.mts.map +1 -0
- package/resources/messaging/conversations/attachments/actions.d.ts +87 -0
- package/resources/messaging/conversations/attachments/actions.d.ts.map +1 -0
- package/resources/messaging/conversations/attachments/actions.js +36 -0
- package/resources/messaging/conversations/attachments/actions.js.map +1 -0
- package/resources/messaging/conversations/attachments/actions.mjs +32 -0
- package/resources/messaging/conversations/attachments/actions.mjs.map +1 -0
- package/resources/messaging/conversations/attachments/attachments.d.mts +10 -0
- package/resources/messaging/conversations/attachments/attachments.d.mts.map +1 -0
- package/resources/messaging/conversations/attachments/attachments.d.ts +10 -0
- package/resources/messaging/conversations/attachments/attachments.d.ts.map +1 -0
- package/resources/messaging/conversations/attachments/attachments.js +17 -0
- package/resources/messaging/conversations/attachments/attachments.js.map +1 -0
- package/resources/messaging/conversations/attachments/attachments.mjs +12 -0
- package/resources/messaging/conversations/attachments/attachments.mjs.map +1 -0
- package/resources/messaging/conversations/attachments/index.d.mts +3 -0
- package/resources/messaging/conversations/attachments/index.d.mts.map +1 -0
- package/resources/messaging/conversations/attachments/index.d.ts +3 -0
- package/resources/messaging/conversations/attachments/index.d.ts.map +1 -0
- package/resources/messaging/conversations/attachments/index.js +9 -0
- package/resources/messaging/conversations/attachments/index.js.map +1 -0
- package/resources/messaging/conversations/attachments/index.mjs +4 -0
- package/resources/messaging/conversations/attachments/index.mjs.map +1 -0
- package/resources/messaging/conversations/attachments.d.mts +2 -0
- package/resources/messaging/conversations/attachments.d.mts.map +1 -0
- package/resources/messaging/conversations/attachments.d.ts +2 -0
- package/resources/messaging/conversations/attachments.d.ts.map +1 -0
- package/resources/messaging/conversations/attachments.js +6 -0
- package/resources/messaging/conversations/attachments.js.map +1 -0
- package/resources/messaging/conversations/attachments.mjs +3 -0
- package/resources/messaging/conversations/attachments.mjs.map +1 -0
- package/resources/messaging/conversations/conversations.d.mts +1367 -0
- package/resources/messaging/conversations/conversations.d.mts.map +1 -0
- package/resources/messaging/conversations/conversations.d.ts +1367 -0
- package/resources/messaging/conversations/conversations.d.ts.map +1 -0
- package/resources/messaging/conversations/conversations.js +113 -0
- package/resources/messaging/conversations/conversations.js.map +1 -0
- package/resources/messaging/conversations/conversations.mjs +108 -0
- package/resources/messaging/conversations/conversations.mjs.map +1 -0
- package/resources/messaging/conversations/index.d.mts +7 -0
- package/resources/messaging/conversations/index.d.mts.map +1 -0
- package/resources/messaging/conversations/index.d.ts +7 -0
- package/resources/messaging/conversations/index.d.ts.map +1 -0
- package/resources/messaging/conversations/index.js +17 -0
- package/resources/messaging/conversations/index.js.map +1 -0
- package/resources/messaging/conversations/index.mjs +8 -0
- package/resources/messaging/conversations/index.mjs.map +1 -0
- package/resources/messaging/conversations/links.d.mts +149 -0
- package/resources/messaging/conversations/links.d.mts.map +1 -0
- package/resources/messaging/conversations/links.d.ts +149 -0
- package/resources/messaging/conversations/links.d.ts.map +1 -0
- package/resources/messaging/conversations/links.js +72 -0
- package/resources/messaging/conversations/links.js.map +1 -0
- package/resources/messaging/conversations/links.mjs +68 -0
- package/resources/messaging/conversations/links.mjs.map +1 -0
- package/resources/messaging/conversations/messages.d.mts +353 -0
- package/resources/messaging/conversations/messages.d.mts.map +1 -0
- package/resources/messaging/conversations/messages.d.ts +353 -0
- package/resources/messaging/conversations/messages.d.ts.map +1 -0
- package/resources/messaging/conversations/messages.js +81 -0
- package/resources/messaging/conversations/messages.js.map +1 -0
- package/resources/messaging/conversations/messages.mjs +77 -0
- package/resources/messaging/conversations/messages.mjs.map +1 -0
- package/resources/messaging/conversations/participants/actions.d.mts +62 -0
- package/resources/messaging/conversations/participants/actions.d.mts.map +1 -0
- package/resources/messaging/conversations/participants/actions.d.ts +62 -0
- package/resources/messaging/conversations/participants/actions.d.ts.map +1 -0
- package/resources/messaging/conversations/participants/actions.js +35 -0
- package/resources/messaging/conversations/participants/actions.js.map +1 -0
- package/resources/messaging/conversations/participants/actions.mjs +31 -0
- package/resources/messaging/conversations/participants/actions.mjs.map +1 -0
- package/resources/messaging/conversations/participants/index.d.mts +3 -0
- package/resources/messaging/conversations/participants/index.d.mts.map +1 -0
- package/resources/messaging/conversations/participants/index.d.ts +3 -0
- package/resources/messaging/conversations/participants/index.d.ts.map +1 -0
- package/resources/messaging/conversations/participants/index.js +9 -0
- package/resources/messaging/conversations/participants/index.js.map +1 -0
- package/resources/messaging/conversations/participants/index.mjs +4 -0
- package/resources/messaging/conversations/participants/index.mjs.map +1 -0
- package/resources/messaging/conversations/participants/participants.d.mts +100 -0
- package/resources/messaging/conversations/participants/participants.d.mts.map +1 -0
- package/resources/messaging/conversations/participants/participants.d.ts +100 -0
- package/resources/messaging/conversations/participants/participants.d.ts.map +1 -0
- package/resources/messaging/conversations/participants/participants.js +64 -0
- package/resources/messaging/conversations/participants/participants.js.map +1 -0
- package/resources/messaging/conversations/participants/participants.mjs +59 -0
- package/resources/messaging/conversations/participants/participants.mjs.map +1 -0
- package/resources/messaging/conversations/participants.d.mts +2 -0
- package/resources/messaging/conversations/participants.d.mts.map +1 -0
- package/resources/messaging/conversations/participants.d.ts +2 -0
- package/resources/messaging/conversations/participants.d.ts.map +1 -0
- package/resources/messaging/conversations/participants.js +6 -0
- package/resources/messaging/conversations/participants.js.map +1 -0
- package/resources/messaging/conversations/participants.mjs +3 -0
- package/resources/messaging/conversations/participants.mjs.map +1 -0
- package/resources/messaging/conversations.d.mts +2 -0
- package/resources/messaging/conversations.d.mts.map +1 -0
- package/resources/messaging/conversations.d.ts +2 -0
- package/resources/messaging/conversations.d.ts.map +1 -0
- package/resources/messaging/conversations.js +6 -0
- package/resources/messaging/conversations.js.map +1 -0
- package/resources/messaging/conversations.mjs +3 -0
- package/resources/messaging/conversations.mjs.map +1 -0
- package/resources/messaging/email-domains/actions.d.mts +27 -0
- package/resources/messaging/email-domains/actions.d.mts.map +1 -0
- package/resources/messaging/email-domains/actions.d.ts +27 -0
- package/resources/messaging/email-domains/actions.d.ts.map +1 -0
- package/resources/messaging/email-domains/actions.js +32 -0
- package/resources/messaging/email-domains/actions.js.map +1 -0
- package/resources/messaging/email-domains/actions.mjs +28 -0
- package/resources/messaging/email-domains/actions.mjs.map +1 -0
- package/resources/messaging/email-domains/email-domains.d.mts +136 -0
- package/resources/messaging/email-domains/email-domains.d.mts.map +1 -0
- package/resources/messaging/email-domains/email-domains.d.ts +136 -0
- package/resources/messaging/email-domains/email-domains.d.ts.map +1 -0
- package/resources/messaging/email-domains/email-domains.js +70 -0
- package/resources/messaging/email-domains/email-domains.js.map +1 -0
- package/resources/messaging/email-domains/email-domains.mjs +65 -0
- package/resources/messaging/email-domains/email-domains.mjs.map +1 -0
- package/resources/messaging/email-domains/index.d.mts +3 -0
- package/resources/messaging/email-domains/index.d.mts.map +1 -0
- package/resources/messaging/email-domains/index.d.ts +3 -0
- package/resources/messaging/email-domains/index.d.ts.map +1 -0
- package/resources/messaging/email-domains/index.js +9 -0
- package/resources/messaging/email-domains/index.js.map +1 -0
- package/resources/messaging/email-domains/index.mjs +4 -0
- package/resources/messaging/email-domains/index.mjs.map +1 -0
- package/resources/messaging/email-domains.d.mts +2 -0
- package/resources/messaging/email-domains.d.mts.map +1 -0
- package/resources/messaging/email-domains.d.ts +2 -0
- package/resources/messaging/email-domains.d.ts.map +1 -0
- package/resources/messaging/email-domains.js +6 -0
- package/resources/messaging/email-domains.js.map +1 -0
- package/resources/messaging/email-domains.mjs +3 -0
- package/resources/messaging/email-domains.mjs.map +1 -0
- package/resources/messaging/email-inboxes.d.mts +375 -0
- package/resources/messaging/email-inboxes.d.mts.map +1 -0
- package/resources/messaging/email-inboxes.d.ts +375 -0
- package/resources/messaging/email-inboxes.d.ts.map +1 -0
- package/resources/messaging/email-inboxes.js +111 -0
- package/resources/messaging/email-inboxes.js.map +1 -0
- package/resources/messaging/email-inboxes.mjs +107 -0
- package/resources/messaging/email-inboxes.mjs.map +1 -0
- package/resources/messaging/groups/groups.d.mts +162 -0
- package/resources/messaging/groups/groups.d.mts.map +1 -0
- package/resources/messaging/groups/groups.d.ts +162 -0
- package/resources/messaging/groups/groups.d.ts.map +1 -0
- package/resources/messaging/groups/groups.js +110 -0
- package/resources/messaging/groups/groups.js.map +1 -0
- package/resources/messaging/groups/groups.mjs +105 -0
- package/resources/messaging/groups/groups.mjs.map +1 -0
- package/resources/messaging/groups/index.d.mts +3 -0
- package/resources/messaging/groups/index.d.mts.map +1 -0
- package/resources/messaging/groups/index.d.ts +3 -0
- package/resources/messaging/groups/index.d.ts.map +1 -0
- package/resources/messaging/groups/index.js +9 -0
- package/resources/messaging/groups/index.js.map +1 -0
- package/resources/messaging/groups/index.mjs +4 -0
- package/resources/messaging/groups/index.mjs.map +1 -0
- package/resources/messaging/groups/members.d.mts +84 -0
- package/resources/messaging/groups/members.d.mts.map +1 -0
- package/resources/messaging/groups/members.d.ts +84 -0
- package/resources/messaging/groups/members.d.ts.map +1 -0
- package/resources/messaging/groups/members.js +52 -0
- package/resources/messaging/groups/members.js.map +1 -0
- package/resources/messaging/groups/members.mjs +48 -0
- package/resources/messaging/groups/members.mjs.map +1 -0
- package/resources/messaging/groups.d.mts +2 -0
- package/resources/messaging/groups.d.mts.map +1 -0
- package/resources/messaging/groups.d.ts +2 -0
- package/resources/messaging/groups.d.ts.map +1 -0
- package/resources/messaging/groups.js +6 -0
- package/resources/messaging/groups.js.map +1 -0
- package/resources/messaging/groups.mjs +3 -0
- package/resources/messaging/groups.mjs.map +1 -0
- package/resources/messaging/index.d.mts +11 -0
- package/resources/messaging/index.d.mts.map +1 -0
- package/resources/messaging/index.d.ts +11 -0
- package/resources/messaging/index.d.ts.map +1 -0
- package/resources/messaging/index.js +25 -0
- package/resources/messaging/index.js.map +1 -0
- package/resources/messaging/index.mjs +12 -0
- package/resources/messaging/index.mjs.map +1 -0
- package/resources/messaging/messages/actions.d.mts +95 -0
- package/resources/messaging/messages/actions.d.mts.map +1 -0
- package/resources/messaging/messages/actions.d.ts +95 -0
- package/resources/messaging/messages/actions.d.ts.map +1 -0
- package/resources/messaging/messages/actions.js +79 -0
- package/resources/messaging/messages/actions.js.map +1 -0
- package/resources/messaging/messages/actions.mjs +75 -0
- package/resources/messaging/messages/actions.mjs.map +1 -0
- package/resources/messaging/messages/index.d.mts +3 -0
- package/resources/messaging/messages/index.d.mts.map +1 -0
- package/resources/messaging/messages/index.d.ts +3 -0
- package/resources/messaging/messages/index.d.ts.map +1 -0
- package/resources/messaging/messages/index.js +9 -0
- package/resources/messaging/messages/index.js.map +1 -0
- package/resources/messaging/messages/index.mjs +4 -0
- package/resources/messaging/messages/index.mjs.map +1 -0
- package/resources/messaging/messages/messages.d.mts +62 -0
- package/resources/messaging/messages/messages.d.mts.map +1 -0
- package/resources/messaging/messages/messages.d.ts +62 -0
- package/resources/messaging/messages/messages.d.ts.map +1 -0
- package/resources/messaging/messages/messages.js +41 -0
- package/resources/messaging/messages/messages.js.map +1 -0
- package/resources/messaging/messages/messages.mjs +36 -0
- package/resources/messaging/messages/messages.mjs.map +1 -0
- package/resources/messaging/messages.d.mts +2 -0
- package/resources/messaging/messages.d.mts.map +1 -0
- package/resources/messaging/messages.d.ts +2 -0
- package/resources/messaging/messages.d.ts.map +1 -0
- package/resources/messaging/messages.js +6 -0
- package/resources/messaging/messages.js.map +1 -0
- package/resources/messaging/messages.mjs +3 -0
- package/resources/messaging/messages.mjs.map +1 -0
- package/resources/messaging/messaging.d.mts +103 -0
- package/resources/messaging/messaging.d.mts.map +1 -0
- package/resources/messaging/messaging.d.ts +103 -0
- package/resources/messaging/messaging.d.ts.map +1 -0
- package/resources/messaging/messaging.js +65 -0
- package/resources/messaging/messaging.js.map +1 -0
- package/resources/messaging/messaging.mjs +60 -0
- package/resources/messaging/messaging.mjs.map +1 -0
- package/resources/messaging/notifications/actions.d.mts +92 -0
- package/resources/messaging/notifications/actions.d.mts.map +1 -0
- package/resources/messaging/notifications/actions.d.ts +92 -0
- package/resources/messaging/notifications/actions.d.ts.map +1 -0
- package/resources/messaging/notifications/actions.js +89 -0
- package/resources/messaging/notifications/actions.js.map +1 -0
- package/resources/messaging/notifications/actions.mjs +85 -0
- package/resources/messaging/notifications/actions.mjs.map +1 -0
- package/resources/messaging/notifications/index.d.mts +3 -0
- package/resources/messaging/notifications/index.d.mts.map +1 -0
- package/resources/messaging/notifications/index.d.ts +3 -0
- package/resources/messaging/notifications/index.d.ts.map +1 -0
- package/resources/messaging/notifications/index.js +9 -0
- package/resources/messaging/notifications/index.js.map +1 -0
- package/resources/messaging/notifications/index.mjs +4 -0
- package/resources/messaging/notifications/index.mjs.map +1 -0
- package/resources/messaging/notifications/notifications.d.mts +444 -0
- package/resources/messaging/notifications/notifications.d.mts.map +1 -0
- package/resources/messaging/notifications/notifications.d.ts +444 -0
- package/resources/messaging/notifications/notifications.d.ts.map +1 -0
- package/resources/messaging/notifications/notifications.js +108 -0
- package/resources/messaging/notifications/notifications.js.map +1 -0
- package/resources/messaging/notifications/notifications.mjs +103 -0
- package/resources/messaging/notifications/notifications.mjs.map +1 -0
- package/resources/messaging/notifications.d.mts +2 -0
- package/resources/messaging/notifications.d.mts.map +1 -0
- package/resources/messaging/notifications.d.ts +2 -0
- package/resources/messaging/notifications.d.ts.map +1 -0
- package/resources/messaging/notifications.js +6 -0
- package/resources/messaging/notifications.js.map +1 -0
- package/resources/messaging/notifications.mjs +3 -0
- package/resources/messaging/notifications.mjs.map +1 -0
- package/resources/messaging/preferences.d.mts +180 -0
- package/resources/messaging/preferences.d.mts.map +1 -0
- package/resources/messaging/preferences.d.ts +180 -0
- package/resources/messaging/preferences.d.ts.map +1 -0
- package/resources/messaging/preferences.js +47 -0
- package/resources/messaging/preferences.js.map +1 -0
- package/resources/messaging/preferences.mjs +43 -0
- package/resources/messaging/preferences.mjs.map +1 -0
- package/resources/messaging.d.mts +2 -0
- package/resources/messaging.d.mts.map +1 -0
- package/resources/messaging.d.ts +2 -0
- package/resources/messaging.d.ts.map +1 -0
- package/resources/messaging.js +6 -0
- package/resources/messaging.js.map +1 -0
- package/resources/messaging.mjs +3 -0
- package/resources/messaging.mjs.map +1 -0
- package/resources/operations/carriers/carriers.d.mts +20 -7
- package/resources/operations/carriers/carriers.d.mts.map +1 -1
- package/resources/operations/carriers/carriers.d.ts +20 -7
- package/resources/operations/carriers/carriers.d.ts.map +1 -1
- package/resources/operations/carriers/carriers.js +16 -1
- package/resources/operations/carriers/carriers.js.map +1 -1
- package/resources/operations/carriers/carriers.mjs +16 -1
- package/resources/operations/carriers/carriers.mjs.map +1 -1
- package/resources/operations/carriers/service-levels.d.mts +15 -0
- package/resources/operations/carriers/service-levels.d.mts.map +1 -1
- package/resources/operations/carriers/service-levels.d.ts +15 -0
- package/resources/operations/carriers/service-levels.d.ts.map +1 -1
- package/resources/operations/carriers/service-levels.js +15 -0
- package/resources/operations/carriers/service-levels.js.map +1 -1
- package/resources/operations/carriers/service-levels.mjs +15 -0
- package/resources/operations/carriers/service-levels.mjs.map +1 -1
- package/resources/operations/location-types.d.mts +6 -2
- package/resources/operations/location-types.d.mts.map +1 -1
- package/resources/operations/location-types.d.ts +6 -2
- package/resources/operations/location-types.d.ts.map +1 -1
- package/resources/operations/location-types.js +4 -0
- package/resources/operations/location-types.js.map +1 -1
- package/resources/operations/location-types.mjs +4 -0
- package/resources/operations/location-types.mjs.map +1 -1
- package/resources/operations/locations.d.mts +27 -10
- package/resources/operations/locations.d.mts.map +1 -1
- package/resources/operations/locations.d.ts +27 -10
- package/resources/operations/locations.d.ts.map +1 -1
- package/resources/operations/locations.js +18 -1
- package/resources/operations/locations.js.map +1 -1
- package/resources/operations/locations.mjs +18 -1
- package/resources/operations/locations.mjs.map +1 -1
- package/resources/operations/scanning-stations.d.mts +23 -6
- package/resources/operations/scanning-stations.d.mts.map +1 -1
- package/resources/operations/scanning-stations.d.ts +23 -6
- package/resources/operations/scanning-stations.d.ts.map +1 -1
- package/resources/operations/scanning-stations.js +18 -1
- package/resources/operations/scanning-stations.js.map +1 -1
- package/resources/operations/scanning-stations.mjs +18 -1
- package/resources/operations/scanning-stations.mjs.map +1 -1
- package/resources/operations/shipping-terms.d.mts +37 -2
- package/resources/operations/shipping-terms.d.mts.map +1 -1
- package/resources/operations/shipping-terms.d.ts +37 -2
- package/resources/operations/shipping-terms.d.ts.map +1 -1
- package/resources/operations/shipping-terms.js +37 -2
- package/resources/operations/shipping-terms.js.map +1 -1
- package/resources/operations/shipping-terms.mjs +37 -2
- package/resources/operations/shipping-terms.mjs.map +1 -1
- package/resources/sales/account-groups.d.mts +21 -1
- package/resources/sales/account-groups.d.mts.map +1 -1
- package/resources/sales/account-groups.d.ts +21 -1
- package/resources/sales/account-groups.d.ts.map +1 -1
- package/resources/sales/account-groups.js +21 -1
- package/resources/sales/account-groups.js.map +1 -1
- package/resources/sales/account-groups.mjs +21 -1
- package/resources/sales/account-groups.mjs.map +1 -1
- package/resources/sales/account-statuses.d.mts +1 -1
- package/resources/sales/account-statuses.d.ts +1 -1
- package/resources/sales/addresses.d.mts +36 -6
- package/resources/sales/addresses.d.mts.map +1 -1
- package/resources/sales/addresses.d.ts +36 -6
- package/resources/sales/addresses.d.ts.map +1 -1
- package/resources/sales/addresses.js +31 -1
- package/resources/sales/addresses.js.map +1 -1
- package/resources/sales/addresses.mjs +31 -1
- package/resources/sales/addresses.mjs.map +1 -1
- package/resources/sales/contacts/actions.d.mts +120 -0
- package/resources/sales/contacts/actions.d.mts.map +1 -0
- package/resources/sales/contacts/actions.d.ts +120 -0
- package/resources/sales/contacts/actions.d.ts.map +1 -0
- package/resources/sales/contacts/actions.js +38 -0
- package/resources/sales/contacts/actions.js.map +1 -0
- package/resources/sales/contacts/actions.mjs +34 -0
- package/resources/sales/contacts/actions.mjs.map +1 -0
- package/resources/sales/contacts/contacts.d.mts +10 -0
- package/resources/sales/contacts/contacts.d.mts.map +1 -0
- package/resources/sales/contacts/contacts.d.ts +10 -0
- package/resources/sales/contacts/contacts.d.ts.map +1 -0
- package/resources/sales/contacts/contacts.js +17 -0
- package/resources/sales/contacts/contacts.js.map +1 -0
- package/resources/sales/contacts/contacts.mjs +12 -0
- package/resources/sales/contacts/contacts.mjs.map +1 -0
- package/resources/sales/contacts/index.d.mts +3 -0
- package/resources/sales/contacts/index.d.mts.map +1 -0
- package/resources/sales/contacts/index.d.ts +3 -0
- package/resources/sales/contacts/index.d.ts.map +1 -0
- package/resources/sales/contacts/index.js +9 -0
- package/resources/sales/contacts/index.js.map +1 -0
- package/resources/sales/contacts/index.mjs +4 -0
- package/resources/sales/contacts/index.mjs.map +1 -0
- package/resources/sales/contacts.d.mts +2 -0
- package/resources/sales/contacts.d.mts.map +1 -0
- package/resources/sales/contacts.d.ts +2 -0
- package/resources/sales/contacts.d.ts.map +1 -0
- package/resources/sales/contacts.js +6 -0
- package/resources/sales/contacts.js.map +1 -0
- package/resources/sales/contacts.mjs +3 -0
- package/resources/sales/contacts.mjs.map +1 -0
- package/resources/sales/customers/actions.d.mts +3 -1
- package/resources/sales/customers/actions.d.mts.map +1 -1
- package/resources/sales/customers/actions.d.ts +3 -1
- package/resources/sales/customers/actions.d.ts.map +1 -1
- package/resources/sales/customers/actions.js +2 -0
- package/resources/sales/customers/actions.js.map +1 -1
- package/resources/sales/customers/actions.mjs +2 -0
- package/resources/sales/customers/actions.mjs.map +1 -1
- package/resources/sales/customers/customers.d.mts +59 -566
- package/resources/sales/customers/customers.d.mts.map +1 -1
- package/resources/sales/customers/customers.d.ts +59 -566
- package/resources/sales/customers/customers.d.ts.map +1 -1
- package/resources/sales/customers/customers.js +52 -13
- package/resources/sales/customers/customers.js.map +1 -1
- package/resources/sales/customers/customers.mjs +52 -13
- package/resources/sales/customers/customers.mjs.map +1 -1
- package/resources/sales/customers/index.d.mts +1 -1
- package/resources/sales/customers/index.d.mts.map +1 -1
- package/resources/sales/customers/index.d.ts +1 -1
- package/resources/sales/customers/index.d.ts.map +1 -1
- package/resources/sales/customers/index.js.map +1 -1
- package/resources/sales/customers/index.mjs.map +1 -1
- package/resources/sales/index.d.mts +2 -1
- package/resources/sales/index.d.mts.map +1 -1
- package/resources/sales/index.d.ts +2 -1
- package/resources/sales/index.d.ts.map +1 -1
- package/resources/sales/index.js +5 -3
- package/resources/sales/index.js.map +1 -1
- package/resources/sales/index.mjs +1 -0
- package/resources/sales/index.mjs.map +1 -1
- package/resources/sales/priorities.d.mts +5 -1
- package/resources/sales/priorities.d.mts.map +1 -1
- package/resources/sales/priorities.d.ts +5 -1
- package/resources/sales/priorities.d.ts.map +1 -1
- package/resources/sales/priorities.js +4 -0
- package/resources/sales/priorities.js.map +1 -1
- package/resources/sales/priorities.mjs +4 -0
- package/resources/sales/priorities.mjs.map +1 -1
- package/resources/sales/sales-orders.d.mts +58 -46
- package/resources/sales/sales-orders.d.mts.map +1 -1
- package/resources/sales/sales-orders.d.ts +58 -46
- package/resources/sales/sales-orders.d.ts.map +1 -1
- package/resources/sales/sales-orders.js +18 -4
- package/resources/sales/sales-orders.js.map +1 -1
- package/resources/sales/sales-orders.mjs +18 -4
- package/resources/sales/sales-orders.mjs.map +1 -1
- package/resources/sales/sales.d.mts +6 -2
- package/resources/sales/sales.d.mts.map +1 -1
- package/resources/sales/sales.d.ts +6 -2
- package/resources/sales/sales.d.ts.map +1 -1
- package/resources/sales/sales.js +4 -0
- package/resources/sales/sales.js.map +1 -1
- package/resources/sales/sales.mjs +4 -0
- package/resources/sales/sales.mjs.map +1 -1
- package/resources/settings/integrations.d.mts +12 -1
- package/resources/settings/integrations.d.mts.map +1 -1
- package/resources/settings/integrations.d.ts +12 -1
- package/resources/settings/integrations.d.ts.map +1 -1
- package/resources/settings/integrations.js +12 -1
- package/resources/settings/integrations.js.map +1 -1
- package/resources/settings/integrations.mjs +12 -1
- package/resources/settings/integrations.mjs.map +1 -1
- package/src/client.ts +22 -2
- package/src/resources/auth/api-keys/actions.ts +2 -0
- package/src/resources/auth/api-keys/api-keys.ts +12 -3
- package/src/resources/catalog/item-categories/item-categories.ts +17 -1
- package/src/resources/catalog/item-categories/properties.ts +4 -0
- package/src/resources/catalog/items/attributes.ts +4 -0
- package/src/resources/catalog/items/items.ts +8 -0
- package/src/resources/catalog/materials.ts +66 -10
- package/src/resources/catalog/parts.ts +30 -0
- package/src/resources/catalog/product-lines.ts +18 -1
- package/src/resources/catalog/products.ts +52 -9
- package/src/resources/catalog/properties/attributes.ts +12 -0
- package/src/resources/catalog/properties/properties.ts +10 -0
- package/src/resources/catalog/unit-groups/unit-groups.ts +29 -7
- package/src/resources/catalog/unit-groups/units.ts +12 -0
- package/src/resources/catalog/units.ts +56 -26
- package/src/resources/core/addresses/actions.ts +1 -0
- package/src/resources/core/audit-events.ts +114 -11
- package/src/resources/core/core.ts +602 -0
- package/src/resources/core/email-logs.ts +6 -1
- package/src/resources/core/index.ts +1 -1
- package/src/resources/core/request-logs.ts +22 -7
- package/src/resources/core/sandboxes.ts +11 -3
- package/src/resources/finance/payment-terms.ts +10 -0
- package/src/resources/identity/account-users/account-users.ts +26 -5
- package/src/resources/identity/account-users/actions.ts +9 -0
- package/src/resources/identity/roles.ts +34 -18
- package/src/resources/index.ts +2 -1
- package/src/resources/messaging/announcements/actions.ts +119 -0
- package/src/resources/messaging/announcements/announcements.ts +234 -0
- package/src/resources/messaging/announcements/index.ts +10 -0
- package/src/resources/messaging/announcements.ts +3 -0
- package/src/resources/messaging/blocks.ts +826 -0
- package/src/resources/messaging/conversations/actions.ts +766 -0
- package/src/resources/messaging/conversations/attachments/actions.ts +116 -0
- package/src/resources/messaging/conversations/attachments/attachments.ts +25 -0
- package/src/resources/messaging/conversations/attachments/index.ts +9 -0
- package/src/resources/messaging/conversations/attachments.ts +3 -0
- package/src/resources/messaging/conversations/conversations.ts +2500 -0
- package/src/resources/messaging/conversations/index.ts +81 -0
- package/src/resources/messaging/conversations/links.ts +692 -0
- package/src/resources/messaging/conversations/messages.ts +929 -0
- package/src/resources/messaging/conversations/participants/actions.ts +92 -0
- package/src/resources/messaging/conversations/participants/index.ts +10 -0
- package/src/resources/messaging/conversations/participants/participants.ts +150 -0
- package/src/resources/messaging/conversations/participants.ts +3 -0
- package/src/resources/messaging/conversations.ts +3 -0
- package/src/resources/messaging/email-domains/actions.ts +32 -0
- package/src/resources/messaging/email-domains/email-domains.ts +170 -0
- package/src/resources/messaging/email-domains/index.ts +10 -0
- package/src/resources/messaging/email-domains.ts +3 -0
- package/src/resources/messaging/email-inboxes.ts +462 -0
- package/src/resources/messaging/groups/groups.ts +211 -0
- package/src/resources/messaging/groups/index.ts +17 -0
- package/src/resources/messaging/groups/members.ts +113 -0
- package/src/resources/messaging/groups.ts +3 -0
- package/src/resources/messaging/index.ts +116 -0
- package/src/resources/messaging/messages/actions.ts +184 -0
- package/src/resources/messaging/messages/index.ts +10 -0
- package/src/resources/messaging/messages/messages.ts +108 -0
- package/src/resources/messaging/messages.ts +3 -0
- package/src/resources/messaging/messaging.ts +353 -0
- package/src/resources/messaging/notifications/actions.ts +139 -0
- package/src/resources/messaging/notifications/index.ts +24 -0
- package/src/resources/messaging/notifications/notifications.ts +1057 -0
- package/src/resources/messaging/notifications.ts +3 -0
- package/src/resources/messaging/preferences.ts +215 -0
- package/src/resources/messaging.ts +3 -0
- package/src/resources/operations/carriers/carriers.ts +20 -7
- package/src/resources/operations/carriers/service-levels.ts +15 -0
- package/src/resources/operations/location-types.ts +6 -2
- package/src/resources/operations/locations.ts +27 -10
- package/src/resources/operations/scanning-stations.ts +23 -6
- package/src/resources/operations/shipping-terms.ts +37 -2
- package/src/resources/sales/account-groups.ts +21 -1
- package/src/resources/sales/account-statuses.ts +1 -1
- package/src/resources/sales/addresses.ts +36 -6
- package/src/resources/sales/contacts/actions.ts +150 -0
- package/src/resources/sales/contacts/contacts.ts +27 -0
- package/src/resources/sales/contacts/index.ts +10 -0
- package/src/resources/sales/contacts.ts +3 -0
- package/src/resources/sales/customers/actions.ts +4 -0
- package/src/resources/sales/customers/customers.ts +62 -679
- package/src/resources/sales/customers/index.ts +0 -15
- package/src/resources/sales/index.ts +1 -15
- package/src/resources/sales/priorities.ts +5 -1
- package/src/resources/sales/sales-orders.ts +58 -48
- package/src/resources/sales/sales.ts +6 -30
- package/src/resources/settings/integrations.ts +12 -1
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -0,0 +1,353 @@
|
|
|
1
|
+
import { APIResource } from "../../../core/resource.js";
|
|
2
|
+
import * as APIKeysAPI from "../../auth/api-keys/api-keys.js";
|
|
3
|
+
import * as ConversationsAPI from "./conversations.js";
|
|
4
|
+
import { APIPromise } from "../../../core/api-promise.js";
|
|
5
|
+
import { RequestOptions } from "../../../internal/request-options.js";
|
|
6
|
+
/**
|
|
7
|
+
* Send, list, edit, and delete chat messages.
|
|
8
|
+
*/
|
|
9
|
+
export declare class Messages extends APIResource {
|
|
10
|
+
/**
|
|
11
|
+
* Posts a message to a conversation.
|
|
12
|
+
*
|
|
13
|
+
* With `mode` = `send` (the default) the message is delivered — immediately, or
|
|
14
|
+
* queued when `scheduled_at` is set — and the request is idempotent on
|
|
15
|
+
* `client_message_id`. With `mode` = `draft` a customer-reply draft is proposed on
|
|
16
|
+
* an external case: it is held at status `draft` for human approval rather than
|
|
17
|
+
* sent, and `channel` is required.
|
|
18
|
+
*
|
|
19
|
+
* This endpoint requires the permission: `messaging:create`.
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```ts
|
|
23
|
+
* const message =
|
|
24
|
+
* await client.messaging.conversations.messages.create(
|
|
25
|
+
* 'cv_01h9z8q1w2e3r4t5y6u7i8cv',
|
|
26
|
+
* {
|
|
27
|
+
* body: 'Sounds good — shipping it today.',
|
|
28
|
+
* client_message_id: 'client_msg_8c7d2f',
|
|
29
|
+
* attachments: [
|
|
30
|
+
* {
|
|
31
|
+
* kind: 'file',
|
|
32
|
+
* s3_key: 'uploads/acme/quote.pdf',
|
|
33
|
+
* filename: 'quote.pdf',
|
|
34
|
+
* content_type: 'application/pdf',
|
|
35
|
+
* size_bytes: 20480,
|
|
36
|
+
* },
|
|
37
|
+
* ],
|
|
38
|
+
* audience: 'customer',
|
|
39
|
+
* cc: ['ap@acme.com'],
|
|
40
|
+
* channel: 'email',
|
|
41
|
+
* link_resource_id: 'or_01d5034136c3ccc048abecc312',
|
|
42
|
+
* link_resource_type: 'sales_order',
|
|
43
|
+
* mentions: ['acus_01ea9983ddb41dacc44ecf997c'],
|
|
44
|
+
* mode: 'send',
|
|
45
|
+
* reply_to_message_id: 'mg_01h9z8q1w2e3r4t5y6u7i8mg',
|
|
46
|
+
* scheduled_at: '2026-05-10T15:00:00Z',
|
|
47
|
+
* source_thread_message_id:
|
|
48
|
+
* 'mg_01h9z8q1w2e3r4t5y6u7i8mg',
|
|
49
|
+
* subject: 'Re: Order #1042',
|
|
50
|
+
* },
|
|
51
|
+
* );
|
|
52
|
+
* ```
|
|
53
|
+
*/
|
|
54
|
+
create(id: string, params: MessageCreateParams, options?: RequestOptions): APIPromise<ConversationsAPI.Message>;
|
|
55
|
+
/**
|
|
56
|
+
* Returns a conversation's messages, newest first, keyset-paginated by sequence.
|
|
57
|
+
*
|
|
58
|
+
* This endpoint requires the permission: `messaging:read`.
|
|
59
|
+
*
|
|
60
|
+
* @example
|
|
61
|
+
* ```ts
|
|
62
|
+
* const listMessage =
|
|
63
|
+
* await client.messaging.conversations.messages.list(
|
|
64
|
+
* 'cv_01h9z8q1w2e3r4t5y6u7i8cv',
|
|
65
|
+
* );
|
|
66
|
+
* ```
|
|
67
|
+
*/
|
|
68
|
+
list(id: string, query?: MessageListParams | null | undefined, options?: RequestOptions): APIPromise<ListMessage>;
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* List represents a paginated list of resources.
|
|
72
|
+
*/
|
|
73
|
+
export interface ListMessage {
|
|
74
|
+
/**
|
|
75
|
+
* Resources in this page.
|
|
76
|
+
*/
|
|
77
|
+
data: Array<ConversationsAPI.Message>;
|
|
78
|
+
/**
|
|
79
|
+
* Resource type identifier.
|
|
80
|
+
*/
|
|
81
|
+
object: 'list';
|
|
82
|
+
/**
|
|
83
|
+
* PageInfo contains URL-based pagination metadata.
|
|
84
|
+
*/
|
|
85
|
+
page_info: APIKeysAPI.PageInfo;
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* A single attachment supplied when sending a message.
|
|
89
|
+
*
|
|
90
|
+
* For uploaded kinds (`file`/`image`) supply the `s3_key` returned by the
|
|
91
|
+
* upload-url endpoint; for `link` supply `url`; for `resource` supply
|
|
92
|
+
* `resource_type` and `resource_id`.
|
|
93
|
+
*/
|
|
94
|
+
export interface MessageAttachmentInput {
|
|
95
|
+
/**
|
|
96
|
+
* The kind of attachment.
|
|
97
|
+
*/
|
|
98
|
+
kind: 'file' | 'image' | 'link' | 'resource';
|
|
99
|
+
/**
|
|
100
|
+
* The MIME content type (file/image).
|
|
101
|
+
*/
|
|
102
|
+
content_type?: string;
|
|
103
|
+
/**
|
|
104
|
+
* The original filename (file/image).
|
|
105
|
+
*/
|
|
106
|
+
filename?: string;
|
|
107
|
+
/**
|
|
108
|
+
* The linked resource id (required for resource).
|
|
109
|
+
*/
|
|
110
|
+
resource_id?: string;
|
|
111
|
+
/**
|
|
112
|
+
* The linked resource type (required for resource).
|
|
113
|
+
*/
|
|
114
|
+
resource_type?: string;
|
|
115
|
+
/**
|
|
116
|
+
* The object-storage key from the upload-url response (required for file/image).
|
|
117
|
+
*/
|
|
118
|
+
s3_key?: string;
|
|
119
|
+
/**
|
|
120
|
+
* The size in bytes (file/image).
|
|
121
|
+
*/
|
|
122
|
+
size_bytes?: number;
|
|
123
|
+
/**
|
|
124
|
+
* The external URL (required for link).
|
|
125
|
+
*/
|
|
126
|
+
url?: string;
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
129
|
+
* Request to post a message to a conversation.
|
|
130
|
+
*/
|
|
131
|
+
export interface SendMessageRequest {
|
|
132
|
+
/**
|
|
133
|
+
* Message body.
|
|
134
|
+
*
|
|
135
|
+
* Required unless the message carries at least one attachment or a resource link.
|
|
136
|
+
*/
|
|
137
|
+
body: string;
|
|
138
|
+
/**
|
|
139
|
+
* Client-supplied dedupe key.
|
|
140
|
+
*
|
|
141
|
+
* A resend with the same value returns the original message. Required when sending
|
|
142
|
+
* (`mode` = `send`); ignored for drafts.
|
|
143
|
+
*/
|
|
144
|
+
client_message_id: string;
|
|
145
|
+
/**
|
|
146
|
+
* Attachments to include with the message.
|
|
147
|
+
*/
|
|
148
|
+
attachments?: Array<MessageAttachmentInput>;
|
|
149
|
+
/**
|
|
150
|
+
* Who the message is addressed to on an external case.
|
|
151
|
+
*
|
|
152
|
+
* - `customer`: sends a customer-visible reply, branded "Customer Service" and
|
|
153
|
+
* delivered by email on an email-bridged case.
|
|
154
|
+
* - `internal`: posts a team-only note that the customer never sees.
|
|
155
|
+
*
|
|
156
|
+
* When omitted, the message is posted as an internal team-only note.
|
|
157
|
+
*/
|
|
158
|
+
audience?: 'internal' | 'customer';
|
|
159
|
+
/**
|
|
160
|
+
* Additional email recipients to copy on a customer reply (email channel).
|
|
161
|
+
*/
|
|
162
|
+
cc?: Array<string>;
|
|
163
|
+
/**
|
|
164
|
+
* The channel a draft will be sent over when approved (`mode` = `draft`).
|
|
165
|
+
*
|
|
166
|
+
* - `message`: delivered as an in-conversation chat message.
|
|
167
|
+
* - `email`: delivered as an outbound email from the conversation's bridged inbox.
|
|
168
|
+
*/
|
|
169
|
+
channel?: 'message' | 'email';
|
|
170
|
+
/**
|
|
171
|
+
* ID of a resource to link in the message, paired with `link_resource_type`.
|
|
172
|
+
*/
|
|
173
|
+
link_resource_id?: string;
|
|
174
|
+
/**
|
|
175
|
+
* Type of a resource to link in the message, paired with `link_resource_id`.
|
|
176
|
+
*/
|
|
177
|
+
link_resource_type?: 'account' | 'actor' | 'entity' | 'record' | 'freight' | 'sales_order_totals' | 'sales_order_related' | 'order_contact' | 'user' | 'address' | 'api_key' | 'created_api_key' | 'refresh_token' | 'list' | 'sandbox' | 'registration_session' | 'pricing_plan' | 'account_plan' | 'plan_change' | 'enterprise_inquiry' | 'request_log' | 'audit_event' | 'audit_field_change' | 'role' | 'unit' | 'account_affiliation' | 'agent_definition' | 'available_tool' | 'agent_definition_tool' | 'agent_account_status' | 'agent_run' | 'agent_action' | 'agent_run_step' | 'agent_token_usage' | 'agent_memory' | 'notification' | 'notification_unread_count' | 'notification_send_result' | 'notification_unread_summary' | 'announcement' | 'conversation' | 'conversation_participant' | 'read_cursor' | 'chat_message' | 'notification_unread_summary_account' | 'messaging_block' | 'notification_preference' | 'message_attachment' | 'attachment_upload_target' | 'scheduled_message' | 'messaging_contact' | 'message_report' | 'tool_group' | 'model' | 'payment_term' | 'shipping_term' | 'quantity' | 'account_group' | 'support_route' | 'support_availability' | 'account_status' | 'geolocation' | 'account_user' | 'department' | 'account_integration' | 'account_price' | 'product_line' | 'item_category' | 'attribute' | 'rate' | 'account_group_product_line_access' | 'sales_target' | 'adjustment_type' | 'account_branding' | 'account_portal' | 'account_logo_url' | 'public_account' | 'property' | 'carrier' | 'service_level' | 'item' | 'item_inventory' | 'product' | 'batch' | 'batch_flow_node' | 'scanning_consumption' | 'open_batch_summary' | 'scanning_production_step_info' | 'scanning_station' | 'production_step' | 'production_run' | 'machine' | 'child_account' | 'unit_group' | 'unit_group_unit' | 'consumption' | 'customer_product_line_access' | 'customer' | 'frequently_ordered_product' | 'priority' | 'delivery' | 'delivery_line' | 'sales_order' | 'location' | 'location_type' | 'lot' | 'email_log' | 'email_domain' | 'email_inbox' | 'inventory_change_log' | 'invoice' | 'invoice_summary' | 'invoice_line' | 'invoice_allocation' | 'invoice_for_payment' | 'shipment' | 'shipment_summary' | 'shipment_line' | 'shipping_case' | 'shipping_case_label_url' | 'settlement' | 'settlement_summary' | 'role_permission' | 'registration_flow' | 'registration_flow_option' | 'transaction' | 'transaction_summary' | 'transaction_method' | 'transaction_type' | 'transaction_allocation' | 'usage_item' | 'account_usage_response' | 'subscription_info' | 'billing_portal_session_response' | 'switch_plan_response' | 'ensure_billing_customer_response' | 'spending_cap_response' | 'agent_spend_info' | 'webhook_response' | 'address_suggestion' | 'address_components' | 'address_details_result' | 'validated_address' | 'plan_limit' | 'plan_change_proration' | 'plan_change_line_item' | 'setup_billing_response' | 'confirm_payment_response' | 'oauth_response' | 'oauth_status_response' | 'stripe_publishable_key' | 'stripe_status' | 'healthcheck' | 'agent_definition_config' | 'trigger_config' | 'customer_contact_info' | 'customer_freight_preferences' | 'customer_defaults' | 'customer_notification_preferences' | 'order_discount' | 'sales_order_line' | 'sales_order_type' | 'sales_order_status' | 'material' | 'supplier_material' | 'part' | 'permission_group' | 'permission' | 'pick' | 'pick_line' | 'product_type' | 'production' | 'production_flow' | 'map' | 'purchase_order' | 'purchase_order_line' | 'supplier' | 'supplier_summary' | 'receivable_entry' | 'receiving_order' | 'receiving_order_line' | 'email_contact' | 'allocation_entry' | 'open_credit_entry' | 'volume_discount' | 'volume_discount_tier' | 'analyze_deliveries_response' | 'analyze_manufacturing_response' | 'analyze_manufacturing_batch_response' | 'analyze_quarterly_orders_response' | 'analyze_new_customers_response' | 'analyze_oee_response' | 'catalog_product_line' | 'catalog_category' | 'catalog_product' | 'catalog_property' | 'catalog_attribute' | 'dc_location' | 'edi_run' | 'inventory_item' | 'analyze_weeks_of_sales_response' | 'bulk_reconcile_items_response' | 'sys_property' | 'sys_property_type' | 'sys_property_value' | 'territory' | 'tenancy' | 'checkout_session' | 'estimate_rate_result' | 'rate_shop_option' | 'rate_shop_result' | 'owner' | 'created_by' | 'message' | 'account_photo_upload_result' | 'user_photo_upload_result' | 'user_photo_url' | 'batch_lot' | 'check_duplicate_result' | 'item_trend_point' | 'pack_pick_response' | 'pick_shipments_response' | 'tenancy_pending_registration' | 'invoice_allocation_entry' | 'allocation_customer' | 'checkout_sales_order_response' | 'create_production_run_response' | 'sales_order_price_quote' | 'hubspot_sync_job' | 'hubspot_sync_report' | 'hubspot_company_review' | 'hubspot_company_candidate' | 'contact_match' | 'reply_draft' | 'conversation_link' | 'messaging_group' | 'messaging_group_member';
|
|
178
|
+
/**
|
|
179
|
+
* Account user ids explicitly @mentioned in the message.
|
|
180
|
+
*
|
|
181
|
+
* A mention delivers a notification even when the recipient has muted the
|
|
182
|
+
* conversation.
|
|
183
|
+
*/
|
|
184
|
+
mentions?: Array<string>;
|
|
185
|
+
/**
|
|
186
|
+
* Whether to deliver the message now or hold it as a customer-reply draft.
|
|
187
|
+
*
|
|
188
|
+
* - `send`: delivers the message (immediately, or at `scheduled_at`). This is the
|
|
189
|
+
* default.
|
|
190
|
+
* - `draft`: proposes a customer-reply draft on an external case, held for human
|
|
191
|
+
* approval rather than sent. Requires `channel`.
|
|
192
|
+
*/
|
|
193
|
+
mode?: 'send' | 'draft';
|
|
194
|
+
/**
|
|
195
|
+
* The message this one is a reply to.
|
|
196
|
+
*/
|
|
197
|
+
reply_to_message_id?: string;
|
|
198
|
+
/**
|
|
199
|
+
* When set, queue the message for delivery at this future time instead of sending
|
|
200
|
+
* now.
|
|
201
|
+
*
|
|
202
|
+
* The created message has status `scheduled`.
|
|
203
|
+
*/
|
|
204
|
+
scheduled_at?: string;
|
|
205
|
+
/**
|
|
206
|
+
* The internal thread message a draft is composed from, when drafting from a
|
|
207
|
+
* thread (`mode` = `draft`).
|
|
208
|
+
*/
|
|
209
|
+
source_thread_message_id?: string;
|
|
210
|
+
/**
|
|
211
|
+
* The email subject for a customer reply on an email-bridged case (`audience` =
|
|
212
|
+
* `customer`).
|
|
213
|
+
*/
|
|
214
|
+
subject?: string;
|
|
215
|
+
}
|
|
216
|
+
export interface MessageCreateParams {
|
|
217
|
+
/**
|
|
218
|
+
* Body param: Message body.
|
|
219
|
+
*
|
|
220
|
+
* Required unless the message carries at least one attachment or a resource link.
|
|
221
|
+
*/
|
|
222
|
+
body: string;
|
|
223
|
+
/**
|
|
224
|
+
* Body param: Client-supplied dedupe key.
|
|
225
|
+
*
|
|
226
|
+
* A resend with the same value returns the original message. Required when sending
|
|
227
|
+
* (`mode` = `send`); ignored for drafts.
|
|
228
|
+
*/
|
|
229
|
+
client_message_id: string;
|
|
230
|
+
/**
|
|
231
|
+
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
232
|
+
* are returned as `null`.
|
|
233
|
+
*/
|
|
234
|
+
include?: Array<'sender' | 'author' | 'resource' | 'attachments' | 'attachments.resource' | 'conversation' | 'conversation.participants' | 'conversation.last_message' | 'reply_to' | 'reply_to.sender' | 'reply_to.author' | 'reply_to.attachments' | 'agent_run'>;
|
|
235
|
+
/**
|
|
236
|
+
* Body param: Attachments to include with the message.
|
|
237
|
+
*/
|
|
238
|
+
attachments?: Array<MessageAttachmentInput>;
|
|
239
|
+
/**
|
|
240
|
+
* Body param: Who the message is addressed to on an external case.
|
|
241
|
+
*
|
|
242
|
+
* - `customer`: sends a customer-visible reply, branded "Customer Service" and
|
|
243
|
+
* delivered by email on an email-bridged case.
|
|
244
|
+
* - `internal`: posts a team-only note that the customer never sees.
|
|
245
|
+
*
|
|
246
|
+
* When omitted, the message is posted as an internal team-only note.
|
|
247
|
+
*/
|
|
248
|
+
audience?: 'internal' | 'customer';
|
|
249
|
+
/**
|
|
250
|
+
* Body param: Additional email recipients to copy on a customer reply (email
|
|
251
|
+
* channel).
|
|
252
|
+
*/
|
|
253
|
+
cc?: Array<string>;
|
|
254
|
+
/**
|
|
255
|
+
* Body param: The channel a draft will be sent over when approved (`mode` =
|
|
256
|
+
* `draft`).
|
|
257
|
+
*
|
|
258
|
+
* - `message`: delivered as an in-conversation chat message.
|
|
259
|
+
* - `email`: delivered as an outbound email from the conversation's bridged inbox.
|
|
260
|
+
*/
|
|
261
|
+
channel?: 'message' | 'email';
|
|
262
|
+
/**
|
|
263
|
+
* Body param: ID of a resource to link in the message, paired with
|
|
264
|
+
* `link_resource_type`.
|
|
265
|
+
*/
|
|
266
|
+
link_resource_id?: string;
|
|
267
|
+
/**
|
|
268
|
+
* Body param: Type of a resource to link in the message, paired with
|
|
269
|
+
* `link_resource_id`.
|
|
270
|
+
*/
|
|
271
|
+
link_resource_type?: 'account' | 'actor' | 'entity' | 'record' | 'freight' | 'sales_order_totals' | 'sales_order_related' | 'order_contact' | 'user' | 'address' | 'api_key' | 'created_api_key' | 'refresh_token' | 'list' | 'sandbox' | 'registration_session' | 'pricing_plan' | 'account_plan' | 'plan_change' | 'enterprise_inquiry' | 'request_log' | 'audit_event' | 'audit_field_change' | 'role' | 'unit' | 'account_affiliation' | 'agent_definition' | 'available_tool' | 'agent_definition_tool' | 'agent_account_status' | 'agent_run' | 'agent_action' | 'agent_run_step' | 'agent_token_usage' | 'agent_memory' | 'notification' | 'notification_unread_count' | 'notification_send_result' | 'notification_unread_summary' | 'announcement' | 'conversation' | 'conversation_participant' | 'read_cursor' | 'chat_message' | 'notification_unread_summary_account' | 'messaging_block' | 'notification_preference' | 'message_attachment' | 'attachment_upload_target' | 'scheduled_message' | 'messaging_contact' | 'message_report' | 'tool_group' | 'model' | 'payment_term' | 'shipping_term' | 'quantity' | 'account_group' | 'support_route' | 'support_availability' | 'account_status' | 'geolocation' | 'account_user' | 'department' | 'account_integration' | 'account_price' | 'product_line' | 'item_category' | 'attribute' | 'rate' | 'account_group_product_line_access' | 'sales_target' | 'adjustment_type' | 'account_branding' | 'account_portal' | 'account_logo_url' | 'public_account' | 'property' | 'carrier' | 'service_level' | 'item' | 'item_inventory' | 'product' | 'batch' | 'batch_flow_node' | 'scanning_consumption' | 'open_batch_summary' | 'scanning_production_step_info' | 'scanning_station' | 'production_step' | 'production_run' | 'machine' | 'child_account' | 'unit_group' | 'unit_group_unit' | 'consumption' | 'customer_product_line_access' | 'customer' | 'frequently_ordered_product' | 'priority' | 'delivery' | 'delivery_line' | 'sales_order' | 'location' | 'location_type' | 'lot' | 'email_log' | 'email_domain' | 'email_inbox' | 'inventory_change_log' | 'invoice' | 'invoice_summary' | 'invoice_line' | 'invoice_allocation' | 'invoice_for_payment' | 'shipment' | 'shipment_summary' | 'shipment_line' | 'shipping_case' | 'shipping_case_label_url' | 'settlement' | 'settlement_summary' | 'role_permission' | 'registration_flow' | 'registration_flow_option' | 'transaction' | 'transaction_summary' | 'transaction_method' | 'transaction_type' | 'transaction_allocation' | 'usage_item' | 'account_usage_response' | 'subscription_info' | 'billing_portal_session_response' | 'switch_plan_response' | 'ensure_billing_customer_response' | 'spending_cap_response' | 'agent_spend_info' | 'webhook_response' | 'address_suggestion' | 'address_components' | 'address_details_result' | 'validated_address' | 'plan_limit' | 'plan_change_proration' | 'plan_change_line_item' | 'setup_billing_response' | 'confirm_payment_response' | 'oauth_response' | 'oauth_status_response' | 'stripe_publishable_key' | 'stripe_status' | 'healthcheck' | 'agent_definition_config' | 'trigger_config' | 'customer_contact_info' | 'customer_freight_preferences' | 'customer_defaults' | 'customer_notification_preferences' | 'order_discount' | 'sales_order_line' | 'sales_order_type' | 'sales_order_status' | 'material' | 'supplier_material' | 'part' | 'permission_group' | 'permission' | 'pick' | 'pick_line' | 'product_type' | 'production' | 'production_flow' | 'map' | 'purchase_order' | 'purchase_order_line' | 'supplier' | 'supplier_summary' | 'receivable_entry' | 'receiving_order' | 'receiving_order_line' | 'email_contact' | 'allocation_entry' | 'open_credit_entry' | 'volume_discount' | 'volume_discount_tier' | 'analyze_deliveries_response' | 'analyze_manufacturing_response' | 'analyze_manufacturing_batch_response' | 'analyze_quarterly_orders_response' | 'analyze_new_customers_response' | 'analyze_oee_response' | 'catalog_product_line' | 'catalog_category' | 'catalog_product' | 'catalog_property' | 'catalog_attribute' | 'dc_location' | 'edi_run' | 'inventory_item' | 'analyze_weeks_of_sales_response' | 'bulk_reconcile_items_response' | 'sys_property' | 'sys_property_type' | 'sys_property_value' | 'territory' | 'tenancy' | 'checkout_session' | 'estimate_rate_result' | 'rate_shop_option' | 'rate_shop_result' | 'owner' | 'created_by' | 'message' | 'account_photo_upload_result' | 'user_photo_upload_result' | 'user_photo_url' | 'batch_lot' | 'check_duplicate_result' | 'item_trend_point' | 'pack_pick_response' | 'pick_shipments_response' | 'tenancy_pending_registration' | 'invoice_allocation_entry' | 'allocation_customer' | 'checkout_sales_order_response' | 'create_production_run_response' | 'sales_order_price_quote' | 'hubspot_sync_job' | 'hubspot_sync_report' | 'hubspot_company_review' | 'hubspot_company_candidate' | 'contact_match' | 'reply_draft' | 'conversation_link' | 'messaging_group' | 'messaging_group_member';
|
|
272
|
+
/**
|
|
273
|
+
* Body param: Account user ids explicitly @mentioned in the message.
|
|
274
|
+
*
|
|
275
|
+
* A mention delivers a notification even when the recipient has muted the
|
|
276
|
+
* conversation.
|
|
277
|
+
*/
|
|
278
|
+
mentions?: Array<string>;
|
|
279
|
+
/**
|
|
280
|
+
* Body param: Whether to deliver the message now or hold it as a customer-reply
|
|
281
|
+
* draft.
|
|
282
|
+
*
|
|
283
|
+
* - `send`: delivers the message (immediately, or at `scheduled_at`). This is the
|
|
284
|
+
* default.
|
|
285
|
+
* - `draft`: proposes a customer-reply draft on an external case, held for human
|
|
286
|
+
* approval rather than sent. Requires `channel`.
|
|
287
|
+
*/
|
|
288
|
+
mode?: 'send' | 'draft';
|
|
289
|
+
/**
|
|
290
|
+
* Body param: The message this one is a reply to.
|
|
291
|
+
*/
|
|
292
|
+
reply_to_message_id?: string;
|
|
293
|
+
/**
|
|
294
|
+
* Body param: When set, queue the message for delivery at this future time instead
|
|
295
|
+
* of sending now.
|
|
296
|
+
*
|
|
297
|
+
* The created message has status `scheduled`.
|
|
298
|
+
*/
|
|
299
|
+
scheduled_at?: string;
|
|
300
|
+
/**
|
|
301
|
+
* Body param: The internal thread message a draft is composed from, when drafting
|
|
302
|
+
* from a thread (`mode` = `draft`).
|
|
303
|
+
*/
|
|
304
|
+
source_thread_message_id?: string;
|
|
305
|
+
/**
|
|
306
|
+
* Body param: The email subject for a customer reply on an email-bridged case
|
|
307
|
+
* (`audience` = `customer`).
|
|
308
|
+
*/
|
|
309
|
+
subject?: string;
|
|
310
|
+
}
|
|
311
|
+
export interface MessageListParams {
|
|
312
|
+
/**
|
|
313
|
+
* Catch-up bound.
|
|
314
|
+
*
|
|
315
|
+
* Only return messages with a sequence greater than this (reconnect sync).
|
|
316
|
+
*/
|
|
317
|
+
after_sequence?: number;
|
|
318
|
+
/**
|
|
319
|
+
* Opaque cursor token identifying where the page of results starts.
|
|
320
|
+
*
|
|
321
|
+
* Use the `cursor` value embedded in a previous response's `next_page_url` or
|
|
322
|
+
* `previous_page_url` to fetch the adjacent page. Omit to start from the first
|
|
323
|
+
* page.
|
|
324
|
+
*/
|
|
325
|
+
cursor?: string;
|
|
326
|
+
/**
|
|
327
|
+
* Sub-objects to expand in the response. When omitted, sub-objects are returned as
|
|
328
|
+
* `null`.
|
|
329
|
+
*/
|
|
330
|
+
include?: Array<'sender' | 'author' | 'resource' | 'attachments' | 'attachments.resource' | 'conversation' | 'conversation.participants' | 'conversation.last_message' | 'reply_to' | 'reply_to.sender' | 'reply_to.author' | 'reply_to.attachments' | 'agent_run'>;
|
|
331
|
+
/**
|
|
332
|
+
* Maximum number of results to return in a single page.
|
|
333
|
+
*/
|
|
334
|
+
limit?: number;
|
|
335
|
+
/**
|
|
336
|
+
* Free-text search term used to filter results.
|
|
337
|
+
*
|
|
338
|
+
* Which fields are matched against the term varies by endpoint.
|
|
339
|
+
*/
|
|
340
|
+
q?: string;
|
|
341
|
+
/**
|
|
342
|
+
* Filter by lifecycle state.
|
|
343
|
+
*
|
|
344
|
+
* Defaults to `sent` (the conversation timeline); pass `draft` to list the case's
|
|
345
|
+
* open customer-reply drafts, or `scheduled` to list your not-yet-sent scheduled
|
|
346
|
+
* messages in this conversation.
|
|
347
|
+
*/
|
|
348
|
+
status?: 'draft' | 'scheduled' | 'sent' | 'canceled' | 'rejected' | 'failed' | 'superseded';
|
|
349
|
+
}
|
|
350
|
+
export declare namespace Messages {
|
|
351
|
+
export { type ListMessage as ListMessage, type MessageAttachmentInput as MessageAttachmentInput, type SendMessageRequest as SendMessageRequest, type MessageCreateParams as MessageCreateParams, type MessageListParams as MessageListParams, };
|
|
352
|
+
}
|
|
353
|
+
//# sourceMappingURL=messages.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../../src/resources/messaging/conversations/messages.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,gBAAgB;OACrB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,OAAO,CAAC;IASvC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC;CAG3B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,CAAC;IAE7C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAE5C;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;IAEnC;;OAEG;IACH,EAAE,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC;IAE9B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EACf,SAAS,GACT,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,oBAAoB,GACpB,qBAAqB,GACrB,eAAe,GACf,MAAM,GACN,SAAS,GACT,SAAS,GACT,iBAAiB,GACjB,eAAe,GACf,MAAM,GACN,SAAS,GACT,sBAAsB,GACtB,cAAc,GACd,cAAc,GACd,aAAa,GACb,oBAAoB,GACpB,aAAa,GACb,aAAa,GACb,oBAAoB,GACpB,MAAM,GACN,MAAM,GACN,qBAAqB,GACrB,kBAAkB,GAClB,gBAAgB,GAChB,uBAAuB,GACvB,sBAAsB,GACtB,WAAW,GACX,cAAc,GACd,gBAAgB,GAChB,mBAAmB,GACnB,cAAc,GACd,cAAc,GACd,2BAA2B,GAC3B,0BAA0B,GAC1B,6BAA6B,GAC7B,cAAc,GACd,cAAc,GACd,0BAA0B,GAC1B,aAAa,GACb,cAAc,GACd,qCAAqC,GACrC,iBAAiB,GACjB,yBAAyB,GACzB,oBAAoB,GACpB,0BAA0B,GAC1B,mBAAmB,GACnB,mBAAmB,GACnB,gBAAgB,GAChB,YAAY,GACZ,OAAO,GACP,cAAc,GACd,eAAe,GACf,UAAU,GACV,eAAe,GACf,eAAe,GACf,sBAAsB,GACtB,gBAAgB,GAChB,aAAa,GACb,cAAc,GACd,YAAY,GACZ,qBAAqB,GACrB,eAAe,GACf,cAAc,GACd,eAAe,GACf,WAAW,GACX,MAAM,GACN,mCAAmC,GACnC,cAAc,GACd,iBAAiB,GACjB,kBAAkB,GAClB,gBAAgB,GAChB,kBAAkB,GAClB,gBAAgB,GAChB,UAAU,GACV,SAAS,GACT,eAAe,GACf,MAAM,GACN,gBAAgB,GAChB,SAAS,GACT,OAAO,GACP,iBAAiB,GACjB,sBAAsB,GACtB,oBAAoB,GACpB,+BAA+B,GAC/B,kBAAkB,GAClB,iBAAiB,GACjB,gBAAgB,GAChB,SAAS,GACT,eAAe,GACf,YAAY,GACZ,iBAAiB,GACjB,aAAa,GACb,8BAA8B,GAC9B,UAAU,GACV,4BAA4B,GAC5B,UAAU,GACV,UAAU,GACV,eAAe,GACf,aAAa,GACb,UAAU,GACV,eAAe,GACf,KAAK,GACL,WAAW,GACX,cAAc,GACd,aAAa,GACb,sBAAsB,GACtB,SAAS,GACT,iBAAiB,GACjB,cAAc,GACd,oBAAoB,GACpB,qBAAqB,GACrB,UAAU,GACV,kBAAkB,GAClB,eAAe,GACf,eAAe,GACf,yBAAyB,GACzB,YAAY,GACZ,oBAAoB,GACpB,iBAAiB,GACjB,mBAAmB,GACnB,0BAA0B,GAC1B,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,kBAAkB,GAClB,wBAAwB,GACxB,YAAY,GACZ,wBAAwB,GACxB,mBAAmB,GACnB,iCAAiC,GACjC,sBAAsB,GACtB,kCAAkC,GAClC,uBAAuB,GACvB,kBAAkB,GAClB,kBAAkB,GAClB,oBAAoB,GACpB,oBAAoB,GACpB,wBAAwB,GACxB,mBAAmB,GACnB,YAAY,GACZ,uBAAuB,GACvB,uBAAuB,GACvB,wBAAwB,GACxB,0BAA0B,GAC1B,gBAAgB,GAChB,uBAAuB,GACvB,wBAAwB,GACxB,eAAe,GACf,aAAa,GACb,yBAAyB,GACzB,gBAAgB,GAChB,uBAAuB,GACvB,8BAA8B,GAC9B,mBAAmB,GACnB,mCAAmC,GACnC,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,oBAAoB,GACpB,UAAU,GACV,mBAAmB,GACnB,MAAM,GACN,kBAAkB,GAClB,YAAY,GACZ,MAAM,GACN,WAAW,GACX,cAAc,GACd,YAAY,GACZ,iBAAiB,GACjB,KAAK,GACL,gBAAgB,GAChB,qBAAqB,GACrB,UAAU,GACV,kBAAkB,GAClB,kBAAkB,GAClB,iBAAiB,GACjB,sBAAsB,GACtB,eAAe,GACf,kBAAkB,GAClB,mBAAmB,GACnB,iBAAiB,GACjB,sBAAsB,GACtB,6BAA6B,GAC7B,gCAAgC,GAChC,sCAAsC,GACtC,mCAAmC,GACnC,gCAAgC,GAChC,sBAAsB,GACtB,sBAAsB,GACtB,kBAAkB,GAClB,iBAAiB,GACjB,kBAAkB,GAClB,mBAAmB,GACnB,aAAa,GACb,SAAS,GACT,gBAAgB,GAChB,iCAAiC,GACjC,+BAA+B,GAC/B,cAAc,GACd,mBAAmB,GACnB,oBAAoB,GACpB,WAAW,GACX,SAAS,GACT,kBAAkB,GAClB,sBAAsB,GACtB,kBAAkB,GAClB,kBAAkB,GAClB,OAAO,GACP,YAAY,GACZ,SAAS,GACT,6BAA6B,GAC7B,0BAA0B,GAC1B,gBAAgB,GAChB,WAAW,GACX,wBAAwB,GACxB,kBAAkB,GAClB,oBAAoB,GACpB,yBAAyB,GACzB,8BAA8B,GAC9B,0BAA0B,GAC1B,qBAAqB,GACrB,+BAA+B,GAC/B,gCAAgC,GAChC,yBAAyB,GACzB,kBAAkB,GAClB,qBAAqB,GACrB,wBAAwB,GACxB,2BAA2B,GAC3B,eAAe,GACf,aAAa,GACb,mBAAmB,GACnB,iBAAiB,GACjB,wBAAwB,CAAC;IAE7B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAExB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,QAAQ,GACR,QAAQ,GACR,UAAU,GACV,aAAa,GACb,sBAAsB,GACtB,cAAc,GACd,2BAA2B,GAC3B,2BAA2B,GAC3B,UAAU,GACV,iBAAiB,GACjB,iBAAiB,GACjB,sBAAsB,GACtB,WAAW,CACd,CAAC;IAEF;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAE5C;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;IAEnC;;;OAGG;IACH,EAAE,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC;IAE9B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,kBAAkB,CAAC,EACf,SAAS,GACT,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,oBAAoB,GACpB,qBAAqB,GACrB,eAAe,GACf,MAAM,GACN,SAAS,GACT,SAAS,GACT,iBAAiB,GACjB,eAAe,GACf,MAAM,GACN,SAAS,GACT,sBAAsB,GACtB,cAAc,GACd,cAAc,GACd,aAAa,GACb,oBAAoB,GACpB,aAAa,GACb,aAAa,GACb,oBAAoB,GACpB,MAAM,GACN,MAAM,GACN,qBAAqB,GACrB,kBAAkB,GAClB,gBAAgB,GAChB,uBAAuB,GACvB,sBAAsB,GACtB,WAAW,GACX,cAAc,GACd,gBAAgB,GAChB,mBAAmB,GACnB,cAAc,GACd,cAAc,GACd,2BAA2B,GAC3B,0BAA0B,GAC1B,6BAA6B,GAC7B,cAAc,GACd,cAAc,GACd,0BAA0B,GAC1B,aAAa,GACb,cAAc,GACd,qCAAqC,GACrC,iBAAiB,GACjB,yBAAyB,GACzB,oBAAoB,GACpB,0BAA0B,GAC1B,mBAAmB,GACnB,mBAAmB,GACnB,gBAAgB,GAChB,YAAY,GACZ,OAAO,GACP,cAAc,GACd,eAAe,GACf,UAAU,GACV,eAAe,GACf,eAAe,GACf,sBAAsB,GACtB,gBAAgB,GAChB,aAAa,GACb,cAAc,GACd,YAAY,GACZ,qBAAqB,GACrB,eAAe,GACf,cAAc,GACd,eAAe,GACf,WAAW,GACX,MAAM,GACN,mCAAmC,GACnC,cAAc,GACd,iBAAiB,GACjB,kBAAkB,GAClB,gBAAgB,GAChB,kBAAkB,GAClB,gBAAgB,GAChB,UAAU,GACV,SAAS,GACT,eAAe,GACf,MAAM,GACN,gBAAgB,GAChB,SAAS,GACT,OAAO,GACP,iBAAiB,GACjB,sBAAsB,GACtB,oBAAoB,GACpB,+BAA+B,GAC/B,kBAAkB,GAClB,iBAAiB,GACjB,gBAAgB,GAChB,SAAS,GACT,eAAe,GACf,YAAY,GACZ,iBAAiB,GACjB,aAAa,GACb,8BAA8B,GAC9B,UAAU,GACV,4BAA4B,GAC5B,UAAU,GACV,UAAU,GACV,eAAe,GACf,aAAa,GACb,UAAU,GACV,eAAe,GACf,KAAK,GACL,WAAW,GACX,cAAc,GACd,aAAa,GACb,sBAAsB,GACtB,SAAS,GACT,iBAAiB,GACjB,cAAc,GACd,oBAAoB,GACpB,qBAAqB,GACrB,UAAU,GACV,kBAAkB,GAClB,eAAe,GACf,eAAe,GACf,yBAAyB,GACzB,YAAY,GACZ,oBAAoB,GACpB,iBAAiB,GACjB,mBAAmB,GACnB,0BAA0B,GAC1B,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,kBAAkB,GAClB,wBAAwB,GACxB,YAAY,GACZ,wBAAwB,GACxB,mBAAmB,GACnB,iCAAiC,GACjC,sBAAsB,GACtB,kCAAkC,GAClC,uBAAuB,GACvB,kBAAkB,GAClB,kBAAkB,GAClB,oBAAoB,GACpB,oBAAoB,GACpB,wBAAwB,GACxB,mBAAmB,GACnB,YAAY,GACZ,uBAAuB,GACvB,uBAAuB,GACvB,wBAAwB,GACxB,0BAA0B,GAC1B,gBAAgB,GAChB,uBAAuB,GACvB,wBAAwB,GACxB,eAAe,GACf,aAAa,GACb,yBAAyB,GACzB,gBAAgB,GAChB,uBAAuB,GACvB,8BAA8B,GAC9B,mBAAmB,GACnB,mCAAmC,GACnC,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,oBAAoB,GACpB,UAAU,GACV,mBAAmB,GACnB,MAAM,GACN,kBAAkB,GAClB,YAAY,GACZ,MAAM,GACN,WAAW,GACX,cAAc,GACd,YAAY,GACZ,iBAAiB,GACjB,KAAK,GACL,gBAAgB,GAChB,qBAAqB,GACrB,UAAU,GACV,kBAAkB,GAClB,kBAAkB,GAClB,iBAAiB,GACjB,sBAAsB,GACtB,eAAe,GACf,kBAAkB,GAClB,mBAAmB,GACnB,iBAAiB,GACjB,sBAAsB,GACtB,6BAA6B,GAC7B,gCAAgC,GAChC,sCAAsC,GACtC,mCAAmC,GACnC,gCAAgC,GAChC,sBAAsB,GACtB,sBAAsB,GACtB,kBAAkB,GAClB,iBAAiB,GACjB,kBAAkB,GAClB,mBAAmB,GACnB,aAAa,GACb,SAAS,GACT,gBAAgB,GAChB,iCAAiC,GACjC,+BAA+B,GAC/B,cAAc,GACd,mBAAmB,GACnB,oBAAoB,GACpB,WAAW,GACX,SAAS,GACT,kBAAkB,GAClB,sBAAsB,GACtB,kBAAkB,GAClB,kBAAkB,GAClB,OAAO,GACP,YAAY,GACZ,SAAS,GACT,6BAA6B,GAC7B,0BAA0B,GAC1B,gBAAgB,GAChB,WAAW,GACX,wBAAwB,GACxB,kBAAkB,GAClB,oBAAoB,GACpB,yBAAyB,GACzB,8BAA8B,GAC9B,0BAA0B,GAC1B,qBAAqB,GACrB,+BAA+B,GAC/B,gCAAgC,GAChC,yBAAyB,GACzB,kBAAkB,GAClB,qBAAqB,GACrB,wBAAwB,GACxB,2BAA2B,GAC3B,eAAe,GACf,aAAa,GACb,mBAAmB,GACnB,iBAAiB,GACjB,wBAAwB,CAAC;IAE7B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAExB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,QAAQ,GACR,QAAQ,GACR,UAAU,GACV,aAAa,GACb,sBAAsB,GACtB,cAAc,GACd,2BAA2B,GAC3B,2BAA2B,GAC3B,UAAU,GACV,iBAAiB,GACjB,iBAAiB,GACjB,sBAAsB,GACtB,WAAW,CACd,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,WAAW,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,YAAY,CAAC;CAC7F;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Messages = void 0;
|
|
5
|
+
const resource_1 = require("../../../core/resource.js");
|
|
6
|
+
const path_1 = require("../../../internal/utils/path.js");
|
|
7
|
+
/**
|
|
8
|
+
* Send, list, edit, and delete chat messages.
|
|
9
|
+
*/
|
|
10
|
+
class Messages extends resource_1.APIResource {
|
|
11
|
+
/**
|
|
12
|
+
* Posts a message to a conversation.
|
|
13
|
+
*
|
|
14
|
+
* With `mode` = `send` (the default) the message is delivered — immediately, or
|
|
15
|
+
* queued when `scheduled_at` is set — and the request is idempotent on
|
|
16
|
+
* `client_message_id`. With `mode` = `draft` a customer-reply draft is proposed on
|
|
17
|
+
* an external case: it is held at status `draft` for human approval rather than
|
|
18
|
+
* sent, and `channel` is required.
|
|
19
|
+
*
|
|
20
|
+
* This endpoint requires the permission: `messaging:create`.
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```ts
|
|
24
|
+
* const message =
|
|
25
|
+
* await client.messaging.conversations.messages.create(
|
|
26
|
+
* 'cv_01h9z8q1w2e3r4t5y6u7i8cv',
|
|
27
|
+
* {
|
|
28
|
+
* body: 'Sounds good — shipping it today.',
|
|
29
|
+
* client_message_id: 'client_msg_8c7d2f',
|
|
30
|
+
* attachments: [
|
|
31
|
+
* {
|
|
32
|
+
* kind: 'file',
|
|
33
|
+
* s3_key: 'uploads/acme/quote.pdf',
|
|
34
|
+
* filename: 'quote.pdf',
|
|
35
|
+
* content_type: 'application/pdf',
|
|
36
|
+
* size_bytes: 20480,
|
|
37
|
+
* },
|
|
38
|
+
* ],
|
|
39
|
+
* audience: 'customer',
|
|
40
|
+
* cc: ['ap@acme.com'],
|
|
41
|
+
* channel: 'email',
|
|
42
|
+
* link_resource_id: 'or_01d5034136c3ccc048abecc312',
|
|
43
|
+
* link_resource_type: 'sales_order',
|
|
44
|
+
* mentions: ['acus_01ea9983ddb41dacc44ecf997c'],
|
|
45
|
+
* mode: 'send',
|
|
46
|
+
* reply_to_message_id: 'mg_01h9z8q1w2e3r4t5y6u7i8mg',
|
|
47
|
+
* scheduled_at: '2026-05-10T15:00:00Z',
|
|
48
|
+
* source_thread_message_id:
|
|
49
|
+
* 'mg_01h9z8q1w2e3r4t5y6u7i8mg',
|
|
50
|
+
* subject: 'Re: Order #1042',
|
|
51
|
+
* },
|
|
52
|
+
* );
|
|
53
|
+
* ```
|
|
54
|
+
*/
|
|
55
|
+
create(id, params, options) {
|
|
56
|
+
const { include, ...body } = params;
|
|
57
|
+
return this._client.post((0, path_1.path) `/v1/messaging/conversations/${id}/messages`, {
|
|
58
|
+
query: { include },
|
|
59
|
+
body,
|
|
60
|
+
...options,
|
|
61
|
+
});
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Returns a conversation's messages, newest first, keyset-paginated by sequence.
|
|
65
|
+
*
|
|
66
|
+
* This endpoint requires the permission: `messaging:read`.
|
|
67
|
+
*
|
|
68
|
+
* @example
|
|
69
|
+
* ```ts
|
|
70
|
+
* const listMessage =
|
|
71
|
+
* await client.messaging.conversations.messages.list(
|
|
72
|
+
* 'cv_01h9z8q1w2e3r4t5y6u7i8cv',
|
|
73
|
+
* );
|
|
74
|
+
* ```
|
|
75
|
+
*/
|
|
76
|
+
list(id, query = {}, options) {
|
|
77
|
+
return this._client.get((0, path_1.path) `/v1/messaging/conversations/${id}/messages`, { query, ...options });
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
exports.Messages = Messages;
|
|
81
|
+
//# sourceMappingURL=messages.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../../src/resources/messaging/conversations/messages.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAKrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,MAAM,CACJ,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,+BAA+B,EAAE,WAAW,EAAE;YACzE,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAU,EACV,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,+BAA+B,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;CACF;AA9ED,4BA8EC"}
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../../core/resource.mjs";
|
|
3
|
+
import { path } from "../../../internal/utils/path.mjs";
|
|
4
|
+
/**
|
|
5
|
+
* Send, list, edit, and delete chat messages.
|
|
6
|
+
*/
|
|
7
|
+
export class Messages extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Posts a message to a conversation.
|
|
10
|
+
*
|
|
11
|
+
* With `mode` = `send` (the default) the message is delivered — immediately, or
|
|
12
|
+
* queued when `scheduled_at` is set — and the request is idempotent on
|
|
13
|
+
* `client_message_id`. With `mode` = `draft` a customer-reply draft is proposed on
|
|
14
|
+
* an external case: it is held at status `draft` for human approval rather than
|
|
15
|
+
* sent, and `channel` is required.
|
|
16
|
+
*
|
|
17
|
+
* This endpoint requires the permission: `messaging:create`.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* ```ts
|
|
21
|
+
* const message =
|
|
22
|
+
* await client.messaging.conversations.messages.create(
|
|
23
|
+
* 'cv_01h9z8q1w2e3r4t5y6u7i8cv',
|
|
24
|
+
* {
|
|
25
|
+
* body: 'Sounds good — shipping it today.',
|
|
26
|
+
* client_message_id: 'client_msg_8c7d2f',
|
|
27
|
+
* attachments: [
|
|
28
|
+
* {
|
|
29
|
+
* kind: 'file',
|
|
30
|
+
* s3_key: 'uploads/acme/quote.pdf',
|
|
31
|
+
* filename: 'quote.pdf',
|
|
32
|
+
* content_type: 'application/pdf',
|
|
33
|
+
* size_bytes: 20480,
|
|
34
|
+
* },
|
|
35
|
+
* ],
|
|
36
|
+
* audience: 'customer',
|
|
37
|
+
* cc: ['ap@acme.com'],
|
|
38
|
+
* channel: 'email',
|
|
39
|
+
* link_resource_id: 'or_01d5034136c3ccc048abecc312',
|
|
40
|
+
* link_resource_type: 'sales_order',
|
|
41
|
+
* mentions: ['acus_01ea9983ddb41dacc44ecf997c'],
|
|
42
|
+
* mode: 'send',
|
|
43
|
+
* reply_to_message_id: 'mg_01h9z8q1w2e3r4t5y6u7i8mg',
|
|
44
|
+
* scheduled_at: '2026-05-10T15:00:00Z',
|
|
45
|
+
* source_thread_message_id:
|
|
46
|
+
* 'mg_01h9z8q1w2e3r4t5y6u7i8mg',
|
|
47
|
+
* subject: 'Re: Order #1042',
|
|
48
|
+
* },
|
|
49
|
+
* );
|
|
50
|
+
* ```
|
|
51
|
+
*/
|
|
52
|
+
create(id, params, options) {
|
|
53
|
+
const { include, ...body } = params;
|
|
54
|
+
return this._client.post(path `/v1/messaging/conversations/${id}/messages`, {
|
|
55
|
+
query: { include },
|
|
56
|
+
body,
|
|
57
|
+
...options,
|
|
58
|
+
});
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* Returns a conversation's messages, newest first, keyset-paginated by sequence.
|
|
62
|
+
*
|
|
63
|
+
* This endpoint requires the permission: `messaging:read`.
|
|
64
|
+
*
|
|
65
|
+
* @example
|
|
66
|
+
* ```ts
|
|
67
|
+
* const listMessage =
|
|
68
|
+
* await client.messaging.conversations.messages.list(
|
|
69
|
+
* 'cv_01h9z8q1w2e3r4t5y6u7i8cv',
|
|
70
|
+
* );
|
|
71
|
+
* ```
|
|
72
|
+
*/
|
|
73
|
+
list(id, query = {}, options) {
|
|
74
|
+
return this._client.get(path `/v1/messaging/conversations/${id}/messages`, { query, ...options });
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
//# sourceMappingURL=messages.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"messages.mjs","sourceRoot":"","sources":["../../../src/resources/messaging/conversations/messages.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,MAAM,CACJ,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,+BAA+B,EAAE,WAAW,EAAE;YACzE,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAU,EACV,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,+BAA+B,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;CACF"}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import { APIResource } from "../../../../core/resource.mjs";
|
|
2
|
+
import * as ConversationsAPI from "../conversations.mjs";
|
|
3
|
+
import { APIPromise } from "../../../../core/api-promise.mjs";
|
|
4
|
+
import { RequestOptions } from "../../../../internal/request-options.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Add, remove, and manage participants (including agents) in a conversation.
|
|
7
|
+
*/
|
|
8
|
+
export declare class Actions extends APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Changes a participant's role within a group conversation.
|
|
11
|
+
*
|
|
12
|
+
* This endpoint requires the permission: `messaging:update`.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* const conversation =
|
|
17
|
+
* await client.messaging.conversations.participants.actions.setRole(
|
|
18
|
+
* 'cvpt_01h9z8q1w2e3r4t5y6u7cvpt',
|
|
19
|
+
* { id: 'cv_01h9z8q1w2e3r4t5y6u7i8cv', role: 'admin' },
|
|
20
|
+
* );
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
23
|
+
setRole(pid: string, params: ActionSetRoleParams, options?: RequestOptions): APIPromise<ConversationsAPI.Conversation>;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Request to change a participant's role (owner only).
|
|
27
|
+
*/
|
|
28
|
+
export interface UpdateParticipantRoleRequest {
|
|
29
|
+
/**
|
|
30
|
+
* The role to assign to the participant.
|
|
31
|
+
*
|
|
32
|
+
* - `owner`: can rename or delete the conversation and manage members and roles.
|
|
33
|
+
* - `admin`: can add and remove members and rename the conversation.
|
|
34
|
+
* - `member`: can post, leave, mute, and react.
|
|
35
|
+
* - `viewer`: read-only access.
|
|
36
|
+
*/
|
|
37
|
+
role: 'owner' | 'admin' | 'member' | 'viewer';
|
|
38
|
+
}
|
|
39
|
+
export interface ActionSetRoleParams {
|
|
40
|
+
/**
|
|
41
|
+
* Path param: Conversation ID.
|
|
42
|
+
*/
|
|
43
|
+
id: string;
|
|
44
|
+
/**
|
|
45
|
+
* Body param: The role to assign to the participant.
|
|
46
|
+
*
|
|
47
|
+
* - `owner`: can rename or delete the conversation and manage members and roles.
|
|
48
|
+
* - `admin`: can add and remove members and rename the conversation.
|
|
49
|
+
* - `member`: can post, leave, mute, and react.
|
|
50
|
+
* - `viewer`: read-only access.
|
|
51
|
+
*/
|
|
52
|
+
role: 'owner' | 'admin' | 'member' | 'viewer';
|
|
53
|
+
/**
|
|
54
|
+
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
55
|
+
* are returned as `null`.
|
|
56
|
+
*/
|
|
57
|
+
include?: Array<'participants' | 'topic' | 'last_message' | 'last_message.sender' | 'last_message.author' | 'last_message.resource' | 'last_message.attachments'>;
|
|
58
|
+
}
|
|
59
|
+
export declare namespace Actions {
|
|
60
|
+
export { type UpdateParticipantRoleRequest as UpdateParticipantRoleRequest, type ActionSetRoleParams as ActionSetRoleParams, };
|
|
61
|
+
}
|
|
62
|
+
//# sourceMappingURL=actions.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"actions.d.mts","sourceRoot":"","sources":["../../../../src/resources/messaging/conversations/participants/actions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,YAAY,CAAC;CAQ7C;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;;;;;OAOG;IACH,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;CAC/C;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;;;OAOG;IACH,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAE9C;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,OAAO,GACP,cAAc,GACd,qBAAqB,GACrB,qBAAqB,GACrB,uBAAuB,GACvB,0BAA0B,CAC7B,CAAC;CACH;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|