@augno/sdk 0.1.9 → 0.7.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 +4 -9
- package/README.md +27 -0
- package/api-promise.d.mts +0 -1
- package/api-promise.d.mts.map +1 -1
- package/api-promise.d.ts +0 -1
- package/api-promise.d.ts.map +1 -1
- package/api-promise.mjs +0 -1
- package/api-promise.mjs.map +1 -1
- package/client.d.mts +4 -1
- package/client.d.mts.map +1 -1
- package/client.d.ts +4 -1
- package/client.d.ts.map +1 -1
- package/client.js +9 -1
- package/client.js.map +1 -1
- package/client.mjs +9 -1
- package/client.mjs.map +1 -1
- package/core/api-promise.d.mts.map +1 -1
- package/core/api-promise.d.ts.map +1 -1
- package/core/api-promise.mjs.map +1 -1
- package/core/error.mjs.map +1 -1
- package/core/resource.d.mts.map +1 -1
- package/core/resource.d.ts.map +1 -1
- package/core/uploads.d.mts.map +1 -1
- package/core/uploads.d.ts.map +1 -1
- package/core/uploads.mjs.map +1 -1
- package/error.d.mts +0 -1
- package/error.d.mts.map +1 -1
- package/error.d.ts +0 -1
- package/error.d.ts.map +1 -1
- package/error.mjs +0 -1
- package/error.mjs.map +1 -1
- package/index.d.mts.map +1 -1
- package/index.d.ts.map +1 -1
- package/index.mjs.map +1 -1
- package/internal/headers.mjs.map +1 -1
- package/internal/parse.d.mts.map +1 -1
- package/internal/parse.d.ts.map +1 -1
- package/internal/parse.mjs.map +1 -1
- package/internal/qs/formats.d.mts.map +1 -1
- package/internal/qs/formats.d.ts.map +1 -1
- package/internal/qs/index.d.mts +2 -2
- package/internal/qs/index.d.mts.map +1 -1
- package/internal/qs/index.d.ts +2 -2
- package/internal/qs/index.d.ts.map +1 -1
- package/internal/qs/index.mjs.map +1 -1
- package/internal/qs/stringify.d.mts.map +1 -1
- package/internal/qs/stringify.d.ts.map +1 -1
- package/internal/qs/stringify.mjs.map +1 -1
- package/internal/qs/utils.d.mts.map +1 -1
- package/internal/qs/utils.d.ts.map +1 -1
- package/internal/qs/utils.mjs.map +1 -1
- package/internal/request-options.d.mts.map +1 -1
- package/internal/request-options.d.ts.map +1 -1
- package/internal/shims.d.mts +0 -6
- package/internal/shims.d.mts.map +1 -1
- package/internal/shims.d.ts +0 -6
- package/internal/shims.d.ts.map +1 -1
- package/internal/to-file.d.mts.map +1 -1
- package/internal/to-file.d.ts.map +1 -1
- package/internal/to-file.mjs.map +1 -1
- package/internal/types.d.mts +4 -4
- package/internal/types.d.mts.map +1 -1
- package/internal/types.d.ts +4 -4
- package/internal/types.d.ts.map +1 -1
- package/internal/uploads.d.mts.map +1 -1
- package/internal/uploads.d.ts.map +1 -1
- package/internal/uploads.mjs.map +1 -1
- package/internal/utils/base64.mjs.map +1 -1
- package/internal/utils/log.d.mts.map +1 -1
- package/internal/utils/log.d.ts.map +1 -1
- package/internal/utils/log.mjs.map +1 -1
- package/internal/utils/path.mjs.map +1 -1
- package/internal/utils/query.mjs.map +1 -1
- package/internal/utils/values.mjs.map +1 -1
- package/internal/utils.d.mts.map +1 -1
- package/internal/utils.d.ts.map +1 -1
- package/internal/utils.mjs.map +1 -1
- package/package.json +3 -3
- package/resource.d.mts +0 -1
- package/resource.d.mts.map +1 -1
- package/resource.d.ts +0 -1
- package/resource.d.ts.map +1 -1
- package/resource.mjs +0 -1
- package/resource.mjs.map +1 -1
- package/resources/auth/api-keys/actions.d.mts +26 -5
- package/resources/auth/api-keys/actions.d.mts.map +1 -1
- package/resources/auth/api-keys/actions.d.ts +26 -5
- package/resources/auth/api-keys/actions.d.ts.map +1 -1
- package/resources/auth/api-keys/actions.js +4 -1
- package/resources/auth/api-keys/actions.js.map +1 -1
- package/resources/auth/api-keys/actions.mjs +4 -1
- package/resources/auth/api-keys/actions.mjs.map +1 -1
- package/resources/auth/api-keys/api-keys.d.mts +134 -70
- package/resources/auth/api-keys/api-keys.d.mts.map +1 -1
- package/resources/auth/api-keys/api-keys.d.ts +134 -70
- package/resources/auth/api-keys/api-keys.d.ts.map +1 -1
- package/resources/auth/api-keys/api-keys.js +24 -22
- package/resources/auth/api-keys/api-keys.js.map +1 -1
- package/resources/auth/api-keys/api-keys.mjs +24 -22
- package/resources/auth/api-keys/api-keys.mjs.map +1 -1
- package/resources/auth/api-keys/index.d.mts +1 -1
- package/resources/auth/api-keys/index.d.mts.map +1 -1
- package/resources/auth/api-keys/index.d.ts +1 -1
- package/resources/auth/api-keys/index.d.ts.map +1 -1
- package/resources/auth/api-keys/index.mjs.map +1 -1
- package/resources/auth/api-keys.d.mts.map +1 -1
- package/resources/auth/api-keys.d.ts.map +1 -1
- package/resources/auth/api-keys.mjs.map +1 -1
- package/resources/auth/auth.d.mts +1 -1
- package/resources/auth/auth.d.mts.map +1 -1
- package/resources/auth/auth.d.ts +1 -1
- package/resources/auth/auth.d.ts.map +1 -1
- package/resources/auth/auth.mjs.map +1 -1
- package/resources/auth/index.d.mts +1 -1
- package/resources/auth/index.d.mts.map +1 -1
- package/resources/auth/index.d.ts +1 -1
- package/resources/auth/index.d.ts.map +1 -1
- package/resources/auth/index.mjs.map +1 -1
- package/resources/auth.d.mts.map +1 -1
- package/resources/auth.d.ts.map +1 -1
- package/resources/auth.mjs.map +1 -1
- package/resources/catalog/catalog.d.mts +9 -9
- package/resources/catalog/catalog.d.mts.map +1 -1
- package/resources/catalog/catalog.d.ts +9 -9
- package/resources/catalog/catalog.d.ts.map +1 -1
- package/resources/catalog/catalog.mjs.map +1 -1
- package/resources/catalog/index.d.mts +9 -9
- package/resources/catalog/index.d.mts.map +1 -1
- package/resources/catalog/index.d.ts +9 -9
- package/resources/catalog/index.d.ts.map +1 -1
- package/resources/catalog/index.mjs.map +1 -1
- package/resources/catalog/item-categories/index.d.mts +1 -1
- package/resources/catalog/item-categories/index.d.mts.map +1 -1
- package/resources/catalog/item-categories/index.d.ts +1 -1
- package/resources/catalog/item-categories/index.d.ts.map +1 -1
- package/resources/catalog/item-categories/index.mjs.map +1 -1
- package/resources/catalog/item-categories/item-categories.d.mts +95 -65
- package/resources/catalog/item-categories/item-categories.d.mts.map +1 -1
- package/resources/catalog/item-categories/item-categories.d.ts +95 -65
- package/resources/catalog/item-categories/item-categories.d.ts.map +1 -1
- package/resources/catalog/item-categories/item-categories.js +38 -30
- package/resources/catalog/item-categories/item-categories.js.map +1 -1
- package/resources/catalog/item-categories/item-categories.mjs +38 -30
- package/resources/catalog/item-categories/item-categories.mjs.map +1 -1
- package/resources/catalog/item-categories/properties.d.mts +9 -4
- package/resources/catalog/item-categories/properties.d.mts.map +1 -1
- package/resources/catalog/item-categories/properties.d.ts +9 -4
- package/resources/catalog/item-categories/properties.d.ts.map +1 -1
- package/resources/catalog/item-categories/properties.js +9 -4
- package/resources/catalog/item-categories/properties.js.map +1 -1
- package/resources/catalog/item-categories/properties.mjs +9 -4
- package/resources/catalog/item-categories/properties.mjs.map +1 -1
- package/resources/catalog/item-categories.d.mts.map +1 -1
- package/resources/catalog/item-categories.d.ts.map +1 -1
- package/resources/catalog/item-categories.mjs.map +1 -1
- package/resources/catalog/items/attributes.d.mts +3 -2
- package/resources/catalog/items/attributes.d.mts.map +1 -1
- package/resources/catalog/items/attributes.d.ts +3 -2
- package/resources/catalog/items/attributes.d.ts.map +1 -1
- package/resources/catalog/items/attributes.js +3 -2
- package/resources/catalog/items/attributes.js.map +1 -1
- package/resources/catalog/items/attributes.mjs +3 -2
- package/resources/catalog/items/attributes.mjs.map +1 -1
- package/resources/catalog/items/index.d.mts +1 -1
- package/resources/catalog/items/index.d.mts.map +1 -1
- package/resources/catalog/items/index.d.ts +1 -1
- package/resources/catalog/items/index.d.ts.map +1 -1
- package/resources/catalog/items/index.mjs.map +1 -1
- package/resources/catalog/items/items.d.mts +88 -52
- package/resources/catalog/items/items.d.mts.map +1 -1
- package/resources/catalog/items/items.d.ts +88 -52
- package/resources/catalog/items/items.d.ts.map +1 -1
- package/resources/catalog/items/items.js +24 -21
- package/resources/catalog/items/items.js.map +1 -1
- package/resources/catalog/items/items.mjs +24 -21
- package/resources/catalog/items/items.mjs.map +1 -1
- package/resources/catalog/items.d.mts.map +1 -1
- package/resources/catalog/items.d.ts.map +1 -1
- package/resources/catalog/items.mjs.map +1 -1
- package/resources/catalog/materials.d.mts +134 -87
- package/resources/catalog/materials.d.mts.map +1 -1
- package/resources/catalog/materials.d.ts +134 -87
- package/resources/catalog/materials.d.ts.map +1 -1
- package/resources/catalog/materials.js +29 -19
- package/resources/catalog/materials.js.map +1 -1
- package/resources/catalog/materials.mjs +29 -19
- package/resources/catalog/materials.mjs.map +1 -1
- package/resources/catalog/parts.d.mts +127 -74
- package/resources/catalog/parts.d.mts.map +1 -1
- package/resources/catalog/parts.d.ts +127 -74
- package/resources/catalog/parts.d.ts.map +1 -1
- package/resources/catalog/parts.js +34 -20
- package/resources/catalog/parts.js.map +1 -1
- package/resources/catalog/parts.mjs +34 -20
- package/resources/catalog/parts.mjs.map +1 -1
- package/resources/catalog/product-lines.d.mts +145 -70
- package/resources/catalog/product-lines.d.mts.map +1 -1
- package/resources/catalog/product-lines.d.ts +145 -70
- package/resources/catalog/product-lines.d.ts.map +1 -1
- package/resources/catalog/product-lines.js +31 -26
- package/resources/catalog/product-lines.js.map +1 -1
- package/resources/catalog/product-lines.mjs +31 -26
- package/resources/catalog/product-lines.mjs.map +1 -1
- package/resources/catalog/products.d.mts +187 -90
- package/resources/catalog/products.d.mts.map +1 -1
- package/resources/catalog/products.d.ts +187 -90
- package/resources/catalog/products.d.ts.map +1 -1
- package/resources/catalog/products.js +25 -20
- package/resources/catalog/products.js.map +1 -1
- package/resources/catalog/products.mjs +25 -20
- package/resources/catalog/products.mjs.map +1 -1
- package/resources/catalog/properties/attributes.d.mts +96 -44
- package/resources/catalog/properties/attributes.d.mts.map +1 -1
- package/resources/catalog/properties/attributes.d.ts +96 -44
- package/resources/catalog/properties/attributes.d.ts.map +1 -1
- package/resources/catalog/properties/attributes.js +31 -21
- package/resources/catalog/properties/attributes.js.map +1 -1
- package/resources/catalog/properties/attributes.mjs +31 -21
- package/resources/catalog/properties/attributes.mjs.map +1 -1
- package/resources/catalog/properties/index.d.mts +2 -2
- package/resources/catalog/properties/index.d.mts.map +1 -1
- package/resources/catalog/properties/index.d.ts +2 -2
- package/resources/catalog/properties/index.d.ts.map +1 -1
- package/resources/catalog/properties/index.mjs.map +1 -1
- package/resources/catalog/properties/properties.d.mts +70 -47
- package/resources/catalog/properties/properties.d.mts.map +1 -1
- package/resources/catalog/properties/properties.d.ts +70 -47
- package/resources/catalog/properties/properties.d.ts.map +1 -1
- package/resources/catalog/properties/properties.js +19 -18
- package/resources/catalog/properties/properties.js.map +1 -1
- package/resources/catalog/properties/properties.mjs +19 -18
- package/resources/catalog/properties/properties.mjs.map +1 -1
- package/resources/catalog/properties.d.mts.map +1 -1
- package/resources/catalog/properties.d.ts.map +1 -1
- package/resources/catalog/properties.mjs.map +1 -1
- package/resources/catalog/unit-groups/index.d.mts +2 -2
- package/resources/catalog/unit-groups/index.d.mts.map +1 -1
- package/resources/catalog/unit-groups/index.d.ts +2 -2
- package/resources/catalog/unit-groups/index.d.ts.map +1 -1
- package/resources/catalog/unit-groups/index.mjs.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.d.mts +130 -83
- package/resources/catalog/unit-groups/unit-groups.d.mts.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.d.ts +130 -83
- package/resources/catalog/unit-groups/unit-groups.d.ts.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.js +33 -24
- package/resources/catalog/unit-groups/unit-groups.js.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.mjs +33 -24
- package/resources/catalog/unit-groups/unit-groups.mjs.map +1 -1
- package/resources/catalog/unit-groups/units.d.mts +78 -54
- package/resources/catalog/unit-groups/units.d.mts.map +1 -1
- package/resources/catalog/unit-groups/units.d.ts +78 -54
- package/resources/catalog/unit-groups/units.d.ts.map +1 -1
- package/resources/catalog/unit-groups/units.js +34 -25
- package/resources/catalog/unit-groups/units.js.map +1 -1
- package/resources/catalog/unit-groups/units.mjs +34 -25
- package/resources/catalog/unit-groups/units.mjs.map +1 -1
- package/resources/catalog/unit-groups.d.mts.map +1 -1
- package/resources/catalog/unit-groups.d.ts.map +1 -1
- package/resources/catalog/unit-groups.mjs.map +1 -1
- package/resources/catalog/units.d.mts +100 -63
- package/resources/catalog/units.d.mts.map +1 -1
- package/resources/catalog/units.d.ts +100 -63
- package/resources/catalog/units.d.ts.map +1 -1
- package/resources/catalog/units.js +26 -25
- package/resources/catalog/units.js.map +1 -1
- package/resources/catalog/units.mjs +26 -25
- package/resources/catalog/units.mjs.map +1 -1
- package/resources/catalog.d.mts.map +1 -1
- package/resources/catalog.d.ts.map +1 -1
- package/resources/catalog.mjs.map +1 -1
- package/resources/core/addresses/actions.d.mts +12 -5
- package/resources/core/addresses/actions.d.mts.map +1 -1
- package/resources/core/addresses/actions.d.ts +12 -5
- package/resources/core/addresses/actions.d.ts.map +1 -1
- package/resources/core/addresses/actions.mjs.map +1 -1
- package/resources/core/addresses/addresses.d.mts +5 -2
- package/resources/core/addresses/addresses.d.mts.map +1 -1
- package/resources/core/addresses/addresses.d.ts +5 -2
- package/resources/core/addresses/addresses.d.ts.map +1 -1
- package/resources/core/addresses/addresses.js.map +1 -1
- package/resources/core/addresses/addresses.mjs.map +1 -1
- package/resources/core/addresses/index.d.mts.map +1 -1
- package/resources/core/addresses/index.d.ts.map +1 -1
- package/resources/core/addresses/index.mjs.map +1 -1
- package/resources/core/addresses.d.mts.map +1 -1
- package/resources/core/addresses.d.ts.map +1 -1
- package/resources/core/addresses.mjs.map +1 -1
- package/resources/core/audit-events.d.mts +78 -34
- package/resources/core/audit-events.d.mts.map +1 -1
- package/resources/core/audit-events.d.ts +78 -34
- package/resources/core/audit-events.d.ts.map +1 -1
- package/resources/core/audit-events.js +13 -10
- package/resources/core/audit-events.js.map +1 -1
- package/resources/core/audit-events.mjs +13 -10
- package/resources/core/audit-events.mjs.map +1 -1
- package/resources/core/core.d.mts +4 -4
- package/resources/core/core.d.mts.map +1 -1
- package/resources/core/core.d.ts +4 -4
- package/resources/core/core.d.ts.map +1 -1
- package/resources/core/core.mjs.map +1 -1
- package/resources/core/email-logs.d.mts +31 -21
- package/resources/core/email-logs.d.mts.map +1 -1
- package/resources/core/email-logs.d.ts +31 -21
- package/resources/core/email-logs.d.ts.map +1 -1
- package/resources/core/email-logs.js +10 -10
- package/resources/core/email-logs.js.map +1 -1
- package/resources/core/email-logs.mjs +10 -10
- package/resources/core/email-logs.mjs.map +1 -1
- package/resources/core/index.d.mts +4 -4
- package/resources/core/index.d.mts.map +1 -1
- package/resources/core/index.d.ts +4 -4
- package/resources/core/index.d.ts.map +1 -1
- package/resources/core/index.mjs.map +1 -1
- package/resources/core/request-logs.d.mts +87 -48
- package/resources/core/request-logs.d.mts.map +1 -1
- package/resources/core/request-logs.d.ts +87 -48
- package/resources/core/request-logs.d.ts.map +1 -1
- package/resources/core/request-logs.js +10 -10
- package/resources/core/request-logs.js.map +1 -1
- package/resources/core/request-logs.mjs +10 -10
- package/resources/core/request-logs.mjs.map +1 -1
- package/resources/core/sandboxes.d.mts +52 -31
- package/resources/core/sandboxes.d.mts.map +1 -1
- package/resources/core/sandboxes.d.ts +52 -31
- package/resources/core/sandboxes.d.ts.map +1 -1
- package/resources/core/sandboxes.js +20 -13
- package/resources/core/sandboxes.js.map +1 -1
- package/resources/core/sandboxes.mjs +20 -13
- package/resources/core/sandboxes.mjs.map +1 -1
- package/resources/core.d.mts.map +1 -1
- package/resources/core.d.ts.map +1 -1
- package/resources/core.mjs.map +1 -1
- package/resources/finance/finance.d.mts +69 -35
- package/resources/finance/finance.d.mts.map +1 -1
- package/resources/finance/finance.d.ts +69 -35
- package/resources/finance/finance.d.ts.map +1 -1
- package/resources/finance/finance.js +10 -10
- package/resources/finance/finance.js.map +1 -1
- package/resources/finance/finance.mjs +10 -10
- package/resources/finance/finance.mjs.map +1 -1
- package/resources/finance/index.d.mts +2 -2
- package/resources/finance/index.d.mts.map +1 -1
- package/resources/finance/index.d.ts +2 -2
- package/resources/finance/index.d.ts.map +1 -1
- package/resources/finance/index.mjs.map +1 -1
- package/resources/finance/payment-terms.d.mts +72 -43
- package/resources/finance/payment-terms.d.mts.map +1 -1
- package/resources/finance/payment-terms.d.ts +72 -43
- package/resources/finance/payment-terms.d.ts.map +1 -1
- package/resources/finance/payment-terms.js +33 -22
- package/resources/finance/payment-terms.js.map +1 -1
- package/resources/finance/payment-terms.mjs +33 -22
- package/resources/finance/payment-terms.mjs.map +1 -1
- package/resources/finance.d.mts.map +1 -1
- package/resources/finance.d.ts.map +1 -1
- package/resources/finance.mjs.map +1 -1
- package/resources/identity/account-users/account-users.d.mts +166 -79
- package/resources/identity/account-users/account-users.d.mts.map +1 -1
- package/resources/identity/account-users/account-users.d.ts +166 -79
- package/resources/identity/account-users/account-users.d.ts.map +1 -1
- package/resources/identity/account-users/account-users.js +43 -25
- package/resources/identity/account-users/account-users.js.map +1 -1
- package/resources/identity/account-users/account-users.mjs +43 -25
- package/resources/identity/account-users/account-users.mjs.map +1 -1
- package/resources/identity/account-users/actions.d.mts +13 -3
- package/resources/identity/account-users/actions.d.mts.map +1 -1
- package/resources/identity/account-users/actions.d.ts +13 -3
- package/resources/identity/account-users/actions.d.ts.map +1 -1
- package/resources/identity/account-users/actions.js +13 -3
- package/resources/identity/account-users/actions.js.map +1 -1
- package/resources/identity/account-users/actions.mjs +13 -3
- package/resources/identity/account-users/actions.mjs.map +1 -1
- package/resources/identity/account-users/index.d.mts +1 -1
- package/resources/identity/account-users/index.d.mts.map +1 -1
- package/resources/identity/account-users/index.d.ts +1 -1
- package/resources/identity/account-users/index.d.ts.map +1 -1
- package/resources/identity/account-users/index.mjs.map +1 -1
- package/resources/identity/account-users.d.mts.map +1 -1
- package/resources/identity/account-users.d.ts.map +1 -1
- package/resources/identity/account-users.mjs.map +1 -1
- package/resources/identity/identity.d.mts +2 -2
- package/resources/identity/identity.d.mts.map +1 -1
- package/resources/identity/identity.d.ts +2 -2
- package/resources/identity/identity.d.ts.map +1 -1
- package/resources/identity/identity.mjs.map +1 -1
- package/resources/identity/index.d.mts +2 -2
- package/resources/identity/index.d.mts.map +1 -1
- package/resources/identity/index.d.ts +2 -2
- package/resources/identity/index.d.ts.map +1 -1
- package/resources/identity/index.mjs.map +1 -1
- package/resources/identity/roles.d.mts +88 -61
- package/resources/identity/roles.d.mts.map +1 -1
- package/resources/identity/roles.d.ts +88 -61
- package/resources/identity/roles.d.ts.map +1 -1
- package/resources/identity/roles.js +33 -27
- package/resources/identity/roles.js.map +1 -1
- package/resources/identity/roles.mjs +33 -27
- package/resources/identity/roles.mjs.map +1 -1
- package/resources/identity.d.mts.map +1 -1
- package/resources/identity.d.ts.map +1 -1
- package/resources/identity.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/operations/carriers/carriers.d.mts +88 -59
- package/resources/operations/carriers/carriers.d.mts.map +1 -1
- package/resources/operations/carriers/carriers.d.ts +88 -59
- package/resources/operations/carriers/carriers.d.ts.map +1 -1
- package/resources/operations/carriers/carriers.js +29 -21
- package/resources/operations/carriers/carriers.js.map +1 -1
- package/resources/operations/carriers/carriers.mjs +29 -21
- package/resources/operations/carriers/carriers.mjs.map +1 -1
- package/resources/operations/carriers/index.d.mts +2 -2
- package/resources/operations/carriers/index.d.mts.map +1 -1
- package/resources/operations/carriers/index.d.ts +2 -2
- package/resources/operations/carriers/index.d.ts.map +1 -1
- package/resources/operations/carriers/index.mjs.map +1 -1
- package/resources/operations/carriers/service-levels.d.mts +115 -68
- package/resources/operations/carriers/service-levels.d.mts.map +1 -1
- package/resources/operations/carriers/service-levels.d.ts +115 -68
- package/resources/operations/carriers/service-levels.d.ts.map +1 -1
- package/resources/operations/carriers/service-levels.js +37 -30
- package/resources/operations/carriers/service-levels.js.map +1 -1
- package/resources/operations/carriers/service-levels.mjs +37 -30
- package/resources/operations/carriers/service-levels.mjs.map +1 -1
- package/resources/operations/carriers.d.mts.map +1 -1
- package/resources/operations/carriers.d.ts.map +1 -1
- package/resources/operations/carriers.mjs.map +1 -1
- package/resources/operations/index.d.mts +4 -4
- package/resources/operations/index.d.mts.map +1 -1
- package/resources/operations/index.d.ts +4 -4
- package/resources/operations/index.d.ts.map +1 -1
- package/resources/operations/index.mjs.map +1 -1
- package/resources/operations/location-types.d.mts +33 -18
- package/resources/operations/location-types.d.mts.map +1 -1
- package/resources/operations/location-types.d.ts +33 -18
- package/resources/operations/location-types.d.ts.map +1 -1
- package/resources/operations/location-types.js +12 -12
- package/resources/operations/location-types.js.map +1 -1
- package/resources/operations/location-types.mjs +12 -12
- package/resources/operations/location-types.mjs.map +1 -1
- package/resources/operations/locations.d.mts +131 -65
- package/resources/operations/locations.d.mts.map +1 -1
- package/resources/operations/locations.d.ts +131 -65
- package/resources/operations/locations.d.ts.map +1 -1
- package/resources/operations/locations.js +24 -20
- package/resources/operations/locations.js.map +1 -1
- package/resources/operations/locations.mjs +24 -20
- package/resources/operations/locations.mjs.map +1 -1
- package/resources/operations/operations.d.mts +4 -4
- package/resources/operations/operations.d.mts.map +1 -1
- package/resources/operations/operations.d.ts +4 -4
- package/resources/operations/operations.d.ts.map +1 -1
- package/resources/operations/operations.mjs.map +1 -1
- package/resources/operations/scanning-stations.d.mts +143 -69
- package/resources/operations/scanning-stations.d.mts.map +1 -1
- package/resources/operations/scanning-stations.d.ts +143 -69
- package/resources/operations/scanning-stations.d.ts.map +1 -1
- package/resources/operations/scanning-stations.js +32 -23
- package/resources/operations/scanning-stations.js.map +1 -1
- package/resources/operations/scanning-stations.mjs +32 -23
- package/resources/operations/scanning-stations.mjs.map +1 -1
- package/resources/operations/shipping-terms.d.mts +117 -81
- package/resources/operations/shipping-terms.d.mts.map +1 -1
- package/resources/operations/shipping-terms.d.ts +117 -81
- package/resources/operations/shipping-terms.d.ts.map +1 -1
- package/resources/operations/shipping-terms.js +28 -26
- package/resources/operations/shipping-terms.js.map +1 -1
- package/resources/operations/shipping-terms.mjs +28 -26
- package/resources/operations/shipping-terms.mjs.map +1 -1
- package/resources/operations.d.mts.map +1 -1
- package/resources/operations.d.ts.map +1 -1
- package/resources/operations.mjs.map +1 -1
- package/resources/sales/account-groups.d.mts +111 -80
- package/resources/sales/account-groups.d.mts.map +1 -1
- package/resources/sales/account-groups.d.ts +111 -80
- package/resources/sales/account-groups.d.ts.map +1 -1
- package/resources/sales/account-groups.js +30 -21
- package/resources/sales/account-groups.js.map +1 -1
- package/resources/sales/account-groups.mjs +30 -21
- package/resources/sales/account-groups.mjs.map +1 -1
- package/resources/sales/account-statuses.d.mts +41 -23
- package/resources/sales/account-statuses.d.mts.map +1 -1
- package/resources/sales/account-statuses.d.ts +41 -23
- package/resources/sales/account-statuses.d.ts.map +1 -1
- package/resources/sales/account-statuses.js +16 -13
- package/resources/sales/account-statuses.js.map +1 -1
- package/resources/sales/account-statuses.mjs +16 -13
- package/resources/sales/account-statuses.mjs.map +1 -1
- package/resources/sales/addresses.d.mts +83 -36
- package/resources/sales/addresses.d.mts.map +1 -1
- package/resources/sales/addresses.d.ts +83 -36
- package/resources/sales/addresses.d.ts.map +1 -1
- package/resources/sales/addresses.js +29 -19
- package/resources/sales/addresses.js.map +1 -1
- package/resources/sales/addresses.mjs +29 -19
- package/resources/sales/addresses.mjs.map +1 -1
- package/resources/sales/customers/actions.d.mts +15 -5
- package/resources/sales/customers/actions.d.mts.map +1 -1
- package/resources/sales/customers/actions.d.ts +15 -5
- package/resources/sales/customers/actions.d.ts.map +1 -1
- package/resources/sales/customers/actions.js +6 -2
- package/resources/sales/customers/actions.js.map +1 -1
- package/resources/sales/customers/actions.mjs +6 -2
- package/resources/sales/customers/actions.mjs.map +1 -1
- package/resources/sales/customers/customers.d.mts +588 -291
- package/resources/sales/customers/customers.d.mts.map +1 -1
- package/resources/sales/customers/customers.d.ts +588 -291
- package/resources/sales/customers/customers.d.ts.map +1 -1
- package/resources/sales/customers/customers.js +58 -30
- package/resources/sales/customers/customers.js.map +1 -1
- package/resources/sales/customers/customers.mjs +58 -30
- 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/customers.d.mts.map +1 -1
- package/resources/sales/customers.d.ts.map +1 -1
- package/resources/sales/customers.mjs.map +1 -1
- package/resources/sales/index.d.mts +6 -6
- package/resources/sales/index.d.mts.map +1 -1
- package/resources/sales/index.d.ts +6 -6
- package/resources/sales/index.d.ts.map +1 -1
- package/resources/sales/index.js.map +1 -1
- package/resources/sales/index.mjs.map +1 -1
- package/resources/sales/priorities.d.mts +31 -21
- package/resources/sales/priorities.d.mts.map +1 -1
- package/resources/sales/priorities.d.ts +31 -21
- package/resources/sales/priorities.d.ts.map +1 -1
- package/resources/sales/priorities.js +10 -10
- package/resources/sales/priorities.js.map +1 -1
- package/resources/sales/priorities.mjs +10 -10
- package/resources/sales/priorities.mjs.map +1 -1
- package/resources/sales/sales-orders.d.mts +877 -7
- package/resources/sales/sales-orders.d.mts.map +1 -1
- package/resources/sales/sales-orders.d.ts +877 -7
- package/resources/sales/sales-orders.d.ts.map +1 -1
- package/resources/sales/sales-orders.js +45 -3
- package/resources/sales/sales-orders.js.map +1 -1
- package/resources/sales/sales-orders.mjs +45 -3
- package/resources/sales/sales-orders.mjs.map +1 -1
- package/resources/sales/sales.d.mts +8 -8
- package/resources/sales/sales.d.mts.map +1 -1
- package/resources/sales/sales.d.ts +8 -8
- package/resources/sales/sales.d.ts.map +1 -1
- package/resources/sales/sales.js.map +1 -1
- package/resources/sales/sales.mjs.map +1 -1
- package/resources/sales.d.mts.map +1 -1
- package/resources/sales.d.ts.map +1 -1
- package/resources/sales.mjs.map +1 -1
- package/resources/settings/index.d.mts +3 -0
- package/resources/settings/index.d.mts.map +1 -0
- package/resources/settings/index.d.ts +3 -0
- package/resources/settings/index.d.ts.map +1 -0
- package/resources/settings/index.js +9 -0
- package/resources/settings/index.js.map +1 -0
- package/resources/settings/index.mjs +4 -0
- package/resources/settings/index.mjs.map +1 -0
- package/resources/settings/integrations.d.mts +238 -0
- package/resources/settings/integrations.d.mts.map +1 -0
- package/resources/settings/integrations.d.ts +238 -0
- package/resources/settings/integrations.d.ts.map +1 -0
- package/resources/settings/integrations.js +80 -0
- package/resources/settings/integrations.js.map +1 -0
- package/resources/settings/integrations.mjs +76 -0
- package/resources/settings/integrations.mjs.map +1 -0
- package/resources/settings/settings.d.mts +10 -0
- package/resources/settings/settings.d.mts.map +1 -0
- package/resources/settings/settings.d.ts +10 -0
- package/resources/settings/settings.d.ts.map +1 -0
- package/resources/settings/settings.js +17 -0
- package/resources/settings/settings.js.map +1 -0
- package/resources/settings/settings.mjs +12 -0
- package/resources/settings/settings.mjs.map +1 -0
- package/resources/settings.d.mts +2 -0
- package/resources/settings.d.mts.map +1 -0
- package/resources/settings.d.ts +2 -0
- package/resources/settings.d.ts.map +1 -0
- package/resources/settings.js +6 -0
- package/resources/settings.js.map +1 -0
- package/resources/settings.mjs +3 -0
- package/resources/settings.mjs.map +1 -0
- package/resources.d.mts.map +1 -1
- package/resources.d.ts.map +1 -1
- package/resources.mjs.map +1 -1
- package/src/client.ts +13 -3
- package/src/resources/auth/api-keys/actions.ts +28 -5
- package/src/resources/auth/api-keys/api-keys.ts +142 -78
- package/src/resources/auth/api-keys/index.ts +1 -1
- package/src/resources/auth/auth.ts +1 -1
- package/src/resources/auth/index.ts +1 -1
- package/src/resources/catalog/catalog.ts +18 -18
- package/src/resources/catalog/index.ts +18 -18
- package/src/resources/catalog/item-categories/index.ts +2 -2
- package/src/resources/catalog/item-categories/item-categories.ts +116 -86
- package/src/resources/catalog/item-categories/properties.ts +9 -4
- package/src/resources/catalog/items/attributes.ts +3 -2
- package/src/resources/catalog/items/index.ts +2 -2
- package/src/resources/catalog/items/items.ts +111 -75
- package/src/resources/catalog/materials.ts +159 -112
- package/src/resources/catalog/parts.ts +145 -92
- package/src/resources/catalog/product-lines.ts +160 -85
- package/src/resources/catalog/products.ts +205 -108
- package/src/resources/catalog/properties/attributes.ts +110 -58
- package/src/resources/catalog/properties/index.ts +4 -4
- package/src/resources/catalog/properties/properties.ts +84 -61
- package/src/resources/catalog/unit-groups/index.ts +4 -4
- package/src/resources/catalog/unit-groups/unit-groups.ts +144 -97
- package/src/resources/catalog/unit-groups/units.ts +97 -73
- package/src/resources/catalog/units.ts +114 -77
- package/src/resources/core/addresses/actions.ts +12 -5
- package/src/resources/core/addresses/addresses.ts +5 -2
- package/src/resources/core/audit-events.ts +142 -47
- package/src/resources/core/core.ts +5 -5
- package/src/resources/core/email-logs.ts +39 -29
- package/src/resources/core/index.ts +5 -5
- package/src/resources/core/request-logs.ts +104 -64
- package/src/resources/core/sandboxes.ts +57 -36
- package/src/resources/finance/finance.ts +78 -44
- package/src/resources/finance/index.ts +4 -4
- package/src/resources/finance/payment-terms.ts +85 -56
- package/src/resources/identity/account-users/account-users.ts +180 -93
- package/src/resources/identity/account-users/actions.ts +13 -3
- package/src/resources/identity/account-users/index.ts +2 -2
- package/src/resources/identity/identity.ts +4 -4
- package/src/resources/identity/index.ts +4 -4
- package/src/resources/identity/roles.ts +96 -69
- package/src/resources/index.ts +3 -2
- package/src/resources/operations/carriers/carriers.ts +97 -68
- package/src/resources/operations/carriers/index.ts +4 -4
- package/src/resources/operations/carriers/service-levels.ts +136 -89
- package/src/resources/operations/index.ts +8 -8
- package/src/resources/operations/location-types.ts +38 -23
- package/src/resources/operations/locations.ts +140 -74
- package/src/resources/operations/operations.ts +8 -8
- package/src/resources/operations/scanning-stations.ts +160 -86
- package/src/resources/operations/shipping-terms.ts +134 -98
- package/src/resources/sales/account-groups.ts +122 -91
- package/src/resources/sales/account-statuses.ts +48 -30
- package/src/resources/sales/addresses.ts +91 -44
- package/src/resources/sales/customers/actions.ts +15 -4
- package/src/resources/sales/customers/customers.ts +660 -351
- package/src/resources/sales/customers/index.ts +4 -2
- package/src/resources/sales/index.ts +25 -6
- package/src/resources/sales/priorities.ts +39 -29
- package/src/resources/sales/sales-orders.ts +1113 -21
- package/src/resources/sales/sales.ts +44 -6
- package/src/resources/settings/index.ts +13 -0
- package/src/resources/settings/integrations.ts +291 -0
- package/src/resources/settings/settings.ts +33 -0
- package/src/resources/settings.ts +3 -0
- package/src/version.ts +1 -1
- package/uploads.d.mts +0 -1
- package/uploads.d.mts.map +1 -1
- package/uploads.d.ts +0 -1
- package/uploads.d.ts.map +1 -1
- package/uploads.mjs +0 -1
- package/uploads.mjs.map +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,17 +12,6 @@ import { RequestOptions } from "../../../internal/request-options.mjs";
|
|
|
12
12
|
*/
|
|
13
13
|
export declare class Items extends APIResource {
|
|
14
14
|
attributes: AttributesAPI.Attributes;
|
|
15
|
-
/**
|
|
16
|
-
* Returns an item by ID.
|
|
17
|
-
*
|
|
18
|
-
* @example
|
|
19
|
-
* ```ts
|
|
20
|
-
* const item = await client.catalog.items.retrieve(
|
|
21
|
-
* 'it_0131e386ac683e8c29a71f6f1f',
|
|
22
|
-
* );
|
|
23
|
-
* ```
|
|
24
|
-
*/
|
|
25
|
-
retrieve(id: string, query?: ItemRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Item>;
|
|
26
15
|
/**
|
|
27
16
|
* Returns a paginated list of items.
|
|
28
17
|
*
|
|
@@ -33,18 +22,16 @@ export declare class Items extends APIResource {
|
|
|
33
22
|
*/
|
|
34
23
|
list(query?: ItemListParams | null | undefined, options?: RequestOptions): APIPromise<ListItem>;
|
|
35
24
|
/**
|
|
36
|
-
*
|
|
37
|
-
* units are updated to the new category's base unit.
|
|
25
|
+
* Returns an item by ID.
|
|
38
26
|
*
|
|
39
27
|
* @example
|
|
40
28
|
* ```ts
|
|
41
|
-
* const item = await client.catalog.items.
|
|
42
|
-
* '
|
|
43
|
-
* { id: 'it_0131e386ac683e8c29a71f6f1f' },
|
|
29
|
+
* const item = await client.catalog.items.retrieve(
|
|
30
|
+
* 'it_0131e386ac683e8c29a71f6f1f',
|
|
44
31
|
* );
|
|
45
32
|
* ```
|
|
46
33
|
*/
|
|
47
|
-
|
|
34
|
+
retrieve(id: string, query?: ItemRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Item>;
|
|
48
35
|
/**
|
|
49
36
|
* Returns inventory quantities for an item, including on-hand, reserved,
|
|
50
37
|
* available-to-promise, and short amounts.
|
|
@@ -58,6 +45,22 @@ export declare class Items extends APIResource {
|
|
|
58
45
|
* ```
|
|
59
46
|
*/
|
|
60
47
|
retrieveInventory(id: string, query?: ItemRetrieveInventoryParams | null | undefined, options?: RequestOptions): APIPromise<ItemInventory>;
|
|
48
|
+
/**
|
|
49
|
+
* Moves an item to a different category.
|
|
50
|
+
*
|
|
51
|
+
* The item's rate units (unit value, unit cost, burn rate) and any related
|
|
52
|
+
* order-point, consumption, and production quantity units are updated to the new
|
|
53
|
+
* category's base unit. Re-assigning the item's current category is a no-op.
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* ```ts
|
|
57
|
+
* const item = await client.catalog.items.changeCategory(
|
|
58
|
+
* 'ic_01ae7bd7bfd21ca0ab81e1357e',
|
|
59
|
+
* { id: 'it_0131e386ac683e8c29a71f6f1f' },
|
|
60
|
+
* );
|
|
61
|
+
* ```
|
|
62
|
+
*/
|
|
63
|
+
changeCategory(categoryID: string, params: ItemChangeCategoryParams, options?: RequestOptions): APIPromise<Item>;
|
|
61
64
|
}
|
|
62
65
|
/**
|
|
63
66
|
* Item is an inventory item (product, material, or part).
|
|
@@ -72,11 +75,13 @@ export interface Item {
|
|
|
72
75
|
*/
|
|
73
76
|
attributes: PropertiesAPI.ListAttribute | null;
|
|
74
77
|
/**
|
|
75
|
-
*
|
|
78
|
+
* Value expressed as a ratio of two units, such as a price per kilogram or a
|
|
79
|
+
* throughput per hour.
|
|
76
80
|
*/
|
|
77
81
|
burn_rate: Rate | null;
|
|
78
82
|
/**
|
|
79
|
-
*
|
|
83
|
+
* A grouping of related catalog items that defines the unit group and properties
|
|
84
|
+
* available to the items within it.
|
|
80
85
|
*/
|
|
81
86
|
category: ItemCategory | null;
|
|
82
87
|
/**
|
|
@@ -88,7 +93,7 @@ export interface Item {
|
|
|
88
93
|
*/
|
|
89
94
|
description: string | null;
|
|
90
95
|
/**
|
|
91
|
-
*
|
|
96
|
+
* Free-form notes about the item.
|
|
92
97
|
*/
|
|
93
98
|
notes: string | null;
|
|
94
99
|
/**
|
|
@@ -96,19 +101,25 @@ export interface Item {
|
|
|
96
101
|
*/
|
|
97
102
|
object: 'item';
|
|
98
103
|
/**
|
|
99
|
-
* Stock keeping unit code.
|
|
104
|
+
* Stock keeping unit code, unique within the account.
|
|
100
105
|
*/
|
|
101
106
|
sku: string;
|
|
102
107
|
/**
|
|
103
|
-
*
|
|
108
|
+
* What kind of item this is.
|
|
109
|
+
*
|
|
110
|
+
* - `product`: a finished product.
|
|
111
|
+
* - `material`: a raw material or component consumed in production.
|
|
112
|
+
* - `part`: a part used in production.
|
|
104
113
|
*/
|
|
105
114
|
type: 'product' | 'material' | 'part';
|
|
106
115
|
/**
|
|
107
|
-
*
|
|
116
|
+
* Value expressed as a ratio of two units, such as a price per kilogram or a
|
|
117
|
+
* throughput per hour.
|
|
108
118
|
*/
|
|
109
119
|
unit_cost: Rate | null;
|
|
110
120
|
/**
|
|
111
|
-
*
|
|
121
|
+
* Value expressed as a ratio of two units, such as a price per kilogram or a
|
|
122
|
+
* throughput per hour.
|
|
112
123
|
*/
|
|
113
124
|
unit_value: Rate | null;
|
|
114
125
|
/**
|
|
@@ -117,7 +128,8 @@ export interface Item {
|
|
|
117
128
|
updated_at: string;
|
|
118
129
|
}
|
|
119
130
|
/**
|
|
120
|
-
*
|
|
131
|
+
* A grouping of related catalog items that defines the unit group and properties
|
|
132
|
+
* available to the items within it.
|
|
121
133
|
*/
|
|
122
134
|
export interface ItemCategory {
|
|
123
135
|
/**
|
|
@@ -129,11 +141,11 @@ export interface ItemCategory {
|
|
|
129
141
|
*/
|
|
130
142
|
created_at: string;
|
|
131
143
|
/**
|
|
132
|
-
* Display name.
|
|
144
|
+
* Display name of the item category.
|
|
133
145
|
*/
|
|
134
146
|
name: string;
|
|
135
147
|
/**
|
|
136
|
-
*
|
|
148
|
+
* Free-form notes about the item category.
|
|
137
149
|
*/
|
|
138
150
|
notes: string | null;
|
|
139
151
|
/**
|
|
@@ -149,11 +161,19 @@ export interface ItemCategory {
|
|
|
149
161
|
*/
|
|
150
162
|
properties: PropertiesAPI.ListProperty | null;
|
|
151
163
|
/**
|
|
152
|
-
*
|
|
164
|
+
* What kind of items this category groups.
|
|
165
|
+
*
|
|
166
|
+
* An item can only be assigned to a category whose type matches the item's `type`.
|
|
167
|
+
*
|
|
168
|
+
* - `material_category`: groups raw materials and components (items of type
|
|
169
|
+
* `material`).
|
|
170
|
+
* - `product_category`: groups finished products and parts (items of type
|
|
171
|
+
* `product` or `part`).
|
|
153
172
|
*/
|
|
154
173
|
type: 'material_category' | 'product_category';
|
|
155
174
|
/**
|
|
156
|
-
*
|
|
175
|
+
* Named collection of units sharing one dimension, defining which units products
|
|
176
|
+
* can be ordered in along with per-unit discounts and customer portal visibility.
|
|
157
177
|
*/
|
|
158
178
|
unit_group: UnitGroupsAPI.UnitGroup | null;
|
|
159
179
|
/**
|
|
@@ -224,12 +244,16 @@ export interface Quantity {
|
|
|
224
244
|
*/
|
|
225
245
|
unit: UnitsAPI.Unit | null;
|
|
226
246
|
/**
|
|
227
|
-
*
|
|
247
|
+
* Raw decimal value of the quantity, as a string to preserve precision.
|
|
248
|
+
*
|
|
249
|
+
* This is the unformatted machine value; see `display_value` for the
|
|
250
|
+
* human-readable rendering with unit and thousands separators.
|
|
228
251
|
*/
|
|
229
252
|
value: string;
|
|
230
253
|
}
|
|
231
254
|
/**
|
|
232
|
-
*
|
|
255
|
+
* Value expressed as a ratio of two units, such as a price per kilogram or a
|
|
256
|
+
* throughput per hour.
|
|
233
257
|
*/
|
|
234
258
|
export interface Rate {
|
|
235
259
|
/**
|
|
@@ -261,17 +285,12 @@ export interface Rate {
|
|
|
261
285
|
*/
|
|
262
286
|
updated_at: string;
|
|
263
287
|
/**
|
|
264
|
-
*
|
|
288
|
+
* Decimal value of the rate, as a string to preserve precision.
|
|
289
|
+
*
|
|
290
|
+
* Expressed as the amount of the numerator unit per one denominator unit.
|
|
265
291
|
*/
|
|
266
292
|
value: string;
|
|
267
293
|
}
|
|
268
|
-
export interface ItemRetrieveParams {
|
|
269
|
-
/**
|
|
270
|
-
* Sub-objects to expand in the response. When omitted, sub-objects are returned as
|
|
271
|
-
* `null`.
|
|
272
|
-
*/
|
|
273
|
-
include?: Array<'category' | 'unit_value' | 'unit_cost' | 'burn_rate' | 'attributes' | 'category.unit_group' | 'category.properties' | 'category.unit_group.base_unit' | 'category.unit_group.associated_units' | 'category.unit_group.associated_units.unit'>;
|
|
274
|
-
}
|
|
275
294
|
export interface ItemListParams {
|
|
276
295
|
/**
|
|
277
296
|
* Filter by attribute IDs.
|
|
@@ -282,7 +301,11 @@ export interface ItemListParams {
|
|
|
282
301
|
*/
|
|
283
302
|
category_ids?: Array<string>;
|
|
284
303
|
/**
|
|
285
|
-
*
|
|
304
|
+
* Opaque cursor token identifying where the page of results starts.
|
|
305
|
+
*
|
|
306
|
+
* Use the `cursor` value embedded in a previous response's `next_page_url` or
|
|
307
|
+
* `previous_page_url` to fetch the adjacent page. Omit to start from the first
|
|
308
|
+
* page.
|
|
286
309
|
*/
|
|
287
310
|
cursor?: string;
|
|
288
311
|
/**
|
|
@@ -300,7 +323,7 @@ export interface ItemListParams {
|
|
|
300
323
|
*/
|
|
301
324
|
include?: Array<'category' | 'unit_value' | 'unit_cost' | 'burn_rate' | 'attributes' | 'category.unit_group' | 'category.properties' | 'category.unit_group.base_unit' | 'category.unit_group.associated_units' | 'category.unit_group.associated_units.unit'>;
|
|
302
325
|
/**
|
|
303
|
-
* Maximum number of results
|
|
326
|
+
* Maximum number of results to return in a single page.
|
|
304
327
|
*/
|
|
305
328
|
limit?: number;
|
|
306
329
|
/**
|
|
@@ -309,7 +332,9 @@ export interface ItemListParams {
|
|
|
309
332
|
*/
|
|
310
333
|
product_line_ids?: Array<string>;
|
|
311
334
|
/**
|
|
312
|
-
*
|
|
335
|
+
* Free-text search term used to filter results.
|
|
336
|
+
*
|
|
337
|
+
* Which fields are matched against the term varies by endpoint.
|
|
313
338
|
*/
|
|
314
339
|
q?: string;
|
|
315
340
|
/**
|
|
@@ -317,7 +342,11 @@ export interface ItemListParams {
|
|
|
317
342
|
*/
|
|
318
343
|
start_date?: string;
|
|
319
344
|
/**
|
|
320
|
-
*
|
|
345
|
+
* Restricts results based on where the item is produced in its production flow.
|
|
346
|
+
*
|
|
347
|
+
* - `all`: no restriction.
|
|
348
|
+
* - `initial_only`: only items produced by an initial production step, i.e. a step
|
|
349
|
+
* with no upstream steps feeding into it.
|
|
321
350
|
*/
|
|
322
351
|
subassembly_filter?: 'all' | 'initial_only';
|
|
323
352
|
/**
|
|
@@ -325,18 +354,14 @@ export interface ItemListParams {
|
|
|
325
354
|
*/
|
|
326
355
|
supplier_id?: string;
|
|
327
356
|
/**
|
|
328
|
-
* Filter
|
|
357
|
+
* Filter to items of these types (`product`, `material`, `part`).
|
|
329
358
|
*/
|
|
330
359
|
types?: Array<string>;
|
|
331
360
|
}
|
|
332
|
-
export interface
|
|
333
|
-
/**
|
|
334
|
-
* Path param: Item ID.
|
|
335
|
-
*/
|
|
336
|
-
id: string;
|
|
361
|
+
export interface ItemRetrieveParams {
|
|
337
362
|
/**
|
|
338
|
-
*
|
|
339
|
-
*
|
|
363
|
+
* Sub-objects to expand in the response. When omitted, sub-objects are returned as
|
|
364
|
+
* `null`.
|
|
340
365
|
*/
|
|
341
366
|
include?: Array<'category' | 'unit_value' | 'unit_cost' | 'burn_rate' | 'attributes' | 'category.unit_group' | 'category.properties' | 'category.unit_group.base_unit' | 'category.unit_group.associated_units' | 'category.unit_group.associated_units.unit'>;
|
|
342
367
|
}
|
|
@@ -347,8 +372,19 @@ export interface ItemRetrieveInventoryParams {
|
|
|
347
372
|
*/
|
|
348
373
|
include?: Array<'on_hand' | 'reserved' | 'available_to_promise' | 'short'>;
|
|
349
374
|
}
|
|
375
|
+
export interface ItemChangeCategoryParams {
|
|
376
|
+
/**
|
|
377
|
+
* Path param: Item ID.
|
|
378
|
+
*/
|
|
379
|
+
id: string;
|
|
380
|
+
/**
|
|
381
|
+
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
382
|
+
* are returned as `null`.
|
|
383
|
+
*/
|
|
384
|
+
include?: Array<'category' | 'unit_value' | 'unit_cost' | 'burn_rate' | 'attributes' | 'category.unit_group' | 'category.properties' | 'category.unit_group.base_unit' | 'category.unit_group.associated_units' | 'category.unit_group.associated_units.unit'>;
|
|
385
|
+
}
|
|
350
386
|
export declare namespace Items {
|
|
351
|
-
export { type Item as Item, type ItemCategory as ItemCategory, type ItemInventory as ItemInventory, type ListItem as ListItem, type Quantity as Quantity, type Rate as Rate, type
|
|
387
|
+
export { type Item as Item, type ItemCategory as ItemCategory, type ItemInventory as ItemInventory, type ListItem as ListItem, type Quantity as Quantity, type Rate as Rate, type ItemListParams as ItemListParams, type ItemRetrieveParams as ItemRetrieveParams, type ItemRetrieveInventoryParams as ItemRetrieveInventoryParams, type ItemChangeCategoryParams as ItemChangeCategoryParams, };
|
|
352
388
|
export { Attributes as Attributes, type AttributeUpdateParams as AttributeUpdateParams, type AttributeDeleteParams as AttributeDeleteParams, };
|
|
353
389
|
}
|
|
354
390
|
//# sourceMappingURL=items.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"items.d.mts","sourceRoot":"","sources":["../../../src/resources/catalog/items/items.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"items.d.mts","sourceRoot":"","sources":["../../../src/resources/catalog/items/items.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,KAAK,UAAU;OACf,KAAK,aAAa;OAClB,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,UAAU,EAAE;OAC5D,KAAK,aAAa;OAClB,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAElF;;;;;;;OAOG;IACH,IAAI,CAAC,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAInG;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAInB;;;;;;;;;;;OAWG;IACH,iBAAiB,CACf,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC;IAI5B;;;;;;;;;;;;;;OAcG;IACH,cAAc,CACZ,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAOpB;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,aAAa,CAAC,aAAa,GAAG,IAAI,CAAC;IAE/C;;;OAGG;IACH,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,QAAQ,EAAE,YAAY,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;;OAMG;IACH,IAAI,EAAE,SAAS,GAAG,UAAU,GAAG,MAAM,CAAC;IAEtC;;;OAGG;IACH,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,UAAU,CAAC,KAAK,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,UAAU,EAAE,aAAa,CAAC,YAAY,GAAG,IAAI,CAAC;IAE9C;;;;;;;;;OASG;IACH,IAAI,EAAE,mBAAmB,GAAG,kBAAkB,CAAC;IAE/C;;;OAGG;IACH,UAAU,EAAE,aAAa,CAAC,SAAS,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,oBAAoB,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;OAEG;IACH,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;IAE3B;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,EAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,EAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B;;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;;;OAGG;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,UAAU,GACV,YAAY,GACZ,WAAW,GACX,WAAW,GACX,YAAY,GACZ,qBAAqB,GACrB,qBAAqB,GACrB,+BAA+B,GAC/B,sCAAsC,GACtC,2CAA2C,CAC9C,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;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;IAEpB;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,KAAK,GAAG,cAAc,CAAC;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,UAAU,GACV,YAAY,GACZ,WAAW,GACX,WAAW,GACX,YAAY,GACZ,qBAAqB,GACrB,qBAAqB,GACrB,+BAA+B,GAC/B,sCAAsC,GACtC,2CAA2C,CAC9C,CAAC;CACH;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,UAAU,GAAG,sBAAsB,GAAG,OAAO,CAAC,CAAC;CAC5E;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,UAAU,GACV,YAAY,GACZ,WAAW,GACX,WAAW,GACX,YAAY,GACZ,qBAAqB,GACrB,qBAAqB,GACrB,+BAA+B,GAC/B,sCAAsC,GACtC,2CAA2C,CAC9C,CAAC;CACH;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
|
|
@@ -12,17 +12,6 @@ import { RequestOptions } from "../../../internal/request-options.js";
|
|
|
12
12
|
*/
|
|
13
13
|
export declare class Items extends APIResource {
|
|
14
14
|
attributes: AttributesAPI.Attributes;
|
|
15
|
-
/**
|
|
16
|
-
* Returns an item by ID.
|
|
17
|
-
*
|
|
18
|
-
* @example
|
|
19
|
-
* ```ts
|
|
20
|
-
* const item = await client.catalog.items.retrieve(
|
|
21
|
-
* 'it_0131e386ac683e8c29a71f6f1f',
|
|
22
|
-
* );
|
|
23
|
-
* ```
|
|
24
|
-
*/
|
|
25
|
-
retrieve(id: string, query?: ItemRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Item>;
|
|
26
15
|
/**
|
|
27
16
|
* Returns a paginated list of items.
|
|
28
17
|
*
|
|
@@ -33,18 +22,16 @@ export declare class Items extends APIResource {
|
|
|
33
22
|
*/
|
|
34
23
|
list(query?: ItemListParams | null | undefined, options?: RequestOptions): APIPromise<ListItem>;
|
|
35
24
|
/**
|
|
36
|
-
*
|
|
37
|
-
* units are updated to the new category's base unit.
|
|
25
|
+
* Returns an item by ID.
|
|
38
26
|
*
|
|
39
27
|
* @example
|
|
40
28
|
* ```ts
|
|
41
|
-
* const item = await client.catalog.items.
|
|
42
|
-
* '
|
|
43
|
-
* { id: 'it_0131e386ac683e8c29a71f6f1f' },
|
|
29
|
+
* const item = await client.catalog.items.retrieve(
|
|
30
|
+
* 'it_0131e386ac683e8c29a71f6f1f',
|
|
44
31
|
* );
|
|
45
32
|
* ```
|
|
46
33
|
*/
|
|
47
|
-
|
|
34
|
+
retrieve(id: string, query?: ItemRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Item>;
|
|
48
35
|
/**
|
|
49
36
|
* Returns inventory quantities for an item, including on-hand, reserved,
|
|
50
37
|
* available-to-promise, and short amounts.
|
|
@@ -58,6 +45,22 @@ export declare class Items extends APIResource {
|
|
|
58
45
|
* ```
|
|
59
46
|
*/
|
|
60
47
|
retrieveInventory(id: string, query?: ItemRetrieveInventoryParams | null | undefined, options?: RequestOptions): APIPromise<ItemInventory>;
|
|
48
|
+
/**
|
|
49
|
+
* Moves an item to a different category.
|
|
50
|
+
*
|
|
51
|
+
* The item's rate units (unit value, unit cost, burn rate) and any related
|
|
52
|
+
* order-point, consumption, and production quantity units are updated to the new
|
|
53
|
+
* category's base unit. Re-assigning the item's current category is a no-op.
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* ```ts
|
|
57
|
+
* const item = await client.catalog.items.changeCategory(
|
|
58
|
+
* 'ic_01ae7bd7bfd21ca0ab81e1357e',
|
|
59
|
+
* { id: 'it_0131e386ac683e8c29a71f6f1f' },
|
|
60
|
+
* );
|
|
61
|
+
* ```
|
|
62
|
+
*/
|
|
63
|
+
changeCategory(categoryID: string, params: ItemChangeCategoryParams, options?: RequestOptions): APIPromise<Item>;
|
|
61
64
|
}
|
|
62
65
|
/**
|
|
63
66
|
* Item is an inventory item (product, material, or part).
|
|
@@ -72,11 +75,13 @@ export interface Item {
|
|
|
72
75
|
*/
|
|
73
76
|
attributes: PropertiesAPI.ListAttribute | null;
|
|
74
77
|
/**
|
|
75
|
-
*
|
|
78
|
+
* Value expressed as a ratio of two units, such as a price per kilogram or a
|
|
79
|
+
* throughput per hour.
|
|
76
80
|
*/
|
|
77
81
|
burn_rate: Rate | null;
|
|
78
82
|
/**
|
|
79
|
-
*
|
|
83
|
+
* A grouping of related catalog items that defines the unit group and properties
|
|
84
|
+
* available to the items within it.
|
|
80
85
|
*/
|
|
81
86
|
category: ItemCategory | null;
|
|
82
87
|
/**
|
|
@@ -88,7 +93,7 @@ export interface Item {
|
|
|
88
93
|
*/
|
|
89
94
|
description: string | null;
|
|
90
95
|
/**
|
|
91
|
-
*
|
|
96
|
+
* Free-form notes about the item.
|
|
92
97
|
*/
|
|
93
98
|
notes: string | null;
|
|
94
99
|
/**
|
|
@@ -96,19 +101,25 @@ export interface Item {
|
|
|
96
101
|
*/
|
|
97
102
|
object: 'item';
|
|
98
103
|
/**
|
|
99
|
-
* Stock keeping unit code.
|
|
104
|
+
* Stock keeping unit code, unique within the account.
|
|
100
105
|
*/
|
|
101
106
|
sku: string;
|
|
102
107
|
/**
|
|
103
|
-
*
|
|
108
|
+
* What kind of item this is.
|
|
109
|
+
*
|
|
110
|
+
* - `product`: a finished product.
|
|
111
|
+
* - `material`: a raw material or component consumed in production.
|
|
112
|
+
* - `part`: a part used in production.
|
|
104
113
|
*/
|
|
105
114
|
type: 'product' | 'material' | 'part';
|
|
106
115
|
/**
|
|
107
|
-
*
|
|
116
|
+
* Value expressed as a ratio of two units, such as a price per kilogram or a
|
|
117
|
+
* throughput per hour.
|
|
108
118
|
*/
|
|
109
119
|
unit_cost: Rate | null;
|
|
110
120
|
/**
|
|
111
|
-
*
|
|
121
|
+
* Value expressed as a ratio of two units, such as a price per kilogram or a
|
|
122
|
+
* throughput per hour.
|
|
112
123
|
*/
|
|
113
124
|
unit_value: Rate | null;
|
|
114
125
|
/**
|
|
@@ -117,7 +128,8 @@ export interface Item {
|
|
|
117
128
|
updated_at: string;
|
|
118
129
|
}
|
|
119
130
|
/**
|
|
120
|
-
*
|
|
131
|
+
* A grouping of related catalog items that defines the unit group and properties
|
|
132
|
+
* available to the items within it.
|
|
121
133
|
*/
|
|
122
134
|
export interface ItemCategory {
|
|
123
135
|
/**
|
|
@@ -129,11 +141,11 @@ export interface ItemCategory {
|
|
|
129
141
|
*/
|
|
130
142
|
created_at: string;
|
|
131
143
|
/**
|
|
132
|
-
* Display name.
|
|
144
|
+
* Display name of the item category.
|
|
133
145
|
*/
|
|
134
146
|
name: string;
|
|
135
147
|
/**
|
|
136
|
-
*
|
|
148
|
+
* Free-form notes about the item category.
|
|
137
149
|
*/
|
|
138
150
|
notes: string | null;
|
|
139
151
|
/**
|
|
@@ -149,11 +161,19 @@ export interface ItemCategory {
|
|
|
149
161
|
*/
|
|
150
162
|
properties: PropertiesAPI.ListProperty | null;
|
|
151
163
|
/**
|
|
152
|
-
*
|
|
164
|
+
* What kind of items this category groups.
|
|
165
|
+
*
|
|
166
|
+
* An item can only be assigned to a category whose type matches the item's `type`.
|
|
167
|
+
*
|
|
168
|
+
* - `material_category`: groups raw materials and components (items of type
|
|
169
|
+
* `material`).
|
|
170
|
+
* - `product_category`: groups finished products and parts (items of type
|
|
171
|
+
* `product` or `part`).
|
|
153
172
|
*/
|
|
154
173
|
type: 'material_category' | 'product_category';
|
|
155
174
|
/**
|
|
156
|
-
*
|
|
175
|
+
* Named collection of units sharing one dimension, defining which units products
|
|
176
|
+
* can be ordered in along with per-unit discounts and customer portal visibility.
|
|
157
177
|
*/
|
|
158
178
|
unit_group: UnitGroupsAPI.UnitGroup | null;
|
|
159
179
|
/**
|
|
@@ -224,12 +244,16 @@ export interface Quantity {
|
|
|
224
244
|
*/
|
|
225
245
|
unit: UnitsAPI.Unit | null;
|
|
226
246
|
/**
|
|
227
|
-
*
|
|
247
|
+
* Raw decimal value of the quantity, as a string to preserve precision.
|
|
248
|
+
*
|
|
249
|
+
* This is the unformatted machine value; see `display_value` for the
|
|
250
|
+
* human-readable rendering with unit and thousands separators.
|
|
228
251
|
*/
|
|
229
252
|
value: string;
|
|
230
253
|
}
|
|
231
254
|
/**
|
|
232
|
-
*
|
|
255
|
+
* Value expressed as a ratio of two units, such as a price per kilogram or a
|
|
256
|
+
* throughput per hour.
|
|
233
257
|
*/
|
|
234
258
|
export interface Rate {
|
|
235
259
|
/**
|
|
@@ -261,17 +285,12 @@ export interface Rate {
|
|
|
261
285
|
*/
|
|
262
286
|
updated_at: string;
|
|
263
287
|
/**
|
|
264
|
-
*
|
|
288
|
+
* Decimal value of the rate, as a string to preserve precision.
|
|
289
|
+
*
|
|
290
|
+
* Expressed as the amount of the numerator unit per one denominator unit.
|
|
265
291
|
*/
|
|
266
292
|
value: string;
|
|
267
293
|
}
|
|
268
|
-
export interface ItemRetrieveParams {
|
|
269
|
-
/**
|
|
270
|
-
* Sub-objects to expand in the response. When omitted, sub-objects are returned as
|
|
271
|
-
* `null`.
|
|
272
|
-
*/
|
|
273
|
-
include?: Array<'category' | 'unit_value' | 'unit_cost' | 'burn_rate' | 'attributes' | 'category.unit_group' | 'category.properties' | 'category.unit_group.base_unit' | 'category.unit_group.associated_units' | 'category.unit_group.associated_units.unit'>;
|
|
274
|
-
}
|
|
275
294
|
export interface ItemListParams {
|
|
276
295
|
/**
|
|
277
296
|
* Filter by attribute IDs.
|
|
@@ -282,7 +301,11 @@ export interface ItemListParams {
|
|
|
282
301
|
*/
|
|
283
302
|
category_ids?: Array<string>;
|
|
284
303
|
/**
|
|
285
|
-
*
|
|
304
|
+
* Opaque cursor token identifying where the page of results starts.
|
|
305
|
+
*
|
|
306
|
+
* Use the `cursor` value embedded in a previous response's `next_page_url` or
|
|
307
|
+
* `previous_page_url` to fetch the adjacent page. Omit to start from the first
|
|
308
|
+
* page.
|
|
286
309
|
*/
|
|
287
310
|
cursor?: string;
|
|
288
311
|
/**
|
|
@@ -300,7 +323,7 @@ export interface ItemListParams {
|
|
|
300
323
|
*/
|
|
301
324
|
include?: Array<'category' | 'unit_value' | 'unit_cost' | 'burn_rate' | 'attributes' | 'category.unit_group' | 'category.properties' | 'category.unit_group.base_unit' | 'category.unit_group.associated_units' | 'category.unit_group.associated_units.unit'>;
|
|
302
325
|
/**
|
|
303
|
-
* Maximum number of results
|
|
326
|
+
* Maximum number of results to return in a single page.
|
|
304
327
|
*/
|
|
305
328
|
limit?: number;
|
|
306
329
|
/**
|
|
@@ -309,7 +332,9 @@ export interface ItemListParams {
|
|
|
309
332
|
*/
|
|
310
333
|
product_line_ids?: Array<string>;
|
|
311
334
|
/**
|
|
312
|
-
*
|
|
335
|
+
* Free-text search term used to filter results.
|
|
336
|
+
*
|
|
337
|
+
* Which fields are matched against the term varies by endpoint.
|
|
313
338
|
*/
|
|
314
339
|
q?: string;
|
|
315
340
|
/**
|
|
@@ -317,7 +342,11 @@ export interface ItemListParams {
|
|
|
317
342
|
*/
|
|
318
343
|
start_date?: string;
|
|
319
344
|
/**
|
|
320
|
-
*
|
|
345
|
+
* Restricts results based on where the item is produced in its production flow.
|
|
346
|
+
*
|
|
347
|
+
* - `all`: no restriction.
|
|
348
|
+
* - `initial_only`: only items produced by an initial production step, i.e. a step
|
|
349
|
+
* with no upstream steps feeding into it.
|
|
321
350
|
*/
|
|
322
351
|
subassembly_filter?: 'all' | 'initial_only';
|
|
323
352
|
/**
|
|
@@ -325,18 +354,14 @@ export interface ItemListParams {
|
|
|
325
354
|
*/
|
|
326
355
|
supplier_id?: string;
|
|
327
356
|
/**
|
|
328
|
-
* Filter
|
|
357
|
+
* Filter to items of these types (`product`, `material`, `part`).
|
|
329
358
|
*/
|
|
330
359
|
types?: Array<string>;
|
|
331
360
|
}
|
|
332
|
-
export interface
|
|
333
|
-
/**
|
|
334
|
-
* Path param: Item ID.
|
|
335
|
-
*/
|
|
336
|
-
id: string;
|
|
361
|
+
export interface ItemRetrieveParams {
|
|
337
362
|
/**
|
|
338
|
-
*
|
|
339
|
-
*
|
|
363
|
+
* Sub-objects to expand in the response. When omitted, sub-objects are returned as
|
|
364
|
+
* `null`.
|
|
340
365
|
*/
|
|
341
366
|
include?: Array<'category' | 'unit_value' | 'unit_cost' | 'burn_rate' | 'attributes' | 'category.unit_group' | 'category.properties' | 'category.unit_group.base_unit' | 'category.unit_group.associated_units' | 'category.unit_group.associated_units.unit'>;
|
|
342
367
|
}
|
|
@@ -347,8 +372,19 @@ export interface ItemRetrieveInventoryParams {
|
|
|
347
372
|
*/
|
|
348
373
|
include?: Array<'on_hand' | 'reserved' | 'available_to_promise' | 'short'>;
|
|
349
374
|
}
|
|
375
|
+
export interface ItemChangeCategoryParams {
|
|
376
|
+
/**
|
|
377
|
+
* Path param: Item ID.
|
|
378
|
+
*/
|
|
379
|
+
id: string;
|
|
380
|
+
/**
|
|
381
|
+
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
382
|
+
* are returned as `null`.
|
|
383
|
+
*/
|
|
384
|
+
include?: Array<'category' | 'unit_value' | 'unit_cost' | 'burn_rate' | 'attributes' | 'category.unit_group' | 'category.properties' | 'category.unit_group.base_unit' | 'category.unit_group.associated_units' | 'category.unit_group.associated_units.unit'>;
|
|
385
|
+
}
|
|
350
386
|
export declare namespace Items {
|
|
351
|
-
export { type Item as Item, type ItemCategory as ItemCategory, type ItemInventory as ItemInventory, type ListItem as ListItem, type Quantity as Quantity, type Rate as Rate, type
|
|
387
|
+
export { type Item as Item, type ItemCategory as ItemCategory, type ItemInventory as ItemInventory, type ListItem as ListItem, type Quantity as Quantity, type Rate as Rate, type ItemListParams as ItemListParams, type ItemRetrieveParams as ItemRetrieveParams, type ItemRetrieveInventoryParams as ItemRetrieveInventoryParams, type ItemChangeCategoryParams as ItemChangeCategoryParams, };
|
|
352
388
|
export { Attributes as Attributes, type AttributeUpdateParams as AttributeUpdateParams, type AttributeDeleteParams as AttributeDeleteParams, };
|
|
353
389
|
}
|
|
354
390
|
//# sourceMappingURL=items.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"items.d.ts","sourceRoot":"","sources":["../../../src/resources/catalog/items/items.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"items.d.ts","sourceRoot":"","sources":["../../../src/resources/catalog/items/items.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,KAAK,UAAU;OACf,KAAK,aAAa;OAClB,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,UAAU,EAAE;OAC5D,KAAK,aAAa;OAClB,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAElF;;;;;;;OAOG;IACH,IAAI,CAAC,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAInG;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAInB;;;;;;;;;;;OAWG;IACH,iBAAiB,CACf,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC;IAI5B;;;;;;;;;;;;;;OAcG;IACH,cAAc,CACZ,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAOpB;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,aAAa,CAAC,aAAa,GAAG,IAAI,CAAC;IAE/C;;;OAGG;IACH,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,QAAQ,EAAE,YAAY,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;;OAMG;IACH,IAAI,EAAE,SAAS,GAAG,UAAU,GAAG,MAAM,CAAC;IAEtC;;;OAGG;IACH,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,UAAU,CAAC,KAAK,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,UAAU,EAAE,aAAa,CAAC,YAAY,GAAG,IAAI,CAAC;IAE9C;;;;;;;;;OASG;IACH,IAAI,EAAE,mBAAmB,GAAG,kBAAkB,CAAC;IAE/C;;;OAGG;IACH,UAAU,EAAE,aAAa,CAAC,SAAS,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,oBAAoB,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;OAEG;IACH,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;IAE3B;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,EAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,EAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B;;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;;;OAGG;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,UAAU,GACV,YAAY,GACZ,WAAW,GACX,WAAW,GACX,YAAY,GACZ,qBAAqB,GACrB,qBAAqB,GACrB,+BAA+B,GAC/B,sCAAsC,GACtC,2CAA2C,CAC9C,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;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;IAEpB;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,KAAK,GAAG,cAAc,CAAC;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,UAAU,GACV,YAAY,GACZ,WAAW,GACX,WAAW,GACX,YAAY,GACZ,qBAAqB,GACrB,qBAAqB,GACrB,+BAA+B,GAC/B,sCAAsC,GACtC,2CAA2C,CAC9C,CAAC;CACH;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,UAAU,GAAG,sBAAsB,GAAG,OAAO,CAAC,CAAC;CAC5E;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,UAAU,GACV,YAAY,GACZ,WAAW,GACX,WAAW,GACX,YAAY,GACZ,qBAAqB,GACrB,qBAAqB,GACrB,+BAA+B,GAC/B,sCAAsC,GACtC,2CAA2C,CAC9C,CAAC;CACH;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
|