@augno/sdk 0.1.9 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +4 -9
- package/README.md +27 -0
- package/api-promise.d.mts +0 -1
- package/api-promise.d.mts.map +1 -1
- package/api-promise.d.ts +0 -1
- package/api-promise.d.ts.map +1 -1
- package/api-promise.mjs +0 -1
- package/api-promise.mjs.map +1 -1
- package/client.d.mts +4 -1
- package/client.d.mts.map +1 -1
- package/client.d.ts +4 -1
- package/client.d.ts.map +1 -1
- package/client.js +9 -1
- package/client.js.map +1 -1
- package/client.mjs +9 -1
- package/client.mjs.map +1 -1
- package/core/api-promise.d.mts.map +1 -1
- package/core/api-promise.d.ts.map +1 -1
- package/core/api-promise.mjs.map +1 -1
- package/core/error.mjs.map +1 -1
- package/core/resource.d.mts.map +1 -1
- package/core/resource.d.ts.map +1 -1
- package/core/uploads.d.mts.map +1 -1
- package/core/uploads.d.ts.map +1 -1
- package/core/uploads.mjs.map +1 -1
- package/error.d.mts +0 -1
- package/error.d.mts.map +1 -1
- package/error.d.ts +0 -1
- package/error.d.ts.map +1 -1
- package/error.mjs +0 -1
- package/error.mjs.map +1 -1
- package/index.d.mts.map +1 -1
- package/index.d.ts.map +1 -1
- package/index.mjs.map +1 -1
- package/internal/headers.mjs.map +1 -1
- package/internal/parse.d.mts.map +1 -1
- package/internal/parse.d.ts.map +1 -1
- package/internal/parse.mjs.map +1 -1
- package/internal/qs/formats.d.mts.map +1 -1
- package/internal/qs/formats.d.ts.map +1 -1
- package/internal/qs/index.d.mts +2 -2
- package/internal/qs/index.d.mts.map +1 -1
- package/internal/qs/index.d.ts +2 -2
- package/internal/qs/index.d.ts.map +1 -1
- package/internal/qs/index.mjs.map +1 -1
- package/internal/qs/stringify.d.mts.map +1 -1
- package/internal/qs/stringify.d.ts.map +1 -1
- package/internal/qs/stringify.mjs.map +1 -1
- package/internal/qs/utils.d.mts.map +1 -1
- package/internal/qs/utils.d.ts.map +1 -1
- package/internal/qs/utils.mjs.map +1 -1
- package/internal/request-options.d.mts.map +1 -1
- package/internal/request-options.d.ts.map +1 -1
- package/internal/shims.d.mts +0 -6
- package/internal/shims.d.mts.map +1 -1
- package/internal/shims.d.ts +0 -6
- package/internal/shims.d.ts.map +1 -1
- package/internal/to-file.d.mts.map +1 -1
- package/internal/to-file.d.ts.map +1 -1
- package/internal/to-file.mjs.map +1 -1
- package/internal/types.d.mts +4 -4
- package/internal/types.d.mts.map +1 -1
- package/internal/types.d.ts +4 -4
- package/internal/types.d.ts.map +1 -1
- package/internal/uploads.d.mts.map +1 -1
- package/internal/uploads.d.ts.map +1 -1
- package/internal/uploads.mjs.map +1 -1
- package/internal/utils/base64.mjs.map +1 -1
- package/internal/utils/log.d.mts.map +1 -1
- package/internal/utils/log.d.ts.map +1 -1
- package/internal/utils/log.mjs.map +1 -1
- package/internal/utils/path.mjs.map +1 -1
- package/internal/utils/query.mjs.map +1 -1
- package/internal/utils/values.mjs.map +1 -1
- package/internal/utils.d.mts.map +1 -1
- package/internal/utils.d.ts.map +1 -1
- package/internal/utils.mjs.map +1 -1
- package/package.json +3 -3
- package/resource.d.mts +0 -1
- package/resource.d.mts.map +1 -1
- package/resource.d.ts +0 -1
- package/resource.d.ts.map +1 -1
- package/resource.mjs +0 -1
- package/resource.mjs.map +1 -1
- package/resources/auth/api-keys/actions.d.mts +26 -5
- package/resources/auth/api-keys/actions.d.mts.map +1 -1
- package/resources/auth/api-keys/actions.d.ts +26 -5
- package/resources/auth/api-keys/actions.d.ts.map +1 -1
- package/resources/auth/api-keys/actions.js +4 -1
- package/resources/auth/api-keys/actions.js.map +1 -1
- package/resources/auth/api-keys/actions.mjs +4 -1
- package/resources/auth/api-keys/actions.mjs.map +1 -1
- package/resources/auth/api-keys/api-keys.d.mts +134 -70
- package/resources/auth/api-keys/api-keys.d.mts.map +1 -1
- package/resources/auth/api-keys/api-keys.d.ts +134 -70
- package/resources/auth/api-keys/api-keys.d.ts.map +1 -1
- package/resources/auth/api-keys/api-keys.js +24 -22
- package/resources/auth/api-keys/api-keys.js.map +1 -1
- package/resources/auth/api-keys/api-keys.mjs +24 -22
- package/resources/auth/api-keys/api-keys.mjs.map +1 -1
- package/resources/auth/api-keys/index.d.mts +1 -1
- package/resources/auth/api-keys/index.d.mts.map +1 -1
- package/resources/auth/api-keys/index.d.ts +1 -1
- package/resources/auth/api-keys/index.d.ts.map +1 -1
- package/resources/auth/api-keys/index.mjs.map +1 -1
- package/resources/auth/api-keys.d.mts.map +1 -1
- package/resources/auth/api-keys.d.ts.map +1 -1
- package/resources/auth/api-keys.mjs.map +1 -1
- package/resources/auth/auth.d.mts +1 -1
- package/resources/auth/auth.d.mts.map +1 -1
- package/resources/auth/auth.d.ts +1 -1
- package/resources/auth/auth.d.ts.map +1 -1
- package/resources/auth/auth.mjs.map +1 -1
- package/resources/auth/index.d.mts +1 -1
- package/resources/auth/index.d.mts.map +1 -1
- package/resources/auth/index.d.ts +1 -1
- package/resources/auth/index.d.ts.map +1 -1
- package/resources/auth/index.mjs.map +1 -1
- package/resources/auth.d.mts.map +1 -1
- package/resources/auth.d.ts.map +1 -1
- package/resources/auth.mjs.map +1 -1
- package/resources/catalog/catalog.d.mts +9 -9
- package/resources/catalog/catalog.d.mts.map +1 -1
- package/resources/catalog/catalog.d.ts +9 -9
- package/resources/catalog/catalog.d.ts.map +1 -1
- package/resources/catalog/catalog.mjs.map +1 -1
- package/resources/catalog/index.d.mts +9 -9
- package/resources/catalog/index.d.mts.map +1 -1
- package/resources/catalog/index.d.ts +9 -9
- package/resources/catalog/index.d.ts.map +1 -1
- package/resources/catalog/index.mjs.map +1 -1
- package/resources/catalog/item-categories/index.d.mts +1 -1
- package/resources/catalog/item-categories/index.d.mts.map +1 -1
- package/resources/catalog/item-categories/index.d.ts +1 -1
- package/resources/catalog/item-categories/index.d.ts.map +1 -1
- package/resources/catalog/item-categories/index.mjs.map +1 -1
- package/resources/catalog/item-categories/item-categories.d.mts +95 -65
- package/resources/catalog/item-categories/item-categories.d.mts.map +1 -1
- package/resources/catalog/item-categories/item-categories.d.ts +95 -65
- package/resources/catalog/item-categories/item-categories.d.ts.map +1 -1
- package/resources/catalog/item-categories/item-categories.js +38 -30
- package/resources/catalog/item-categories/item-categories.js.map +1 -1
- package/resources/catalog/item-categories/item-categories.mjs +38 -30
- package/resources/catalog/item-categories/item-categories.mjs.map +1 -1
- package/resources/catalog/item-categories/properties.d.mts +9 -4
- package/resources/catalog/item-categories/properties.d.mts.map +1 -1
- package/resources/catalog/item-categories/properties.d.ts +9 -4
- package/resources/catalog/item-categories/properties.d.ts.map +1 -1
- package/resources/catalog/item-categories/properties.js +9 -4
- package/resources/catalog/item-categories/properties.js.map +1 -1
- package/resources/catalog/item-categories/properties.mjs +9 -4
- package/resources/catalog/item-categories/properties.mjs.map +1 -1
- package/resources/catalog/item-categories.d.mts.map +1 -1
- package/resources/catalog/item-categories.d.ts.map +1 -1
- package/resources/catalog/item-categories.mjs.map +1 -1
- package/resources/catalog/items/attributes.d.mts +3 -2
- package/resources/catalog/items/attributes.d.mts.map +1 -1
- package/resources/catalog/items/attributes.d.ts +3 -2
- package/resources/catalog/items/attributes.d.ts.map +1 -1
- package/resources/catalog/items/attributes.js +3 -2
- package/resources/catalog/items/attributes.js.map +1 -1
- package/resources/catalog/items/attributes.mjs +3 -2
- package/resources/catalog/items/attributes.mjs.map +1 -1
- package/resources/catalog/items/index.d.mts +1 -1
- package/resources/catalog/items/index.d.mts.map +1 -1
- package/resources/catalog/items/index.d.ts +1 -1
- package/resources/catalog/items/index.d.ts.map +1 -1
- package/resources/catalog/items/index.mjs.map +1 -1
- package/resources/catalog/items/items.d.mts +88 -52
- package/resources/catalog/items/items.d.mts.map +1 -1
- package/resources/catalog/items/items.d.ts +88 -52
- package/resources/catalog/items/items.d.ts.map +1 -1
- package/resources/catalog/items/items.js +24 -21
- package/resources/catalog/items/items.js.map +1 -1
- package/resources/catalog/items/items.mjs +24 -21
- package/resources/catalog/items/items.mjs.map +1 -1
- package/resources/catalog/items.d.mts.map +1 -1
- package/resources/catalog/items.d.ts.map +1 -1
- package/resources/catalog/items.mjs.map +1 -1
- package/resources/catalog/materials.d.mts +134 -87
- package/resources/catalog/materials.d.mts.map +1 -1
- package/resources/catalog/materials.d.ts +134 -87
- package/resources/catalog/materials.d.ts.map +1 -1
- package/resources/catalog/materials.js +29 -19
- package/resources/catalog/materials.js.map +1 -1
- package/resources/catalog/materials.mjs +29 -19
- package/resources/catalog/materials.mjs.map +1 -1
- package/resources/catalog/parts.d.mts +127 -74
- package/resources/catalog/parts.d.mts.map +1 -1
- package/resources/catalog/parts.d.ts +127 -74
- package/resources/catalog/parts.d.ts.map +1 -1
- package/resources/catalog/parts.js +34 -20
- package/resources/catalog/parts.js.map +1 -1
- package/resources/catalog/parts.mjs +34 -20
- package/resources/catalog/parts.mjs.map +1 -1
- package/resources/catalog/product-lines.d.mts +145 -70
- package/resources/catalog/product-lines.d.mts.map +1 -1
- package/resources/catalog/product-lines.d.ts +145 -70
- package/resources/catalog/product-lines.d.ts.map +1 -1
- package/resources/catalog/product-lines.js +31 -26
- package/resources/catalog/product-lines.js.map +1 -1
- package/resources/catalog/product-lines.mjs +31 -26
- package/resources/catalog/product-lines.mjs.map +1 -1
- package/resources/catalog/products.d.mts +187 -90
- package/resources/catalog/products.d.mts.map +1 -1
- package/resources/catalog/products.d.ts +187 -90
- package/resources/catalog/products.d.ts.map +1 -1
- package/resources/catalog/products.js +25 -20
- package/resources/catalog/products.js.map +1 -1
- package/resources/catalog/products.mjs +25 -20
- package/resources/catalog/products.mjs.map +1 -1
- package/resources/catalog/properties/attributes.d.mts +96 -44
- package/resources/catalog/properties/attributes.d.mts.map +1 -1
- package/resources/catalog/properties/attributes.d.ts +96 -44
- package/resources/catalog/properties/attributes.d.ts.map +1 -1
- package/resources/catalog/properties/attributes.js +31 -21
- package/resources/catalog/properties/attributes.js.map +1 -1
- package/resources/catalog/properties/attributes.mjs +31 -21
- package/resources/catalog/properties/attributes.mjs.map +1 -1
- package/resources/catalog/properties/index.d.mts +2 -2
- package/resources/catalog/properties/index.d.mts.map +1 -1
- package/resources/catalog/properties/index.d.ts +2 -2
- package/resources/catalog/properties/index.d.ts.map +1 -1
- package/resources/catalog/properties/index.mjs.map +1 -1
- package/resources/catalog/properties/properties.d.mts +70 -47
- package/resources/catalog/properties/properties.d.mts.map +1 -1
- package/resources/catalog/properties/properties.d.ts +70 -47
- package/resources/catalog/properties/properties.d.ts.map +1 -1
- package/resources/catalog/properties/properties.js +19 -18
- package/resources/catalog/properties/properties.js.map +1 -1
- package/resources/catalog/properties/properties.mjs +19 -18
- package/resources/catalog/properties/properties.mjs.map +1 -1
- package/resources/catalog/properties.d.mts.map +1 -1
- package/resources/catalog/properties.d.ts.map +1 -1
- package/resources/catalog/properties.mjs.map +1 -1
- package/resources/catalog/unit-groups/index.d.mts +2 -2
- package/resources/catalog/unit-groups/index.d.mts.map +1 -1
- package/resources/catalog/unit-groups/index.d.ts +2 -2
- package/resources/catalog/unit-groups/index.d.ts.map +1 -1
- package/resources/catalog/unit-groups/index.mjs.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.d.mts +130 -83
- package/resources/catalog/unit-groups/unit-groups.d.mts.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.d.ts +130 -83
- package/resources/catalog/unit-groups/unit-groups.d.ts.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.js +33 -24
- package/resources/catalog/unit-groups/unit-groups.js.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.mjs +33 -24
- package/resources/catalog/unit-groups/unit-groups.mjs.map +1 -1
- package/resources/catalog/unit-groups/units.d.mts +78 -54
- package/resources/catalog/unit-groups/units.d.mts.map +1 -1
- package/resources/catalog/unit-groups/units.d.ts +78 -54
- package/resources/catalog/unit-groups/units.d.ts.map +1 -1
- package/resources/catalog/unit-groups/units.js +34 -25
- package/resources/catalog/unit-groups/units.js.map +1 -1
- package/resources/catalog/unit-groups/units.mjs +34 -25
- package/resources/catalog/unit-groups/units.mjs.map +1 -1
- package/resources/catalog/unit-groups.d.mts.map +1 -1
- package/resources/catalog/unit-groups.d.ts.map +1 -1
- package/resources/catalog/unit-groups.mjs.map +1 -1
- package/resources/catalog/units.d.mts +100 -63
- package/resources/catalog/units.d.mts.map +1 -1
- package/resources/catalog/units.d.ts +100 -63
- package/resources/catalog/units.d.ts.map +1 -1
- package/resources/catalog/units.js +26 -25
- package/resources/catalog/units.js.map +1 -1
- package/resources/catalog/units.mjs +26 -25
- package/resources/catalog/units.mjs.map +1 -1
- package/resources/catalog.d.mts.map +1 -1
- package/resources/catalog.d.ts.map +1 -1
- package/resources/catalog.mjs.map +1 -1
- package/resources/core/addresses/actions.d.mts +12 -5
- package/resources/core/addresses/actions.d.mts.map +1 -1
- package/resources/core/addresses/actions.d.ts +12 -5
- package/resources/core/addresses/actions.d.ts.map +1 -1
- package/resources/core/addresses/actions.mjs.map +1 -1
- package/resources/core/addresses/addresses.d.mts +5 -2
- package/resources/core/addresses/addresses.d.mts.map +1 -1
- package/resources/core/addresses/addresses.d.ts +5 -2
- package/resources/core/addresses/addresses.d.ts.map +1 -1
- package/resources/core/addresses/addresses.js.map +1 -1
- package/resources/core/addresses/addresses.mjs.map +1 -1
- package/resources/core/addresses/index.d.mts.map +1 -1
- package/resources/core/addresses/index.d.ts.map +1 -1
- package/resources/core/addresses/index.mjs.map +1 -1
- package/resources/core/addresses.d.mts.map +1 -1
- package/resources/core/addresses.d.ts.map +1 -1
- package/resources/core/addresses.mjs.map +1 -1
- package/resources/core/audit-events.d.mts +78 -34
- package/resources/core/audit-events.d.mts.map +1 -1
- package/resources/core/audit-events.d.ts +78 -34
- package/resources/core/audit-events.d.ts.map +1 -1
- package/resources/core/audit-events.js +13 -10
- package/resources/core/audit-events.js.map +1 -1
- package/resources/core/audit-events.mjs +13 -10
- package/resources/core/audit-events.mjs.map +1 -1
- package/resources/core/core.d.mts +4 -4
- package/resources/core/core.d.mts.map +1 -1
- package/resources/core/core.d.ts +4 -4
- package/resources/core/core.d.ts.map +1 -1
- package/resources/core/core.mjs.map +1 -1
- package/resources/core/email-logs.d.mts +31 -21
- package/resources/core/email-logs.d.mts.map +1 -1
- package/resources/core/email-logs.d.ts +31 -21
- package/resources/core/email-logs.d.ts.map +1 -1
- package/resources/core/email-logs.js +10 -10
- package/resources/core/email-logs.js.map +1 -1
- package/resources/core/email-logs.mjs +10 -10
- package/resources/core/email-logs.mjs.map +1 -1
- package/resources/core/index.d.mts +4 -4
- package/resources/core/index.d.mts.map +1 -1
- package/resources/core/index.d.ts +4 -4
- package/resources/core/index.d.ts.map +1 -1
- package/resources/core/index.mjs.map +1 -1
- package/resources/core/request-logs.d.mts +87 -48
- package/resources/core/request-logs.d.mts.map +1 -1
- package/resources/core/request-logs.d.ts +87 -48
- package/resources/core/request-logs.d.ts.map +1 -1
- package/resources/core/request-logs.js +10 -10
- package/resources/core/request-logs.js.map +1 -1
- package/resources/core/request-logs.mjs +10 -10
- package/resources/core/request-logs.mjs.map +1 -1
- package/resources/core/sandboxes.d.mts +52 -31
- package/resources/core/sandboxes.d.mts.map +1 -1
- package/resources/core/sandboxes.d.ts +52 -31
- package/resources/core/sandboxes.d.ts.map +1 -1
- package/resources/core/sandboxes.js +20 -13
- package/resources/core/sandboxes.js.map +1 -1
- package/resources/core/sandboxes.mjs +20 -13
- package/resources/core/sandboxes.mjs.map +1 -1
- package/resources/core.d.mts.map +1 -1
- package/resources/core.d.ts.map +1 -1
- package/resources/core.mjs.map +1 -1
- package/resources/finance/finance.d.mts +69 -35
- package/resources/finance/finance.d.mts.map +1 -1
- package/resources/finance/finance.d.ts +69 -35
- package/resources/finance/finance.d.ts.map +1 -1
- package/resources/finance/finance.js +10 -10
- package/resources/finance/finance.js.map +1 -1
- package/resources/finance/finance.mjs +10 -10
- package/resources/finance/finance.mjs.map +1 -1
- package/resources/finance/index.d.mts +2 -2
- package/resources/finance/index.d.mts.map +1 -1
- package/resources/finance/index.d.ts +2 -2
- package/resources/finance/index.d.ts.map +1 -1
- package/resources/finance/index.mjs.map +1 -1
- package/resources/finance/payment-terms.d.mts +72 -43
- package/resources/finance/payment-terms.d.mts.map +1 -1
- package/resources/finance/payment-terms.d.ts +72 -43
- package/resources/finance/payment-terms.d.ts.map +1 -1
- package/resources/finance/payment-terms.js +33 -22
- package/resources/finance/payment-terms.js.map +1 -1
- package/resources/finance/payment-terms.mjs +33 -22
- package/resources/finance/payment-terms.mjs.map +1 -1
- package/resources/finance.d.mts.map +1 -1
- package/resources/finance.d.ts.map +1 -1
- package/resources/finance.mjs.map +1 -1
- package/resources/identity/account-users/account-users.d.mts +166 -79
- package/resources/identity/account-users/account-users.d.mts.map +1 -1
- package/resources/identity/account-users/account-users.d.ts +166 -79
- package/resources/identity/account-users/account-users.d.ts.map +1 -1
- package/resources/identity/account-users/account-users.js +43 -25
- package/resources/identity/account-users/account-users.js.map +1 -1
- package/resources/identity/account-users/account-users.mjs +43 -25
- package/resources/identity/account-users/account-users.mjs.map +1 -1
- package/resources/identity/account-users/actions.d.mts +13 -3
- package/resources/identity/account-users/actions.d.mts.map +1 -1
- package/resources/identity/account-users/actions.d.ts +13 -3
- package/resources/identity/account-users/actions.d.ts.map +1 -1
- package/resources/identity/account-users/actions.js +13 -3
- package/resources/identity/account-users/actions.js.map +1 -1
- package/resources/identity/account-users/actions.mjs +13 -3
- package/resources/identity/account-users/actions.mjs.map +1 -1
- package/resources/identity/account-users/index.d.mts +1 -1
- package/resources/identity/account-users/index.d.mts.map +1 -1
- package/resources/identity/account-users/index.d.ts +1 -1
- package/resources/identity/account-users/index.d.ts.map +1 -1
- package/resources/identity/account-users/index.mjs.map +1 -1
- package/resources/identity/account-users.d.mts.map +1 -1
- package/resources/identity/account-users.d.ts.map +1 -1
- package/resources/identity/account-users.mjs.map +1 -1
- package/resources/identity/identity.d.mts +2 -2
- package/resources/identity/identity.d.mts.map +1 -1
- package/resources/identity/identity.d.ts +2 -2
- package/resources/identity/identity.d.ts.map +1 -1
- package/resources/identity/identity.mjs.map +1 -1
- package/resources/identity/index.d.mts +2 -2
- package/resources/identity/index.d.mts.map +1 -1
- package/resources/identity/index.d.ts +2 -2
- package/resources/identity/index.d.ts.map +1 -1
- package/resources/identity/index.mjs.map +1 -1
- package/resources/identity/roles.d.mts +88 -61
- package/resources/identity/roles.d.mts.map +1 -1
- package/resources/identity/roles.d.ts +88 -61
- package/resources/identity/roles.d.ts.map +1 -1
- package/resources/identity/roles.js +33 -27
- package/resources/identity/roles.js.map +1 -1
- package/resources/identity/roles.mjs +33 -27
- package/resources/identity/roles.mjs.map +1 -1
- package/resources/identity.d.mts.map +1 -1
- package/resources/identity.d.ts.map +1 -1
- package/resources/identity.mjs.map +1 -1
- package/resources/index.d.mts +2 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/operations/carriers/carriers.d.mts +88 -59
- package/resources/operations/carriers/carriers.d.mts.map +1 -1
- package/resources/operations/carriers/carriers.d.ts +88 -59
- package/resources/operations/carriers/carriers.d.ts.map +1 -1
- package/resources/operations/carriers/carriers.js +29 -21
- package/resources/operations/carriers/carriers.js.map +1 -1
- package/resources/operations/carriers/carriers.mjs +29 -21
- package/resources/operations/carriers/carriers.mjs.map +1 -1
- package/resources/operations/carriers/index.d.mts +2 -2
- package/resources/operations/carriers/index.d.mts.map +1 -1
- package/resources/operations/carriers/index.d.ts +2 -2
- package/resources/operations/carriers/index.d.ts.map +1 -1
- package/resources/operations/carriers/index.mjs.map +1 -1
- package/resources/operations/carriers/service-levels.d.mts +115 -68
- package/resources/operations/carriers/service-levels.d.mts.map +1 -1
- package/resources/operations/carriers/service-levels.d.ts +115 -68
- package/resources/operations/carriers/service-levels.d.ts.map +1 -1
- package/resources/operations/carriers/service-levels.js +37 -30
- package/resources/operations/carriers/service-levels.js.map +1 -1
- package/resources/operations/carriers/service-levels.mjs +37 -30
- package/resources/operations/carriers/service-levels.mjs.map +1 -1
- package/resources/operations/carriers.d.mts.map +1 -1
- package/resources/operations/carriers.d.ts.map +1 -1
- package/resources/operations/carriers.mjs.map +1 -1
- package/resources/operations/index.d.mts +4 -4
- package/resources/operations/index.d.mts.map +1 -1
- package/resources/operations/index.d.ts +4 -4
- package/resources/operations/index.d.ts.map +1 -1
- package/resources/operations/index.mjs.map +1 -1
- package/resources/operations/location-types.d.mts +33 -18
- package/resources/operations/location-types.d.mts.map +1 -1
- package/resources/operations/location-types.d.ts +33 -18
- package/resources/operations/location-types.d.ts.map +1 -1
- package/resources/operations/location-types.js +12 -12
- package/resources/operations/location-types.js.map +1 -1
- package/resources/operations/location-types.mjs +12 -12
- package/resources/operations/location-types.mjs.map +1 -1
- package/resources/operations/locations.d.mts +131 -65
- package/resources/operations/locations.d.mts.map +1 -1
- package/resources/operations/locations.d.ts +131 -65
- package/resources/operations/locations.d.ts.map +1 -1
- package/resources/operations/locations.js +24 -20
- package/resources/operations/locations.js.map +1 -1
- package/resources/operations/locations.mjs +24 -20
- package/resources/operations/locations.mjs.map +1 -1
- package/resources/operations/operations.d.mts +4 -4
- package/resources/operations/operations.d.mts.map +1 -1
- package/resources/operations/operations.d.ts +4 -4
- package/resources/operations/operations.d.ts.map +1 -1
- package/resources/operations/operations.mjs.map +1 -1
- package/resources/operations/scanning-stations.d.mts +143 -69
- package/resources/operations/scanning-stations.d.mts.map +1 -1
- package/resources/operations/scanning-stations.d.ts +143 -69
- package/resources/operations/scanning-stations.d.ts.map +1 -1
- package/resources/operations/scanning-stations.js +32 -23
- package/resources/operations/scanning-stations.js.map +1 -1
- package/resources/operations/scanning-stations.mjs +32 -23
- package/resources/operations/scanning-stations.mjs.map +1 -1
- package/resources/operations/shipping-terms.d.mts +117 -81
- package/resources/operations/shipping-terms.d.mts.map +1 -1
- package/resources/operations/shipping-terms.d.ts +117 -81
- package/resources/operations/shipping-terms.d.ts.map +1 -1
- package/resources/operations/shipping-terms.js +28 -26
- package/resources/operations/shipping-terms.js.map +1 -1
- package/resources/operations/shipping-terms.mjs +28 -26
- package/resources/operations/shipping-terms.mjs.map +1 -1
- package/resources/operations.d.mts.map +1 -1
- package/resources/operations.d.ts.map +1 -1
- package/resources/operations.mjs.map +1 -1
- package/resources/sales/account-groups.d.mts +111 -80
- package/resources/sales/account-groups.d.mts.map +1 -1
- package/resources/sales/account-groups.d.ts +111 -80
- package/resources/sales/account-groups.d.ts.map +1 -1
- package/resources/sales/account-groups.js +30 -21
- package/resources/sales/account-groups.js.map +1 -1
- package/resources/sales/account-groups.mjs +30 -21
- package/resources/sales/account-groups.mjs.map +1 -1
- package/resources/sales/account-statuses.d.mts +41 -23
- package/resources/sales/account-statuses.d.mts.map +1 -1
- package/resources/sales/account-statuses.d.ts +41 -23
- package/resources/sales/account-statuses.d.ts.map +1 -1
- package/resources/sales/account-statuses.js +16 -13
- package/resources/sales/account-statuses.js.map +1 -1
- package/resources/sales/account-statuses.mjs +16 -13
- package/resources/sales/account-statuses.mjs.map +1 -1
- package/resources/sales/addresses.d.mts +83 -36
- package/resources/sales/addresses.d.mts.map +1 -1
- package/resources/sales/addresses.d.ts +83 -36
- package/resources/sales/addresses.d.ts.map +1 -1
- package/resources/sales/addresses.js +29 -19
- package/resources/sales/addresses.js.map +1 -1
- package/resources/sales/addresses.mjs +29 -19
- package/resources/sales/addresses.mjs.map +1 -1
- package/resources/sales/customers/actions.d.mts +15 -5
- package/resources/sales/customers/actions.d.mts.map +1 -1
- package/resources/sales/customers/actions.d.ts +15 -5
- package/resources/sales/customers/actions.d.ts.map +1 -1
- package/resources/sales/customers/actions.js +6 -2
- package/resources/sales/customers/actions.js.map +1 -1
- package/resources/sales/customers/actions.mjs +6 -2
- package/resources/sales/customers/actions.mjs.map +1 -1
- package/resources/sales/customers/customers.d.mts +588 -291
- package/resources/sales/customers/customers.d.mts.map +1 -1
- package/resources/sales/customers/customers.d.ts +588 -291
- package/resources/sales/customers/customers.d.ts.map +1 -1
- package/resources/sales/customers/customers.js +58 -30
- package/resources/sales/customers/customers.js.map +1 -1
- package/resources/sales/customers/customers.mjs +58 -30
- package/resources/sales/customers/customers.mjs.map +1 -1
- package/resources/sales/customers/index.d.mts +1 -1
- package/resources/sales/customers/index.d.mts.map +1 -1
- package/resources/sales/customers/index.d.ts +1 -1
- package/resources/sales/customers/index.d.ts.map +1 -1
- package/resources/sales/customers/index.js.map +1 -1
- package/resources/sales/customers/index.mjs.map +1 -1
- package/resources/sales/customers.d.mts.map +1 -1
- package/resources/sales/customers.d.ts.map +1 -1
- package/resources/sales/customers.mjs.map +1 -1
- package/resources/sales/index.d.mts +6 -6
- package/resources/sales/index.d.mts.map +1 -1
- package/resources/sales/index.d.ts +6 -6
- package/resources/sales/index.d.ts.map +1 -1
- package/resources/sales/index.js.map +1 -1
- package/resources/sales/index.mjs.map +1 -1
- package/resources/sales/priorities.d.mts +31 -21
- package/resources/sales/priorities.d.mts.map +1 -1
- package/resources/sales/priorities.d.ts +31 -21
- package/resources/sales/priorities.d.ts.map +1 -1
- package/resources/sales/priorities.js +10 -10
- package/resources/sales/priorities.js.map +1 -1
- package/resources/sales/priorities.mjs +10 -10
- package/resources/sales/priorities.mjs.map +1 -1
- package/resources/sales/sales-orders.d.mts +877 -7
- package/resources/sales/sales-orders.d.mts.map +1 -1
- package/resources/sales/sales-orders.d.ts +877 -7
- package/resources/sales/sales-orders.d.ts.map +1 -1
- package/resources/sales/sales-orders.js +45 -3
- package/resources/sales/sales-orders.js.map +1 -1
- package/resources/sales/sales-orders.mjs +45 -3
- package/resources/sales/sales-orders.mjs.map +1 -1
- package/resources/sales/sales.d.mts +8 -8
- package/resources/sales/sales.d.mts.map +1 -1
- package/resources/sales/sales.d.ts +8 -8
- package/resources/sales/sales.d.ts.map +1 -1
- package/resources/sales/sales.js.map +1 -1
- package/resources/sales/sales.mjs.map +1 -1
- package/resources/sales.d.mts.map +1 -1
- package/resources/sales.d.ts.map +1 -1
- package/resources/sales.mjs.map +1 -1
- package/resources/settings/index.d.mts +3 -0
- package/resources/settings/index.d.mts.map +1 -0
- package/resources/settings/index.d.ts +3 -0
- package/resources/settings/index.d.ts.map +1 -0
- package/resources/settings/index.js +9 -0
- package/resources/settings/index.js.map +1 -0
- package/resources/settings/index.mjs +4 -0
- package/resources/settings/index.mjs.map +1 -0
- package/resources/settings/integrations.d.mts +238 -0
- package/resources/settings/integrations.d.mts.map +1 -0
- package/resources/settings/integrations.d.ts +238 -0
- package/resources/settings/integrations.d.ts.map +1 -0
- package/resources/settings/integrations.js +80 -0
- package/resources/settings/integrations.js.map +1 -0
- package/resources/settings/integrations.mjs +76 -0
- package/resources/settings/integrations.mjs.map +1 -0
- package/resources/settings/settings.d.mts +10 -0
- package/resources/settings/settings.d.mts.map +1 -0
- package/resources/settings/settings.d.ts +10 -0
- package/resources/settings/settings.d.ts.map +1 -0
- package/resources/settings/settings.js +17 -0
- package/resources/settings/settings.js.map +1 -0
- package/resources/settings/settings.mjs +12 -0
- package/resources/settings/settings.mjs.map +1 -0
- package/resources/settings.d.mts +2 -0
- package/resources/settings.d.mts.map +1 -0
- package/resources/settings.d.ts +2 -0
- package/resources/settings.d.ts.map +1 -0
- package/resources/settings.js +6 -0
- package/resources/settings.js.map +1 -0
- package/resources/settings.mjs +3 -0
- package/resources/settings.mjs.map +1 -0
- package/resources.d.mts.map +1 -1
- package/resources.d.ts.map +1 -1
- package/resources.mjs.map +1 -1
- package/src/client.ts +13 -3
- package/src/resources/auth/api-keys/actions.ts +28 -5
- package/src/resources/auth/api-keys/api-keys.ts +142 -78
- package/src/resources/auth/api-keys/index.ts +1 -1
- package/src/resources/auth/auth.ts +1 -1
- package/src/resources/auth/index.ts +1 -1
- package/src/resources/catalog/catalog.ts +18 -18
- package/src/resources/catalog/index.ts +18 -18
- package/src/resources/catalog/item-categories/index.ts +2 -2
- package/src/resources/catalog/item-categories/item-categories.ts +116 -86
- package/src/resources/catalog/item-categories/properties.ts +9 -4
- package/src/resources/catalog/items/attributes.ts +3 -2
- package/src/resources/catalog/items/index.ts +2 -2
- package/src/resources/catalog/items/items.ts +111 -75
- package/src/resources/catalog/materials.ts +159 -112
- package/src/resources/catalog/parts.ts +145 -92
- package/src/resources/catalog/product-lines.ts +160 -85
- package/src/resources/catalog/products.ts +205 -108
- package/src/resources/catalog/properties/attributes.ts +110 -58
- package/src/resources/catalog/properties/index.ts +4 -4
- package/src/resources/catalog/properties/properties.ts +84 -61
- package/src/resources/catalog/unit-groups/index.ts +4 -4
- package/src/resources/catalog/unit-groups/unit-groups.ts +144 -97
- package/src/resources/catalog/unit-groups/units.ts +97 -73
- package/src/resources/catalog/units.ts +114 -77
- package/src/resources/core/addresses/actions.ts +12 -5
- package/src/resources/core/addresses/addresses.ts +5 -2
- package/src/resources/core/audit-events.ts +142 -47
- package/src/resources/core/core.ts +5 -5
- package/src/resources/core/email-logs.ts +39 -29
- package/src/resources/core/index.ts +5 -5
- package/src/resources/core/request-logs.ts +104 -64
- package/src/resources/core/sandboxes.ts +57 -36
- package/src/resources/finance/finance.ts +78 -44
- package/src/resources/finance/index.ts +4 -4
- package/src/resources/finance/payment-terms.ts +85 -56
- package/src/resources/identity/account-users/account-users.ts +180 -93
- package/src/resources/identity/account-users/actions.ts +13 -3
- package/src/resources/identity/account-users/index.ts +2 -2
- package/src/resources/identity/identity.ts +4 -4
- package/src/resources/identity/index.ts +4 -4
- package/src/resources/identity/roles.ts +96 -69
- package/src/resources/index.ts +3 -2
- package/src/resources/operations/carriers/carriers.ts +97 -68
- package/src/resources/operations/carriers/index.ts +4 -4
- package/src/resources/operations/carriers/service-levels.ts +136 -89
- package/src/resources/operations/index.ts +8 -8
- package/src/resources/operations/location-types.ts +38 -23
- package/src/resources/operations/locations.ts +140 -74
- package/src/resources/operations/operations.ts +8 -8
- package/src/resources/operations/scanning-stations.ts +160 -86
- package/src/resources/operations/shipping-terms.ts +134 -98
- package/src/resources/sales/account-groups.ts +122 -91
- package/src/resources/sales/account-statuses.ts +48 -30
- package/src/resources/sales/addresses.ts +91 -44
- package/src/resources/sales/customers/actions.ts +15 -4
- package/src/resources/sales/customers/customers.ts +660 -351
- package/src/resources/sales/customers/index.ts +4 -2
- package/src/resources/sales/index.ts +25 -6
- package/src/resources/sales/priorities.ts +39 -29
- package/src/resources/sales/sales-orders.ts +1113 -21
- package/src/resources/sales/sales.ts +44 -6
- package/src/resources/settings/index.ts +13 -0
- package/src/resources/settings/integrations.ts +291 -0
- package/src/resources/settings/settings.ts +33 -0
- package/src/resources/settings.ts +3 -0
- package/src/version.ts +1 -1
- package/uploads.d.mts +0 -1
- package/uploads.d.mts.map +1 -1
- package/uploads.d.ts +0 -1
- package/uploads.d.ts.map +1 -1
- package/uploads.mjs +0 -1
- package/uploads.mjs.map +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -10,18 +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
|
-
* sku: 'ALM-2024-1001',
|
|
20
|
-
* type: 'sale',
|
|
21
|
-
* });
|
|
17
|
+
* const listProduct = await client.catalog.products.list();
|
|
22
18
|
* ```
|
|
23
19
|
*/
|
|
24
|
-
|
|
20
|
+
list(query?: ProductListParams | null | undefined, options?: RequestOptions): APIPromise<ListProduct>;
|
|
25
21
|
/**
|
|
26
22
|
* Returns a product by ID.
|
|
27
23
|
*
|
|
@@ -34,25 +30,34 @@ export declare class Products extends APIResource {
|
|
|
34
30
|
*/
|
|
35
31
|
retrieve(id: string, query?: ProductRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Product>;
|
|
36
32
|
/**
|
|
37
|
-
*
|
|
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.
|
|
38
38
|
*
|
|
39
39
|
* @example
|
|
40
40
|
* ```ts
|
|
41
|
-
* const product = await client.catalog.products.
|
|
42
|
-
* '
|
|
43
|
-
*
|
|
41
|
+
* const product = await client.catalog.products.create({
|
|
42
|
+
* category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
|
|
43
|
+
* sku: 'ALM-2024-1001',
|
|
44
|
+
* type: 'sale',
|
|
45
|
+
* });
|
|
44
46
|
* ```
|
|
45
47
|
*/
|
|
46
|
-
|
|
48
|
+
create(params: ProductCreateParams, options?: RequestOptions): APIPromise<Product>;
|
|
47
49
|
/**
|
|
48
|
-
*
|
|
50
|
+
* Partially updates a product.
|
|
49
51
|
*
|
|
50
52
|
* @example
|
|
51
53
|
* ```ts
|
|
52
|
-
* const
|
|
54
|
+
* const product = await client.catalog.products.update(
|
|
55
|
+
* 'pd_013c29ab3f1518d0004094c316',
|
|
56
|
+
* { sku: 'SKU-002' },
|
|
57
|
+
* );
|
|
53
58
|
* ```
|
|
54
59
|
*/
|
|
55
|
-
|
|
60
|
+
update(id: string, params?: ProductUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Product>;
|
|
56
61
|
/**
|
|
57
62
|
* Soft-deletes a product and returns the deleted product.
|
|
58
63
|
*
|
|
@@ -83,15 +88,29 @@ export declare class Products extends APIResource {
|
|
|
83
88
|
*/
|
|
84
89
|
export interface CreateProductRequest {
|
|
85
90
|
/**
|
|
86
|
-
*
|
|
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.
|
|
87
95
|
*/
|
|
88
96
|
category_id: string;
|
|
89
97
|
/**
|
|
90
|
-
*
|
|
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.
|
|
91
102
|
*/
|
|
92
103
|
sku: string;
|
|
93
104
|
/**
|
|
94
|
-
* 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.
|
|
95
114
|
*/
|
|
96
115
|
type: 'sale' | 'service' | 'shipping' | 'credit' | 'return' | 'tax';
|
|
97
116
|
/**
|
|
@@ -107,19 +126,28 @@ export interface CreateProductRequest {
|
|
|
107
126
|
*/
|
|
108
127
|
notes?: string;
|
|
109
128
|
/**
|
|
110
|
-
* 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.
|
|
111
137
|
*/
|
|
112
138
|
portal_visibility?: 'visible' | 'hidden';
|
|
113
139
|
/**
|
|
114
|
-
*
|
|
140
|
+
* ID of the product line to assign the product to.
|
|
115
141
|
*/
|
|
116
142
|
product_line_id?: string;
|
|
117
143
|
/**
|
|
118
|
-
*
|
|
144
|
+
* A rate value with its numerator and denominator units, used in create and update
|
|
145
|
+
* requests.
|
|
119
146
|
*/
|
|
120
147
|
unit_cost?: MaterialsAPI.RateInput;
|
|
121
148
|
/**
|
|
122
|
-
*
|
|
149
|
+
* A rate value with its numerator and denominator units, used in create and update
|
|
150
|
+
* requests.
|
|
123
151
|
*/
|
|
124
152
|
unit_price?: MaterialsAPI.RateInput;
|
|
125
153
|
}
|
|
@@ -141,7 +169,8 @@ export interface ListProduct {
|
|
|
141
169
|
page_info: APIKeysAPI.PageInfo;
|
|
142
170
|
}
|
|
143
171
|
/**
|
|
144
|
-
* Product
|
|
172
|
+
* Product pairs an inventory item with how it is sold: its product type, optional
|
|
173
|
+
* product line, and customer portal visibility.
|
|
145
174
|
*/
|
|
146
175
|
export interface Product {
|
|
147
176
|
/**
|
|
@@ -161,15 +190,30 @@ export interface Product {
|
|
|
161
190
|
*/
|
|
162
191
|
object: 'product';
|
|
163
192
|
/**
|
|
164
|
-
*
|
|
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.
|
|
165
198
|
*/
|
|
166
199
|
portal_visibility: 'visible' | 'hidden';
|
|
167
200
|
/**
|
|
168
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.
|
|
169
205
|
*/
|
|
170
206
|
product_line: ProductLinesAPI.ProductLine | null;
|
|
171
207
|
/**
|
|
172
|
-
* 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.
|
|
173
217
|
*/
|
|
174
218
|
type: 'sale' | 'service' | 'shipping' | 'credit' | 'return' | 'tax';
|
|
175
219
|
/**
|
|
@@ -183,71 +227,89 @@ export interface Product {
|
|
|
183
227
|
export interface UpdateProductRequest {
|
|
184
228
|
/**
|
|
185
229
|
* Description.
|
|
230
|
+
*
|
|
231
|
+
* Send `null` to clear.
|
|
186
232
|
*/
|
|
187
233
|
description?: string | null;
|
|
188
234
|
/**
|
|
189
235
|
* Notes.
|
|
236
|
+
*
|
|
237
|
+
* Send `null` to clear.
|
|
190
238
|
*/
|
|
191
239
|
notes?: string | null;
|
|
192
240
|
/**
|
|
193
|
-
* 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.
|
|
194
246
|
*/
|
|
195
247
|
portal_visibility?: 'visible' | 'hidden';
|
|
196
248
|
/**
|
|
197
|
-
*
|
|
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.
|
|
198
253
|
*/
|
|
199
254
|
sku?: string;
|
|
200
255
|
/**
|
|
201
|
-
*
|
|
256
|
+
* A rate value with its numerator and denominator units, used in create and update
|
|
257
|
+
* requests.
|
|
202
258
|
*/
|
|
203
259
|
unit_price?: MaterialsAPI.RateInput;
|
|
204
260
|
}
|
|
205
|
-
export interface
|
|
261
|
+
export interface ProductListParams {
|
|
206
262
|
/**
|
|
207
|
-
*
|
|
263
|
+
* Filter by attribute IDs.
|
|
208
264
|
*/
|
|
209
|
-
|
|
265
|
+
attribute_ids?: Array<string>;
|
|
210
266
|
/**
|
|
211
|
-
*
|
|
267
|
+
* Filter by category IDs.
|
|
212
268
|
*/
|
|
213
|
-
|
|
269
|
+
category_ids?: Array<string>;
|
|
214
270
|
/**
|
|
215
|
-
*
|
|
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.
|
|
216
276
|
*/
|
|
217
|
-
|
|
277
|
+
cursor?: string;
|
|
218
278
|
/**
|
|
219
|
-
*
|
|
220
|
-
* are returned as `null`.
|
|
279
|
+
* Filter by customer IDs.
|
|
221
280
|
*/
|
|
222
|
-
|
|
281
|
+
customer_ids?: Array<string>;
|
|
223
282
|
/**
|
|
224
|
-
*
|
|
283
|
+
* End of creation date range.
|
|
225
284
|
*/
|
|
226
|
-
|
|
285
|
+
end_date?: string;
|
|
227
286
|
/**
|
|
228
|
-
*
|
|
287
|
+
* Sub-objects to expand in the response. When omitted, sub-objects are returned as
|
|
288
|
+
* `null`.
|
|
229
289
|
*/
|
|
230
|
-
|
|
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'>;
|
|
231
291
|
/**
|
|
232
|
-
*
|
|
292
|
+
* Maximum number of results to return in a single page.
|
|
233
293
|
*/
|
|
234
|
-
|
|
294
|
+
limit?: number;
|
|
235
295
|
/**
|
|
236
|
-
*
|
|
296
|
+
* Filter by customer portal visibility.
|
|
237
297
|
*/
|
|
238
298
|
portal_visibility?: 'visible' | 'hidden';
|
|
239
299
|
/**
|
|
240
|
-
*
|
|
300
|
+
* Filter by product line IDs.
|
|
241
301
|
*/
|
|
242
|
-
|
|
302
|
+
product_line_ids?: Array<string>;
|
|
243
303
|
/**
|
|
244
|
-
*
|
|
304
|
+
* Free-text search term used to filter results.
|
|
305
|
+
*
|
|
306
|
+
* Which fields are matched against the term varies by endpoint.
|
|
245
307
|
*/
|
|
246
|
-
|
|
308
|
+
q?: string;
|
|
247
309
|
/**
|
|
248
|
-
*
|
|
310
|
+
* Start of creation date range.
|
|
249
311
|
*/
|
|
250
|
-
|
|
312
|
+
start_date?: string;
|
|
251
313
|
}
|
|
252
314
|
export interface ProductRetrieveParams {
|
|
253
315
|
/**
|
|
@@ -256,79 +318,114 @@ export interface ProductRetrieveParams {
|
|
|
256
318
|
*/
|
|
257
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'>;
|
|
258
320
|
}
|
|
259
|
-
export interface
|
|
321
|
+
export interface ProductCreateParams {
|
|
260
322
|
/**
|
|
261
|
-
*
|
|
262
|
-
*
|
|
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.
|
|
263
327
|
*/
|
|
264
|
-
|
|
328
|
+
category_id: string;
|
|
265
329
|
/**
|
|
266
|
-
* 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.
|
|
267
334
|
*/
|
|
268
|
-
|
|
335
|
+
sku: string;
|
|
269
336
|
/**
|
|
270
|
-
* 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.
|
|
271
346
|
*/
|
|
272
|
-
|
|
347
|
+
type: 'sale' | 'service' | 'shipping' | 'credit' | 'return' | 'tax';
|
|
273
348
|
/**
|
|
274
|
-
*
|
|
349
|
+
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
350
|
+
* are returned as `null`.
|
|
275
351
|
*/
|
|
276
|
-
|
|
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'>;
|
|
277
353
|
/**
|
|
278
|
-
* Body param:
|
|
354
|
+
* Body param: Attribute IDs to connect to the product at creation time.
|
|
279
355
|
*/
|
|
280
|
-
|
|
356
|
+
attribute_ids?: Array<string>;
|
|
281
357
|
/**
|
|
282
|
-
* Body param:
|
|
358
|
+
* Body param: Description.
|
|
283
359
|
*/
|
|
284
|
-
|
|
285
|
-
}
|
|
286
|
-
export interface ProductListParams {
|
|
360
|
+
description?: string;
|
|
287
361
|
/**
|
|
288
|
-
*
|
|
362
|
+
* Body param: Notes.
|
|
289
363
|
*/
|
|
290
|
-
|
|
364
|
+
notes?: string;
|
|
291
365
|
/**
|
|
292
|
-
*
|
|
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.
|
|
293
374
|
*/
|
|
294
|
-
|
|
375
|
+
portal_visibility?: 'visible' | 'hidden';
|
|
295
376
|
/**
|
|
296
|
-
*
|
|
377
|
+
* Body param: ID of the product line to assign the product to.
|
|
297
378
|
*/
|
|
298
|
-
|
|
379
|
+
product_line_id?: string;
|
|
299
380
|
/**
|
|
300
|
-
*
|
|
381
|
+
* Body param: A rate value with its numerator and denominator units, used in
|
|
382
|
+
* create and update requests.
|
|
301
383
|
*/
|
|
302
|
-
|
|
384
|
+
unit_cost?: MaterialsAPI.RateInput;
|
|
303
385
|
/**
|
|
304
|
-
*
|
|
386
|
+
* Body param: A rate value with its numerator and denominator units, used in
|
|
387
|
+
* create and update requests.
|
|
305
388
|
*/
|
|
306
|
-
|
|
389
|
+
unit_price?: MaterialsAPI.RateInput;
|
|
390
|
+
}
|
|
391
|
+
export interface ProductUpdateParams {
|
|
307
392
|
/**
|
|
308
|
-
* Sub-objects to expand in the response. When omitted, sub-objects
|
|
309
|
-
* `null`.
|
|
393
|
+
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
394
|
+
* are returned as `null`.
|
|
310
395
|
*/
|
|
311
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'>;
|
|
312
397
|
/**
|
|
313
|
-
*
|
|
398
|
+
* Body param: Description.
|
|
399
|
+
*
|
|
400
|
+
* Send `null` to clear.
|
|
314
401
|
*/
|
|
315
|
-
|
|
402
|
+
description?: string | null;
|
|
316
403
|
/**
|
|
317
|
-
*
|
|
404
|
+
* Body param: Notes.
|
|
405
|
+
*
|
|
406
|
+
* Send `null` to clear.
|
|
318
407
|
*/
|
|
319
|
-
|
|
408
|
+
notes?: string | null;
|
|
320
409
|
/**
|
|
321
|
-
*
|
|
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.
|
|
322
415
|
*/
|
|
323
|
-
|
|
416
|
+
portal_visibility?: 'visible' | 'hidden';
|
|
324
417
|
/**
|
|
325
|
-
*
|
|
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.
|
|
326
422
|
*/
|
|
327
|
-
|
|
423
|
+
sku?: string;
|
|
328
424
|
/**
|
|
329
|
-
*
|
|
425
|
+
* Body param: A rate value with its numerator and denominator units, used in
|
|
426
|
+
* create and update requests.
|
|
330
427
|
*/
|
|
331
|
-
|
|
428
|
+
unit_price?: MaterialsAPI.RateInput;
|
|
332
429
|
}
|
|
333
430
|
export interface ProductDeleteParams {
|
|
334
431
|
/**
|
|
@@ -349,6 +446,6 @@ export interface ProductChangeProductLineParams {
|
|
|
349
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'>;
|
|
350
447
|
}
|
|
351
448
|
export declare namespace Products {
|
|
352
|
-
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, };
|
|
353
450
|
}
|
|
354
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,20 +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
|
-
* sku: 'ALM-2024-1001',
|
|
19
|
-
* type: 'sale',
|
|
20
|
-
* });
|
|
16
|
+
* const listProduct = await client.catalog.products.list();
|
|
21
17
|
* ```
|
|
22
18
|
*/
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
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 });
|
|
26
21
|
}
|
|
27
22
|
/**
|
|
28
23
|
* Returns a product by ID.
|
|
@@ -38,29 +33,39 @@ class Products extends resource_1.APIResource {
|
|
|
38
33
|
return this._client.get((0, path_1.path) `/v1/catalog/products/${id}`, { query, ...options });
|
|
39
34
|
}
|
|
40
35
|
/**
|
|
41
|
-
*
|
|
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.
|
|
42
41
|
*
|
|
43
42
|
* @example
|
|
44
43
|
* ```ts
|
|
45
|
-
* const product = await client.catalog.products.
|
|
46
|
-
* '
|
|
47
|
-
*
|
|
44
|
+
* const product = await client.catalog.products.create({
|
|
45
|
+
* category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
|
|
46
|
+
* sku: 'ALM-2024-1001',
|
|
47
|
+
* type: 'sale',
|
|
48
|
+
* });
|
|
48
49
|
* ```
|
|
49
50
|
*/
|
|
50
|
-
|
|
51
|
-
const { include, ...body } = params
|
|
52
|
-
return this._client.
|
|
51
|
+
create(params, options) {
|
|
52
|
+
const { include, ...body } = params;
|
|
53
|
+
return this._client.post('/v1/catalog/products', { query: { include }, body, ...options });
|
|
53
54
|
}
|
|
54
55
|
/**
|
|
55
|
-
*
|
|
56
|
+
* Partially updates a product.
|
|
56
57
|
*
|
|
57
58
|
* @example
|
|
58
59
|
* ```ts
|
|
59
|
-
* const
|
|
60
|
+
* const product = await client.catalog.products.update(
|
|
61
|
+
* 'pd_013c29ab3f1518d0004094c316',
|
|
62
|
+
* { sku: 'SKU-002' },
|
|
63
|
+
* );
|
|
60
64
|
* ```
|
|
61
65
|
*/
|
|
62
|
-
|
|
63
|
-
|
|
66
|
+
update(id, params = {}, options) {
|
|
67
|
+
const { include, ...body } = params ?? {};
|
|
68
|
+
return this._client.patch((0, path_1.path) `/v1/catalog/products/${id}`, { query: { include }, body, ...options });
|
|
64
69
|
}
|
|
65
70
|
/**
|
|
66
71
|
* Soft-deletes a product and returns the deleted product.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"products.js","sourceRoot":"","sources":["../../src/resources/catalog/products.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAOlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC
|
|
1
|
+
{"version":3,"file":"products.js","sourceRoot":"","sources":["../../src/resources/catalog/products.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAOlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;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"}
|