@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
|
@@ -11,21 +11,14 @@ import { RequestOptions } from "../../../internal/request-options.mjs";
|
|
|
11
11
|
export declare class Carriers extends APIResource {
|
|
12
12
|
serviceLevels: ServiceLevelsAPI.ServiceLevels;
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
15
|
-
* will be registered with Shippo and service levels will be auto-synced as
|
|
16
|
-
* options.
|
|
14
|
+
* Returns a paginated list of carriers for the current account.
|
|
17
15
|
*
|
|
18
16
|
* @example
|
|
19
17
|
* ```ts
|
|
20
|
-
* const
|
|
21
|
-
* account_number: '1234567890',
|
|
22
|
-
* code: 'fedex',
|
|
23
|
-
* name: 'FedEx',
|
|
24
|
-
* customer_portal_visibility: 'visible',
|
|
25
|
-
* });
|
|
18
|
+
* const listCarrier = await client.operations.carriers.list();
|
|
26
19
|
* ```
|
|
27
20
|
*/
|
|
28
|
-
|
|
21
|
+
list(query?: CarrierListParams | null | undefined, options?: RequestOptions): APIPromise<ListCarrier>;
|
|
29
22
|
/**
|
|
30
23
|
* Returns a carrier by ID.
|
|
31
24
|
*
|
|
@@ -37,6 +30,24 @@ export declare class Carriers extends APIResource {
|
|
|
37
30
|
* ```
|
|
38
31
|
*/
|
|
39
32
|
retrieve(id: string, query?: CarrierRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<CustomersAPI.Carrier>;
|
|
33
|
+
/**
|
|
34
|
+
* Creates a carrier.
|
|
35
|
+
*
|
|
36
|
+
* If a Shippo-supported code (`fedex`, `ups`, `usps`) is provided, the carrier is
|
|
37
|
+
* connected through Shippo and its service levels are auto-synced, initially
|
|
38
|
+
* hidden from the customer portal. Sandbox accounts skip the Shippo connection.
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```ts
|
|
42
|
+
* const carrier = await client.operations.carriers.create({
|
|
43
|
+
* name: 'FedEx',
|
|
44
|
+
* account_number: '1234567890',
|
|
45
|
+
* code: 'fedex',
|
|
46
|
+
* customer_portal_visibility: 'visible',
|
|
47
|
+
* });
|
|
48
|
+
* ```
|
|
49
|
+
*/
|
|
50
|
+
create(params: CarrierCreateParams, options?: RequestOptions): APIPromise<CustomersAPI.Carrier>;
|
|
40
51
|
/**
|
|
41
52
|
* Partially updates a carrier's name and portal visibility.
|
|
42
53
|
*
|
|
@@ -50,17 +61,10 @@ export declare class Carriers extends APIResource {
|
|
|
50
61
|
*/
|
|
51
62
|
update(id: string, params?: CarrierUpdateParams | null | undefined, options?: RequestOptions): APIPromise<CustomersAPI.Carrier>;
|
|
52
63
|
/**
|
|
53
|
-
*
|
|
64
|
+
* Deletes a carrier and all of its service levels.
|
|
54
65
|
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
* const listCarrier = await client.operations.carriers.list();
|
|
58
|
-
* ```
|
|
59
|
-
*/
|
|
60
|
-
list(query?: CarrierListParams | null | undefined, options?: RequestOptions): APIPromise<ListCarrier>;
|
|
61
|
-
/**
|
|
62
|
-
* Deletes a carrier and cascades to remove all options. If the carrier is managed
|
|
63
|
-
* by Shippo, the Shippo account is deactivated.
|
|
66
|
+
* If the carrier is connected through Shippo, its Shippo carrier account is
|
|
67
|
+
* deactivated. System-owned carriers cannot be deleted.
|
|
64
68
|
*
|
|
65
69
|
* @example
|
|
66
70
|
* ```ts
|
|
@@ -76,20 +80,30 @@ export declare class Carriers extends APIResource {
|
|
|
76
80
|
*/
|
|
77
81
|
export interface CreateCarrierRequest {
|
|
78
82
|
/**
|
|
79
|
-
*
|
|
83
|
+
* Human-readable name for the carrier.
|
|
84
|
+
*
|
|
85
|
+
* Must be unique among your account's carriers.
|
|
80
86
|
*/
|
|
81
|
-
|
|
87
|
+
name: string;
|
|
82
88
|
/**
|
|
83
|
-
*
|
|
89
|
+
* Your account number with this carrier.
|
|
90
|
+
*
|
|
91
|
+
* Required when `code` is `ups` or `usps`, which connect to Shippo using this
|
|
92
|
+
* number; FedEx connects via OAuth instead.
|
|
84
93
|
*/
|
|
85
|
-
|
|
94
|
+
account_number?: string;
|
|
86
95
|
/**
|
|
87
|
-
*
|
|
96
|
+
* Well-known carrier code.
|
|
97
|
+
*
|
|
98
|
+
* Omit for a custom carrier. Providing a Shippo-supported code (`fedex`, `ups`,
|
|
99
|
+
* `usps`) connects the carrier through Shippo and auto-syncs its service levels.
|
|
88
100
|
*/
|
|
89
|
-
|
|
101
|
+
code?: 'fedex' | 'ups' | 'usps' | 'will_call' | 'delivery' | 'ltl' | 'ltl1' | 'freight_collect';
|
|
90
102
|
/**
|
|
91
|
-
*
|
|
92
|
-
*
|
|
103
|
+
* Carrier visibility in the customer portal.
|
|
104
|
+
*
|
|
105
|
+
* A `visible` carrier can be selected by your customers at checkout; a `hidden`
|
|
106
|
+
* carrier is not offered there. New carriers are visible unless set to `hidden`.
|
|
93
107
|
*/
|
|
94
108
|
customer_portal_visibility?: 'visible' | 'hidden';
|
|
95
109
|
}
|
|
@@ -115,40 +129,44 @@ export interface ListCarrier {
|
|
|
115
129
|
*/
|
|
116
130
|
export interface UpdateCarrierRequest {
|
|
117
131
|
/**
|
|
118
|
-
*
|
|
119
|
-
*
|
|
132
|
+
* Carrier visibility in the customer portal.
|
|
133
|
+
*
|
|
134
|
+
* If `visible`, this carrier will be available for your customers to utilize when
|
|
135
|
+
* they go to checkout. If `hidden`, this carrier will not be an option on
|
|
136
|
+
* checkout.
|
|
120
137
|
*/
|
|
121
138
|
customer_portal_visibility?: 'visible' | 'hidden';
|
|
122
139
|
/**
|
|
123
|
-
*
|
|
140
|
+
* Human-readable name for the carrier, unique among your account's carriers.
|
|
124
141
|
*/
|
|
125
142
|
name?: string;
|
|
126
143
|
}
|
|
127
144
|
export interface CarrierDeleteResponse {
|
|
128
145
|
}
|
|
129
|
-
export interface
|
|
130
|
-
/**
|
|
131
|
-
* Body param: Carrier account number. Required for UPS and USPS carriers.
|
|
132
|
-
*/
|
|
133
|
-
account_number: string | null;
|
|
146
|
+
export interface CarrierListParams {
|
|
134
147
|
/**
|
|
135
|
-
*
|
|
148
|
+
* Opaque cursor token identifying where the page of results starts.
|
|
149
|
+
*
|
|
150
|
+
* Use the `cursor` value embedded in a previous response's `next_page_url` or
|
|
151
|
+
* `previous_page_url` to fetch the adjacent page. Omit to start from the first
|
|
152
|
+
* page.
|
|
136
153
|
*/
|
|
137
|
-
|
|
154
|
+
cursor?: string;
|
|
138
155
|
/**
|
|
139
|
-
*
|
|
156
|
+
* Sub-objects to expand in the response. When omitted, sub-objects are returned as
|
|
157
|
+
* `null`.
|
|
140
158
|
*/
|
|
141
|
-
|
|
159
|
+
include?: Array<'owner' | 'owner.account' | 'service_levels'>;
|
|
142
160
|
/**
|
|
143
|
-
*
|
|
144
|
-
* are returned as `null`.
|
|
161
|
+
* Maximum number of results to return in a single page.
|
|
145
162
|
*/
|
|
146
|
-
|
|
163
|
+
limit?: number;
|
|
147
164
|
/**
|
|
148
|
-
*
|
|
149
|
-
*
|
|
165
|
+
* Free-text search term used to filter results.
|
|
166
|
+
*
|
|
167
|
+
* Which fields are matched against the term varies by endpoint.
|
|
150
168
|
*/
|
|
151
|
-
|
|
169
|
+
q?: string;
|
|
152
170
|
}
|
|
153
171
|
export interface CarrierRetrieveParams {
|
|
154
172
|
/**
|
|
@@ -157,43 +175,62 @@ export interface CarrierRetrieveParams {
|
|
|
157
175
|
*/
|
|
158
176
|
include?: Array<'owner' | 'owner.account' | 'service_levels'>;
|
|
159
177
|
}
|
|
160
|
-
export interface
|
|
178
|
+
export interface CarrierCreateParams {
|
|
179
|
+
/**
|
|
180
|
+
* Body param: Human-readable name for the carrier.
|
|
181
|
+
*
|
|
182
|
+
* Must be unique among your account's carriers.
|
|
183
|
+
*/
|
|
184
|
+
name: string;
|
|
161
185
|
/**
|
|
162
186
|
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
163
187
|
* are returned as `null`.
|
|
164
188
|
*/
|
|
165
189
|
include?: Array<'owner' | 'owner.account' | 'service_levels'>;
|
|
166
190
|
/**
|
|
167
|
-
* Body param:
|
|
168
|
-
*
|
|
191
|
+
* Body param: Your account number with this carrier.
|
|
192
|
+
*
|
|
193
|
+
* Required when `code` is `ups` or `usps`, which connect to Shippo using this
|
|
194
|
+
* number; FedEx connects via OAuth instead.
|
|
169
195
|
*/
|
|
170
|
-
|
|
196
|
+
account_number?: string;
|
|
171
197
|
/**
|
|
172
|
-
* Body param:
|
|
198
|
+
* Body param: Well-known carrier code.
|
|
199
|
+
*
|
|
200
|
+
* Omit for a custom carrier. Providing a Shippo-supported code (`fedex`, `ups`,
|
|
201
|
+
* `usps`) connects the carrier through Shippo and auto-syncs its service levels.
|
|
173
202
|
*/
|
|
174
|
-
|
|
175
|
-
}
|
|
176
|
-
export interface CarrierListParams {
|
|
203
|
+
code?: 'fedex' | 'ups' | 'usps' | 'will_call' | 'delivery' | 'ltl' | 'ltl1' | 'freight_collect';
|
|
177
204
|
/**
|
|
178
|
-
*
|
|
205
|
+
* Body param: Carrier visibility in the customer portal.
|
|
206
|
+
*
|
|
207
|
+
* A `visible` carrier can be selected by your customers at checkout; a `hidden`
|
|
208
|
+
* carrier is not offered there. New carriers are visible unless set to `hidden`.
|
|
179
209
|
*/
|
|
180
|
-
|
|
210
|
+
customer_portal_visibility?: 'visible' | 'hidden';
|
|
211
|
+
}
|
|
212
|
+
export interface CarrierUpdateParams {
|
|
181
213
|
/**
|
|
182
|
-
* Sub-objects to expand in the response. When omitted, sub-objects
|
|
183
|
-
* `null`.
|
|
214
|
+
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
215
|
+
* are returned as `null`.
|
|
184
216
|
*/
|
|
185
217
|
include?: Array<'owner' | 'owner.account' | 'service_levels'>;
|
|
186
218
|
/**
|
|
187
|
-
*
|
|
219
|
+
* Body param: Carrier visibility in the customer portal.
|
|
220
|
+
*
|
|
221
|
+
* If `visible`, this carrier will be available for your customers to utilize when
|
|
222
|
+
* they go to checkout. If `hidden`, this carrier will not be an option on
|
|
223
|
+
* checkout.
|
|
188
224
|
*/
|
|
189
|
-
|
|
225
|
+
customer_portal_visibility?: 'visible' | 'hidden';
|
|
190
226
|
/**
|
|
191
|
-
*
|
|
227
|
+
* Body param: Human-readable name for the carrier, unique among your account's
|
|
228
|
+
* carriers.
|
|
192
229
|
*/
|
|
193
|
-
|
|
230
|
+
name?: string;
|
|
194
231
|
}
|
|
195
232
|
export declare namespace Carriers {
|
|
196
|
-
export { type CreateCarrierRequest as CreateCarrierRequest, type ListCarrier as ListCarrier, type UpdateCarrierRequest as UpdateCarrierRequest, type CarrierDeleteResponse as CarrierDeleteResponse, type
|
|
197
|
-
export { ServiceLevels as ServiceLevels, type CreateServiceLevelRequest as CreateServiceLevelRequest, type UpdateServiceLevelRequest as UpdateServiceLevelRequest, type ServiceLevelDeleteResponse as ServiceLevelDeleteResponse, type
|
|
233
|
+
export { type CreateCarrierRequest as CreateCarrierRequest, type ListCarrier as ListCarrier, type UpdateCarrierRequest as UpdateCarrierRequest, type CarrierDeleteResponse as CarrierDeleteResponse, type CarrierListParams as CarrierListParams, type CarrierRetrieveParams as CarrierRetrieveParams, type CarrierCreateParams as CarrierCreateParams, type CarrierUpdateParams as CarrierUpdateParams, };
|
|
234
|
+
export { ServiceLevels as ServiceLevels, type CreateServiceLevelRequest as CreateServiceLevelRequest, type UpdateServiceLevelRequest as UpdateServiceLevelRequest, type ServiceLevelDeleteResponse as ServiceLevelDeleteResponse, type ServiceLevelListParams as ServiceLevelListParams, type ServiceLevelRetrieveParams as ServiceLevelRetrieveParams, type ServiceLevelCreateParams as ServiceLevelCreateParams, type ServiceLevelUpdateParams as ServiceLevelUpdateParams, type ServiceLevelDeleteParams as ServiceLevelDeleteParams, };
|
|
198
235
|
}
|
|
199
236
|
//# sourceMappingURL=carriers.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"carriers.d.mts","sourceRoot":"","sources":["../../../src/resources/operations/carriers/carriers.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"carriers.d.mts","sourceRoot":"","sources":["../../../src/resources/operations/carriers/carriers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,gBAAgB;OACrB,EACL,yBAAyB,EACzB,wBAAwB,EACxB,wBAAwB,EACxB,0BAA0B,EAC1B,sBAAsB,EACtB,0BAA0B,EAC1B,wBAAwB,EACxB,aAAa,EACb,yBAAyB,EAC1B;OACM,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;IAEjG;;;;;;;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,YAAY,CAAC,OAAO,CAAC;IAInC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC;IAK/F;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC;IAKnC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGhF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,WAAW,GAAG,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,iBAAiB,CAAC;IAEhG;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;;OAMG;IACH,0BAA0B,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAElD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;CAAG;AAEzC,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,gBAAgB,CAAC,CAAC;IAE9D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,gBAAgB,CAAC,CAAC;CAC/D;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,gBAAgB,CAAC,CAAC;IAE9D;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,WAAW,GAAG,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,iBAAiB,CAAC;IAEhG;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;CACnD;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,gBAAgB,CAAC,CAAC;IAE9D;;;;;;OAMG;IACH,0BAA0B,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAElD;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,aAAa,IAAI,aAAa,EAC9B,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
|
|
@@ -11,21 +11,14 @@ import { RequestOptions } from "../../../internal/request-options.js";
|
|
|
11
11
|
export declare class Carriers extends APIResource {
|
|
12
12
|
serviceLevels: ServiceLevelsAPI.ServiceLevels;
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
15
|
-
* will be registered with Shippo and service levels will be auto-synced as
|
|
16
|
-
* options.
|
|
14
|
+
* Returns a paginated list of carriers for the current account.
|
|
17
15
|
*
|
|
18
16
|
* @example
|
|
19
17
|
* ```ts
|
|
20
|
-
* const
|
|
21
|
-
* account_number: '1234567890',
|
|
22
|
-
* code: 'fedex',
|
|
23
|
-
* name: 'FedEx',
|
|
24
|
-
* customer_portal_visibility: 'visible',
|
|
25
|
-
* });
|
|
18
|
+
* const listCarrier = await client.operations.carriers.list();
|
|
26
19
|
* ```
|
|
27
20
|
*/
|
|
28
|
-
|
|
21
|
+
list(query?: CarrierListParams | null | undefined, options?: RequestOptions): APIPromise<ListCarrier>;
|
|
29
22
|
/**
|
|
30
23
|
* Returns a carrier by ID.
|
|
31
24
|
*
|
|
@@ -37,6 +30,24 @@ export declare class Carriers extends APIResource {
|
|
|
37
30
|
* ```
|
|
38
31
|
*/
|
|
39
32
|
retrieve(id: string, query?: CarrierRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<CustomersAPI.Carrier>;
|
|
33
|
+
/**
|
|
34
|
+
* Creates a carrier.
|
|
35
|
+
*
|
|
36
|
+
* If a Shippo-supported code (`fedex`, `ups`, `usps`) is provided, the carrier is
|
|
37
|
+
* connected through Shippo and its service levels are auto-synced, initially
|
|
38
|
+
* hidden from the customer portal. Sandbox accounts skip the Shippo connection.
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```ts
|
|
42
|
+
* const carrier = await client.operations.carriers.create({
|
|
43
|
+
* name: 'FedEx',
|
|
44
|
+
* account_number: '1234567890',
|
|
45
|
+
* code: 'fedex',
|
|
46
|
+
* customer_portal_visibility: 'visible',
|
|
47
|
+
* });
|
|
48
|
+
* ```
|
|
49
|
+
*/
|
|
50
|
+
create(params: CarrierCreateParams, options?: RequestOptions): APIPromise<CustomersAPI.Carrier>;
|
|
40
51
|
/**
|
|
41
52
|
* Partially updates a carrier's name and portal visibility.
|
|
42
53
|
*
|
|
@@ -50,17 +61,10 @@ export declare class Carriers extends APIResource {
|
|
|
50
61
|
*/
|
|
51
62
|
update(id: string, params?: CarrierUpdateParams | null | undefined, options?: RequestOptions): APIPromise<CustomersAPI.Carrier>;
|
|
52
63
|
/**
|
|
53
|
-
*
|
|
64
|
+
* Deletes a carrier and all of its service levels.
|
|
54
65
|
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
* const listCarrier = await client.operations.carriers.list();
|
|
58
|
-
* ```
|
|
59
|
-
*/
|
|
60
|
-
list(query?: CarrierListParams | null | undefined, options?: RequestOptions): APIPromise<ListCarrier>;
|
|
61
|
-
/**
|
|
62
|
-
* Deletes a carrier and cascades to remove all options. If the carrier is managed
|
|
63
|
-
* by Shippo, the Shippo account is deactivated.
|
|
66
|
+
* If the carrier is connected through Shippo, its Shippo carrier account is
|
|
67
|
+
* deactivated. System-owned carriers cannot be deleted.
|
|
64
68
|
*
|
|
65
69
|
* @example
|
|
66
70
|
* ```ts
|
|
@@ -76,20 +80,30 @@ export declare class Carriers extends APIResource {
|
|
|
76
80
|
*/
|
|
77
81
|
export interface CreateCarrierRequest {
|
|
78
82
|
/**
|
|
79
|
-
*
|
|
83
|
+
* Human-readable name for the carrier.
|
|
84
|
+
*
|
|
85
|
+
* Must be unique among your account's carriers.
|
|
80
86
|
*/
|
|
81
|
-
|
|
87
|
+
name: string;
|
|
82
88
|
/**
|
|
83
|
-
*
|
|
89
|
+
* Your account number with this carrier.
|
|
90
|
+
*
|
|
91
|
+
* Required when `code` is `ups` or `usps`, which connect to Shippo using this
|
|
92
|
+
* number; FedEx connects via OAuth instead.
|
|
84
93
|
*/
|
|
85
|
-
|
|
94
|
+
account_number?: string;
|
|
86
95
|
/**
|
|
87
|
-
*
|
|
96
|
+
* Well-known carrier code.
|
|
97
|
+
*
|
|
98
|
+
* Omit for a custom carrier. Providing a Shippo-supported code (`fedex`, `ups`,
|
|
99
|
+
* `usps`) connects the carrier through Shippo and auto-syncs its service levels.
|
|
88
100
|
*/
|
|
89
|
-
|
|
101
|
+
code?: 'fedex' | 'ups' | 'usps' | 'will_call' | 'delivery' | 'ltl' | 'ltl1' | 'freight_collect';
|
|
90
102
|
/**
|
|
91
|
-
*
|
|
92
|
-
*
|
|
103
|
+
* Carrier visibility in the customer portal.
|
|
104
|
+
*
|
|
105
|
+
* A `visible` carrier can be selected by your customers at checkout; a `hidden`
|
|
106
|
+
* carrier is not offered there. New carriers are visible unless set to `hidden`.
|
|
93
107
|
*/
|
|
94
108
|
customer_portal_visibility?: 'visible' | 'hidden';
|
|
95
109
|
}
|
|
@@ -115,40 +129,44 @@ export interface ListCarrier {
|
|
|
115
129
|
*/
|
|
116
130
|
export interface UpdateCarrierRequest {
|
|
117
131
|
/**
|
|
118
|
-
*
|
|
119
|
-
*
|
|
132
|
+
* Carrier visibility in the customer portal.
|
|
133
|
+
*
|
|
134
|
+
* If `visible`, this carrier will be available for your customers to utilize when
|
|
135
|
+
* they go to checkout. If `hidden`, this carrier will not be an option on
|
|
136
|
+
* checkout.
|
|
120
137
|
*/
|
|
121
138
|
customer_portal_visibility?: 'visible' | 'hidden';
|
|
122
139
|
/**
|
|
123
|
-
*
|
|
140
|
+
* Human-readable name for the carrier, unique among your account's carriers.
|
|
124
141
|
*/
|
|
125
142
|
name?: string;
|
|
126
143
|
}
|
|
127
144
|
export interface CarrierDeleteResponse {
|
|
128
145
|
}
|
|
129
|
-
export interface
|
|
130
|
-
/**
|
|
131
|
-
* Body param: Carrier account number. Required for UPS and USPS carriers.
|
|
132
|
-
*/
|
|
133
|
-
account_number: string | null;
|
|
146
|
+
export interface CarrierListParams {
|
|
134
147
|
/**
|
|
135
|
-
*
|
|
148
|
+
* Opaque cursor token identifying where the page of results starts.
|
|
149
|
+
*
|
|
150
|
+
* Use the `cursor` value embedded in a previous response's `next_page_url` or
|
|
151
|
+
* `previous_page_url` to fetch the adjacent page. Omit to start from the first
|
|
152
|
+
* page.
|
|
136
153
|
*/
|
|
137
|
-
|
|
154
|
+
cursor?: string;
|
|
138
155
|
/**
|
|
139
|
-
*
|
|
156
|
+
* Sub-objects to expand in the response. When omitted, sub-objects are returned as
|
|
157
|
+
* `null`.
|
|
140
158
|
*/
|
|
141
|
-
|
|
159
|
+
include?: Array<'owner' | 'owner.account' | 'service_levels'>;
|
|
142
160
|
/**
|
|
143
|
-
*
|
|
144
|
-
* are returned as `null`.
|
|
161
|
+
* Maximum number of results to return in a single page.
|
|
145
162
|
*/
|
|
146
|
-
|
|
163
|
+
limit?: number;
|
|
147
164
|
/**
|
|
148
|
-
*
|
|
149
|
-
*
|
|
165
|
+
* Free-text search term used to filter results.
|
|
166
|
+
*
|
|
167
|
+
* Which fields are matched against the term varies by endpoint.
|
|
150
168
|
*/
|
|
151
|
-
|
|
169
|
+
q?: string;
|
|
152
170
|
}
|
|
153
171
|
export interface CarrierRetrieveParams {
|
|
154
172
|
/**
|
|
@@ -157,43 +175,62 @@ export interface CarrierRetrieveParams {
|
|
|
157
175
|
*/
|
|
158
176
|
include?: Array<'owner' | 'owner.account' | 'service_levels'>;
|
|
159
177
|
}
|
|
160
|
-
export interface
|
|
178
|
+
export interface CarrierCreateParams {
|
|
179
|
+
/**
|
|
180
|
+
* Body param: Human-readable name for the carrier.
|
|
181
|
+
*
|
|
182
|
+
* Must be unique among your account's carriers.
|
|
183
|
+
*/
|
|
184
|
+
name: string;
|
|
161
185
|
/**
|
|
162
186
|
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
163
187
|
* are returned as `null`.
|
|
164
188
|
*/
|
|
165
189
|
include?: Array<'owner' | 'owner.account' | 'service_levels'>;
|
|
166
190
|
/**
|
|
167
|
-
* Body param:
|
|
168
|
-
*
|
|
191
|
+
* Body param: Your account number with this carrier.
|
|
192
|
+
*
|
|
193
|
+
* Required when `code` is `ups` or `usps`, which connect to Shippo using this
|
|
194
|
+
* number; FedEx connects via OAuth instead.
|
|
169
195
|
*/
|
|
170
|
-
|
|
196
|
+
account_number?: string;
|
|
171
197
|
/**
|
|
172
|
-
* Body param:
|
|
198
|
+
* Body param: Well-known carrier code.
|
|
199
|
+
*
|
|
200
|
+
* Omit for a custom carrier. Providing a Shippo-supported code (`fedex`, `ups`,
|
|
201
|
+
* `usps`) connects the carrier through Shippo and auto-syncs its service levels.
|
|
173
202
|
*/
|
|
174
|
-
|
|
175
|
-
}
|
|
176
|
-
export interface CarrierListParams {
|
|
203
|
+
code?: 'fedex' | 'ups' | 'usps' | 'will_call' | 'delivery' | 'ltl' | 'ltl1' | 'freight_collect';
|
|
177
204
|
/**
|
|
178
|
-
*
|
|
205
|
+
* Body param: Carrier visibility in the customer portal.
|
|
206
|
+
*
|
|
207
|
+
* A `visible` carrier can be selected by your customers at checkout; a `hidden`
|
|
208
|
+
* carrier is not offered there. New carriers are visible unless set to `hidden`.
|
|
179
209
|
*/
|
|
180
|
-
|
|
210
|
+
customer_portal_visibility?: 'visible' | 'hidden';
|
|
211
|
+
}
|
|
212
|
+
export interface CarrierUpdateParams {
|
|
181
213
|
/**
|
|
182
|
-
* Sub-objects to expand in the response. When omitted, sub-objects
|
|
183
|
-
* `null`.
|
|
214
|
+
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|
|
215
|
+
* are returned as `null`.
|
|
184
216
|
*/
|
|
185
217
|
include?: Array<'owner' | 'owner.account' | 'service_levels'>;
|
|
186
218
|
/**
|
|
187
|
-
*
|
|
219
|
+
* Body param: Carrier visibility in the customer portal.
|
|
220
|
+
*
|
|
221
|
+
* If `visible`, this carrier will be available for your customers to utilize when
|
|
222
|
+
* they go to checkout. If `hidden`, this carrier will not be an option on
|
|
223
|
+
* checkout.
|
|
188
224
|
*/
|
|
189
|
-
|
|
225
|
+
customer_portal_visibility?: 'visible' | 'hidden';
|
|
190
226
|
/**
|
|
191
|
-
*
|
|
227
|
+
* Body param: Human-readable name for the carrier, unique among your account's
|
|
228
|
+
* carriers.
|
|
192
229
|
*/
|
|
193
|
-
|
|
230
|
+
name?: string;
|
|
194
231
|
}
|
|
195
232
|
export declare namespace Carriers {
|
|
196
|
-
export { type CreateCarrierRequest as CreateCarrierRequest, type ListCarrier as ListCarrier, type UpdateCarrierRequest as UpdateCarrierRequest, type CarrierDeleteResponse as CarrierDeleteResponse, type
|
|
197
|
-
export { ServiceLevels as ServiceLevels, type CreateServiceLevelRequest as CreateServiceLevelRequest, type UpdateServiceLevelRequest as UpdateServiceLevelRequest, type ServiceLevelDeleteResponse as ServiceLevelDeleteResponse, type
|
|
233
|
+
export { type CreateCarrierRequest as CreateCarrierRequest, type ListCarrier as ListCarrier, type UpdateCarrierRequest as UpdateCarrierRequest, type CarrierDeleteResponse as CarrierDeleteResponse, type CarrierListParams as CarrierListParams, type CarrierRetrieveParams as CarrierRetrieveParams, type CarrierCreateParams as CarrierCreateParams, type CarrierUpdateParams as CarrierUpdateParams, };
|
|
234
|
+
export { ServiceLevels as ServiceLevels, type CreateServiceLevelRequest as CreateServiceLevelRequest, type UpdateServiceLevelRequest as UpdateServiceLevelRequest, type ServiceLevelDeleteResponse as ServiceLevelDeleteResponse, type ServiceLevelListParams as ServiceLevelListParams, type ServiceLevelRetrieveParams as ServiceLevelRetrieveParams, type ServiceLevelCreateParams as ServiceLevelCreateParams, type ServiceLevelUpdateParams as ServiceLevelUpdateParams, type ServiceLevelDeleteParams as ServiceLevelDeleteParams, };
|
|
198
235
|
}
|
|
199
236
|
//# sourceMappingURL=carriers.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"carriers.d.ts","sourceRoot":"","sources":["../../../src/resources/operations/carriers/carriers.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"carriers.d.ts","sourceRoot":"","sources":["../../../src/resources/operations/carriers/carriers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,gBAAgB;OACrB,EACL,yBAAyB,EACzB,wBAAwB,EACxB,wBAAwB,EACxB,0BAA0B,EAC1B,sBAAsB,EACtB,0BAA0B,EAC1B,wBAAwB,EACxB,aAAa,EACb,yBAAyB,EAC1B;OACM,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;IAEjG;;;;;;;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,YAAY,CAAC,OAAO,CAAC;IAInC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC;IAK/F;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC;IAKnC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGhF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,WAAW,GAAG,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,iBAAiB,CAAC;IAEhG;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;;OAMG;IACH,0BAA0B,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAElD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;CAAG;AAEzC,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,gBAAgB,CAAC,CAAC;IAE9D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,gBAAgB,CAAC,CAAC;CAC/D;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,gBAAgB,CAAC,CAAC;IAE9D;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,WAAW,GAAG,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,iBAAiB,CAAC;IAEhG;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;CACnD;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,eAAe,GAAG,gBAAgB,CAAC,CAAC;IAE9D;;;;;;OAMG;IACH,0BAA0B,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAElD;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,aAAa,IAAI,aAAa,EAC9B,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
|
|
@@ -16,23 +16,15 @@ class Carriers extends resource_1.APIResource {
|
|
|
16
16
|
this.serviceLevels = new ServiceLevelsAPI.ServiceLevels(this._client);
|
|
17
17
|
}
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
20
|
-
* will be registered with Shippo and service levels will be auto-synced as
|
|
21
|
-
* options.
|
|
19
|
+
* Returns a paginated list of carriers for the current account.
|
|
22
20
|
*
|
|
23
21
|
* @example
|
|
24
22
|
* ```ts
|
|
25
|
-
* const
|
|
26
|
-
* account_number: '1234567890',
|
|
27
|
-
* code: 'fedex',
|
|
28
|
-
* name: 'FedEx',
|
|
29
|
-
* customer_portal_visibility: 'visible',
|
|
30
|
-
* });
|
|
23
|
+
* const listCarrier = await client.operations.carriers.list();
|
|
31
24
|
* ```
|
|
32
25
|
*/
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
return this._client.post('/v1/operations/carriers', { query: { include }, body, ...options });
|
|
26
|
+
list(query = {}, options) {
|
|
27
|
+
return this._client.get('/v1/operations/carriers', { query, ...options });
|
|
36
28
|
}
|
|
37
29
|
/**
|
|
38
30
|
* Returns a carrier by ID.
|
|
@@ -47,6 +39,27 @@ class Carriers extends resource_1.APIResource {
|
|
|
47
39
|
retrieve(id, query = {}, options) {
|
|
48
40
|
return this._client.get((0, path_1.path) `/v1/operations/carriers/${id}`, { query, ...options });
|
|
49
41
|
}
|
|
42
|
+
/**
|
|
43
|
+
* Creates a carrier.
|
|
44
|
+
*
|
|
45
|
+
* If a Shippo-supported code (`fedex`, `ups`, `usps`) is provided, the carrier is
|
|
46
|
+
* connected through Shippo and its service levels are auto-synced, initially
|
|
47
|
+
* hidden from the customer portal. Sandbox accounts skip the Shippo connection.
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* ```ts
|
|
51
|
+
* const carrier = await client.operations.carriers.create({
|
|
52
|
+
* name: 'FedEx',
|
|
53
|
+
* account_number: '1234567890',
|
|
54
|
+
* code: 'fedex',
|
|
55
|
+
* customer_portal_visibility: 'visible',
|
|
56
|
+
* });
|
|
57
|
+
* ```
|
|
58
|
+
*/
|
|
59
|
+
create(params, options) {
|
|
60
|
+
const { include, ...body } = params;
|
|
61
|
+
return this._client.post('/v1/operations/carriers', { query: { include }, body, ...options });
|
|
62
|
+
}
|
|
50
63
|
/**
|
|
51
64
|
* Partially updates a carrier's name and portal visibility.
|
|
52
65
|
*
|
|
@@ -63,19 +76,10 @@ class Carriers extends resource_1.APIResource {
|
|
|
63
76
|
return this._client.patch((0, path_1.path) `/v1/operations/carriers/${id}`, { query: { include }, body, ...options });
|
|
64
77
|
}
|
|
65
78
|
/**
|
|
66
|
-
*
|
|
79
|
+
* Deletes a carrier and all of its service levels.
|
|
67
80
|
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
* const listCarrier = await client.operations.carriers.list();
|
|
71
|
-
* ```
|
|
72
|
-
*/
|
|
73
|
-
list(query = {}, options) {
|
|
74
|
-
return this._client.get('/v1/operations/carriers', { query, ...options });
|
|
75
|
-
}
|
|
76
|
-
/**
|
|
77
|
-
* Deletes a carrier and cascades to remove all options. If the carrier is managed
|
|
78
|
-
* by Shippo, the Shippo account is deactivated.
|
|
81
|
+
* If the carrier is connected through Shippo, its Shippo carrier account is
|
|
82
|
+
* deactivated. System-owned carriers cannot be deleted.
|
|
79
83
|
*
|
|
80
84
|
* @example
|
|
81
85
|
* ```ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"carriers.js","sourceRoot":"","sources":["../../../src/resources/operations/carriers/carriers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AAErD,8EAAqD;AACrD,wDAU0B;AAI1B,0DAAoD;AAEpD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"carriers.js","sourceRoot":"","sources":["../../../src/resources/operations/carriers/carriers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AAErD,8EAAqD;AACrD,wDAU0B;AAI1B,0DAAoD;AAEpD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA0FnG,CAAC;IAxFC;;;;;;;OAOG;IACH,IAAI,CAAC,QAA8C,EAAE,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAU,EACV,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,2BAA2B,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;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,yBAAyB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,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,2BAA2B,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,2BAA2B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;CACF;AA3FD,4BA2FC;AAkLD,QAAQ,CAAC,aAAa,GAAG,8BAAa,CAAC"}
|