@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
|
@@ -12,6 +12,9 @@ export declare class Products extends APIResource {
|
|
|
12
12
|
/**
|
|
13
13
|
* Returns a paginated list of products for the target account.
|
|
14
14
|
*
|
|
15
|
+
* This endpoint requires the permissions: `items:read`, `customers:read`,
|
|
16
|
+
* `suppliers:read`.
|
|
17
|
+
*
|
|
15
18
|
* @example
|
|
16
19
|
* ```ts
|
|
17
20
|
* const listProduct = await client.catalog.products.list();
|
|
@@ -21,6 +24,9 @@ export declare class Products extends APIResource {
|
|
|
21
24
|
/**
|
|
22
25
|
* Returns a product by ID.
|
|
23
26
|
*
|
|
27
|
+
* This endpoint requires the permissions: `items:read`, `customers:read`,
|
|
28
|
+
* `suppliers:read`.
|
|
29
|
+
*
|
|
24
30
|
* @example
|
|
25
31
|
* ```ts
|
|
26
32
|
* const product = await client.catalog.products.retrieve(
|
|
@@ -36,12 +42,31 @@ export declare class Products extends APIResource {
|
|
|
36
42
|
* zero rates in the category's base unit unless `unit_price` or `unit_cost` is
|
|
37
43
|
* provided.
|
|
38
44
|
*
|
|
45
|
+
* This endpoint requires the permission: `items:create`.
|
|
46
|
+
*
|
|
39
47
|
* @example
|
|
40
48
|
* ```ts
|
|
41
49
|
* const product = await client.catalog.products.create({
|
|
42
50
|
* category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
|
|
43
51
|
* sku: 'ALM-2024-1001',
|
|
44
52
|
* type: 'sale',
|
|
53
|
+
* attribute_ids: ['at_01c9493ec0c46bb0ed12708ae4'],
|
|
54
|
+
* description:
|
|
55
|
+
* 'Wireless barcode scanner with charging cradle',
|
|
56
|
+
* notes:
|
|
57
|
+
* 'Ships with a 2-year warranty; register for extended coverage.',
|
|
58
|
+
* portal_visibility: 'visible',
|
|
59
|
+
* product_line_id: 'pl_01996357326a0d3f7b129542ea',
|
|
60
|
+
* unit_cost: {
|
|
61
|
+
* value: '112.00',
|
|
62
|
+
* numerator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
63
|
+
* denominator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
64
|
+
* },
|
|
65
|
+
* unit_price: {
|
|
66
|
+
* value: '199.00',
|
|
67
|
+
* numerator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
68
|
+
* denominator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
69
|
+
* },
|
|
45
70
|
* });
|
|
46
71
|
* ```
|
|
47
72
|
*/
|
|
@@ -49,11 +74,25 @@ export declare class Products extends APIResource {
|
|
|
49
74
|
/**
|
|
50
75
|
* Partially updates a product.
|
|
51
76
|
*
|
|
77
|
+
* This endpoint requires the permission: `items:update`.
|
|
78
|
+
*
|
|
52
79
|
* @example
|
|
53
80
|
* ```ts
|
|
54
81
|
* const product = await client.catalog.products.update(
|
|
55
82
|
* 'pd_013c29ab3f1518d0004094c316',
|
|
56
|
-
* {
|
|
83
|
+
* {
|
|
84
|
+
* description:
|
|
85
|
+
* 'Wireless barcode scanner with charging cradle (v2)',
|
|
86
|
+
* notes:
|
|
87
|
+
* 'Firmware 2.1 improves Bluetooth pairing reliability.',
|
|
88
|
+
* portal_visibility: 'visible',
|
|
89
|
+
* sku: 'SKU-002',
|
|
90
|
+
* unit_price: {
|
|
91
|
+
* value: '219.00',
|
|
92
|
+
* numerator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
93
|
+
* denominator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
94
|
+
* },
|
|
95
|
+
* },
|
|
57
96
|
* );
|
|
58
97
|
* ```
|
|
59
98
|
*/
|
|
@@ -61,6 +100,8 @@ export declare class Products extends APIResource {
|
|
|
61
100
|
/**
|
|
62
101
|
* Soft-deletes a product and returns the deleted product.
|
|
63
102
|
*
|
|
103
|
+
* This endpoint requires the permission: `items:delete`.
|
|
104
|
+
*
|
|
64
105
|
* @example
|
|
65
106
|
* ```ts
|
|
66
107
|
* const product = await client.catalog.products.delete(
|
|
@@ -72,6 +113,8 @@ export declare class Products extends APIResource {
|
|
|
72
113
|
/**
|
|
73
114
|
* Changes the product line assignment for a product.
|
|
74
115
|
*
|
|
116
|
+
* This endpoint requires the permission: `items:update`.
|
|
117
|
+
*
|
|
75
118
|
* @example
|
|
76
119
|
* ```ts
|
|
77
120
|
* const product =
|
|
@@ -118,11 +161,11 @@ export interface CreateProductRequest {
|
|
|
118
161
|
*/
|
|
119
162
|
attribute_ids?: Array<string>;
|
|
120
163
|
/**
|
|
121
|
-
*
|
|
164
|
+
* Free-form description of the product.
|
|
122
165
|
*/
|
|
123
166
|
description?: string;
|
|
124
167
|
/**
|
|
125
|
-
*
|
|
168
|
+
* Free-form notes about the product.
|
|
126
169
|
*/
|
|
127
170
|
notes?: string;
|
|
128
171
|
/**
|
|
@@ -226,13 +269,13 @@ export interface Product {
|
|
|
226
269
|
*/
|
|
227
270
|
export interface UpdateProductRequest {
|
|
228
271
|
/**
|
|
229
|
-
*
|
|
272
|
+
* Free-form description of the product.
|
|
230
273
|
*
|
|
231
274
|
* Send `null` to clear.
|
|
232
275
|
*/
|
|
233
276
|
description?: string | null;
|
|
234
277
|
/**
|
|
235
|
-
*
|
|
278
|
+
* Free-form notes about the product.
|
|
236
279
|
*
|
|
237
280
|
* Send `null` to clear.
|
|
238
281
|
*/
|
|
@@ -355,11 +398,11 @@ export interface ProductCreateParams {
|
|
|
355
398
|
*/
|
|
356
399
|
attribute_ids?: Array<string>;
|
|
357
400
|
/**
|
|
358
|
-
* Body param:
|
|
401
|
+
* Body param: Free-form description of the product.
|
|
359
402
|
*/
|
|
360
403
|
description?: string;
|
|
361
404
|
/**
|
|
362
|
-
* Body param:
|
|
405
|
+
* Body param: Free-form notes about the product.
|
|
363
406
|
*/
|
|
364
407
|
notes?: string;
|
|
365
408
|
/**
|
|
@@ -395,13 +438,13 @@ export interface ProductUpdateParams {
|
|
|
395
438
|
*/
|
|
396
439
|
include?: Array<'product_line' | 'product_line.unit_group' | 'product_line.unit_group.base_unit' | 'product_line.unit_group.associated_units' | 'product_line.unit_group.associated_units.unit' | 'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.category.unit_group.base_unit' | 'item.category.unit_group.associated_units' | 'item.category.unit_group.associated_units.unit' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
|
|
397
440
|
/**
|
|
398
|
-
* Body param:
|
|
441
|
+
* Body param: Free-form description of the product.
|
|
399
442
|
*
|
|
400
443
|
* Send `null` to clear.
|
|
401
444
|
*/
|
|
402
445
|
description?: string | null;
|
|
403
446
|
/**
|
|
404
|
-
* Body param:
|
|
447
|
+
* Body param: Free-form notes about the product.
|
|
405
448
|
*
|
|
406
449
|
* Send `null` to clear.
|
|
407
450
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"products.d.ts","sourceRoot":"","sources":["../../src/resources/catalog/products.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,KAAK,eAAe;OACpB,KAAK,UAAU;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC
|
|
1
|
+
{"version":3,"file":"products.d.ts","sourceRoot":"","sources":["../../src/resources/catalog/products.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,KAAK,eAAe;OACpB,KAAK,UAAU;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAIzG;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAItB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAKlF;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAKtB;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAKtB;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CACf,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;CAOvB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;;;;;;OAUG;IACH,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;IAEpE;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEzC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;;;;;OAMG;IACH,iBAAiB,EAAE,SAAS,GAAG,QAAQ,CAAC;IAExC;;;;;OAKG;IACH,YAAY,EAAE,eAAe,CAAC,WAAW,GAAG,IAAI,CAAC;IAEjD;;;;;;;;;;OAUG;IACH,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;IAEpE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEzC;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEzC;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;CACH;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;;;;;;OAUG;IACH,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;IAEpE;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;IAEF;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEzC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;IAEF;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEzC;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;CACH;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;CACH;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
|
|
@@ -11,6 +11,9 @@ class Products extends resource_1.APIResource {
|
|
|
11
11
|
/**
|
|
12
12
|
* Returns a paginated list of products for the target account.
|
|
13
13
|
*
|
|
14
|
+
* This endpoint requires the permissions: `items:read`, `customers:read`,
|
|
15
|
+
* `suppliers:read`.
|
|
16
|
+
*
|
|
14
17
|
* @example
|
|
15
18
|
* ```ts
|
|
16
19
|
* const listProduct = await client.catalog.products.list();
|
|
@@ -22,6 +25,9 @@ class Products extends resource_1.APIResource {
|
|
|
22
25
|
/**
|
|
23
26
|
* Returns a product by ID.
|
|
24
27
|
*
|
|
28
|
+
* This endpoint requires the permissions: `items:read`, `customers:read`,
|
|
29
|
+
* `suppliers:read`.
|
|
30
|
+
*
|
|
25
31
|
* @example
|
|
26
32
|
* ```ts
|
|
27
33
|
* const product = await client.catalog.products.retrieve(
|
|
@@ -39,12 +45,31 @@ class Products extends resource_1.APIResource {
|
|
|
39
45
|
* zero rates in the category's base unit unless `unit_price` or `unit_cost` is
|
|
40
46
|
* provided.
|
|
41
47
|
*
|
|
48
|
+
* This endpoint requires the permission: `items:create`.
|
|
49
|
+
*
|
|
42
50
|
* @example
|
|
43
51
|
* ```ts
|
|
44
52
|
* const product = await client.catalog.products.create({
|
|
45
53
|
* category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
|
|
46
54
|
* sku: 'ALM-2024-1001',
|
|
47
55
|
* type: 'sale',
|
|
56
|
+
* attribute_ids: ['at_01c9493ec0c46bb0ed12708ae4'],
|
|
57
|
+
* description:
|
|
58
|
+
* 'Wireless barcode scanner with charging cradle',
|
|
59
|
+
* notes:
|
|
60
|
+
* 'Ships with a 2-year warranty; register for extended coverage.',
|
|
61
|
+
* portal_visibility: 'visible',
|
|
62
|
+
* product_line_id: 'pl_01996357326a0d3f7b129542ea',
|
|
63
|
+
* unit_cost: {
|
|
64
|
+
* value: '112.00',
|
|
65
|
+
* numerator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
66
|
+
* denominator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
67
|
+
* },
|
|
68
|
+
* unit_price: {
|
|
69
|
+
* value: '199.00',
|
|
70
|
+
* numerator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
71
|
+
* denominator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
72
|
+
* },
|
|
48
73
|
* });
|
|
49
74
|
* ```
|
|
50
75
|
*/
|
|
@@ -55,11 +80,25 @@ class Products extends resource_1.APIResource {
|
|
|
55
80
|
/**
|
|
56
81
|
* Partially updates a product.
|
|
57
82
|
*
|
|
83
|
+
* This endpoint requires the permission: `items:update`.
|
|
84
|
+
*
|
|
58
85
|
* @example
|
|
59
86
|
* ```ts
|
|
60
87
|
* const product = await client.catalog.products.update(
|
|
61
88
|
* 'pd_013c29ab3f1518d0004094c316',
|
|
62
|
-
* {
|
|
89
|
+
* {
|
|
90
|
+
* description:
|
|
91
|
+
* 'Wireless barcode scanner with charging cradle (v2)',
|
|
92
|
+
* notes:
|
|
93
|
+
* 'Firmware 2.1 improves Bluetooth pairing reliability.',
|
|
94
|
+
* portal_visibility: 'visible',
|
|
95
|
+
* sku: 'SKU-002',
|
|
96
|
+
* unit_price: {
|
|
97
|
+
* value: '219.00',
|
|
98
|
+
* numerator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
99
|
+
* denominator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
100
|
+
* },
|
|
101
|
+
* },
|
|
63
102
|
* );
|
|
64
103
|
* ```
|
|
65
104
|
*/
|
|
@@ -70,6 +109,8 @@ class Products extends resource_1.APIResource {
|
|
|
70
109
|
/**
|
|
71
110
|
* Soft-deletes a product and returns the deleted product.
|
|
72
111
|
*
|
|
112
|
+
* This endpoint requires the permission: `items:delete`.
|
|
113
|
+
*
|
|
73
114
|
* @example
|
|
74
115
|
* ```ts
|
|
75
116
|
* const product = await client.catalog.products.delete(
|
|
@@ -84,6 +125,8 @@ class Products extends resource_1.APIResource {
|
|
|
84
125
|
/**
|
|
85
126
|
* Changes the product line assignment for a product.
|
|
86
127
|
*
|
|
128
|
+
* This endpoint requires the permission: `items:update`.
|
|
129
|
+
*
|
|
87
130
|
* @example
|
|
88
131
|
* ```ts
|
|
89
132
|
* const product =
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"products.js","sourceRoot":"","sources":["../../src/resources/catalog/products.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAOlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC
|
|
1
|
+
{"version":3,"file":"products.js","sourceRoot":"","sources":["../../src/resources/catalog/products.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAOlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,QAA8C,EAAE,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAU,EACV,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,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,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CACf,aAAqB,EACrB,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,iBAAiB,aAAa,EAAE,EAAE;YACtF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA7JD,4BA6JC"}
|
|
@@ -8,6 +8,9 @@ export class Products extends APIResource {
|
|
|
8
8
|
/**
|
|
9
9
|
* Returns a paginated list of products for the target account.
|
|
10
10
|
*
|
|
11
|
+
* This endpoint requires the permissions: `items:read`, `customers:read`,
|
|
12
|
+
* `suppliers:read`.
|
|
13
|
+
*
|
|
11
14
|
* @example
|
|
12
15
|
* ```ts
|
|
13
16
|
* const listProduct = await client.catalog.products.list();
|
|
@@ -19,6 +22,9 @@ export class Products extends APIResource {
|
|
|
19
22
|
/**
|
|
20
23
|
* Returns a product by ID.
|
|
21
24
|
*
|
|
25
|
+
* This endpoint requires the permissions: `items:read`, `customers:read`,
|
|
26
|
+
* `suppliers:read`.
|
|
27
|
+
*
|
|
22
28
|
* @example
|
|
23
29
|
* ```ts
|
|
24
30
|
* const product = await client.catalog.products.retrieve(
|
|
@@ -36,12 +42,31 @@ export class Products extends APIResource {
|
|
|
36
42
|
* zero rates in the category's base unit unless `unit_price` or `unit_cost` is
|
|
37
43
|
* provided.
|
|
38
44
|
*
|
|
45
|
+
* This endpoint requires the permission: `items:create`.
|
|
46
|
+
*
|
|
39
47
|
* @example
|
|
40
48
|
* ```ts
|
|
41
49
|
* const product = await client.catalog.products.create({
|
|
42
50
|
* category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
|
|
43
51
|
* sku: 'ALM-2024-1001',
|
|
44
52
|
* type: 'sale',
|
|
53
|
+
* attribute_ids: ['at_01c9493ec0c46bb0ed12708ae4'],
|
|
54
|
+
* description:
|
|
55
|
+
* 'Wireless barcode scanner with charging cradle',
|
|
56
|
+
* notes:
|
|
57
|
+
* 'Ships with a 2-year warranty; register for extended coverage.',
|
|
58
|
+
* portal_visibility: 'visible',
|
|
59
|
+
* product_line_id: 'pl_01996357326a0d3f7b129542ea',
|
|
60
|
+
* unit_cost: {
|
|
61
|
+
* value: '112.00',
|
|
62
|
+
* numerator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
63
|
+
* denominator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
64
|
+
* },
|
|
65
|
+
* unit_price: {
|
|
66
|
+
* value: '199.00',
|
|
67
|
+
* numerator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
68
|
+
* denominator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
69
|
+
* },
|
|
45
70
|
* });
|
|
46
71
|
* ```
|
|
47
72
|
*/
|
|
@@ -52,11 +77,25 @@ export class Products extends APIResource {
|
|
|
52
77
|
/**
|
|
53
78
|
* Partially updates a product.
|
|
54
79
|
*
|
|
80
|
+
* This endpoint requires the permission: `items:update`.
|
|
81
|
+
*
|
|
55
82
|
* @example
|
|
56
83
|
* ```ts
|
|
57
84
|
* const product = await client.catalog.products.update(
|
|
58
85
|
* 'pd_013c29ab3f1518d0004094c316',
|
|
59
|
-
* {
|
|
86
|
+
* {
|
|
87
|
+
* description:
|
|
88
|
+
* 'Wireless barcode scanner with charging cradle (v2)',
|
|
89
|
+
* notes:
|
|
90
|
+
* 'Firmware 2.1 improves Bluetooth pairing reliability.',
|
|
91
|
+
* portal_visibility: 'visible',
|
|
92
|
+
* sku: 'SKU-002',
|
|
93
|
+
* unit_price: {
|
|
94
|
+
* value: '219.00',
|
|
95
|
+
* numerator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
96
|
+
* denominator_unit_id: 'un_01966263f74a5a0cae356000a1',
|
|
97
|
+
* },
|
|
98
|
+
* },
|
|
60
99
|
* );
|
|
61
100
|
* ```
|
|
62
101
|
*/
|
|
@@ -67,6 +106,8 @@ export class Products extends APIResource {
|
|
|
67
106
|
/**
|
|
68
107
|
* Soft-deletes a product and returns the deleted product.
|
|
69
108
|
*
|
|
109
|
+
* This endpoint requires the permission: `items:delete`.
|
|
110
|
+
*
|
|
70
111
|
* @example
|
|
71
112
|
* ```ts
|
|
72
113
|
* const product = await client.catalog.products.delete(
|
|
@@ -81,6 +122,8 @@ export class Products extends APIResource {
|
|
|
81
122
|
/**
|
|
82
123
|
* Changes the product line assignment for a product.
|
|
83
124
|
*
|
|
125
|
+
* This endpoint requires the permission: `items:update`.
|
|
126
|
+
*
|
|
84
127
|
* @example
|
|
85
128
|
* ```ts
|
|
86
129
|
* const product =
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"products.mjs","sourceRoot":"","sources":["../../src/resources/catalog/products.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAOf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC
|
|
1
|
+
{"version":3,"file":"products.mjs","sourceRoot":"","sources":["../../src/resources/catalog/products.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAOf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,QAA8C,EAAE,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAU,EACV,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CACf,aAAqB,EACrB,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wBAAwB,EAAE,iBAAiB,aAAa,EAAE,EAAE;YACtF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -9,6 +9,8 @@ export declare class Attributes extends APIResource {
|
|
|
9
9
|
/**
|
|
10
10
|
* Returns a paginated list of attributes for a property.
|
|
11
11
|
*
|
|
12
|
+
* This endpoint requires the permission: `properties:read`.
|
|
13
|
+
*
|
|
12
14
|
* @example
|
|
13
15
|
* ```ts
|
|
14
16
|
* const listAttribute =
|
|
@@ -21,6 +23,8 @@ export declare class Attributes extends APIResource {
|
|
|
21
23
|
/**
|
|
22
24
|
* Returns an attribute by ID within a property.
|
|
23
25
|
*
|
|
26
|
+
* This endpoint requires the permission: `properties:read`.
|
|
27
|
+
*
|
|
24
28
|
* @example
|
|
25
29
|
* ```ts
|
|
26
30
|
* const attribute =
|
|
@@ -34,6 +38,8 @@ export declare class Attributes extends APIResource {
|
|
|
34
38
|
/**
|
|
35
39
|
* Creates an attribute under a property.
|
|
36
40
|
*
|
|
41
|
+
* This endpoint requires the permission: `properties:create`.
|
|
42
|
+
*
|
|
37
43
|
* @example
|
|
38
44
|
* ```ts
|
|
39
45
|
* const attribute =
|
|
@@ -51,6 +57,8 @@ export declare class Attributes extends APIResource {
|
|
|
51
57
|
/**
|
|
52
58
|
* Partially updates an attribute.
|
|
53
59
|
*
|
|
60
|
+
* This endpoint requires the permission: `properties:update`.
|
|
61
|
+
*
|
|
54
62
|
* @example
|
|
55
63
|
* ```ts
|
|
56
64
|
* const attribute =
|
|
@@ -58,6 +66,8 @@ export declare class Attributes extends APIResource {
|
|
|
58
66
|
* 'at_01c9493ec0c46bb0ed12708ae4',
|
|
59
67
|
* {
|
|
60
68
|
* property_id: 'pp_01e21344878064372f69e67093',
|
|
69
|
+
* color: 'blue',
|
|
70
|
+
* sort_order: 2,
|
|
61
71
|
* value: 'Blue',
|
|
62
72
|
* },
|
|
63
73
|
* );
|
|
@@ -70,6 +80,8 @@ export declare class Attributes extends APIResource {
|
|
|
70
80
|
* Remaining attributes in the property are shifted so their sort orders stay
|
|
71
81
|
* contiguous.
|
|
72
82
|
*
|
|
83
|
+
* This endpoint requires the permission: `properties:delete`.
|
|
84
|
+
*
|
|
73
85
|
* @example
|
|
74
86
|
* ```ts
|
|
75
87
|
* const attribute =
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"attributes.d.mts","sourceRoot":"","sources":["../../../src/resources/catalog/properties/attributes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC
|
|
1
|
+
{"version":3,"file":"attributes.d.mts","sourceRoot":"","sources":["../../../src/resources/catalog/properties/attributes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,aAAa,CAAC;IAI1C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAKtC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAItC;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAQtC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAIvC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,uBAAuB;CAAG;AAE3C,MAAM,WAAW,mBAAmB;IAClC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
|
|
@@ -9,6 +9,8 @@ export declare class Attributes extends APIResource {
|
|
|
9
9
|
/**
|
|
10
10
|
* Returns a paginated list of attributes for a property.
|
|
11
11
|
*
|
|
12
|
+
* This endpoint requires the permission: `properties:read`.
|
|
13
|
+
*
|
|
12
14
|
* @example
|
|
13
15
|
* ```ts
|
|
14
16
|
* const listAttribute =
|
|
@@ -21,6 +23,8 @@ export declare class Attributes extends APIResource {
|
|
|
21
23
|
/**
|
|
22
24
|
* Returns an attribute by ID within a property.
|
|
23
25
|
*
|
|
26
|
+
* This endpoint requires the permission: `properties:read`.
|
|
27
|
+
*
|
|
24
28
|
* @example
|
|
25
29
|
* ```ts
|
|
26
30
|
* const attribute =
|
|
@@ -34,6 +38,8 @@ export declare class Attributes extends APIResource {
|
|
|
34
38
|
/**
|
|
35
39
|
* Creates an attribute under a property.
|
|
36
40
|
*
|
|
41
|
+
* This endpoint requires the permission: `properties:create`.
|
|
42
|
+
*
|
|
37
43
|
* @example
|
|
38
44
|
* ```ts
|
|
39
45
|
* const attribute =
|
|
@@ -51,6 +57,8 @@ export declare class Attributes extends APIResource {
|
|
|
51
57
|
/**
|
|
52
58
|
* Partially updates an attribute.
|
|
53
59
|
*
|
|
60
|
+
* This endpoint requires the permission: `properties:update`.
|
|
61
|
+
*
|
|
54
62
|
* @example
|
|
55
63
|
* ```ts
|
|
56
64
|
* const attribute =
|
|
@@ -58,6 +66,8 @@ export declare class Attributes extends APIResource {
|
|
|
58
66
|
* 'at_01c9493ec0c46bb0ed12708ae4',
|
|
59
67
|
* {
|
|
60
68
|
* property_id: 'pp_01e21344878064372f69e67093',
|
|
69
|
+
* color: 'blue',
|
|
70
|
+
* sort_order: 2,
|
|
61
71
|
* value: 'Blue',
|
|
62
72
|
* },
|
|
63
73
|
* );
|
|
@@ -70,6 +80,8 @@ export declare class Attributes extends APIResource {
|
|
|
70
80
|
* Remaining attributes in the property are shifted so their sort orders stay
|
|
71
81
|
* contiguous.
|
|
72
82
|
*
|
|
83
|
+
* This endpoint requires the permission: `properties:delete`.
|
|
84
|
+
*
|
|
73
85
|
* @example
|
|
74
86
|
* ```ts
|
|
75
87
|
* const attribute =
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"attributes.d.ts","sourceRoot":"","sources":["../../../src/resources/catalog/properties/attributes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC
|
|
1
|
+
{"version":3,"file":"attributes.d.ts","sourceRoot":"","sources":["../../../src/resources/catalog/properties/attributes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,aAAa,CAAC;IAI1C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAKtC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAItC;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAQtC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAIvC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,uBAAuB;CAAG;AAE3C,MAAM,WAAW,mBAAmB;IAClC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
|
|
@@ -11,6 +11,8 @@ class Attributes extends resource_1.APIResource {
|
|
|
11
11
|
/**
|
|
12
12
|
* Returns a paginated list of attributes for a property.
|
|
13
13
|
*
|
|
14
|
+
* This endpoint requires the permission: `properties:read`.
|
|
15
|
+
*
|
|
14
16
|
* @example
|
|
15
17
|
* ```ts
|
|
16
18
|
* const listAttribute =
|
|
@@ -25,6 +27,8 @@ class Attributes extends resource_1.APIResource {
|
|
|
25
27
|
/**
|
|
26
28
|
* Returns an attribute by ID within a property.
|
|
27
29
|
*
|
|
30
|
+
* This endpoint requires the permission: `properties:read`.
|
|
31
|
+
*
|
|
28
32
|
* @example
|
|
29
33
|
* ```ts
|
|
30
34
|
* const attribute =
|
|
@@ -41,6 +45,8 @@ class Attributes extends resource_1.APIResource {
|
|
|
41
45
|
/**
|
|
42
46
|
* Creates an attribute under a property.
|
|
43
47
|
*
|
|
48
|
+
* This endpoint requires the permission: `properties:create`.
|
|
49
|
+
*
|
|
44
50
|
* @example
|
|
45
51
|
* ```ts
|
|
46
52
|
* const attribute =
|
|
@@ -60,6 +66,8 @@ class Attributes extends resource_1.APIResource {
|
|
|
60
66
|
/**
|
|
61
67
|
* Partially updates an attribute.
|
|
62
68
|
*
|
|
69
|
+
* This endpoint requires the permission: `properties:update`.
|
|
70
|
+
*
|
|
63
71
|
* @example
|
|
64
72
|
* ```ts
|
|
65
73
|
* const attribute =
|
|
@@ -67,6 +75,8 @@ class Attributes extends resource_1.APIResource {
|
|
|
67
75
|
* 'at_01c9493ec0c46bb0ed12708ae4',
|
|
68
76
|
* {
|
|
69
77
|
* property_id: 'pp_01e21344878064372f69e67093',
|
|
78
|
+
* color: 'blue',
|
|
79
|
+
* sort_order: 2,
|
|
70
80
|
* value: 'Blue',
|
|
71
81
|
* },
|
|
72
82
|
* );
|
|
@@ -85,6 +95,8 @@ class Attributes extends resource_1.APIResource {
|
|
|
85
95
|
* Remaining attributes in the property are shifted so their sort orders stay
|
|
86
96
|
* contiguous.
|
|
87
97
|
*
|
|
98
|
+
* This endpoint requires the permission: `properties:delete`.
|
|
99
|
+
*
|
|
88
100
|
* @example
|
|
89
101
|
* ```ts
|
|
90
102
|
* const attribute =
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"attributes.js","sourceRoot":"","sources":["../../../src/resources/catalog/properties/attributes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,UAAW,SAAQ,sBAAW;IACzC
|
|
1
|
+
{"version":3,"file":"attributes.js","sourceRoot":"","sources":["../../../src/resources/catalog/properties/attributes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,UAAkB,EAClB,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,UAAU,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,EAAU,EACV,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,WAAW,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,UAAkB,EAClB,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,0BAA0B,UAAU,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,EAAU,EACV,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,0BAA0B,WAAW,eAAe,EAAE,EAAE,EAAE;YACtF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,EAAU,EACV,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,0BAA0B,WAAW,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACpG,CAAC;CACF;AA/HD,gCA+HC"}
|
|
@@ -8,6 +8,8 @@ export class Attributes extends APIResource {
|
|
|
8
8
|
/**
|
|
9
9
|
* Returns a paginated list of attributes for a property.
|
|
10
10
|
*
|
|
11
|
+
* This endpoint requires the permission: `properties:read`.
|
|
12
|
+
*
|
|
11
13
|
* @example
|
|
12
14
|
* ```ts
|
|
13
15
|
* const listAttribute =
|
|
@@ -22,6 +24,8 @@ export class Attributes extends APIResource {
|
|
|
22
24
|
/**
|
|
23
25
|
* Returns an attribute by ID within a property.
|
|
24
26
|
*
|
|
27
|
+
* This endpoint requires the permission: `properties:read`.
|
|
28
|
+
*
|
|
25
29
|
* @example
|
|
26
30
|
* ```ts
|
|
27
31
|
* const attribute =
|
|
@@ -38,6 +42,8 @@ export class Attributes extends APIResource {
|
|
|
38
42
|
/**
|
|
39
43
|
* Creates an attribute under a property.
|
|
40
44
|
*
|
|
45
|
+
* This endpoint requires the permission: `properties:create`.
|
|
46
|
+
*
|
|
41
47
|
* @example
|
|
42
48
|
* ```ts
|
|
43
49
|
* const attribute =
|
|
@@ -57,6 +63,8 @@ export class Attributes extends APIResource {
|
|
|
57
63
|
/**
|
|
58
64
|
* Partially updates an attribute.
|
|
59
65
|
*
|
|
66
|
+
* This endpoint requires the permission: `properties:update`.
|
|
67
|
+
*
|
|
60
68
|
* @example
|
|
61
69
|
* ```ts
|
|
62
70
|
* const attribute =
|
|
@@ -64,6 +72,8 @@ export class Attributes extends APIResource {
|
|
|
64
72
|
* 'at_01c9493ec0c46bb0ed12708ae4',
|
|
65
73
|
* {
|
|
66
74
|
* property_id: 'pp_01e21344878064372f69e67093',
|
|
75
|
+
* color: 'blue',
|
|
76
|
+
* sort_order: 2,
|
|
67
77
|
* value: 'Blue',
|
|
68
78
|
* },
|
|
69
79
|
* );
|
|
@@ -82,6 +92,8 @@ export class Attributes extends APIResource {
|
|
|
82
92
|
* Remaining attributes in the property are shifted so their sort orders stay
|
|
83
93
|
* contiguous.
|
|
84
94
|
*
|
|
95
|
+
* This endpoint requires the permission: `properties:delete`.
|
|
96
|
+
*
|
|
85
97
|
* @example
|
|
86
98
|
* ```ts
|
|
87
99
|
* const attribute =
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"attributes.mjs","sourceRoot":"","sources":["../../../src/resources/catalog/properties/attributes.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC
|
|
1
|
+
{"version":3,"file":"attributes.mjs","sourceRoot":"","sources":["../../../src/resources/catalog/properties/attributes.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,UAAkB,EAClB,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,UAAU,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,EAAU,EACV,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,WAAW,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,UAAkB,EAClB,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,0BAA0B,UAAU,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,EAAU,EACV,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,0BAA0B,WAAW,eAAe,EAAE,EAAE,EAAE;YACtF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,EAAU,EACV,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,0BAA0B,WAAW,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACpG,CAAC;CACF"}
|