@augno/sdk 0.1.6 → 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 +5 -4
- 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 +13 -18
- 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 -66
- package/resources/catalog/item-categories/item-categories.d.mts.map +1 -1
- package/resources/catalog/item-categories/item-categories.d.ts +95 -66
- package/resources/catalog/item-categories/item-categories.d.ts.map +1 -1
- package/resources/catalog/item-categories/item-categories.js +37 -30
- package/resources/catalog/item-categories/item-categories.js.map +1 -1
- package/resources/catalog/item-categories/item-categories.mjs +37 -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 +142 -95
- package/resources/catalog/materials.d.mts.map +1 -1
- package/resources/catalog/materials.d.ts +142 -95
- package/resources/catalog/materials.d.ts.map +1 -1
- package/resources/catalog/materials.js +28 -19
- package/resources/catalog/materials.js.map +1 -1
- package/resources/catalog/materials.mjs +28 -19
- package/resources/catalog/materials.mjs.map +1 -1
- package/resources/catalog/parts.d.mts +131 -81
- package/resources/catalog/parts.d.mts.map +1 -1
- package/resources/catalog/parts.d.ts +131 -81
- package/resources/catalog/parts.d.ts.map +1 -1
- package/resources/catalog/parts.js +34 -21
- package/resources/catalog/parts.js.map +1 -1
- package/resources/catalog/parts.mjs +34 -21
- package/resources/catalog/parts.mjs.map +1 -1
- package/resources/catalog/product-lines.d.mts +145 -71
- package/resources/catalog/product-lines.d.mts.map +1 -1
- package/resources/catalog/product-lines.d.ts +145 -71
- package/resources/catalog/product-lines.d.ts.map +1 -1
- package/resources/catalog/product-lines.js +30 -26
- package/resources/catalog/product-lines.js.map +1 -1
- package/resources/catalog/product-lines.mjs +30 -26
- package/resources/catalog/product-lines.mjs.map +1 -1
- package/resources/catalog/products.d.mts +196 -104
- package/resources/catalog/products.d.mts.map +1 -1
- package/resources/catalog/products.d.ts +196 -104
- package/resources/catalog/products.d.ts.map +1 -1
- package/resources/catalog/products.js +24 -21
- package/resources/catalog/products.js.map +1 -1
- package/resources/catalog/products.mjs +24 -21
- package/resources/catalog/products.mjs.map +1 -1
- package/resources/catalog/properties/attributes.d.mts +97 -48
- package/resources/catalog/properties/attributes.d.mts.map +1 -1
- package/resources/catalog/properties/attributes.d.ts +97 -48
- package/resources/catalog/properties/attributes.d.ts.map +1 -1
- package/resources/catalog/properties/attributes.js +27 -20
- package/resources/catalog/properties/attributes.js.map +1 -1
- package/resources/catalog/properties/attributes.mjs +27 -20
- 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 -48
- package/resources/catalog/properties/properties.d.mts.map +1 -1
- package/resources/catalog/properties/properties.d.ts +70 -48
- package/resources/catalog/properties/properties.d.ts.map +1 -1
- package/resources/catalog/properties/properties.js +18 -18
- package/resources/catalog/properties/properties.js.map +1 -1
- package/resources/catalog/properties/properties.mjs +18 -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 +123 -85
- package/resources/catalog/unit-groups/unit-groups.d.mts.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.d.ts +123 -85
- package/resources/catalog/unit-groups/unit-groups.d.ts.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.js +25 -25
- package/resources/catalog/unit-groups/unit-groups.js.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.mjs +25 -25
- package/resources/catalog/unit-groups/unit-groups.mjs.map +1 -1
- package/resources/catalog/unit-groups/units.d.mts +75 -59
- package/resources/catalog/unit-groups/units.d.mts.map +1 -1
- package/resources/catalog/unit-groups/units.d.ts +75 -59
- package/resources/catalog/unit-groups/units.d.ts.map +1 -1
- package/resources/catalog/unit-groups/units.js +31 -30
- package/resources/catalog/unit-groups/units.js.map +1 -1
- package/resources/catalog/unit-groups/units.mjs +31 -30
- 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 -64
- package/resources/catalog/units.d.mts.map +1 -1
- package/resources/catalog/units.d.ts +100 -64
- package/resources/catalog/units.d.ts.map +1 -1
- package/resources/catalog/units.js +25 -25
- package/resources/catalog/units.js.map +1 -1
- package/resources/catalog/units.mjs +25 -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 +95 -41
- package/resources/core/request-logs.d.mts.map +1 -1
- package/resources/core/request-logs.d.ts +95 -41
- 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 +53 -32
- package/resources/core/sandboxes.d.mts.map +1 -1
- package/resources/core/sandboxes.d.ts +53 -32
- 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 -44
- package/resources/finance/payment-terms.d.mts.map +1 -1
- package/resources/finance/payment-terms.d.ts +72 -44
- package/resources/finance/payment-terms.d.ts.map +1 -1
- package/resources/finance/payment-terms.js +32 -22
- package/resources/finance/payment-terms.js.map +1 -1
- package/resources/finance/payment-terms.mjs +32 -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 +175 -93
- package/resources/identity/account-users/account-users.d.mts.map +1 -1
- package/resources/identity/account-users/account-users.d.ts +175 -93
- package/resources/identity/account-users/account-users.d.ts.map +1 -1
- package/resources/identity/account-users/account-users.js +43 -30
- package/resources/identity/account-users/account-users.js.map +1 -1
- package/resources/identity/account-users/account-users.mjs +43 -30
- 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 +84 -61
- package/resources/identity/roles.d.mts.map +1 -1
- package/resources/identity/roles.d.ts +84 -61
- package/resources/identity/roles.d.ts.map +1 -1
- package/resources/identity/roles.js +29 -27
- package/resources/identity/roles.js.map +1 -1
- package/resources/identity/roles.mjs +29 -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 +101 -64
- package/resources/operations/carriers/carriers.d.mts.map +1 -1
- package/resources/operations/carriers/carriers.d.ts +101 -64
- package/resources/operations/carriers/carriers.d.ts.map +1 -1
- package/resources/operations/carriers/carriers.js +28 -24
- package/resources/operations/carriers/carriers.js.map +1 -1
- package/resources/operations/carriers/carriers.mjs +28 -24
- 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 +113 -69
- package/resources/operations/carriers/service-levels.d.mts.map +1 -1
- package/resources/operations/carriers/service-levels.d.ts +113 -69
- package/resources/operations/carriers/service-levels.d.ts.map +1 -1
- package/resources/operations/carriers/service-levels.js +34 -30
- package/resources/operations/carriers/service-levels.js.map +1 -1
- package/resources/operations/carriers/service-levels.mjs +34 -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 +132 -67
- package/resources/operations/locations.d.mts.map +1 -1
- package/resources/operations/locations.d.ts +132 -67
- package/resources/operations/locations.d.ts.map +1 -1
- package/resources/operations/locations.js +23 -20
- package/resources/operations/locations.js.map +1 -1
- package/resources/operations/locations.mjs +23 -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 -72
- package/resources/operations/scanning-stations.d.mts.map +1 -1
- package/resources/operations/scanning-stations.d.ts +143 -72
- package/resources/operations/scanning-stations.d.ts.map +1 -1
- package/resources/operations/scanning-stations.js +31 -25
- package/resources/operations/scanning-stations.js.map +1 -1
- package/resources/operations/scanning-stations.mjs +31 -25
- package/resources/operations/scanning-stations.mjs.map +1 -1
- package/resources/operations/shipping-terms.d.mts +121 -86
- package/resources/operations/shipping-terms.d.mts.map +1 -1
- package/resources/operations/shipping-terms.d.ts +121 -86
- package/resources/operations/shipping-terms.d.ts.map +1 -1
- package/resources/operations/shipping-terms.js +27 -26
- package/resources/operations/shipping-terms.js.map +1 -1
- package/resources/operations/shipping-terms.mjs +27 -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 +149 -66
- package/resources/sales/account-groups.d.mts.map +1 -1
- package/resources/sales/account-groups.d.ts +149 -66
- package/resources/sales/account-groups.d.ts.map +1 -1
- package/resources/sales/account-groups.js +29 -21
- package/resources/sales/account-groups.js.map +1 -1
- package/resources/sales/account-groups.mjs +29 -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 +96 -50
- package/resources/sales/addresses.d.mts.map +1 -1
- package/resources/sales/addresses.d.ts +96 -50
- package/resources/sales/addresses.d.ts.map +1 -1
- package/resources/sales/addresses.js +28 -19
- package/resources/sales/addresses.js.map +1 -1
- package/resources/sales/addresses.mjs +28 -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 +583 -288
- package/resources/sales/customers/customers.d.mts.map +1 -1
- package/resources/sales/customers/customers.d.ts +583 -288
- package/resources/sales/customers/customers.d.ts.map +1 -1
- package/resources/sales/customers/customers.js +52 -30
- package/resources/sales/customers/customers.js.map +1 -1
- package/resources/sales/customers/customers.mjs +52 -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 +115 -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 +167 -120
- package/src/resources/catalog/parts.ts +149 -99
- package/src/resources/catalog/product-lines.ts +159 -85
- package/src/resources/catalog/products.ts +211 -119
- package/src/resources/catalog/properties/attributes.ts +109 -82
- package/src/resources/catalog/properties/index.ts +4 -4
- package/src/resources/catalog/properties/properties.ts +83 -61
- package/src/resources/catalog/unit-groups/index.ts +4 -4
- package/src/resources/catalog/unit-groups/unit-groups.ts +140 -102
- package/src/resources/catalog/unit-groups/units.ts +94 -78
- package/src/resources/catalog/units.ts +113 -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 +154 -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 +113 -57
- package/src/resources/core/sandboxes.ts +58 -37
- package/src/resources/finance/finance.ts +78 -44
- package/src/resources/finance/index.ts +4 -4
- package/src/resources/finance/payment-terms.ts +84 -56
- package/src/resources/identity/account-users/account-users.ts +190 -105
- 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 +92 -69
- package/src/resources/index.ts +3 -2
- package/src/resources/operations/carriers/carriers.ts +109 -72
- package/src/resources/operations/carriers/index.ts +4 -4
- package/src/resources/operations/carriers/service-levels.ts +133 -89
- package/src/resources/operations/index.ts +8 -8
- package/src/resources/operations/location-types.ts +38 -23
- package/src/resources/operations/locations.ts +141 -76
- package/src/resources/operations/operations.ts +8 -8
- package/src/resources/operations/scanning-stations.ts +159 -88
- package/src/resources/operations/shipping-terms.ts +135 -100
- package/src/resources/sales/account-groups.ts +159 -76
- package/src/resources/sales/account-statuses.ts +48 -30
- package/src/resources/sales/addresses.ts +104 -58
- package/src/resources/sales/customers/actions.ts +15 -4
- package/src/resources/sales/customers/customers.ts +655 -347
- 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
|
@@ -8,17 +8,14 @@ import { RequestOptions } from "../../internal/request-options.js";
|
|
|
8
8
|
*/
|
|
9
9
|
export declare class Materials extends APIResource {
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
11
|
+
* Returns a paginated list of materials.
|
|
12
12
|
*
|
|
13
13
|
* @example
|
|
14
14
|
* ```ts
|
|
15
|
-
* const
|
|
16
|
-
* category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
|
|
17
|
-
* sku: 'MAT-001',
|
|
18
|
-
* });
|
|
15
|
+
* const listMaterial = await client.catalog.materials.list();
|
|
19
16
|
* ```
|
|
20
17
|
*/
|
|
21
|
-
|
|
18
|
+
list(query?: MaterialListParams | null | undefined, options?: RequestOptions): APIPromise<ListMaterial>;
|
|
22
19
|
/**
|
|
23
20
|
* Returns a material by ID.
|
|
24
21
|
*
|
|
@@ -30,9 +27,26 @@ export declare class Materials extends APIResource {
|
|
|
30
27
|
* ```
|
|
31
28
|
*/
|
|
32
29
|
retrieve(id: string, query?: MaterialRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Material>;
|
|
30
|
+
/**
|
|
31
|
+
* Creates a material with the specified SKU and category.
|
|
32
|
+
*
|
|
33
|
+
* Inventory tracking for the new material starts at a zero on-hand quantity in the
|
|
34
|
+
* category's base unit.
|
|
35
|
+
*
|
|
36
|
+
* @example
|
|
37
|
+
* ```ts
|
|
38
|
+
* const material = await client.catalog.materials.create({
|
|
39
|
+
* category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
|
|
40
|
+
* sku: 'MAT-001',
|
|
41
|
+
* });
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
create(params: MaterialCreateParams, options?: RequestOptions): APIPromise<Material>;
|
|
33
45
|
/**
|
|
34
46
|
* Partially updates a material.
|
|
35
47
|
*
|
|
48
|
+
* Fields not provided retain their current values.
|
|
49
|
+
*
|
|
36
50
|
* @example
|
|
37
51
|
* ```ts
|
|
38
52
|
* const material = await client.catalog.materials.update(
|
|
@@ -43,16 +57,11 @@ export declare class Materials extends APIResource {
|
|
|
43
57
|
*/
|
|
44
58
|
update(id: string, params?: MaterialUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Material>;
|
|
45
59
|
/**
|
|
46
|
-
*
|
|
60
|
+
* Deletes a material.
|
|
47
61
|
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
* ```
|
|
52
|
-
*/
|
|
53
|
-
list(query?: MaterialListParams | null | undefined, options?: RequestOptions): APIPromise<ListMaterial>;
|
|
54
|
-
/**
|
|
55
|
-
* Deletes a material by ID.
|
|
62
|
+
* This is a soft delete: the material is marked deleted and no longer returned by
|
|
63
|
+
* other endpoints, but the record is retained. Deleting an already-deleted
|
|
64
|
+
* material returns an error.
|
|
56
65
|
*
|
|
57
66
|
* @example
|
|
58
67
|
* ```ts
|
|
@@ -68,42 +77,49 @@ export declare class Materials extends APIResource {
|
|
|
68
77
|
*/
|
|
69
78
|
export interface CreateMaterialRequest {
|
|
70
79
|
/**
|
|
71
|
-
*
|
|
80
|
+
* ID of the item category to place the material in.
|
|
81
|
+
*
|
|
82
|
+
* The category's unit group determines the base unit used for the material's rates
|
|
83
|
+
* (`unit_value`, `unit_cost`, `burn_rate`).
|
|
72
84
|
*/
|
|
73
85
|
category_id: string;
|
|
74
86
|
/**
|
|
75
|
-
*
|
|
87
|
+
* Stock keeping unit code for the material.
|
|
88
|
+
*
|
|
89
|
+
* Must be unique within the account; creating a material with a SKU already used
|
|
90
|
+
* by another item fails with a conflict error.
|
|
76
91
|
*/
|
|
77
92
|
sku: string;
|
|
78
93
|
/**
|
|
79
|
-
*
|
|
94
|
+
* IDs of existing attributes to link to the material at creation time.
|
|
80
95
|
*/
|
|
81
96
|
attribute_ids?: Array<string>;
|
|
82
97
|
/**
|
|
83
|
-
*
|
|
98
|
+
* Free-form description of the material.
|
|
84
99
|
*/
|
|
85
|
-
description?: string
|
|
100
|
+
description?: string;
|
|
86
101
|
/**
|
|
87
102
|
* QuantityInputRequest is a quantity value and unit.
|
|
88
103
|
*/
|
|
89
|
-
lead_time?: QuantityInputRequest
|
|
104
|
+
lead_time?: QuantityInputRequest;
|
|
90
105
|
/**
|
|
91
|
-
*
|
|
106
|
+
* Free-form notes about the material.
|
|
92
107
|
*/
|
|
93
|
-
notes?: string
|
|
108
|
+
notes?: string;
|
|
94
109
|
/**
|
|
95
110
|
* QuantityInputRequest is a quantity value and unit.
|
|
96
111
|
*/
|
|
97
|
-
order_point?: QuantityInputRequest
|
|
112
|
+
order_point?: QuantityInputRequest;
|
|
98
113
|
/**
|
|
99
|
-
*
|
|
114
|
+
* A rate value with its numerator and denominator units, used in create and update
|
|
115
|
+
* requests.
|
|
100
116
|
*/
|
|
101
|
-
unit_cost?: RateInput
|
|
117
|
+
unit_cost?: RateInput;
|
|
102
118
|
/**
|
|
103
|
-
*
|
|
104
|
-
*
|
|
119
|
+
* A rate value with its numerator and denominator units, used in create and update
|
|
120
|
+
* requests.
|
|
105
121
|
*/
|
|
106
|
-
unit_price?: RateInput
|
|
122
|
+
unit_price?: RateInput;
|
|
107
123
|
}
|
|
108
124
|
/**
|
|
109
125
|
* List represents a paginated list of resources.
|
|
@@ -123,7 +139,12 @@ export interface ListMaterial {
|
|
|
123
139
|
page_info: APIKeysAPI.PageInfo;
|
|
124
140
|
}
|
|
125
141
|
/**
|
|
126
|
-
*
|
|
142
|
+
* A material in the account's catalog: a raw material or component consumed in
|
|
143
|
+
* production.
|
|
144
|
+
*
|
|
145
|
+
* Material-level data such as the SKU, description, category, pricing, and
|
|
146
|
+
* attributes lives on the underlying `item`; the material record adds the
|
|
147
|
+
* reordering fields `order_point` and `lead_time`.
|
|
127
148
|
*/
|
|
128
149
|
export interface Material {
|
|
129
150
|
/**
|
|
@@ -160,25 +181,30 @@ export interface Material {
|
|
|
160
181
|
*/
|
|
161
182
|
export interface QuantityInputRequest {
|
|
162
183
|
/**
|
|
163
|
-
*
|
|
184
|
+
* ID of the unit the value is expressed in.
|
|
164
185
|
*/
|
|
165
186
|
unit_id: string;
|
|
166
187
|
/**
|
|
167
|
-
*
|
|
188
|
+
* Decimal value of the quantity.
|
|
168
189
|
*/
|
|
169
190
|
value: string;
|
|
170
191
|
}
|
|
192
|
+
/**
|
|
193
|
+
* A rate value with its numerator and denominator units, used in create and update
|
|
194
|
+
* requests.
|
|
195
|
+
*/
|
|
171
196
|
export interface RateInput {
|
|
172
197
|
/**
|
|
173
|
-
*
|
|
198
|
+
* ID of the unit for the rate's denominator (the per-unit basis).
|
|
174
199
|
*/
|
|
175
200
|
denominator_unit_id: string;
|
|
176
201
|
/**
|
|
177
|
-
*
|
|
202
|
+
* ID of the unit for the rate's numerator (e.g. the currency of a price).
|
|
178
203
|
*/
|
|
179
204
|
numerator_unit_id: string;
|
|
180
205
|
/**
|
|
181
|
-
* Decimal value of the rate
|
|
206
|
+
* Decimal value of the rate, expressed as the amount of the numerator unit per one
|
|
207
|
+
* denominator unit.
|
|
182
208
|
*/
|
|
183
209
|
value: string;
|
|
184
210
|
}
|
|
@@ -187,7 +213,7 @@ export interface RateInput {
|
|
|
187
213
|
*/
|
|
188
214
|
export interface UpdateMaterialRequest {
|
|
189
215
|
/**
|
|
190
|
-
*
|
|
216
|
+
* New description for the material.
|
|
191
217
|
*/
|
|
192
218
|
description?: string;
|
|
193
219
|
/**
|
|
@@ -195,7 +221,7 @@ export interface UpdateMaterialRequest {
|
|
|
195
221
|
*/
|
|
196
222
|
lead_time?: QuantityInputRequest;
|
|
197
223
|
/**
|
|
198
|
-
*
|
|
224
|
+
* New notes for the material.
|
|
199
225
|
*/
|
|
200
226
|
notes?: string;
|
|
201
227
|
/**
|
|
@@ -203,57 +229,58 @@ export interface UpdateMaterialRequest {
|
|
|
203
229
|
*/
|
|
204
230
|
order_point?: QuantityInputRequest;
|
|
205
231
|
/**
|
|
206
|
-
*
|
|
232
|
+
* New stock keeping unit code for the material.
|
|
233
|
+
*
|
|
234
|
+
* Must remain unique within the account; a conflict error is returned if another
|
|
235
|
+
* item already uses it.
|
|
207
236
|
*/
|
|
208
237
|
sku?: string;
|
|
209
238
|
/**
|
|
210
|
-
*
|
|
239
|
+
* A rate value with its numerator and denominator units, used in create and update
|
|
240
|
+
* requests.
|
|
211
241
|
*/
|
|
212
|
-
unit_cost?: RateInput
|
|
242
|
+
unit_cost?: RateInput;
|
|
213
243
|
}
|
|
214
|
-
export interface
|
|
215
|
-
/**
|
|
216
|
-
* Body param: Category ID.
|
|
217
|
-
*/
|
|
218
|
-
category_id: string;
|
|
219
|
-
/**
|
|
220
|
-
* Body param: SKU code.
|
|
221
|
-
*/
|
|
222
|
-
sku: string;
|
|
244
|
+
export interface MaterialListParams {
|
|
223
245
|
/**
|
|
224
|
-
*
|
|
225
|
-
* are returned as `null`.
|
|
246
|
+
* Filter by attribute IDs.
|
|
226
247
|
*/
|
|
227
|
-
|
|
248
|
+
attribute_ids?: Array<string>;
|
|
228
249
|
/**
|
|
229
|
-
*
|
|
250
|
+
* Filter by category IDs.
|
|
230
251
|
*/
|
|
231
|
-
|
|
252
|
+
category_ids?: Array<string>;
|
|
232
253
|
/**
|
|
233
|
-
*
|
|
254
|
+
* Opaque cursor token identifying where the page of results starts.
|
|
255
|
+
*
|
|
256
|
+
* Use the `cursor` value embedded in a previous response's `next_page_url` or
|
|
257
|
+
* `previous_page_url` to fetch the adjacent page. Omit to start from the first
|
|
258
|
+
* page.
|
|
234
259
|
*/
|
|
235
|
-
|
|
260
|
+
cursor?: string;
|
|
236
261
|
/**
|
|
237
|
-
*
|
|
262
|
+
* Filter to materials created on or before this date.
|
|
238
263
|
*/
|
|
239
|
-
|
|
264
|
+
end_date?: string;
|
|
240
265
|
/**
|
|
241
|
-
*
|
|
266
|
+
* Sub-objects to expand in the response. When omitted, sub-objects are returned as
|
|
267
|
+
* `null`.
|
|
242
268
|
*/
|
|
243
|
-
|
|
269
|
+
include?: Array<'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
|
|
244
270
|
/**
|
|
245
|
-
*
|
|
271
|
+
* Maximum number of results to return in a single page.
|
|
246
272
|
*/
|
|
247
|
-
|
|
273
|
+
limit?: number;
|
|
248
274
|
/**
|
|
249
|
-
*
|
|
275
|
+
* Free-text search term used to filter results.
|
|
276
|
+
*
|
|
277
|
+
* Which fields are matched against the term varies by endpoint.
|
|
250
278
|
*/
|
|
251
|
-
|
|
279
|
+
q?: string;
|
|
252
280
|
/**
|
|
253
|
-
*
|
|
254
|
-
* denominator must not be.
|
|
281
|
+
* Filter to materials created on or after this date.
|
|
255
282
|
*/
|
|
256
|
-
|
|
283
|
+
start_date?: string;
|
|
257
284
|
}
|
|
258
285
|
export interface MaterialRetrieveParams {
|
|
259
286
|
/**
|
|
@@ -262,14 +289,32 @@ export interface MaterialRetrieveParams {
|
|
|
262
289
|
*/
|
|
263
290
|
include?: Array<'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
|
|
264
291
|
}
|
|
265
|
-
export interface
|
|
292
|
+
export interface MaterialCreateParams {
|
|
293
|
+
/**
|
|
294
|
+
* Body param: ID of the item category to place the material in.
|
|
295
|
+
*
|
|
296
|
+
* The category's unit group determines the base unit used for the material's rates
|
|
297
|
+
* (`unit_value`, `unit_cost`, `burn_rate`).
|
|
298
|
+
*/
|
|
299
|
+
category_id: string;
|
|
300
|
+
/**
|
|
301
|
+
* Body param: Stock keeping unit code for the material.
|
|
302
|
+
*
|
|
303
|
+
* Must be unique within the account; creating a material with a SKU already used
|
|
304
|
+
* by another item fails with a conflict error.
|
|
305
|
+
*/
|
|
306
|
+
sku: string;
|
|
266
307
|
/**
|
|
267
308
|
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
268
309
|
* are returned as `null`.
|
|
269
310
|
*/
|
|
270
311
|
include?: Array<'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
|
|
271
312
|
/**
|
|
272
|
-
* Body param:
|
|
313
|
+
* Body param: IDs of existing attributes to link to the material at creation time.
|
|
314
|
+
*/
|
|
315
|
+
attribute_ids?: Array<string>;
|
|
316
|
+
/**
|
|
317
|
+
* Body param: Free-form description of the material.
|
|
273
318
|
*/
|
|
274
319
|
description?: string;
|
|
275
320
|
/**
|
|
@@ -277,7 +322,7 @@ export interface MaterialUpdateParams {
|
|
|
277
322
|
*/
|
|
278
323
|
lead_time?: QuantityInputRequest;
|
|
279
324
|
/**
|
|
280
|
-
* Body param:
|
|
325
|
+
* Body param: Free-form notes about the material.
|
|
281
326
|
*/
|
|
282
327
|
notes?: string;
|
|
283
328
|
/**
|
|
@@ -285,50 +330,52 @@ export interface MaterialUpdateParams {
|
|
|
285
330
|
*/
|
|
286
331
|
order_point?: QuantityInputRequest;
|
|
287
332
|
/**
|
|
288
|
-
* Body param:
|
|
333
|
+
* Body param: A rate value with its numerator and denominator units, used in
|
|
334
|
+
* create and update requests.
|
|
289
335
|
*/
|
|
290
|
-
|
|
336
|
+
unit_cost?: RateInput;
|
|
291
337
|
/**
|
|
292
|
-
* Body param:
|
|
338
|
+
* Body param: A rate value with its numerator and denominator units, used in
|
|
339
|
+
* create and update requests.
|
|
293
340
|
*/
|
|
294
|
-
|
|
341
|
+
unit_price?: RateInput;
|
|
295
342
|
}
|
|
296
|
-
export interface
|
|
297
|
-
/**
|
|
298
|
-
* Filter by attribute IDs.
|
|
299
|
-
*/
|
|
300
|
-
attribute_ids?: Array<string>;
|
|
343
|
+
export interface MaterialUpdateParams {
|
|
301
344
|
/**
|
|
302
|
-
*
|
|
345
|
+
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
346
|
+
* are returned as `null`.
|
|
303
347
|
*/
|
|
304
|
-
|
|
348
|
+
include?: Array<'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
|
|
305
349
|
/**
|
|
306
|
-
*
|
|
350
|
+
* Body param: New description for the material.
|
|
307
351
|
*/
|
|
308
|
-
|
|
352
|
+
description?: string;
|
|
309
353
|
/**
|
|
310
|
-
*
|
|
354
|
+
* Body param: QuantityInputRequest is a quantity value and unit.
|
|
311
355
|
*/
|
|
312
|
-
|
|
356
|
+
lead_time?: QuantityInputRequest;
|
|
313
357
|
/**
|
|
314
|
-
*
|
|
315
|
-
* `null`.
|
|
358
|
+
* Body param: New notes for the material.
|
|
316
359
|
*/
|
|
317
|
-
|
|
360
|
+
notes?: string;
|
|
318
361
|
/**
|
|
319
|
-
*
|
|
362
|
+
* Body param: QuantityInputRequest is a quantity value and unit.
|
|
320
363
|
*/
|
|
321
|
-
|
|
364
|
+
order_point?: QuantityInputRequest;
|
|
322
365
|
/**
|
|
323
|
-
*
|
|
366
|
+
* Body param: New stock keeping unit code for the material.
|
|
367
|
+
*
|
|
368
|
+
* Must remain unique within the account; a conflict error is returned if another
|
|
369
|
+
* item already uses it.
|
|
324
370
|
*/
|
|
325
|
-
|
|
371
|
+
sku?: string;
|
|
326
372
|
/**
|
|
327
|
-
*
|
|
373
|
+
* Body param: A rate value with its numerator and denominator units, used in
|
|
374
|
+
* create and update requests.
|
|
328
375
|
*/
|
|
329
|
-
|
|
376
|
+
unit_cost?: RateInput;
|
|
330
377
|
}
|
|
331
378
|
export declare namespace Materials {
|
|
332
|
-
export { type CreateMaterialRequest as CreateMaterialRequest, type ListMaterial as ListMaterial, type Material as Material, type QuantityInputRequest as QuantityInputRequest, type RateInput as RateInput, type UpdateMaterialRequest as UpdateMaterialRequest, type
|
|
379
|
+
export { type CreateMaterialRequest as CreateMaterialRequest, type ListMaterial as ListMaterial, type Material as Material, type QuantityInputRequest as QuantityInputRequest, type RateInput as RateInput, type UpdateMaterialRequest as UpdateMaterialRequest, type MaterialListParams as MaterialListParams, type MaterialRetrieveParams as MaterialRetrieveParams, type MaterialCreateParams as MaterialCreateParams, type MaterialUpdateParams as MaterialUpdateParams, };
|
|
333
380
|
}
|
|
334
381
|
//# sourceMappingURL=materials.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"materials.d.ts","sourceRoot":"","sources":["../../src/resources/catalog/materials.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"materials.d.ts","sourceRoot":"","sources":["../../src/resources/catalog/materials.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAI3B;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC;IAIvB;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAKpF;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC;IAKvB;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGnE;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,oBAAoB,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;;OAGG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;;OAGG;IACH,UAAU,CAAC,EAAE,SAAS,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACvB;;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,SAAS,EAAE,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,oBAAoB,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC;;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,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,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,SAAS,CAAC,EAAE,oBAAoB,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;;OAGG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;;OAGG;IACH,UAAU,CAAC,EAAE,SAAS,CAAC;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;IAEF;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,oBAAoB,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|
|
@@ -9,19 +9,15 @@ const path_1 = require("../../internal/utils/path.js");
|
|
|
9
9
|
*/
|
|
10
10
|
class Materials extends resource_1.APIResource {
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
12
|
+
* Returns a paginated list of materials.
|
|
13
13
|
*
|
|
14
14
|
* @example
|
|
15
15
|
* ```ts
|
|
16
|
-
* const
|
|
17
|
-
* category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
|
|
18
|
-
* sku: 'MAT-001',
|
|
19
|
-
* });
|
|
16
|
+
* const listMaterial = await client.catalog.materials.list();
|
|
20
17
|
* ```
|
|
21
18
|
*/
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
return this._client.post('/v1/catalog/materials', { query: { include }, body, ...options });
|
|
19
|
+
list(query = {}, options) {
|
|
20
|
+
return this._client.get('/v1/catalog/materials', { query, ...options });
|
|
25
21
|
}
|
|
26
22
|
/**
|
|
27
23
|
* Returns a material by ID.
|
|
@@ -36,9 +32,29 @@ class Materials extends resource_1.APIResource {
|
|
|
36
32
|
retrieve(id, query = {}, options) {
|
|
37
33
|
return this._client.get((0, path_1.path) `/v1/catalog/materials/${id}`, { query, ...options });
|
|
38
34
|
}
|
|
35
|
+
/**
|
|
36
|
+
* Creates a material with the specified SKU and category.
|
|
37
|
+
*
|
|
38
|
+
* Inventory tracking for the new material starts at a zero on-hand quantity in the
|
|
39
|
+
* category's base unit.
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
* ```ts
|
|
43
|
+
* const material = await client.catalog.materials.create({
|
|
44
|
+
* category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
|
|
45
|
+
* sku: 'MAT-001',
|
|
46
|
+
* });
|
|
47
|
+
* ```
|
|
48
|
+
*/
|
|
49
|
+
create(params, options) {
|
|
50
|
+
const { include, ...body } = params;
|
|
51
|
+
return this._client.post('/v1/catalog/materials', { query: { include }, body, ...options });
|
|
52
|
+
}
|
|
39
53
|
/**
|
|
40
54
|
* Partially updates a material.
|
|
41
55
|
*
|
|
56
|
+
* Fields not provided retain their current values.
|
|
57
|
+
*
|
|
42
58
|
* @example
|
|
43
59
|
* ```ts
|
|
44
60
|
* const material = await client.catalog.materials.update(
|
|
@@ -52,18 +68,11 @@ class Materials extends resource_1.APIResource {
|
|
|
52
68
|
return this._client.patch((0, path_1.path) `/v1/catalog/materials/${id}`, { query: { include }, body, ...options });
|
|
53
69
|
}
|
|
54
70
|
/**
|
|
55
|
-
*
|
|
71
|
+
* Deletes a material.
|
|
56
72
|
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
* ```
|
|
61
|
-
*/
|
|
62
|
-
list(query = {}, options) {
|
|
63
|
-
return this._client.get('/v1/catalog/materials', { query, ...options });
|
|
64
|
-
}
|
|
65
|
-
/**
|
|
66
|
-
* Deletes a material by ID.
|
|
73
|
+
* This is a soft delete: the material is marked deleted and no longer returned by
|
|
74
|
+
* other endpoints, but the record is retained. Deleting an already-deleted
|
|
75
|
+
* material returns an error.
|
|
67
76
|
*
|
|
68
77
|
* @example
|
|
69
78
|
* ```ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"materials.js","sourceRoot":"","sources":["../../src/resources/catalog/materials.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAKlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,SAAU,SAAQ,sBAAW;IACxC
|
|
1
|
+
{"version":3,"file":"materials.js","sourceRoot":"","sources":["../../src/resources/catalog/materials.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAKlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;OAOG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAU,EACV,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAA4B,EAAE,OAAwB;QAC3D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAU,EACV,SAAkD,EAAE,EACpD,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,yBAAyB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,yBAAyB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;CACF;AA5FD,8BA4FC"}
|
|
@@ -6,19 +6,15 @@ import { path } from "../../internal/utils/path.mjs";
|
|
|
6
6
|
*/
|
|
7
7
|
export class Materials extends APIResource {
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Returns a paginated list of materials.
|
|
10
10
|
*
|
|
11
11
|
* @example
|
|
12
12
|
* ```ts
|
|
13
|
-
* const
|
|
14
|
-
* category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
|
|
15
|
-
* sku: 'MAT-001',
|
|
16
|
-
* });
|
|
13
|
+
* const listMaterial = await client.catalog.materials.list();
|
|
17
14
|
* ```
|
|
18
15
|
*/
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
return this._client.post('/v1/catalog/materials', { query: { include }, body, ...options });
|
|
16
|
+
list(query = {}, options) {
|
|
17
|
+
return this._client.get('/v1/catalog/materials', { query, ...options });
|
|
22
18
|
}
|
|
23
19
|
/**
|
|
24
20
|
* Returns a material by ID.
|
|
@@ -33,9 +29,29 @@ export class Materials extends APIResource {
|
|
|
33
29
|
retrieve(id, query = {}, options) {
|
|
34
30
|
return this._client.get(path `/v1/catalog/materials/${id}`, { query, ...options });
|
|
35
31
|
}
|
|
32
|
+
/**
|
|
33
|
+
* Creates a material with the specified SKU and category.
|
|
34
|
+
*
|
|
35
|
+
* Inventory tracking for the new material starts at a zero on-hand quantity in the
|
|
36
|
+
* category's base unit.
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* ```ts
|
|
40
|
+
* const material = await client.catalog.materials.create({
|
|
41
|
+
* category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
|
|
42
|
+
* sku: 'MAT-001',
|
|
43
|
+
* });
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
create(params, options) {
|
|
47
|
+
const { include, ...body } = params;
|
|
48
|
+
return this._client.post('/v1/catalog/materials', { query: { include }, body, ...options });
|
|
49
|
+
}
|
|
36
50
|
/**
|
|
37
51
|
* Partially updates a material.
|
|
38
52
|
*
|
|
53
|
+
* Fields not provided retain their current values.
|
|
54
|
+
*
|
|
39
55
|
* @example
|
|
40
56
|
* ```ts
|
|
41
57
|
* const material = await client.catalog.materials.update(
|
|
@@ -49,18 +65,11 @@ export class Materials extends APIResource {
|
|
|
49
65
|
return this._client.patch(path `/v1/catalog/materials/${id}`, { query: { include }, body, ...options });
|
|
50
66
|
}
|
|
51
67
|
/**
|
|
52
|
-
*
|
|
68
|
+
* Deletes a material.
|
|
53
69
|
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
* ```
|
|
58
|
-
*/
|
|
59
|
-
list(query = {}, options) {
|
|
60
|
-
return this._client.get('/v1/catalog/materials', { query, ...options });
|
|
61
|
-
}
|
|
62
|
-
/**
|
|
63
|
-
* Deletes a material by ID.
|
|
70
|
+
* This is a soft delete: the material is marked deleted and no longer returned by
|
|
71
|
+
* other endpoints, but the record is retained. Deleting an already-deleted
|
|
72
|
+
* material returns an error.
|
|
64
73
|
*
|
|
65
74
|
* @example
|
|
66
75
|
* ```ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"materials.mjs","sourceRoot":"","sources":["../../src/resources/catalog/materials.ts"],"names":[],"mappings":"AAAA,sFAAsF;
|
|
1
|
+
{"version":3,"file":"materials.mjs","sourceRoot":"","sources":["../../src/resources/catalog/materials.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;OAOG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAU,EACV,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAA4B,EAAE,OAAwB;QAC3D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAU,EACV,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,yBAAyB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,yBAAyB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;CACF"}
|