@augno/sdk 0.7.0 → 0.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +3 -3
- 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 +1 -1
- 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 +11 -3
- package/resources/auth/api-keys/api-keys.d.mts.map +1 -1
- package/resources/auth/api-keys/api-keys.d.ts +11 -3
- package/resources/auth/api-keys/api-keys.d.ts.map +1 -1
- package/resources/auth/api-keys/api-keys.js +8 -0
- package/resources/auth/api-keys/api-keys.js.map +1 -1
- package/resources/auth/api-keys/api-keys.mjs +8 -0
- package/resources/auth/api-keys/api-keys.mjs.map +1 -1
- package/resources/catalog/item-categories/item-categories.d.mts +12 -0
- package/resources/catalog/item-categories/item-categories.d.mts.map +1 -1
- package/resources/catalog/item-categories/item-categories.d.ts +12 -0
- package/resources/catalog/item-categories/item-categories.d.ts.map +1 -1
- package/resources/catalog/item-categories/item-categories.js +12 -0
- package/resources/catalog/item-categories/item-categories.js.map +1 -1
- package/resources/catalog/item-categories/item-categories.mjs +12 -0
- 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 +24 -9
- package/resources/catalog/materials.d.mts.map +1 -1
- package/resources/catalog/materials.d.ts +24 -9
- package/resources/catalog/materials.d.ts.map +1 -1
- package/resources/catalog/materials.js +15 -0
- package/resources/catalog/materials.js.map +1 -1
- package/resources/catalog/materials.mjs +15 -0
- package/resources/catalog/materials.mjs.map +1 -1
- package/resources/catalog/parts.d.mts +15 -0
- package/resources/catalog/parts.d.mts.map +1 -1
- package/resources/catalog/parts.d.ts +15 -0
- package/resources/catalog/parts.d.ts.map +1 -1
- package/resources/catalog/parts.js +15 -0
- package/resources/catalog/parts.js.map +1 -1
- package/resources/catalog/parts.mjs +15 -0
- package/resources/catalog/parts.mjs.map +1 -1
- package/resources/catalog/product-lines.d.mts +12 -0
- package/resources/catalog/product-lines.d.mts.map +1 -1
- package/resources/catalog/product-lines.d.ts +12 -0
- package/resources/catalog/product-lines.d.ts.map +1 -1
- package/resources/catalog/product-lines.js +12 -0
- package/resources/catalog/product-lines.js.map +1 -1
- package/resources/catalog/product-lines.mjs +12 -0
- package/resources/catalog/product-lines.mjs.map +1 -1
- package/resources/catalog/products.d.mts +22 -8
- package/resources/catalog/products.d.mts.map +1 -1
- package/resources/catalog/products.d.ts +22 -8
- package/resources/catalog/products.d.ts.map +1 -1
- package/resources/catalog/products.js +14 -0
- package/resources/catalog/products.js.map +1 -1
- package/resources/catalog/products.mjs +14 -0
- package/resources/catalog/products.mjs.map +1 -1
- package/resources/catalog/properties/attributes.d.mts +10 -0
- package/resources/catalog/properties/attributes.d.mts.map +1 -1
- package/resources/catalog/properties/attributes.d.ts +10 -0
- package/resources/catalog/properties/attributes.d.ts.map +1 -1
- package/resources/catalog/properties/attributes.js +10 -0
- package/resources/catalog/properties/attributes.js.map +1 -1
- package/resources/catalog/properties/attributes.mjs +10 -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 +18 -7
- package/resources/catalog/unit-groups/unit-groups.d.mts.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.d.ts +18 -7
- package/resources/catalog/unit-groups/unit-groups.d.ts.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.js +12 -2
- package/resources/catalog/unit-groups/unit-groups.js.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.mjs +12 -2
- package/resources/catalog/unit-groups/unit-groups.mjs.map +1 -1
- package/resources/catalog/unit-groups/units.d.mts +10 -0
- package/resources/catalog/unit-groups/units.d.mts.map +1 -1
- package/resources/catalog/unit-groups/units.d.ts +10 -0
- package/resources/catalog/unit-groups/units.d.ts.map +1 -1
- package/resources/catalog/unit-groups/units.js +10 -0
- package/resources/catalog/unit-groups/units.js.map +1 -1
- package/resources/catalog/unit-groups/units.mjs +10 -0
- package/resources/catalog/unit-groups/units.mjs.map +1 -1
- package/resources/catalog/units.d.mts +48 -25
- package/resources/catalog/units.d.mts.map +1 -1
- package/resources/catalog/units.d.ts +48 -25
- package/resources/catalog/units.d.ts.map +1 -1
- package/resources/catalog/units.js +14 -2
- package/resources/catalog/units.js.map +1 -1
- package/resources/catalog/units.mjs +14 -2
- package/resources/catalog/units.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 +17 -5
- package/resources/identity/account-users/account-users.d.mts.map +1 -1
- package/resources/identity/account-users/account-users.d.ts +17 -5
- package/resources/identity/account-users/account-users.d.ts.map +1 -1
- package/resources/identity/account-users/account-users.js +12 -0
- package/resources/identity/account-users/account-users.js.map +1 -1
- package/resources/identity/account-users/account-users.mjs +12 -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 +1328 -0
- package/resources/messaging/conversations/conversations.d.mts.map +1 -0
- package/resources/messaging/conversations/conversations.d.ts +1328 -0
- package/resources/messaging/conversations/conversations.d.ts.map +1 -0
- package/resources/messaging/conversations/conversations.js +109 -0
- package/resources/messaging/conversations/conversations.js.map +1 -0
- package/resources/messaging/conversations/conversations.mjs +104 -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 +332 -0
- package/resources/messaging/conversations/messages.d.mts.map +1 -0
- package/resources/messaging/conversations/messages.d.ts +332 -0
- package/resources/messaging/conversations/messages.d.ts.map +1 -0
- package/resources/messaging/conversations/messages.js +60 -0
- package/resources/messaging/conversations/messages.js.map +1 -0
- package/resources/messaging/conversations/messages.mjs +56 -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 +327 -0
- package/resources/messaging/email-inboxes.d.mts.map +1 -0
- package/resources/messaging/email-inboxes.d.ts +327 -0
- package/resources/messaging/email-inboxes.d.ts.map +1 -0
- package/resources/messaging/email-inboxes.js +101 -0
- package/resources/messaging/email-inboxes.js.map +1 -0
- package/resources/messaging/email-inboxes.mjs +97 -0
- package/resources/messaging/email-inboxes.mjs.map +1 -0
- package/resources/messaging/groups/groups.d.mts +159 -0
- package/resources/messaging/groups/groups.d.mts.map +1 -0
- package/resources/messaging/groups/groups.d.ts +159 -0
- package/resources/messaging/groups/groups.d.ts.map +1 -0
- package/resources/messaging/groups/groups.js +107 -0
- package/resources/messaging/groups/groups.js.map +1 -0
- package/resources/messaging/groups/groups.mjs +102 -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 +83 -0
- package/resources/messaging/groups/members.d.mts.map +1 -0
- package/resources/messaging/groups/members.d.ts +83 -0
- package/resources/messaging/groups/members.d.ts.map +1 -0
- package/resources/messaging/groups/members.js +51 -0
- package/resources/messaging/groups/members.js.map +1 -0
- package/resources/messaging/groups/members.mjs +47 -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 +61 -0
- package/resources/messaging/messages/messages.d.mts.map +1 -0
- package/resources/messaging/messages/messages.d.ts +61 -0
- package/resources/messaging/messages/messages.d.ts.map +1 -0
- package/resources/messaging/messages/messages.js +40 -0
- package/resources/messaging/messages/messages.js.map +1 -0
- package/resources/messaging/messages/messages.mjs +35 -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 +440 -0
- package/resources/messaging/notifications/notifications.d.mts.map +1 -0
- package/resources/messaging/notifications/notifications.d.ts +440 -0
- package/resources/messaging/notifications/notifications.d.ts.map +1 -0
- package/resources/messaging/notifications/notifications.js +104 -0
- package/resources/messaging/notifications/notifications.js.map +1 -0
- package/resources/messaging/notifications/notifications.mjs +99 -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 +16 -6
- package/resources/operations/carriers/carriers.d.mts.map +1 -1
- package/resources/operations/carriers/carriers.d.ts +16 -6
- package/resources/operations/carriers/carriers.d.ts.map +1 -1
- package/resources/operations/carriers/carriers.js +12 -0
- package/resources/operations/carriers/carriers.js.map +1 -1
- package/resources/operations/carriers/carriers.mjs +12 -0
- package/resources/operations/carriers/carriers.mjs.map +1 -1
- package/resources/operations/carriers/service-levels.d.mts +12 -0
- package/resources/operations/carriers/service-levels.d.mts.map +1 -1
- package/resources/operations/carriers/service-levels.d.ts +12 -0
- package/resources/operations/carriers/service-levels.d.ts.map +1 -1
- package/resources/operations/carriers/service-levels.js +12 -0
- package/resources/operations/carriers/service-levels.js.map +1 -1
- package/resources/operations/carriers/service-levels.mjs +12 -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 +19 -9
- package/resources/operations/locations.d.mts.map +1 -1
- package/resources/operations/locations.d.ts +19 -9
- package/resources/operations/locations.d.ts.map +1 -1
- package/resources/operations/locations.js +10 -0
- package/resources/operations/locations.js.map +1 -1
- package/resources/operations/locations.mjs +10 -0
- package/resources/operations/locations.mjs.map +1 -1
- package/resources/operations/scanning-stations.d.mts +15 -5
- package/resources/operations/scanning-stations.d.mts.map +1 -1
- package/resources/operations/scanning-stations.d.ts +15 -5
- package/resources/operations/scanning-stations.d.ts.map +1 -1
- package/resources/operations/scanning-stations.js +10 -0
- package/resources/operations/scanning-stations.js.map +1 -1
- package/resources/operations/scanning-stations.mjs +10 -0
- package/resources/operations/scanning-stations.mjs.map +1 -1
- package/resources/operations/shipping-terms.d.mts +10 -0
- package/resources/operations/shipping-terms.d.mts.map +1 -1
- package/resources/operations/shipping-terms.d.ts +10 -0
- package/resources/operations/shipping-terms.d.ts.map +1 -1
- package/resources/operations/shipping-terms.js +10 -0
- package/resources/operations/shipping-terms.js.map +1 -1
- package/resources/operations/shipping-terms.mjs +10 -0
- package/resources/operations/shipping-terms.mjs.map +1 -1
- package/resources/sales/account-groups.d.mts +10 -0
- package/resources/sales/account-groups.d.mts.map +1 -1
- package/resources/sales/account-groups.d.ts +10 -0
- package/resources/sales/account-groups.d.ts.map +1 -1
- package/resources/sales/account-groups.js +10 -0
- package/resources/sales/account-groups.js.map +1 -1
- package/resources/sales/account-groups.mjs +10 -0
- 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 +20 -5
- package/resources/sales/addresses.d.mts.map +1 -1
- package/resources/sales/addresses.d.ts +20 -5
- package/resources/sales/addresses.d.ts.map +1 -1
- package/resources/sales/addresses.js +15 -0
- package/resources/sales/addresses.js.map +1 -1
- package/resources/sales/addresses.mjs +15 -0
- 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 +17 -553
- package/resources/sales/customers/customers.d.mts.map +1 -1
- package/resources/sales/customers/customers.d.ts +17 -553
- package/resources/sales/customers/customers.d.ts.map +1 -1
- package/resources/sales/customers/customers.js +10 -0
- package/resources/sales/customers/customers.js.map +1 -1
- package/resources/sales/customers/customers.mjs +10 -0
- 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 +45 -42
- package/resources/sales/sales-orders.d.mts.map +1 -1
- package/resources/sales/sales-orders.d.ts +45 -42
- package/resources/sales/sales-orders.d.ts.map +1 -1
- package/resources/sales/sales-orders.js +5 -0
- package/resources/sales/sales-orders.js.map +1 -1
- package/resources/sales/sales-orders.mjs +5 -0
- 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 +8 -0
- package/resources/settings/integrations.d.mts.map +1 -1
- package/resources/settings/integrations.d.ts +8 -0
- package/resources/settings/integrations.d.ts.map +1 -1
- package/resources/settings/integrations.js +8 -0
- package/resources/settings/integrations.js.map +1 -1
- package/resources/settings/integrations.mjs +8 -0
- 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 +11 -3
- package/src/resources/catalog/item-categories/item-categories.ts +12 -0
- 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 +24 -9
- package/src/resources/catalog/parts.ts +15 -0
- package/src/resources/catalog/product-lines.ts +12 -0
- package/src/resources/catalog/products.ts +22 -8
- package/src/resources/catalog/properties/attributes.ts +10 -0
- package/src/resources/catalog/properties/properties.ts +10 -0
- package/src/resources/catalog/unit-groups/unit-groups.ts +18 -7
- package/src/resources/catalog/unit-groups/units.ts +10 -0
- package/src/resources/catalog/units.ts +48 -25
- package/src/resources/core/audit-events.ts +111 -11
- package/src/resources/core/core.ts +600 -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 +17 -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 +2452 -0
- package/src/resources/messaging/conversations/index.ts +80 -0
- package/src/resources/messaging/conversations/links.ts +690 -0
- package/src/resources/messaging/conversations/messages.ts +906 -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 +408 -0
- package/src/resources/messaging/groups/groups.ts +208 -0
- package/src/resources/messaging/groups/index.ts +17 -0
- package/src/resources/messaging/groups/members.ts +112 -0
- package/src/resources/messaging/groups.ts +3 -0
- package/src/resources/messaging/index.ts +115 -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 +107 -0
- package/src/resources/messaging/messages.ts +3 -0
- package/src/resources/messaging/messaging.ts +351 -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 +1051 -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 +16 -6
- package/src/resources/operations/carriers/service-levels.ts +12 -0
- package/src/resources/operations/location-types.ts +6 -2
- package/src/resources/operations/locations.ts +19 -9
- package/src/resources/operations/scanning-stations.ts +15 -5
- package/src/resources/operations/shipping-terms.ts +10 -0
- package/src/resources/sales/account-groups.ts +10 -0
- package/src/resources/sales/account-statuses.ts +1 -1
- package/src/resources/sales/addresses.ts +20 -5
- 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 +20 -666
- 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 +45 -44
- package/src/resources/sales/sales.ts +6 -30
- package/src/resources/settings/integrations.ts +8 -0
- 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
|
@@ -10,6 +10,8 @@ export declare class Roles extends APIResource {
|
|
|
10
10
|
* Returns a paginated list of roles for the target account, including global
|
|
11
11
|
* roles.
|
|
12
12
|
*
|
|
13
|
+
* This endpoint requires the permission: `roles:read`.
|
|
14
|
+
*
|
|
13
15
|
* @example
|
|
14
16
|
* ```ts
|
|
15
17
|
* const listRole = await client.identity.roles.list();
|
|
@@ -19,6 +21,8 @@ export declare class Roles extends APIResource {
|
|
|
19
21
|
/**
|
|
20
22
|
* Returns a role by ID, including its permissions.
|
|
21
23
|
*
|
|
24
|
+
* This endpoint requires the permission: `roles:read`.
|
|
25
|
+
*
|
|
22
26
|
* @example
|
|
23
27
|
* ```ts
|
|
24
28
|
* const role = await client.identity.roles.retrieve(
|
|
@@ -28,8 +32,11 @@ export declare class Roles extends APIResource {
|
|
|
28
32
|
*/
|
|
29
33
|
retrieve(id: string, query?: RoleRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<APIKeysAPI.Role>;
|
|
30
34
|
/**
|
|
31
|
-
* Creates a custom role with the specified permissions.
|
|
32
|
-
*
|
|
35
|
+
* Creates a custom role with the specified permissions.
|
|
36
|
+
*
|
|
37
|
+
* Roles created through the API always have type `user`.
|
|
38
|
+
*
|
|
39
|
+
* This endpoint requires the permission: `roles:create`.
|
|
33
40
|
*
|
|
34
41
|
* @example
|
|
35
42
|
* ```ts
|
|
@@ -46,8 +53,11 @@ export declare class Roles extends APIResource {
|
|
|
46
53
|
*/
|
|
47
54
|
create(params: RoleCreateParams, options?: RequestOptions): APIPromise<APIKeysAPI.Role>;
|
|
48
55
|
/**
|
|
49
|
-
* Partially updates a custom role's name or permissions.
|
|
50
|
-
*
|
|
56
|
+
* Partially updates a custom role's name or permissions.
|
|
57
|
+
*
|
|
58
|
+
* Provided permissions replace all existing ones; global roles cannot be modified.
|
|
59
|
+
*
|
|
60
|
+
* This endpoint requires the permission: `roles:update`.
|
|
51
61
|
*
|
|
52
62
|
* @example
|
|
53
63
|
* ```ts
|
|
@@ -62,8 +72,12 @@ export declare class Roles extends APIResource {
|
|
|
62
72
|
*/
|
|
63
73
|
update(id: string, params?: RoleUpdateParams | null | undefined, options?: RequestOptions): APIPromise<APIKeysAPI.Role>;
|
|
64
74
|
/**
|
|
65
|
-
* Deletes a role and its associated permissions.
|
|
66
|
-
*
|
|
75
|
+
* Deletes a role and its associated permissions.
|
|
76
|
+
*
|
|
77
|
+
* Global roles and roles currently assigned to one or more users cannot be
|
|
78
|
+
* deleted.
|
|
79
|
+
*
|
|
80
|
+
* This endpoint requires the permission: `roles:delete`.
|
|
67
81
|
*
|
|
68
82
|
* @example
|
|
69
83
|
* ```ts
|
|
@@ -88,7 +102,7 @@ export interface CreateRoleRequest {
|
|
|
88
102
|
* The action must be one of `create`, `read`, `update`, or `delete`. Omit to
|
|
89
103
|
* create a role with no permissions.
|
|
90
104
|
*/
|
|
91
|
-
permissions
|
|
105
|
+
permissions?: Array<string>;
|
|
92
106
|
}
|
|
93
107
|
/**
|
|
94
108
|
* List represents a paginated list of resources.
|
|
@@ -112,8 +126,9 @@ export interface ListRole {
|
|
|
112
126
|
*/
|
|
113
127
|
export interface UpdateRoleRequest {
|
|
114
128
|
/**
|
|
115
|
-
* New display name for the role, unique within the account.
|
|
116
|
-
*
|
|
129
|
+
* New display name for the role, unique within the account.
|
|
130
|
+
*
|
|
131
|
+
* Omit to leave unchanged.
|
|
117
132
|
*/
|
|
118
133
|
name?: string;
|
|
119
134
|
/**
|
|
@@ -168,6 +183,11 @@ export interface RoleCreateParams {
|
|
|
168
183
|
* Body param: Display name for the role, unique within the account.
|
|
169
184
|
*/
|
|
170
185
|
name: string;
|
|
186
|
+
/**
|
|
187
|
+
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
188
|
+
* are returned as `null`.
|
|
189
|
+
*/
|
|
190
|
+
include?: Array<'owner' | 'owner.account' | 'permissions'>;
|
|
171
191
|
/**
|
|
172
192
|
* Body param: Permissions to grant, in `{domain}:{action}` format, such as
|
|
173
193
|
* `customers:read`.
|
|
@@ -175,12 +195,7 @@ export interface RoleCreateParams {
|
|
|
175
195
|
* The action must be one of `create`, `read`, `update`, or `delete`. Omit to
|
|
176
196
|
* create a role with no permissions.
|
|
177
197
|
*/
|
|
178
|
-
permissions
|
|
179
|
-
/**
|
|
180
|
-
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
181
|
-
* are returned as `null`.
|
|
182
|
-
*/
|
|
183
|
-
include?: Array<'owner' | 'owner.account' | 'permissions'>;
|
|
198
|
+
permissions?: Array<string>;
|
|
184
199
|
}
|
|
185
200
|
export interface RoleUpdateParams {
|
|
186
201
|
/**
|
|
@@ -189,8 +204,9 @@ export interface RoleUpdateParams {
|
|
|
189
204
|
*/
|
|
190
205
|
include?: Array<'owner' | 'owner.account' | 'permissions'>;
|
|
191
206
|
/**
|
|
192
|
-
* Body param: New display name for the role, unique within the account.
|
|
193
|
-
*
|
|
207
|
+
* Body param: New display name for the role, unique within the account.
|
|
208
|
+
*
|
|
209
|
+
* Omit to leave unchanged.
|
|
194
210
|
*/
|
|
195
211
|
name?: string;
|
|
196
212
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"roles.d.mts","sourceRoot":"","sources":["../../src/resources/identity/roles.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC
|
|
1
|
+
{"version":3,"file":"roles.d.mts","sourceRoot":"","sources":["../../src/resources/identity/roles.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAInG;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;IAI9B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;IAKvF;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;IAK9B;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAG7E;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,kBAAkB;CAAG;AAEtC,MAAM,WAAW,cAAc;IAC7B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;IAE3D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,WAAW,GAAG,OAAO,CAAC,CAAC;CACrE;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;CAC5D;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;IAE3D;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;IAE3D;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
|
|
@@ -10,6 +10,8 @@ export declare class Roles extends APIResource {
|
|
|
10
10
|
* Returns a paginated list of roles for the target account, including global
|
|
11
11
|
* roles.
|
|
12
12
|
*
|
|
13
|
+
* This endpoint requires the permission: `roles:read`.
|
|
14
|
+
*
|
|
13
15
|
* @example
|
|
14
16
|
* ```ts
|
|
15
17
|
* const listRole = await client.identity.roles.list();
|
|
@@ -19,6 +21,8 @@ export declare class Roles extends APIResource {
|
|
|
19
21
|
/**
|
|
20
22
|
* Returns a role by ID, including its permissions.
|
|
21
23
|
*
|
|
24
|
+
* This endpoint requires the permission: `roles:read`.
|
|
25
|
+
*
|
|
22
26
|
* @example
|
|
23
27
|
* ```ts
|
|
24
28
|
* const role = await client.identity.roles.retrieve(
|
|
@@ -28,8 +32,11 @@ export declare class Roles extends APIResource {
|
|
|
28
32
|
*/
|
|
29
33
|
retrieve(id: string, query?: RoleRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<APIKeysAPI.Role>;
|
|
30
34
|
/**
|
|
31
|
-
* Creates a custom role with the specified permissions.
|
|
32
|
-
*
|
|
35
|
+
* Creates a custom role with the specified permissions.
|
|
36
|
+
*
|
|
37
|
+
* Roles created through the API always have type `user`.
|
|
38
|
+
*
|
|
39
|
+
* This endpoint requires the permission: `roles:create`.
|
|
33
40
|
*
|
|
34
41
|
* @example
|
|
35
42
|
* ```ts
|
|
@@ -46,8 +53,11 @@ export declare class Roles extends APIResource {
|
|
|
46
53
|
*/
|
|
47
54
|
create(params: RoleCreateParams, options?: RequestOptions): APIPromise<APIKeysAPI.Role>;
|
|
48
55
|
/**
|
|
49
|
-
* Partially updates a custom role's name or permissions.
|
|
50
|
-
*
|
|
56
|
+
* Partially updates a custom role's name or permissions.
|
|
57
|
+
*
|
|
58
|
+
* Provided permissions replace all existing ones; global roles cannot be modified.
|
|
59
|
+
*
|
|
60
|
+
* This endpoint requires the permission: `roles:update`.
|
|
51
61
|
*
|
|
52
62
|
* @example
|
|
53
63
|
* ```ts
|
|
@@ -62,8 +72,12 @@ export declare class Roles extends APIResource {
|
|
|
62
72
|
*/
|
|
63
73
|
update(id: string, params?: RoleUpdateParams | null | undefined, options?: RequestOptions): APIPromise<APIKeysAPI.Role>;
|
|
64
74
|
/**
|
|
65
|
-
* Deletes a role and its associated permissions.
|
|
66
|
-
*
|
|
75
|
+
* Deletes a role and its associated permissions.
|
|
76
|
+
*
|
|
77
|
+
* Global roles and roles currently assigned to one or more users cannot be
|
|
78
|
+
* deleted.
|
|
79
|
+
*
|
|
80
|
+
* This endpoint requires the permission: `roles:delete`.
|
|
67
81
|
*
|
|
68
82
|
* @example
|
|
69
83
|
* ```ts
|
|
@@ -88,7 +102,7 @@ export interface CreateRoleRequest {
|
|
|
88
102
|
* The action must be one of `create`, `read`, `update`, or `delete`. Omit to
|
|
89
103
|
* create a role with no permissions.
|
|
90
104
|
*/
|
|
91
|
-
permissions
|
|
105
|
+
permissions?: Array<string>;
|
|
92
106
|
}
|
|
93
107
|
/**
|
|
94
108
|
* List represents a paginated list of resources.
|
|
@@ -112,8 +126,9 @@ export interface ListRole {
|
|
|
112
126
|
*/
|
|
113
127
|
export interface UpdateRoleRequest {
|
|
114
128
|
/**
|
|
115
|
-
* New display name for the role, unique within the account.
|
|
116
|
-
*
|
|
129
|
+
* New display name for the role, unique within the account.
|
|
130
|
+
*
|
|
131
|
+
* Omit to leave unchanged.
|
|
117
132
|
*/
|
|
118
133
|
name?: string;
|
|
119
134
|
/**
|
|
@@ -168,6 +183,11 @@ export interface RoleCreateParams {
|
|
|
168
183
|
* Body param: Display name for the role, unique within the account.
|
|
169
184
|
*/
|
|
170
185
|
name: string;
|
|
186
|
+
/**
|
|
187
|
+
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
188
|
+
* are returned as `null`.
|
|
189
|
+
*/
|
|
190
|
+
include?: Array<'owner' | 'owner.account' | 'permissions'>;
|
|
171
191
|
/**
|
|
172
192
|
* Body param: Permissions to grant, in `{domain}:{action}` format, such as
|
|
173
193
|
* `customers:read`.
|
|
@@ -175,12 +195,7 @@ export interface RoleCreateParams {
|
|
|
175
195
|
* The action must be one of `create`, `read`, `update`, or `delete`. Omit to
|
|
176
196
|
* create a role with no permissions.
|
|
177
197
|
*/
|
|
178
|
-
permissions
|
|
179
|
-
/**
|
|
180
|
-
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
181
|
-
* are returned as `null`.
|
|
182
|
-
*/
|
|
183
|
-
include?: Array<'owner' | 'owner.account' | 'permissions'>;
|
|
198
|
+
permissions?: Array<string>;
|
|
184
199
|
}
|
|
185
200
|
export interface RoleUpdateParams {
|
|
186
201
|
/**
|
|
@@ -189,8 +204,9 @@ export interface RoleUpdateParams {
|
|
|
189
204
|
*/
|
|
190
205
|
include?: Array<'owner' | 'owner.account' | 'permissions'>;
|
|
191
206
|
/**
|
|
192
|
-
* Body param: New display name for the role, unique within the account.
|
|
193
|
-
*
|
|
207
|
+
* Body param: New display name for the role, unique within the account.
|
|
208
|
+
*
|
|
209
|
+
* Omit to leave unchanged.
|
|
194
210
|
*/
|
|
195
211
|
name?: string;
|
|
196
212
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"roles.d.ts","sourceRoot":"","sources":["../../src/resources/identity/roles.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC
|
|
1
|
+
{"version":3,"file":"roles.d.ts","sourceRoot":"","sources":["../../src/resources/identity/roles.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAInG;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;IAI9B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;IAKvF;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;IAK9B;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAG7E;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,kBAAkB;CAAG;AAEtC,MAAM,WAAW,cAAc;IAC7B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;IAE3D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,WAAW,GAAG,OAAO,CAAC,CAAC;CACrE;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;CAC5D;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;IAE3D;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC,CAAC;IAE3D;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
|
|
@@ -12,6 +12,8 @@ class Roles extends resource_1.APIResource {
|
|
|
12
12
|
* Returns a paginated list of roles for the target account, including global
|
|
13
13
|
* roles.
|
|
14
14
|
*
|
|
15
|
+
* This endpoint requires the permission: `roles:read`.
|
|
16
|
+
*
|
|
15
17
|
* @example
|
|
16
18
|
* ```ts
|
|
17
19
|
* const listRole = await client.identity.roles.list();
|
|
@@ -23,6 +25,8 @@ class Roles extends resource_1.APIResource {
|
|
|
23
25
|
/**
|
|
24
26
|
* Returns a role by ID, including its permissions.
|
|
25
27
|
*
|
|
28
|
+
* This endpoint requires the permission: `roles:read`.
|
|
29
|
+
*
|
|
26
30
|
* @example
|
|
27
31
|
* ```ts
|
|
28
32
|
* const role = await client.identity.roles.retrieve(
|
|
@@ -34,8 +38,11 @@ class Roles extends resource_1.APIResource {
|
|
|
34
38
|
return this._client.get((0, path_1.path) `/v1/identity/roles/${id}`, { query, ...options });
|
|
35
39
|
}
|
|
36
40
|
/**
|
|
37
|
-
* Creates a custom role with the specified permissions.
|
|
38
|
-
*
|
|
41
|
+
* Creates a custom role with the specified permissions.
|
|
42
|
+
*
|
|
43
|
+
* Roles created through the API always have type `user`.
|
|
44
|
+
*
|
|
45
|
+
* This endpoint requires the permission: `roles:create`.
|
|
39
46
|
*
|
|
40
47
|
* @example
|
|
41
48
|
* ```ts
|
|
@@ -55,8 +62,11 @@ class Roles extends resource_1.APIResource {
|
|
|
55
62
|
return this._client.post('/v1/identity/roles', { query: { include }, body, ...options });
|
|
56
63
|
}
|
|
57
64
|
/**
|
|
58
|
-
* Partially updates a custom role's name or permissions.
|
|
59
|
-
*
|
|
65
|
+
* Partially updates a custom role's name or permissions.
|
|
66
|
+
*
|
|
67
|
+
* Provided permissions replace all existing ones; global roles cannot be modified.
|
|
68
|
+
*
|
|
69
|
+
* This endpoint requires the permission: `roles:update`.
|
|
60
70
|
*
|
|
61
71
|
* @example
|
|
62
72
|
* ```ts
|
|
@@ -74,8 +84,12 @@ class Roles extends resource_1.APIResource {
|
|
|
74
84
|
return this._client.patch((0, path_1.path) `/v1/identity/roles/${id}`, { query: { include }, body, ...options });
|
|
75
85
|
}
|
|
76
86
|
/**
|
|
77
|
-
* Deletes a role and its associated permissions.
|
|
78
|
-
*
|
|
87
|
+
* Deletes a role and its associated permissions.
|
|
88
|
+
*
|
|
89
|
+
* Global roles and roles currently assigned to one or more users cannot be
|
|
90
|
+
* deleted.
|
|
91
|
+
*
|
|
92
|
+
* This endpoint requires the permission: `roles:delete`.
|
|
79
93
|
*
|
|
80
94
|
* @example
|
|
81
95
|
* ```ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"roles.js","sourceRoot":"","sources":["../../src/resources/identity/roles.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC
|
|
1
|
+
{"version":3,"file":"roles.js","sourceRoot":"","sources":["../../src/resources/identity/roles.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,QAA2C,EAAE,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAU,EACV,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,EAAU,EACV,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF;AA1GD,sBA0GC"}
|
|
@@ -9,6 +9,8 @@ export class Roles extends APIResource {
|
|
|
9
9
|
* Returns a paginated list of roles for the target account, including global
|
|
10
10
|
* roles.
|
|
11
11
|
*
|
|
12
|
+
* This endpoint requires the permission: `roles:read`.
|
|
13
|
+
*
|
|
12
14
|
* @example
|
|
13
15
|
* ```ts
|
|
14
16
|
* const listRole = await client.identity.roles.list();
|
|
@@ -20,6 +22,8 @@ export class Roles extends APIResource {
|
|
|
20
22
|
/**
|
|
21
23
|
* Returns a role by ID, including its permissions.
|
|
22
24
|
*
|
|
25
|
+
* This endpoint requires the permission: `roles:read`.
|
|
26
|
+
*
|
|
23
27
|
* @example
|
|
24
28
|
* ```ts
|
|
25
29
|
* const role = await client.identity.roles.retrieve(
|
|
@@ -31,8 +35,11 @@ export class Roles extends APIResource {
|
|
|
31
35
|
return this._client.get(path `/v1/identity/roles/${id}`, { query, ...options });
|
|
32
36
|
}
|
|
33
37
|
/**
|
|
34
|
-
* Creates a custom role with the specified permissions.
|
|
35
|
-
*
|
|
38
|
+
* Creates a custom role with the specified permissions.
|
|
39
|
+
*
|
|
40
|
+
* Roles created through the API always have type `user`.
|
|
41
|
+
*
|
|
42
|
+
* This endpoint requires the permission: `roles:create`.
|
|
36
43
|
*
|
|
37
44
|
* @example
|
|
38
45
|
* ```ts
|
|
@@ -52,8 +59,11 @@ export class Roles extends APIResource {
|
|
|
52
59
|
return this._client.post('/v1/identity/roles', { query: { include }, body, ...options });
|
|
53
60
|
}
|
|
54
61
|
/**
|
|
55
|
-
* Partially updates a custom role's name or permissions.
|
|
56
|
-
*
|
|
62
|
+
* Partially updates a custom role's name or permissions.
|
|
63
|
+
*
|
|
64
|
+
* Provided permissions replace all existing ones; global roles cannot be modified.
|
|
65
|
+
*
|
|
66
|
+
* This endpoint requires the permission: `roles:update`.
|
|
57
67
|
*
|
|
58
68
|
* @example
|
|
59
69
|
* ```ts
|
|
@@ -71,8 +81,12 @@ export class Roles extends APIResource {
|
|
|
71
81
|
return this._client.patch(path `/v1/identity/roles/${id}`, { query: { include }, body, ...options });
|
|
72
82
|
}
|
|
73
83
|
/**
|
|
74
|
-
* Deletes a role and its associated permissions.
|
|
75
|
-
*
|
|
84
|
+
* Deletes a role and its associated permissions.
|
|
85
|
+
*
|
|
86
|
+
* Global roles and roles currently assigned to one or more users cannot be
|
|
87
|
+
* deleted.
|
|
88
|
+
*
|
|
89
|
+
* This endpoint requires the permission: `roles:delete`.
|
|
76
90
|
*
|
|
77
91
|
* @example
|
|
78
92
|
* ```ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"roles.mjs","sourceRoot":"","sources":["../../src/resources/identity/roles.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC
|
|
1
|
+
{"version":3,"file":"roles.mjs","sourceRoot":"","sources":["../../src/resources/identity/roles.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,QAA2C,EAAE,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAU,EACV,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,sBAAsB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,EAAU,EACV,SAA8C,EAAE,EAChD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,sBAAsB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,sBAAsB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF"}
|
package/resources/index.d.mts
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
export { Auth } from "./auth/auth.mjs";
|
|
2
2
|
export { Catalog } from "./catalog/catalog.mjs";
|
|
3
|
-
export { Core } from "./core/core.mjs";
|
|
3
|
+
export { Core, type Entity, type ListEntity, type CoreRetrieveSearchParams } from "./core/core.mjs";
|
|
4
4
|
export { Finance, type AdjustmentType, type ListAdjustmentType, type ListTransactionMethod, type ListTransactionType, type TransactionMethod, type TransactionType, type FinanceRetrieveTransactionTypesParams, type FinanceRetrieveTransactionMethodsParams, type FinanceRetrieveAdjustmentTypesParams, } from "./finance/finance.mjs";
|
|
5
5
|
export { Identity } from "./identity/identity.mjs";
|
|
6
|
+
export { Messaging, type ListActor, type MessagingRetrieveContactsParams } from "./messaging/messaging.mjs";
|
|
6
7
|
export { Operations } from "./operations/operations.mjs";
|
|
7
8
|
export { Sales } from "./sales/sales.mjs";
|
|
8
9
|
export { Settings } from "./settings/settings.mjs";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EAAE,IAAI,EAAE;OACR,EAAE,OAAO,EAAE;OACX,EAAE,IAAI,EAAE;
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EAAE,IAAI,EAAE;OACR,EAAE,OAAO,EAAE;OACX,EAAE,IAAI,EAAE,KAAK,MAAM,EAAE,KAAK,UAAU,EAAE,KAAK,wBAAwB,EAAE;OACrE,EACL,OAAO,EACP,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,qCAAqC,EAC1C,KAAK,uCAAuC,EAC5C,KAAK,oCAAoC,GAC1C;OACM,EAAE,QAAQ,EAAE;OACZ,EAAE,SAAS,EAAE,KAAK,SAAS,EAAE,KAAK,+BAA+B,EAAE;OACnE,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,EAAE;OACT,EAAE,QAAQ,EAAE"}
|
package/resources/index.d.ts
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
export { Auth } from "./auth/auth.js";
|
|
2
2
|
export { Catalog } from "./catalog/catalog.js";
|
|
3
|
-
export { Core } from "./core/core.js";
|
|
3
|
+
export { Core, type Entity, type ListEntity, type CoreRetrieveSearchParams } from "./core/core.js";
|
|
4
4
|
export { Finance, type AdjustmentType, type ListAdjustmentType, type ListTransactionMethod, type ListTransactionType, type TransactionMethod, type TransactionType, type FinanceRetrieveTransactionTypesParams, type FinanceRetrieveTransactionMethodsParams, type FinanceRetrieveAdjustmentTypesParams, } from "./finance/finance.js";
|
|
5
5
|
export { Identity } from "./identity/identity.js";
|
|
6
|
+
export { Messaging, type ListActor, type MessagingRetrieveContactsParams } from "./messaging/messaging.js";
|
|
6
7
|
export { Operations } from "./operations/operations.js";
|
|
7
8
|
export { Sales } from "./sales/sales.js";
|
|
8
9
|
export { Settings } from "./settings/settings.js";
|
package/resources/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EAAE,IAAI,EAAE;OACR,EAAE,OAAO,EAAE;OACX,EAAE,IAAI,EAAE;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EAAE,IAAI,EAAE;OACR,EAAE,OAAO,EAAE;OACX,EAAE,IAAI,EAAE,KAAK,MAAM,EAAE,KAAK,UAAU,EAAE,KAAK,wBAAwB,EAAE;OACrE,EACL,OAAO,EACP,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,qCAAqC,EAC1C,KAAK,uCAAuC,EAC5C,KAAK,oCAAoC,GAC1C;OACM,EAAE,QAAQ,EAAE;OACZ,EAAE,SAAS,EAAE,KAAK,SAAS,EAAE,KAAK,+BAA+B,EAAE;OACnE,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,EAAE;OACT,EAAE,QAAQ,EAAE"}
|
package/resources/index.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.Settings = exports.Sales = exports.Operations = exports.Identity = exports.Finance = exports.Core = exports.Catalog = exports.Auth = void 0;
|
|
4
|
+
exports.Settings = exports.Sales = exports.Operations = exports.Messaging = exports.Identity = exports.Finance = exports.Core = exports.Catalog = exports.Auth = void 0;
|
|
5
5
|
var auth_1 = require("./auth/auth.js");
|
|
6
6
|
Object.defineProperty(exports, "Auth", { enumerable: true, get: function () { return auth_1.Auth; } });
|
|
7
7
|
var catalog_1 = require("./catalog/catalog.js");
|
|
@@ -12,6 +12,8 @@ var finance_1 = require("./finance/finance.js");
|
|
|
12
12
|
Object.defineProperty(exports, "Finance", { enumerable: true, get: function () { return finance_1.Finance; } });
|
|
13
13
|
var identity_1 = require("./identity/identity.js");
|
|
14
14
|
Object.defineProperty(exports, "Identity", { enumerable: true, get: function () { return identity_1.Identity; } });
|
|
15
|
+
var messaging_1 = require("./messaging/messaging.js");
|
|
16
|
+
Object.defineProperty(exports, "Messaging", { enumerable: true, get: function () { return messaging_1.Messaging; } });
|
|
15
17
|
var operations_1 = require("./operations/operations.js");
|
|
16
18
|
Object.defineProperty(exports, "Operations", { enumerable: true, get: function () { return operations_1.Operations; } });
|
|
17
19
|
var sales_1 = require("./sales/sales.js");
|
package/resources/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,uCAAmC;AAA1B,4FAAA,IAAI,OAAA;AACb,gDAA4C;AAAnC,kGAAA,OAAO,OAAA;AAChB,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,uCAAmC;AAA1B,4FAAA,IAAI,OAAA;AACb,gDAA4C;AAAnC,kGAAA,OAAO,OAAA;AAChB,uCAAgG;AAAvF,4FAAA,IAAI,OAAA;AACb,gDAW2B;AAVzB,kGAAA,OAAO,OAAA;AAWT,mDAA+C;AAAtC,oGAAA,QAAQ,OAAA;AACjB,sDAAwG;AAA/F,sGAAA,SAAS,OAAA;AAClB,yDAAqD;AAA5C,wGAAA,UAAU,OAAA;AACnB,0CAAsC;AAA7B,8FAAA,KAAK,OAAA;AACd,mDAA+C;AAAtC,oGAAA,QAAQ,OAAA"}
|
package/resources/index.mjs
CHANGED
|
@@ -4,6 +4,7 @@ export { Catalog } from "./catalog/catalog.mjs";
|
|
|
4
4
|
export { Core } from "./core/core.mjs";
|
|
5
5
|
export { Finance, } from "./finance/finance.mjs";
|
|
6
6
|
export { Identity } from "./identity/identity.mjs";
|
|
7
|
+
export { Messaging } from "./messaging/messaging.mjs";
|
|
7
8
|
export { Operations } from "./operations/operations.mjs";
|
|
8
9
|
export { Sales } from "./sales/sales.mjs";
|
|
9
10
|
export { Settings } from "./settings/settings.mjs";
|
package/resources/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,IAAI,EAAE;OACR,EAAE,OAAO,EAAE;OACX,EAAE,IAAI,
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,IAAI,EAAE;OACR,EAAE,OAAO,EAAE;OACX,EAAE,IAAI,EAA+D;OACrE,EACL,OAAO,GAUR;OACM,EAAE,QAAQ,EAAE;OACZ,EAAE,SAAS,EAAwD;OACnE,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,EAAE;OACT,EAAE,QAAQ,EAAE"}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
import { APIResource } from "../../../core/resource.mjs";
|
|
2
|
+
import * as AnnouncementsAPI from "./announcements.mjs";
|
|
3
|
+
import { APIPromise } from "../../../core/api-promise.mjs";
|
|
4
|
+
import { RequestOptions } from "../../../internal/request-options.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* List, read, and manage broadcast announcements.
|
|
7
|
+
*/
|
|
8
|
+
export declare class Actions extends APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Marks an announcement as seen for the calling actor.
|
|
11
|
+
*
|
|
12
|
+
* This endpoint requires the permission: `messaging:update`.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* const announcement =
|
|
17
|
+
* await client.messaging.announcements.actions.seen(
|
|
18
|
+
* 'an_01c4d5e6f7a8b9c0d1e2f3a4',
|
|
19
|
+
* );
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
seen(id: string, params?: ActionSeenParams | null | undefined, options?: RequestOptions): APIPromise<AnnouncementsAPI.Announcement>;
|
|
23
|
+
/**
|
|
24
|
+
* Marks an announcement as read for the calling actor.
|
|
25
|
+
*
|
|
26
|
+
* This endpoint requires the permission: `messaging:update`.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```ts
|
|
30
|
+
* const announcement =
|
|
31
|
+
* await client.messaging.announcements.actions.read(
|
|
32
|
+
* 'an_01c4d5e6f7a8b9c0d1e2f3a4',
|
|
33
|
+
* );
|
|
34
|
+
* ```
|
|
35
|
+
*/
|
|
36
|
+
read(id: string, params?: ActionReadParams | null | undefined, options?: RequestOptions): APIPromise<AnnouncementsAPI.Announcement>;
|
|
37
|
+
/**
|
|
38
|
+
* Marks an announcement as dismissed for the calling actor.
|
|
39
|
+
*
|
|
40
|
+
* This endpoint requires the permission: `messaging:update`.
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```ts
|
|
44
|
+
* const announcement =
|
|
45
|
+
* await client.messaging.announcements.actions.dismiss(
|
|
46
|
+
* 'an_01c4d5e6f7a8b9c0d1e2f3a4',
|
|
47
|
+
* );
|
|
48
|
+
* ```
|
|
49
|
+
*/
|
|
50
|
+
dismiss(id: string, params?: ActionDismissParams | null | undefined, options?: RequestOptions): APIPromise<AnnouncementsAPI.Announcement>;
|
|
51
|
+
}
|
|
52
|
+
export interface ActionSeenParams {
|
|
53
|
+
/**
|
|
54
|
+
* Sub-objects to expand in the response. When omitted, sub-objects are returned as
|
|
55
|
+
* `null`.
|
|
56
|
+
*/
|
|
57
|
+
include?: Array<'resource'>;
|
|
58
|
+
}
|
|
59
|
+
export interface ActionReadParams {
|
|
60
|
+
/**
|
|
61
|
+
* Sub-objects to expand in the response. When omitted, sub-objects are returned as
|
|
62
|
+
* `null`.
|
|
63
|
+
*/
|
|
64
|
+
include?: Array<'resource'>;
|
|
65
|
+
}
|
|
66
|
+
export interface ActionDismissParams {
|
|
67
|
+
/**
|
|
68
|
+
* Sub-objects to expand in the response. When omitted, sub-objects are returned as
|
|
69
|
+
* `null`.
|
|
70
|
+
*/
|
|
71
|
+
include?: Array<'resource'>;
|
|
72
|
+
}
|
|
73
|
+
export declare namespace Actions {
|
|
74
|
+
export { type ActionSeenParams as ActionSeenParams, type ActionReadParams as ActionReadParams, type ActionDismissParams as ActionDismissParams, };
|
|
75
|
+
}
|
|
76
|
+
//# sourceMappingURL=actions.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"actions.d.mts","sourceRoot":"","sources":["../../../src/resources/messaging/announcements/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;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,YAAY,CAAC;IAQ5C;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,YAAY,CAAC;IAQ5C;;;;;;;;;;;;OAYG;IACH,OAAO,CACL,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,YAAY,CAAC;CAO7C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
import { APIResource } from "../../../core/resource.js";
|
|
2
|
+
import * as AnnouncementsAPI from "./announcements.js";
|
|
3
|
+
import { APIPromise } from "../../../core/api-promise.js";
|
|
4
|
+
import { RequestOptions } from "../../../internal/request-options.js";
|
|
5
|
+
/**
|
|
6
|
+
* List, read, and manage broadcast announcements.
|
|
7
|
+
*/
|
|
8
|
+
export declare class Actions extends APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Marks an announcement as seen for the calling actor.
|
|
11
|
+
*
|
|
12
|
+
* This endpoint requires the permission: `messaging:update`.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* const announcement =
|
|
17
|
+
* await client.messaging.announcements.actions.seen(
|
|
18
|
+
* 'an_01c4d5e6f7a8b9c0d1e2f3a4',
|
|
19
|
+
* );
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
seen(id: string, params?: ActionSeenParams | null | undefined, options?: RequestOptions): APIPromise<AnnouncementsAPI.Announcement>;
|
|
23
|
+
/**
|
|
24
|
+
* Marks an announcement as read for the calling actor.
|
|
25
|
+
*
|
|
26
|
+
* This endpoint requires the permission: `messaging:update`.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```ts
|
|
30
|
+
* const announcement =
|
|
31
|
+
* await client.messaging.announcements.actions.read(
|
|
32
|
+
* 'an_01c4d5e6f7a8b9c0d1e2f3a4',
|
|
33
|
+
* );
|
|
34
|
+
* ```
|
|
35
|
+
*/
|
|
36
|
+
read(id: string, params?: ActionReadParams | null | undefined, options?: RequestOptions): APIPromise<AnnouncementsAPI.Announcement>;
|
|
37
|
+
/**
|
|
38
|
+
* Marks an announcement as dismissed for the calling actor.
|
|
39
|
+
*
|
|
40
|
+
* This endpoint requires the permission: `messaging:update`.
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```ts
|
|
44
|
+
* const announcement =
|
|
45
|
+
* await client.messaging.announcements.actions.dismiss(
|
|
46
|
+
* 'an_01c4d5e6f7a8b9c0d1e2f3a4',
|
|
47
|
+
* );
|
|
48
|
+
* ```
|
|
49
|
+
*/
|
|
50
|
+
dismiss(id: string, params?: ActionDismissParams | null | undefined, options?: RequestOptions): APIPromise<AnnouncementsAPI.Announcement>;
|
|
51
|
+
}
|
|
52
|
+
export interface ActionSeenParams {
|
|
53
|
+
/**
|
|
54
|
+
* Sub-objects to expand in the response. When omitted, sub-objects are returned as
|
|
55
|
+
* `null`.
|
|
56
|
+
*/
|
|
57
|
+
include?: Array<'resource'>;
|
|
58
|
+
}
|
|
59
|
+
export interface ActionReadParams {
|
|
60
|
+
/**
|
|
61
|
+
* Sub-objects to expand in the response. When omitted, sub-objects are returned as
|
|
62
|
+
* `null`.
|
|
63
|
+
*/
|
|
64
|
+
include?: Array<'resource'>;
|
|
65
|
+
}
|
|
66
|
+
export interface ActionDismissParams {
|
|
67
|
+
/**
|
|
68
|
+
* Sub-objects to expand in the response. When omitted, sub-objects are returned as
|
|
69
|
+
* `null`.
|
|
70
|
+
*/
|
|
71
|
+
include?: Array<'resource'>;
|
|
72
|
+
}
|
|
73
|
+
export declare namespace Actions {
|
|
74
|
+
export { type ActionSeenParams as ActionSeenParams, type ActionReadParams as ActionReadParams, type ActionDismissParams as ActionDismissParams, };
|
|
75
|
+
}
|
|
76
|
+
//# sourceMappingURL=actions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../src/resources/messaging/announcements/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;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,YAAY,CAAC;IAQ5C;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,YAAY,CAAC;IAQ5C;;;;;;;;;;;;OAYG;IACH,OAAO,CACL,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,YAAY,CAAC;CAO7C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|