@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
|
@@ -10,19 +10,14 @@ import { RequestOptions } from "../../internal/request-options.js";
|
|
|
10
10
|
*/
|
|
11
11
|
export declare class Products extends APIResource {
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* Returns a paginated list of products for the target account.
|
|
14
14
|
*
|
|
15
15
|
* @example
|
|
16
16
|
* ```ts
|
|
17
|
-
* const
|
|
18
|
-
* category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
|
|
19
|
-
* product_line_id: 'product_line_id',
|
|
20
|
-
* sku: 'ALM-2024-1001',
|
|
21
|
-
* type: 'sale',
|
|
22
|
-
* });
|
|
17
|
+
* const listProduct = await client.catalog.products.list();
|
|
23
18
|
* ```
|
|
24
19
|
*/
|
|
25
|
-
|
|
20
|
+
list(query?: ProductListParams | null | undefined, options?: RequestOptions): APIPromise<ListProduct>;
|
|
26
21
|
/**
|
|
27
22
|
* Returns a product by ID.
|
|
28
23
|
*
|
|
@@ -35,26 +30,34 @@ export declare class Products extends APIResource {
|
|
|
35
30
|
*/
|
|
36
31
|
retrieve(id: string, query?: ProductRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Product>;
|
|
37
32
|
/**
|
|
38
|
-
*
|
|
33
|
+
* Creates a product and its backing inventory item.
|
|
34
|
+
*
|
|
35
|
+
* The new item starts with zero on-hand inventory, and its pricing defaults to
|
|
36
|
+
* zero rates in the category's base unit unless `unit_price` or `unit_cost` is
|
|
37
|
+
* provided.
|
|
39
38
|
*
|
|
40
39
|
* @example
|
|
41
40
|
* ```ts
|
|
42
|
-
* const product = await client.catalog.products.
|
|
43
|
-
* '
|
|
44
|
-
*
|
|
45
|
-
*
|
|
41
|
+
* const product = await client.catalog.products.create({
|
|
42
|
+
* category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
|
|
43
|
+
* sku: 'ALM-2024-1001',
|
|
44
|
+
* type: 'sale',
|
|
45
|
+
* });
|
|
46
46
|
* ```
|
|
47
47
|
*/
|
|
48
|
-
|
|
48
|
+
create(params: ProductCreateParams, options?: RequestOptions): APIPromise<Product>;
|
|
49
49
|
/**
|
|
50
|
-
*
|
|
50
|
+
* Partially updates a product.
|
|
51
51
|
*
|
|
52
52
|
* @example
|
|
53
53
|
* ```ts
|
|
54
|
-
* const
|
|
54
|
+
* const product = await client.catalog.products.update(
|
|
55
|
+
* 'pd_013c29ab3f1518d0004094c316',
|
|
56
|
+
* { sku: 'SKU-002' },
|
|
57
|
+
* );
|
|
55
58
|
* ```
|
|
56
59
|
*/
|
|
57
|
-
|
|
60
|
+
update(id: string, params?: ProductUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Product>;
|
|
58
61
|
/**
|
|
59
62
|
* Soft-deletes a product and returns the deleted product.
|
|
60
63
|
*
|
|
@@ -85,19 +88,29 @@ export declare class Products extends APIResource {
|
|
|
85
88
|
*/
|
|
86
89
|
export interface CreateProductRequest {
|
|
87
90
|
/**
|
|
88
|
-
*
|
|
91
|
+
* ID of the item category for the product's item.
|
|
92
|
+
*
|
|
93
|
+
* The category's unit group determines the default units used for the product's
|
|
94
|
+
* pricing rates and inventory tracking.
|
|
89
95
|
*/
|
|
90
96
|
category_id: string;
|
|
91
97
|
/**
|
|
92
|
-
*
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
* SKU.
|
|
98
|
+
* Stock keeping unit code for the product's item.
|
|
99
|
+
*
|
|
100
|
+
* Must be unique within the account; creation fails with a conflict error if
|
|
101
|
+
* another item already uses it.
|
|
97
102
|
*/
|
|
98
103
|
sku: string;
|
|
99
104
|
/**
|
|
100
|
-
* Product type code
|
|
105
|
+
* Product type code, which determines how the product behaves on orders and
|
|
106
|
+
* invoices.
|
|
107
|
+
*
|
|
108
|
+
* - `sale`: a standard sellable product.
|
|
109
|
+
* - `service`: a non-physical service line, such as labor or installation.
|
|
110
|
+
* - `shipping`: a shipping charge applied to an order.
|
|
111
|
+
* - `credit`: a credit applied against an order or invoice.
|
|
112
|
+
* - `return`: a returned product (RMA).
|
|
113
|
+
* - `tax`: a tax line.
|
|
101
114
|
*/
|
|
102
115
|
type: 'sale' | 'service' | 'shipping' | 'credit' | 'return' | 'tax';
|
|
103
116
|
/**
|
|
@@ -107,24 +120,36 @@ export interface CreateProductRequest {
|
|
|
107
120
|
/**
|
|
108
121
|
* Description.
|
|
109
122
|
*/
|
|
110
|
-
description?: string
|
|
123
|
+
description?: string;
|
|
111
124
|
/**
|
|
112
125
|
* Notes.
|
|
113
126
|
*/
|
|
114
|
-
notes?: string
|
|
127
|
+
notes?: string;
|
|
115
128
|
/**
|
|
116
|
-
* Whether
|
|
129
|
+
* Whether the product is shown to buyers in the customer portal.
|
|
130
|
+
*
|
|
131
|
+
* - `visible`: buyers can see and order the product in the portal.
|
|
132
|
+
* - `hidden`: the product is concealed from the portal but remains usable
|
|
133
|
+
* internally.
|
|
134
|
+
*
|
|
135
|
+
* When omitted, the product is created hidden, so it must be set to `visible`
|
|
136
|
+
* before buyers can see it.
|
|
117
137
|
*/
|
|
118
138
|
portal_visibility?: 'visible' | 'hidden';
|
|
119
139
|
/**
|
|
120
|
-
*
|
|
140
|
+
* ID of the product line to assign the product to.
|
|
141
|
+
*/
|
|
142
|
+
product_line_id?: string;
|
|
143
|
+
/**
|
|
144
|
+
* A rate value with its numerator and denominator units, used in create and update
|
|
145
|
+
* requests.
|
|
121
146
|
*/
|
|
122
|
-
unit_cost?: MaterialsAPI.RateInput
|
|
147
|
+
unit_cost?: MaterialsAPI.RateInput;
|
|
123
148
|
/**
|
|
124
|
-
*
|
|
125
|
-
*
|
|
149
|
+
* A rate value with its numerator and denominator units, used in create and update
|
|
150
|
+
* requests.
|
|
126
151
|
*/
|
|
127
|
-
unit_price?: MaterialsAPI.RateInput
|
|
152
|
+
unit_price?: MaterialsAPI.RateInput;
|
|
128
153
|
}
|
|
129
154
|
/**
|
|
130
155
|
* List represents a paginated list of resources.
|
|
@@ -144,7 +169,8 @@ export interface ListProduct {
|
|
|
144
169
|
page_info: APIKeysAPI.PageInfo;
|
|
145
170
|
}
|
|
146
171
|
/**
|
|
147
|
-
* Product
|
|
172
|
+
* Product pairs an inventory item with how it is sold: its product type, optional
|
|
173
|
+
* product line, and customer portal visibility.
|
|
148
174
|
*/
|
|
149
175
|
export interface Product {
|
|
150
176
|
/**
|
|
@@ -164,15 +190,30 @@ export interface Product {
|
|
|
164
190
|
*/
|
|
165
191
|
object: 'product';
|
|
166
192
|
/**
|
|
167
|
-
*
|
|
193
|
+
* Whether the product is shown to buyers in the customer portal.
|
|
194
|
+
*
|
|
195
|
+
* - `visible`: buyers can see and order the product in the portal.
|
|
196
|
+
* - `hidden`: the product is concealed from the portal but remains usable
|
|
197
|
+
* internally.
|
|
168
198
|
*/
|
|
169
199
|
portal_visibility: 'visible' | 'hidden';
|
|
170
200
|
/**
|
|
171
201
|
* Product line resource.
|
|
202
|
+
*
|
|
203
|
+
* A product line groups related products in your catalog and carries the default
|
|
204
|
+
* commission policy, freight policy, and unit group for those products.
|
|
172
205
|
*/
|
|
173
206
|
product_line: ProductLinesAPI.ProductLine | null;
|
|
174
207
|
/**
|
|
175
|
-
* Product type code
|
|
208
|
+
* Product type code, which determines how the product behaves on orders and
|
|
209
|
+
* invoices.
|
|
210
|
+
*
|
|
211
|
+
* - `sale`: a standard sellable product.
|
|
212
|
+
* - `service`: a non-physical service line, such as labor or installation.
|
|
213
|
+
* - `shipping`: a shipping charge applied to an order.
|
|
214
|
+
* - `credit`: a credit applied against an order or invoice.
|
|
215
|
+
* - `return`: a returned product (RMA).
|
|
216
|
+
* - `tax`: a tax line.
|
|
176
217
|
*/
|
|
177
218
|
type: 'sale' | 'service' | 'shipping' | 'credit' | 'return' | 'tax';
|
|
178
219
|
/**
|
|
@@ -186,72 +227,89 @@ export interface Product {
|
|
|
186
227
|
export interface UpdateProductRequest {
|
|
187
228
|
/**
|
|
188
229
|
* Description.
|
|
230
|
+
*
|
|
231
|
+
* Send `null` to clear.
|
|
189
232
|
*/
|
|
190
233
|
description?: string | null;
|
|
191
234
|
/**
|
|
192
235
|
* Notes.
|
|
236
|
+
*
|
|
237
|
+
* Send `null` to clear.
|
|
193
238
|
*/
|
|
194
239
|
notes?: string | null;
|
|
195
240
|
/**
|
|
196
|
-
* Whether
|
|
241
|
+
* Whether the product is shown to buyers in the customer portal.
|
|
242
|
+
*
|
|
243
|
+
* - `visible`: buyers can see and order the product in the portal.
|
|
244
|
+
* - `hidden`: the product is concealed from the portal but remains usable
|
|
245
|
+
* internally.
|
|
197
246
|
*/
|
|
198
247
|
portal_visibility?: 'visible' | 'hidden';
|
|
199
248
|
/**
|
|
200
|
-
*
|
|
249
|
+
* New stock keeping unit code for the product's item.
|
|
250
|
+
*
|
|
251
|
+
* Must be unique within the account; the update fails with a conflict error if
|
|
252
|
+
* another item already uses it.
|
|
201
253
|
*/
|
|
202
254
|
sku?: string;
|
|
203
255
|
/**
|
|
204
|
-
*
|
|
256
|
+
* A rate value with its numerator and denominator units, used in create and update
|
|
257
|
+
* requests.
|
|
205
258
|
*/
|
|
206
|
-
unit_price?: MaterialsAPI.RateInput
|
|
259
|
+
unit_price?: MaterialsAPI.RateInput;
|
|
207
260
|
}
|
|
208
|
-
export interface
|
|
261
|
+
export interface ProductListParams {
|
|
209
262
|
/**
|
|
210
|
-
*
|
|
263
|
+
* Filter by attribute IDs.
|
|
211
264
|
*/
|
|
212
|
-
|
|
265
|
+
attribute_ids?: Array<string>;
|
|
213
266
|
/**
|
|
214
|
-
*
|
|
267
|
+
* Filter by category IDs.
|
|
215
268
|
*/
|
|
216
|
-
|
|
269
|
+
category_ids?: Array<string>;
|
|
217
270
|
/**
|
|
218
|
-
*
|
|
271
|
+
* Opaque cursor token identifying where the page of results starts.
|
|
272
|
+
*
|
|
273
|
+
* Use the `cursor` value embedded in a previous response's `next_page_url` or
|
|
274
|
+
* `previous_page_url` to fetch the adjacent page. Omit to start from the first
|
|
275
|
+
* page.
|
|
219
276
|
*/
|
|
220
|
-
|
|
277
|
+
cursor?: string;
|
|
221
278
|
/**
|
|
222
|
-
*
|
|
279
|
+
* Filter by customer IDs.
|
|
223
280
|
*/
|
|
224
|
-
|
|
281
|
+
customer_ids?: Array<string>;
|
|
225
282
|
/**
|
|
226
|
-
*
|
|
227
|
-
* are returned as `null`.
|
|
283
|
+
* End of creation date range.
|
|
228
284
|
*/
|
|
229
|
-
|
|
285
|
+
end_date?: string;
|
|
230
286
|
/**
|
|
231
|
-
*
|
|
287
|
+
* Sub-objects to expand in the response. When omitted, sub-objects are returned as
|
|
288
|
+
* `null`.
|
|
232
289
|
*/
|
|
233
|
-
|
|
290
|
+
include?: Array<'product_line' | 'product_line.unit_group' | 'product_line.unit_group.base_unit' | 'product_line.unit_group.associated_units' | 'product_line.unit_group.associated_units.unit' | 'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.category.unit_group.base_unit' | 'item.category.unit_group.associated_units' | 'item.category.unit_group.associated_units.unit' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
|
|
234
291
|
/**
|
|
235
|
-
*
|
|
292
|
+
* Maximum number of results to return in a single page.
|
|
236
293
|
*/
|
|
237
|
-
|
|
294
|
+
limit?: number;
|
|
238
295
|
/**
|
|
239
|
-
*
|
|
296
|
+
* Filter by customer portal visibility.
|
|
240
297
|
*/
|
|
241
|
-
|
|
298
|
+
portal_visibility?: 'visible' | 'hidden';
|
|
242
299
|
/**
|
|
243
|
-
*
|
|
300
|
+
* Filter by product line IDs.
|
|
244
301
|
*/
|
|
245
|
-
|
|
302
|
+
product_line_ids?: Array<string>;
|
|
246
303
|
/**
|
|
247
|
-
*
|
|
304
|
+
* Free-text search term used to filter results.
|
|
305
|
+
*
|
|
306
|
+
* Which fields are matched against the term varies by endpoint.
|
|
248
307
|
*/
|
|
249
|
-
|
|
308
|
+
q?: string;
|
|
250
309
|
/**
|
|
251
|
-
*
|
|
252
|
-
* denominator must not be.
|
|
310
|
+
* Start of creation date range.
|
|
253
311
|
*/
|
|
254
|
-
|
|
312
|
+
start_date?: string;
|
|
255
313
|
}
|
|
256
314
|
export interface ProductRetrieveParams {
|
|
257
315
|
/**
|
|
@@ -260,80 +318,114 @@ export interface ProductRetrieveParams {
|
|
|
260
318
|
*/
|
|
261
319
|
include?: Array<'product_line' | 'product_line.unit_group' | 'product_line.unit_group.base_unit' | 'product_line.unit_group.associated_units' | 'product_line.unit_group.associated_units.unit' | 'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.category.unit_group.base_unit' | 'item.category.unit_group.associated_units' | 'item.category.unit_group.associated_units.unit' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
|
|
262
320
|
}
|
|
263
|
-
export interface
|
|
321
|
+
export interface ProductCreateParams {
|
|
264
322
|
/**
|
|
265
|
-
*
|
|
266
|
-
*
|
|
323
|
+
* Body param: ID of the item category for the product's item.
|
|
324
|
+
*
|
|
325
|
+
* The category's unit group determines the default units used for the product's
|
|
326
|
+
* pricing rates and inventory tracking.
|
|
267
327
|
*/
|
|
268
|
-
|
|
328
|
+
category_id: string;
|
|
269
329
|
/**
|
|
270
|
-
* Body param:
|
|
330
|
+
* Body param: Stock keeping unit code for the product's item.
|
|
331
|
+
*
|
|
332
|
+
* Must be unique within the account; creation fails with a conflict error if
|
|
333
|
+
* another item already uses it.
|
|
271
334
|
*/
|
|
272
|
-
|
|
335
|
+
sku: string;
|
|
273
336
|
/**
|
|
274
|
-
* Body param:
|
|
337
|
+
* Body param: Product type code, which determines how the product behaves on
|
|
338
|
+
* orders and invoices.
|
|
339
|
+
*
|
|
340
|
+
* - `sale`: a standard sellable product.
|
|
341
|
+
* - `service`: a non-physical service line, such as labor or installation.
|
|
342
|
+
* - `shipping`: a shipping charge applied to an order.
|
|
343
|
+
* - `credit`: a credit applied against an order or invoice.
|
|
344
|
+
* - `return`: a returned product (RMA).
|
|
345
|
+
* - `tax`: a tax line.
|
|
275
346
|
*/
|
|
276
|
-
|
|
347
|
+
type: 'sale' | 'service' | 'shipping' | 'credit' | 'return' | 'tax';
|
|
277
348
|
/**
|
|
278
|
-
*
|
|
349
|
+
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
350
|
+
* are returned as `null`.
|
|
279
351
|
*/
|
|
280
|
-
|
|
352
|
+
include?: Array<'product_line' | 'product_line.unit_group' | 'product_line.unit_group.base_unit' | 'product_line.unit_group.associated_units' | 'product_line.unit_group.associated_units.unit' | 'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.category.unit_group.base_unit' | 'item.category.unit_group.associated_units' | 'item.category.unit_group.associated_units.unit' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
|
|
281
353
|
/**
|
|
282
|
-
* Body param:
|
|
354
|
+
* Body param: Attribute IDs to connect to the product at creation time.
|
|
283
355
|
*/
|
|
284
|
-
|
|
356
|
+
attribute_ids?: Array<string>;
|
|
285
357
|
/**
|
|
286
|
-
* Body param:
|
|
287
|
-
* must not be.
|
|
358
|
+
* Body param: Description.
|
|
288
359
|
*/
|
|
289
|
-
|
|
290
|
-
}
|
|
291
|
-
export interface ProductListParams {
|
|
360
|
+
description?: string;
|
|
292
361
|
/**
|
|
293
|
-
*
|
|
362
|
+
* Body param: Notes.
|
|
294
363
|
*/
|
|
295
|
-
|
|
364
|
+
notes?: string;
|
|
296
365
|
/**
|
|
297
|
-
*
|
|
366
|
+
* Body param: Whether the product is shown to buyers in the customer portal.
|
|
367
|
+
*
|
|
368
|
+
* - `visible`: buyers can see and order the product in the portal.
|
|
369
|
+
* - `hidden`: the product is concealed from the portal but remains usable
|
|
370
|
+
* internally.
|
|
371
|
+
*
|
|
372
|
+
* When omitted, the product is created hidden, so it must be set to `visible`
|
|
373
|
+
* before buyers can see it.
|
|
298
374
|
*/
|
|
299
|
-
|
|
375
|
+
portal_visibility?: 'visible' | 'hidden';
|
|
300
376
|
/**
|
|
301
|
-
*
|
|
377
|
+
* Body param: ID of the product line to assign the product to.
|
|
302
378
|
*/
|
|
303
|
-
|
|
379
|
+
product_line_id?: string;
|
|
304
380
|
/**
|
|
305
|
-
*
|
|
381
|
+
* Body param: A rate value with its numerator and denominator units, used in
|
|
382
|
+
* create and update requests.
|
|
306
383
|
*/
|
|
307
|
-
|
|
384
|
+
unit_cost?: MaterialsAPI.RateInput;
|
|
308
385
|
/**
|
|
309
|
-
*
|
|
386
|
+
* Body param: A rate value with its numerator and denominator units, used in
|
|
387
|
+
* create and update requests.
|
|
310
388
|
*/
|
|
311
|
-
|
|
389
|
+
unit_price?: MaterialsAPI.RateInput;
|
|
390
|
+
}
|
|
391
|
+
export interface ProductUpdateParams {
|
|
312
392
|
/**
|
|
313
|
-
* Sub-objects to expand in the response. When omitted, sub-objects
|
|
314
|
-
* `null`.
|
|
393
|
+
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
394
|
+
* are returned as `null`.
|
|
315
395
|
*/
|
|
316
396
|
include?: Array<'product_line' | 'product_line.unit_group' | 'product_line.unit_group.base_unit' | 'product_line.unit_group.associated_units' | 'product_line.unit_group.associated_units.unit' | 'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.category.unit_group.base_unit' | 'item.category.unit_group.associated_units' | 'item.category.unit_group.associated_units.unit' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
|
|
317
397
|
/**
|
|
318
|
-
*
|
|
398
|
+
* Body param: Description.
|
|
399
|
+
*
|
|
400
|
+
* Send `null` to clear.
|
|
319
401
|
*/
|
|
320
|
-
|
|
402
|
+
description?: string | null;
|
|
321
403
|
/**
|
|
322
|
-
*
|
|
404
|
+
* Body param: Notes.
|
|
405
|
+
*
|
|
406
|
+
* Send `null` to clear.
|
|
323
407
|
*/
|
|
324
|
-
|
|
408
|
+
notes?: string | null;
|
|
325
409
|
/**
|
|
326
|
-
*
|
|
410
|
+
* Body param: Whether the product is shown to buyers in the customer portal.
|
|
411
|
+
*
|
|
412
|
+
* - `visible`: buyers can see and order the product in the portal.
|
|
413
|
+
* - `hidden`: the product is concealed from the portal but remains usable
|
|
414
|
+
* internally.
|
|
327
415
|
*/
|
|
328
|
-
|
|
416
|
+
portal_visibility?: 'visible' | 'hidden';
|
|
329
417
|
/**
|
|
330
|
-
*
|
|
418
|
+
* Body param: New stock keeping unit code for the product's item.
|
|
419
|
+
*
|
|
420
|
+
* Must be unique within the account; the update fails with a conflict error if
|
|
421
|
+
* another item already uses it.
|
|
331
422
|
*/
|
|
332
|
-
|
|
423
|
+
sku?: string;
|
|
333
424
|
/**
|
|
334
|
-
*
|
|
425
|
+
* Body param: A rate value with its numerator and denominator units, used in
|
|
426
|
+
* create and update requests.
|
|
335
427
|
*/
|
|
336
|
-
|
|
428
|
+
unit_price?: MaterialsAPI.RateInput;
|
|
337
429
|
}
|
|
338
430
|
export interface ProductDeleteParams {
|
|
339
431
|
/**
|
|
@@ -354,6 +446,6 @@ export interface ProductChangeProductLineParams {
|
|
|
354
446
|
include?: Array<'product_line' | 'product_line.unit_group' | 'product_line.unit_group.base_unit' | 'product_line.unit_group.associated_units' | 'product_line.unit_group.associated_units.unit' | 'item' | 'item.category' | 'item.category.properties' | 'item.category.unit_group' | 'item.category.unit_group.base_unit' | 'item.category.unit_group.associated_units' | 'item.category.unit_group.associated_units.unit' | 'item.unit_value' | 'item.unit_cost' | 'item.burn_rate' | 'item.attributes'>;
|
|
355
447
|
}
|
|
356
448
|
export declare namespace Products {
|
|
357
|
-
export { type CreateProductRequest as CreateProductRequest, type ListProduct as ListProduct, type Product as Product, type UpdateProductRequest as UpdateProductRequest, type
|
|
449
|
+
export { type CreateProductRequest as CreateProductRequest, type ListProduct as ListProduct, type Product as Product, type UpdateProductRequest as UpdateProductRequest, type ProductListParams as ProductListParams, type ProductRetrieveParams as ProductRetrieveParams, type ProductCreateParams as ProductCreateParams, type ProductUpdateParams as ProductUpdateParams, type ProductDeleteParams as ProductDeleteParams, type ProductChangeProductLineParams as ProductChangeProductLineParams, };
|
|
358
450
|
}
|
|
359
451
|
//# sourceMappingURL=products.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"products.d.ts","sourceRoot":"","sources":["../../src/resources/catalog/products.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"products.d.ts","sourceRoot":"","sources":["../../src/resources/catalog/products.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,KAAK,eAAe;OACpB,KAAK,UAAU;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;OAOG;IACH,IAAI,CAAC,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAIzG;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAItB;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAKlF;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAKtB;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAKtB;;;;;;;;;;;OAWG;IACH,iBAAiB,CACf,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;CAOvB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;;;;;;OAUG;IACH,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;IAEpE;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEzC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;;;;;OAMG;IACH,iBAAiB,EAAE,SAAS,GAAG,QAAQ,CAAC;IAExC;;;;;OAKG;IACH,YAAY,EAAE,eAAe,CAAC,WAAW,GAAG,IAAI,CAAC;IAEjD;;;;;;;;;;OAUG;IACH,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;IAEpE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEzC;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEzC;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;CACH;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;;;;;;OAUG;IACH,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;IAEpE;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;IAEF;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEzC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;IAEF;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEzC;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;CACH;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACX,cAAc,GACd,yBAAyB,GACzB,mCAAmC,GACnC,0CAA0C,GAC1C,+CAA+C,GAC/C,MAAM,GACN,eAAe,GACf,0BAA0B,GAC1B,0BAA0B,GAC1B,oCAAoC,GACpC,2CAA2C,GAC3C,gDAAgD,GAChD,iBAAiB,GACjB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CACpB,CAAC;CACH;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
|
|
@@ -9,21 +9,15 @@ const path_1 = require("../../internal/utils/path.js");
|
|
|
9
9
|
*/
|
|
10
10
|
class Products extends resource_1.APIResource {
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
12
|
+
* Returns a paginated list of products for the target account.
|
|
13
13
|
*
|
|
14
14
|
* @example
|
|
15
15
|
* ```ts
|
|
16
|
-
* const
|
|
17
|
-
* category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
|
|
18
|
-
* product_line_id: 'product_line_id',
|
|
19
|
-
* sku: 'ALM-2024-1001',
|
|
20
|
-
* type: 'sale',
|
|
21
|
-
* });
|
|
16
|
+
* const listProduct = await client.catalog.products.list();
|
|
22
17
|
* ```
|
|
23
18
|
*/
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
return this._client.post('/v1/catalog/products', { query: { include }, body, ...options });
|
|
19
|
+
list(query = {}, options) {
|
|
20
|
+
return this._client.get('/v1/catalog/products', { query, ...options });
|
|
27
21
|
}
|
|
28
22
|
/**
|
|
29
23
|
* Returns a product by ID.
|
|
@@ -38,6 +32,26 @@ class Products extends resource_1.APIResource {
|
|
|
38
32
|
retrieve(id, query = {}, options) {
|
|
39
33
|
return this._client.get((0, path_1.path) `/v1/catalog/products/${id}`, { query, ...options });
|
|
40
34
|
}
|
|
35
|
+
/**
|
|
36
|
+
* Creates a product and its backing inventory item.
|
|
37
|
+
*
|
|
38
|
+
* The new item starts with zero on-hand inventory, and its pricing defaults to
|
|
39
|
+
* zero rates in the category's base unit unless `unit_price` or `unit_cost` is
|
|
40
|
+
* provided.
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```ts
|
|
44
|
+
* const product = await client.catalog.products.create({
|
|
45
|
+
* category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
|
|
46
|
+
* sku: 'ALM-2024-1001',
|
|
47
|
+
* type: 'sale',
|
|
48
|
+
* });
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
51
|
+
create(params, options) {
|
|
52
|
+
const { include, ...body } = params;
|
|
53
|
+
return this._client.post('/v1/catalog/products', { query: { include }, body, ...options });
|
|
54
|
+
}
|
|
41
55
|
/**
|
|
42
56
|
* Partially updates a product.
|
|
43
57
|
*
|
|
@@ -53,17 +67,6 @@ class Products extends resource_1.APIResource {
|
|
|
53
67
|
const { include, ...body } = params ?? {};
|
|
54
68
|
return this._client.patch((0, path_1.path) `/v1/catalog/products/${id}`, { query: { include }, body, ...options });
|
|
55
69
|
}
|
|
56
|
-
/**
|
|
57
|
-
* Returns a paginated list of products for the target account.
|
|
58
|
-
*
|
|
59
|
-
* @example
|
|
60
|
-
* ```ts
|
|
61
|
-
* const listProduct = await client.catalog.products.list();
|
|
62
|
-
* ```
|
|
63
|
-
*/
|
|
64
|
-
list(query = {}, options) {
|
|
65
|
-
return this._client.get('/v1/catalog/products', { query, ...options });
|
|
66
|
-
}
|
|
67
70
|
/**
|
|
68
71
|
* Soft-deletes a product and returns the deleted product.
|
|
69
72
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"products.js","sourceRoot":"","sources":["../../src/resources/catalog/products.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAOlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC
|
|
1
|
+
{"version":3,"file":"products.js","sourceRoot":"","sources":["../../src/resources/catalog/products.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAOlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;OAOG;IACH,IAAI,CAAC,QAA8C,EAAE,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAU,EACV,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,iBAAiB,CACf,aAAqB,EACrB,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,iBAAiB,aAAa,EAAE,EAAE;YACtF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAlHD,4BAkHC"}
|