@aimee.shop/sdk 0.26.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/LICENSE +21 -0
- package/README.md +144 -0
- package/dist/browser/browser-auth.d.ts +115 -0
- package/dist/browser/browser-auth.d.ts.map +1 -0
- package/dist/browser/browser-auth.js +234 -0
- package/dist/browser/browser-auth.js.map +1 -0
- package/dist/browser/index.d.ts +62 -0
- package/dist/browser/index.d.ts.map +1 -0
- package/dist/browser/index.js +69 -0
- package/dist/browser/index.js.map +1 -0
- package/dist/core/auth/api-key.authenticator.d.ts +16 -0
- package/dist/core/auth/api-key.authenticator.d.ts.map +1 -0
- package/dist/core/auth/api-key.authenticator.js +28 -0
- package/dist/core/auth/api-key.authenticator.js.map +1 -0
- package/dist/core/auth/auth-chain.d.ts +33 -0
- package/dist/core/auth/auth-chain.d.ts.map +1 -0
- package/dist/core/auth/auth-chain.js +65 -0
- package/dist/core/auth/auth-chain.js.map +1 -0
- package/dist/core/auth/authenticator.d.ts +19 -0
- package/dist/core/auth/authenticator.d.ts.map +1 -0
- package/dist/core/auth/authenticator.js +2 -0
- package/dist/core/auth/authenticator.js.map +1 -0
- package/dist/core/auth/cognito.authenticator.d.ts +28 -0
- package/dist/core/auth/cognito.authenticator.d.ts.map +1 -0
- package/dist/core/auth/cognito.authenticator.js +89 -0
- package/dist/core/auth/cognito.authenticator.js.map +1 -0
- package/dist/core/auth/index.d.ts +8 -0
- package/dist/core/auth/index.d.ts.map +1 -0
- package/dist/core/auth/index.js +6 -0
- package/dist/core/auth/index.js.map +1 -0
- package/dist/core/auth/interactive.authenticator.d.ts +22 -0
- package/dist/core/auth/interactive.authenticator.d.ts.map +1 -0
- package/dist/core/auth/interactive.authenticator.js +126 -0
- package/dist/core/auth/interactive.authenticator.js.map +1 -0
- package/dist/core/auth/lazy-interactive.authenticator.d.ts +51 -0
- package/dist/core/auth/lazy-interactive.authenticator.d.ts.map +1 -0
- package/dist/core/auth/lazy-interactive.authenticator.js +112 -0
- package/dist/core/auth/lazy-interactive.authenticator.js.map +1 -0
- package/dist/core/auth/token.authenticator.d.ts +20 -0
- package/dist/core/auth/token.authenticator.d.ts.map +1 -0
- package/dist/core/auth/token.authenticator.js +45 -0
- package/dist/core/auth/token.authenticator.js.map +1 -0
- package/dist/core/config.d.ts +72 -0
- package/dist/core/config.d.ts.map +1 -0
- package/dist/core/config.js +120 -0
- package/dist/core/config.js.map +1 -0
- package/dist/core/errors/index.d.ts +101 -0
- package/dist/core/errors/index.d.ts.map +1 -0
- package/dist/core/errors/index.js +119 -0
- package/dist/core/errors/index.js.map +1 -0
- package/dist/core/events/event-envelope.d.ts +34 -0
- package/dist/core/events/event-envelope.d.ts.map +1 -0
- package/dist/core/events/event-envelope.js +2 -0
- package/dist/core/events/event-envelope.js.map +1 -0
- package/dist/core/events/event-names.d.ts +552 -0
- package/dist/core/events/event-names.d.ts.map +1 -0
- package/dist/core/events/event-names.js +593 -0
- package/dist/core/events/event-names.js.map +1 -0
- package/dist/core/events/index.d.ts +4 -0
- package/dist/core/events/index.d.ts.map +1 -0
- package/dist/core/events/index.js +11 -0
- package/dist/core/events/index.js.map +1 -0
- package/dist/core/http-client.d.ts +88 -0
- package/dist/core/http-client.d.ts.map +1 -0
- package/dist/core/http-client.js +293 -0
- package/dist/core/http-client.js.map +1 -0
- package/dist/core/retry.d.ts +48 -0
- package/dist/core/retry.d.ts.map +1 -0
- package/dist/core/retry.js +57 -0
- package/dist/core/retry.js.map +1 -0
- package/dist/core/sdk.d.ts +153 -0
- package/dist/core/sdk.d.ts.map +1 -0
- package/dist/core/sdk.js +327 -0
- package/dist/core/sdk.js.map +1 -0
- package/dist/core/types/address.d.ts +18 -0
- package/dist/core/types/address.d.ts.map +1 -0
- package/dist/core/types/address.js +2 -0
- package/dist/core/types/address.js.map +1 -0
- package/dist/core/types/geo.d.ts +59 -0
- package/dist/core/types/geo.d.ts.map +1 -0
- package/dist/core/types/geo.js +78 -0
- package/dist/core/types/geo.js.map +1 -0
- package/dist/core/types/pagination.d.ts +42 -0
- package/dist/core/types/pagination.d.ts.map +1 -0
- package/dist/core/types/pagination.js +2 -0
- package/dist/core/types/pagination.js.map +1 -0
- package/dist/index.d.ts +68 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +37 -0
- package/dist/index.js.map +1 -0
- package/dist/services/core/assets.client.d.ts +520 -0
- package/dist/services/core/assets.client.d.ts.map +1 -0
- package/dist/services/core/assets.client.js +297 -0
- package/dist/services/core/assets.client.js.map +1 -0
- package/dist/services/core/base-resource.d.ts +70 -0
- package/dist/services/core/base-resource.d.ts.map +1 -0
- package/dist/services/core/base-resource.js +97 -0
- package/dist/services/core/base-resource.js.map +1 -0
- package/dist/services/core/cart-messages/cart-messages.client.d.ts +30 -0
- package/dist/services/core/cart-messages/cart-messages.client.d.ts.map +1 -0
- package/dist/services/core/cart-messages/cart-messages.client.js +30 -0
- package/dist/services/core/cart-messages/cart-messages.client.js.map +1 -0
- package/dist/services/core/cart-messages/index.d.ts +4 -0
- package/dist/services/core/cart-messages/index.d.ts.map +1 -0
- package/dist/services/core/cart-messages/index.js +3 -0
- package/dist/services/core/cart-messages/index.js.map +1 -0
- package/dist/services/core/cart-messages/types.d.ts +106 -0
- package/dist/services/core/cart-messages/types.d.ts.map +1 -0
- package/dist/services/core/cart-messages/types.js +6 -0
- package/dist/services/core/cart-messages/types.js.map +1 -0
- package/dist/services/core/carts.client.d.ts +253 -0
- package/dist/services/core/carts.client.d.ts.map +1 -0
- package/dist/services/core/carts.client.js +110 -0
- package/dist/services/core/carts.client.js.map +1 -0
- package/dist/services/core/categories.client.d.ts +105 -0
- package/dist/services/core/categories.client.d.ts.map +1 -0
- package/dist/services/core/categories.client.js +135 -0
- package/dist/services/core/categories.client.js.map +1 -0
- package/dist/services/core/checkout.client.d.ts +414 -0
- package/dist/services/core/checkout.client.d.ts.map +1 -0
- package/dist/services/core/checkout.client.js +153 -0
- package/dist/services/core/checkout.client.js.map +1 -0
- package/dist/services/core/cms/cms.client.d.ts +111 -0
- package/dist/services/core/cms/cms.client.d.ts.map +1 -0
- package/dist/services/core/cms/cms.client.js +148 -0
- package/dist/services/core/cms/cms.client.js.map +1 -0
- package/dist/services/core/cms/collections.client.d.ts +45 -0
- package/dist/services/core/cms/collections.client.d.ts.map +1 -0
- package/dist/services/core/cms/collections.client.js +67 -0
- package/dist/services/core/cms/collections.client.js.map +1 -0
- package/dist/services/core/cms/content-types.client.d.ts +101 -0
- package/dist/services/core/cms/content-types.client.d.ts.map +1 -0
- package/dist/services/core/cms/content-types.client.js +143 -0
- package/dist/services/core/cms/content-types.client.js.map +1 -0
- package/dist/services/core/cms/entries.client.d.ts +187 -0
- package/dist/services/core/cms/entries.client.d.ts.map +1 -0
- package/dist/services/core/cms/entries.client.js +265 -0
- package/dist/services/core/cms/entries.client.js.map +1 -0
- package/dist/services/core/cms/index.d.ts +10 -0
- package/dist/services/core/cms/index.d.ts.map +1 -0
- package/dist/services/core/cms/index.js +10 -0
- package/dist/services/core/cms/index.js.map +1 -0
- package/dist/services/core/cms/media.client.d.ts +63 -0
- package/dist/services/core/cms/media.client.d.ts.map +1 -0
- package/dist/services/core/cms/media.client.js +95 -0
- package/dist/services/core/cms/media.client.js.map +1 -0
- package/dist/services/core/cms/modules.client.d.ts +64 -0
- package/dist/services/core/cms/modules.client.d.ts.map +1 -0
- package/dist/services/core/cms/modules.client.js +88 -0
- package/dist/services/core/cms/modules.client.js.map +1 -0
- package/dist/services/core/cms/navigation.client.d.ts +78 -0
- package/dist/services/core/cms/navigation.client.d.ts.map +1 -0
- package/dist/services/core/cms/navigation.client.js +116 -0
- package/dist/services/core/cms/navigation.client.js.map +1 -0
- package/dist/services/core/cms/public.client.d.ts +64 -0
- package/dist/services/core/cms/public.client.d.ts.map +1 -0
- package/dist/services/core/cms/public.client.js +102 -0
- package/dist/services/core/cms/public.client.js.map +1 -0
- package/dist/services/core/cms/types.d.ts +804 -0
- package/dist/services/core/cms/types.d.ts.map +1 -0
- package/dist/services/core/cms/types.js +43 -0
- package/dist/services/core/cms/types.js.map +1 -0
- package/dist/services/core/customers.client.d.ts +285 -0
- package/dist/services/core/customers.client.d.ts.map +1 -0
- package/dist/services/core/customers.client.js +133 -0
- package/dist/services/core/customers.client.js.map +1 -0
- package/dist/services/core/discounts.client.d.ts +197 -0
- package/dist/services/core/discounts.client.d.ts.map +1 -0
- package/dist/services/core/discounts.client.js +81 -0
- package/dist/services/core/discounts.client.js.map +1 -0
- package/dist/services/core/exports/exports.client.d.ts +55 -0
- package/dist/services/core/exports/exports.client.d.ts.map +1 -0
- package/dist/services/core/exports/exports.client.js +80 -0
- package/dist/services/core/exports/exports.client.js.map +1 -0
- package/dist/services/core/exports/index.d.ts +4 -0
- package/dist/services/core/exports/index.d.ts.map +1 -0
- package/dist/services/core/exports/index.js +3 -0
- package/dist/services/core/exports/index.js.map +1 -0
- package/dist/services/core/exports/types.d.ts +68 -0
- package/dist/services/core/exports/types.d.ts.map +1 -0
- package/dist/services/core/exports/types.js +25 -0
- package/dist/services/core/exports/types.js.map +1 -0
- package/dist/services/core/facets.client.d.ts +127 -0
- package/dist/services/core/facets.client.d.ts.map +1 -0
- package/dist/services/core/facets.client.js +81 -0
- package/dist/services/core/facets.client.js.map +1 -0
- package/dist/services/core/fulfillments.client.d.ts +94 -0
- package/dist/services/core/fulfillments.client.d.ts.map +1 -0
- package/dist/services/core/fulfillments.client.js +66 -0
- package/dist/services/core/fulfillments.client.js.map +1 -0
- package/dist/services/core/inventory/adjustments.client.d.ts +60 -0
- package/dist/services/core/inventory/adjustments.client.d.ts.map +1 -0
- package/dist/services/core/inventory/adjustments.client.js +76 -0
- package/dist/services/core/inventory/adjustments.client.js.map +1 -0
- package/dist/services/core/inventory/index.d.ts +8 -0
- package/dist/services/core/inventory/index.d.ts.map +1 -0
- package/dist/services/core/inventory/index.js +7 -0
- package/dist/services/core/inventory/index.js.map +1 -0
- package/dist/services/core/inventory/inventory.client.d.ts +90 -0
- package/dist/services/core/inventory/inventory.client.d.ts.map +1 -0
- package/dist/services/core/inventory/inventory.client.js +135 -0
- package/dist/services/core/inventory/inventory.client.js.map +1 -0
- package/dist/services/core/inventory/locations.client.d.ts +71 -0
- package/dist/services/core/inventory/locations.client.d.ts.map +1 -0
- package/dist/services/core/inventory/locations.client.js +107 -0
- package/dist/services/core/inventory/locations.client.js.map +1 -0
- package/dist/services/core/inventory/reservations.client.d.ts +58 -0
- package/dist/services/core/inventory/reservations.client.d.ts.map +1 -0
- package/dist/services/core/inventory/reservations.client.js +87 -0
- package/dist/services/core/inventory/reservations.client.js.map +1 -0
- package/dist/services/core/inventory/stock.client.d.ts +74 -0
- package/dist/services/core/inventory/stock.client.d.ts.map +1 -0
- package/dist/services/core/inventory/stock.client.js +113 -0
- package/dist/services/core/inventory/stock.client.js.map +1 -0
- package/dist/services/core/inventory/types.d.ts +337 -0
- package/dist/services/core/inventory/types.d.ts.map +1 -0
- package/dist/services/core/inventory/types.js +2 -0
- package/dist/services/core/inventory/types.js.map +1 -0
- package/dist/services/core/invoices.client.d.ts +92 -0
- package/dist/services/core/invoices.client.d.ts.map +1 -0
- package/dist/services/core/invoices.client.js +68 -0
- package/dist/services/core/invoices.client.js.map +1 -0
- package/dist/services/core/notification-config.client.d.ts +57 -0
- package/dist/services/core/notification-config.client.d.ts.map +1 -0
- package/dist/services/core/notification-config.client.js +41 -0
- package/dist/services/core/notification-config.client.js.map +1 -0
- package/dist/services/core/openai-feed.client.d.ts +90 -0
- package/dist/services/core/openai-feed.client.d.ts.map +1 -0
- package/dist/services/core/openai-feed.client.js +63 -0
- package/dist/services/core/openai-feed.client.js.map +1 -0
- package/dist/services/core/option-types.client.d.ts +119 -0
- package/dist/services/core/option-types.client.d.ts.map +1 -0
- package/dist/services/core/option-types.client.js +81 -0
- package/dist/services/core/option-types.client.js.map +1 -0
- package/dist/services/core/option-values.client.d.ts +72 -0
- package/dist/services/core/option-values.client.d.ts.map +1 -0
- package/dist/services/core/option-values.client.js +64 -0
- package/dist/services/core/option-values.client.js.map +1 -0
- package/dist/services/core/order-edits.client.d.ts +88 -0
- package/dist/services/core/order-edits.client.d.ts.map +1 -0
- package/dist/services/core/order-edits.client.js +62 -0
- package/dist/services/core/order-edits.client.js.map +1 -0
- package/dist/services/core/orders.client.d.ts +284 -0
- package/dist/services/core/orders.client.d.ts.map +1 -0
- package/dist/services/core/orders.client.js +150 -0
- package/dist/services/core/orders.client.js.map +1 -0
- package/dist/services/core/pricing/currencies.client.d.ts +109 -0
- package/dist/services/core/pricing/currencies.client.d.ts.map +1 -0
- package/dist/services/core/pricing/currencies.client.js +145 -0
- package/dist/services/core/pricing/currencies.client.js.map +1 -0
- package/dist/services/core/pricing/customer-groups.client.d.ts +126 -0
- package/dist/services/core/pricing/customer-groups.client.d.ts.map +1 -0
- package/dist/services/core/pricing/customer-groups.client.js +154 -0
- package/dist/services/core/pricing/customer-groups.client.js.map +1 -0
- package/dist/services/core/pricing/geo-zones.client.d.ts +89 -0
- package/dist/services/core/pricing/geo-zones.client.d.ts.map +1 -0
- package/dist/services/core/pricing/geo-zones.client.js +116 -0
- package/dist/services/core/pricing/geo-zones.client.js.map +1 -0
- package/dist/services/core/pricing/index.d.ts +13 -0
- package/dist/services/core/pricing/index.d.ts.map +1 -0
- package/dist/services/core/pricing/index.js +13 -0
- package/dist/services/core/pricing/index.js.map +1 -0
- package/dist/services/core/pricing/markets.client.d.ts +154 -0
- package/dist/services/core/pricing/markets.client.d.ts.map +1 -0
- package/dist/services/core/pricing/markets.client.js +194 -0
- package/dist/services/core/pricing/markets.client.js.map +1 -0
- package/dist/services/core/pricing/pricing.client.d.ts +280 -0
- package/dist/services/core/pricing/pricing.client.d.ts.map +1 -0
- package/dist/services/core/pricing/pricing.client.js +363 -0
- package/dist/services/core/pricing/pricing.client.js.map +1 -0
- package/dist/services/core/pricing/product-geo-restrictions.client.d.ts +79 -0
- package/dist/services/core/pricing/product-geo-restrictions.client.d.ts.map +1 -0
- package/dist/services/core/pricing/product-geo-restrictions.client.js +109 -0
- package/dist/services/core/pricing/product-geo-restrictions.client.js.map +1 -0
- package/dist/services/core/pricing/product-market-settings.client.d.ts +168 -0
- package/dist/services/core/pricing/product-market-settings.client.d.ts.map +1 -0
- package/dist/services/core/pricing/product-market-settings.client.js +213 -0
- package/dist/services/core/pricing/product-market-settings.client.js.map +1 -0
- package/dist/services/core/pricing/rules.client.d.ts +46 -0
- package/dist/services/core/pricing/rules.client.d.ts.map +1 -0
- package/dist/services/core/pricing/rules.client.js +57 -0
- package/dist/services/core/pricing/rules.client.js.map +1 -0
- package/dist/services/core/pricing/store-markets.client.d.ts +168 -0
- package/dist/services/core/pricing/store-markets.client.d.ts.map +1 -0
- package/dist/services/core/pricing/store-markets.client.js +209 -0
- package/dist/services/core/pricing/store-markets.client.js.map +1 -0
- package/dist/services/core/pricing/tiers.client.d.ts +57 -0
- package/dist/services/core/pricing/tiers.client.d.ts.map +1 -0
- package/dist/services/core/pricing/tiers.client.js +72 -0
- package/dist/services/core/pricing/tiers.client.js.map +1 -0
- package/dist/services/core/pricing/types.d.ts +782 -0
- package/dist/services/core/pricing/types.d.ts.map +1 -0
- package/dist/services/core/pricing/types.js +2 -0
- package/dist/services/core/pricing/types.js.map +1 -0
- package/dist/services/core/pricing/variant-prices.client.d.ts +307 -0
- package/dist/services/core/pricing/variant-prices.client.d.ts.map +1 -0
- package/dist/services/core/pricing/variant-prices.client.js +347 -0
- package/dist/services/core/pricing/variant-prices.client.js.map +1 -0
- package/dist/services/core/product-relations.client.d.ts +260 -0
- package/dist/services/core/product-relations.client.d.ts.map +1 -0
- package/dist/services/core/product-relations.client.js +141 -0
- package/dist/services/core/product-relations.client.js.map +1 -0
- package/dist/services/core/products.client.d.ts +564 -0
- package/dist/services/core/products.client.d.ts.map +1 -0
- package/dist/services/core/products.client.js +277 -0
- package/dist/services/core/products.client.js.map +1 -0
- package/dist/services/core/returns.client.d.ts +199 -0
- package/dist/services/core/returns.client.d.ts.map +1 -0
- package/dist/services/core/returns.client.js +106 -0
- package/dist/services/core/returns.client.js.map +1 -0
- package/dist/services/core/reviews.client.d.ts +218 -0
- package/dist/services/core/reviews.client.d.ts.map +1 -0
- package/dist/services/core/reviews.client.js +161 -0
- package/dist/services/core/reviews.client.js.map +1 -0
- package/dist/services/core/search.client.d.ts +127 -0
- package/dist/services/core/search.client.d.ts.map +1 -0
- package/dist/services/core/search.client.js +120 -0
- package/dist/services/core/search.client.js.map +1 -0
- package/dist/services/core/shipping/classes.client.d.ts +20 -0
- package/dist/services/core/shipping/classes.client.d.ts.map +1 -0
- package/dist/services/core/shipping/classes.client.js +43 -0
- package/dist/services/core/shipping/classes.client.js.map +1 -0
- package/dist/services/core/shipping/index.d.ts +11 -0
- package/dist/services/core/shipping/index.d.ts.map +1 -0
- package/dist/services/core/shipping/index.js +11 -0
- package/dist/services/core/shipping/index.js.map +1 -0
- package/dist/services/core/shipping/labels.client.d.ts +20 -0
- package/dist/services/core/shipping/labels.client.d.ts.map +1 -0
- package/dist/services/core/shipping/labels.client.js +49 -0
- package/dist/services/core/shipping/labels.client.js.map +1 -0
- package/dist/services/core/shipping/providers.client.d.ts +19 -0
- package/dist/services/core/shipping/providers.client.d.ts.map +1 -0
- package/dist/services/core/shipping/providers.client.js +46 -0
- package/dist/services/core/shipping/providers.client.js.map +1 -0
- package/dist/services/core/shipping/rates.client.d.ts +19 -0
- package/dist/services/core/shipping/rates.client.d.ts.map +1 -0
- package/dist/services/core/shipping/rates.client.js +37 -0
- package/dist/services/core/shipping/rates.client.js.map +1 -0
- package/dist/services/core/shipping/rules.client.d.ts +17 -0
- package/dist/services/core/shipping/rules.client.d.ts.map +1 -0
- package/dist/services/core/shipping/rules.client.js +34 -0
- package/dist/services/core/shipping/rules.client.js.map +1 -0
- package/dist/services/core/shipping/shipper-identity.client.d.ts +49 -0
- package/dist/services/core/shipping/shipper-identity.client.d.ts.map +1 -0
- package/dist/services/core/shipping/shipper-identity.client.js +61 -0
- package/dist/services/core/shipping/shipper-identity.client.js.map +1 -0
- package/dist/services/core/shipping/shipping.client.d.ts +99 -0
- package/dist/services/core/shipping/shipping.client.d.ts.map +1 -0
- package/dist/services/core/shipping/shipping.client.js +165 -0
- package/dist/services/core/shipping/shipping.client.js.map +1 -0
- package/dist/services/core/shipping/store-providers.client.d.ts +48 -0
- package/dist/services/core/shipping/store-providers.client.d.ts.map +1 -0
- package/dist/services/core/shipping/store-providers.client.js +59 -0
- package/dist/services/core/shipping/store-providers.client.js.map +1 -0
- package/dist/services/core/shipping/types.d.ts +488 -0
- package/dist/services/core/shipping/types.d.ts.map +1 -0
- package/dist/services/core/shipping/types.js +3 -0
- package/dist/services/core/shipping/types.js.map +1 -0
- package/dist/services/core/shipping/zones.client.d.ts +16 -0
- package/dist/services/core/shipping/zones.client.d.ts.map +1 -0
- package/dist/services/core/shipping/zones.client.js +29 -0
- package/dist/services/core/shipping/zones.client.js.map +1 -0
- package/dist/services/core/storefront/index.d.ts +10 -0
- package/dist/services/core/storefront/index.d.ts.map +1 -0
- package/dist/services/core/storefront/index.js +10 -0
- package/dist/services/core/storefront/index.js.map +1 -0
- package/dist/services/core/storefront/storefront-addresses.client.d.ts +67 -0
- package/dist/services/core/storefront/storefront-addresses.client.d.ts.map +1 -0
- package/dist/services/core/storefront/storefront-addresses.client.js +95 -0
- package/dist/services/core/storefront/storefront-addresses.client.js.map +1 -0
- package/dist/services/core/storefront/storefront-auth.client.d.ts +104 -0
- package/dist/services/core/storefront/storefront-auth.client.d.ts.map +1 -0
- package/dist/services/core/storefront/storefront-auth.client.js +132 -0
- package/dist/services/core/storefront/storefront-auth.client.js.map +1 -0
- package/dist/services/core/storefront/storefront-orders.client.d.ts +73 -0
- package/dist/services/core/storefront/storefront-orders.client.d.ts.map +1 -0
- package/dist/services/core/storefront/storefront-orders.client.js +78 -0
- package/dist/services/core/storefront/storefront-orders.client.js.map +1 -0
- package/dist/services/core/storefront/storefront-plans.client.d.ts +76 -0
- package/dist/services/core/storefront/storefront-plans.client.d.ts.map +1 -0
- package/dist/services/core/storefront/storefront-plans.client.js +52 -0
- package/dist/services/core/storefront/storefront-plans.client.js.map +1 -0
- package/dist/services/core/storefront/storefront-reviews.client.d.ts +60 -0
- package/dist/services/core/storefront/storefront-reviews.client.d.ts.map +1 -0
- package/dist/services/core/storefront/storefront-reviews.client.js +88 -0
- package/dist/services/core/storefront/storefront-reviews.client.js.map +1 -0
- package/dist/services/core/storefront/storefront-subscriptions.client.d.ts +199 -0
- package/dist/services/core/storefront/storefront-subscriptions.client.d.ts.map +1 -0
- package/dist/services/core/storefront/storefront-subscriptions.client.js +149 -0
- package/dist/services/core/storefront/storefront-subscriptions.client.js.map +1 -0
- package/dist/services/core/storefront/storefront.client.d.ts +166 -0
- package/dist/services/core/storefront/storefront.client.d.ts.map +1 -0
- package/dist/services/core/storefront/storefront.client.js +228 -0
- package/dist/services/core/storefront/storefront.client.js.map +1 -0
- package/dist/services/core/storefront/types.d.ts +131 -0
- package/dist/services/core/storefront/types.d.ts.map +1 -0
- package/dist/services/core/storefront/types.js +3 -0
- package/dist/services/core/storefront/types.js.map +1 -0
- package/dist/services/core/storefront-redirects/index.d.ts +4 -0
- package/dist/services/core/storefront-redirects/index.d.ts.map +1 -0
- package/dist/services/core/storefront-redirects/index.js +3 -0
- package/dist/services/core/storefront-redirects/index.js.map +1 -0
- package/dist/services/core/storefront-redirects/storefront-redirects.client.d.ts +79 -0
- package/dist/services/core/storefront-redirects/storefront-redirects.client.d.ts.map +1 -0
- package/dist/services/core/storefront-redirects/storefront-redirects.client.js +132 -0
- package/dist/services/core/storefront-redirects/storefront-redirects.client.js.map +1 -0
- package/dist/services/core/storefront-redirects/storefront-redirects.public.client.d.ts +35 -0
- package/dist/services/core/storefront-redirects/storefront-redirects.public.client.d.ts.map +1 -0
- package/dist/services/core/storefront-redirects/storefront-redirects.public.client.js +42 -0
- package/dist/services/core/storefront-redirects/storefront-redirects.public.client.js.map +1 -0
- package/dist/services/core/storefront-redirects/types.d.ts +117 -0
- package/dist/services/core/storefront-redirects/types.d.ts.map +1 -0
- package/dist/services/core/storefront-redirects/types.js +2 -0
- package/dist/services/core/storefront-redirects/types.js.map +1 -0
- package/dist/services/core/stores/ai-discovery.client.d.ts +98 -0
- package/dist/services/core/stores/ai-discovery.client.d.ts.map +1 -0
- package/dist/services/core/stores/ai-discovery.client.js +72 -0
- package/dist/services/core/stores/ai-discovery.client.js.map +1 -0
- package/dist/services/core/stores/configuration.client.d.ts +238 -0
- package/dist/services/core/stores/configuration.client.d.ts.map +1 -0
- package/dist/services/core/stores/configuration.client.js +88 -0
- package/dist/services/core/stores/configuration.client.js.map +1 -0
- package/dist/services/core/stores/index.d.ts +11 -0
- package/dist/services/core/stores/index.d.ts.map +1 -0
- package/dist/services/core/stores/index.js +6 -0
- package/dist/services/core/stores/index.js.map +1 -0
- package/dist/services/core/stores/members.client.d.ts +91 -0
- package/dist/services/core/stores/members.client.d.ts.map +1 -0
- package/dist/services/core/stores/members.client.js +70 -0
- package/dist/services/core/stores/members.client.js.map +1 -0
- package/dist/services/core/stores/stores.client.d.ts +190 -0
- package/dist/services/core/stores/stores.client.d.ts.map +1 -0
- package/dist/services/core/stores/stores.client.js +177 -0
- package/dist/services/core/stores/stores.client.js.map +1 -0
- package/dist/services/core/stores/theme.types.d.ts +109 -0
- package/dist/services/core/stores/theme.types.d.ts.map +1 -0
- package/dist/services/core/stores/theme.types.js +27 -0
- package/dist/services/core/stores/theme.types.js.map +1 -0
- package/dist/services/core/taxes/index.d.ts +7 -0
- package/dist/services/core/taxes/index.d.ts.map +1 -0
- package/dist/services/core/taxes/index.js +7 -0
- package/dist/services/core/taxes/index.js.map +1 -0
- package/dist/services/core/taxes/jurisdictions.client.d.ts +61 -0
- package/dist/services/core/taxes/jurisdictions.client.d.ts.map +1 -0
- package/dist/services/core/taxes/jurisdictions.client.js +93 -0
- package/dist/services/core/taxes/jurisdictions.client.js.map +1 -0
- package/dist/services/core/taxes/providers.client.d.ts +111 -0
- package/dist/services/core/taxes/providers.client.d.ts.map +1 -0
- package/dist/services/core/taxes/providers.client.js +188 -0
- package/dist/services/core/taxes/providers.client.js.map +1 -0
- package/dist/services/core/taxes/rates.client.d.ts +63 -0
- package/dist/services/core/taxes/rates.client.d.ts.map +1 -0
- package/dist/services/core/taxes/rates.client.js +97 -0
- package/dist/services/core/taxes/rates.client.js.map +1 -0
- package/dist/services/core/taxes/store-providers.client.d.ts +48 -0
- package/dist/services/core/taxes/store-providers.client.d.ts.map +1 -0
- package/dist/services/core/taxes/store-providers.client.js +59 -0
- package/dist/services/core/taxes/store-providers.client.js.map +1 -0
- package/dist/services/core/taxes/taxes.client.d.ts +81 -0
- package/dist/services/core/taxes/taxes.client.d.ts.map +1 -0
- package/dist/services/core/taxes/taxes.client.js +117 -0
- package/dist/services/core/taxes/taxes.client.js.map +1 -0
- package/dist/services/core/taxes/types.d.ts +406 -0
- package/dist/services/core/taxes/types.d.ts.map +1 -0
- package/dist/services/core/taxes/types.js +3 -0
- package/dist/services/core/taxes/types.js.map +1 -0
- package/dist/services/core/variants.client.d.ts +415 -0
- package/dist/services/core/variants.client.d.ts.map +1 -0
- package/dist/services/core/variants.client.js +289 -0
- package/dist/services/core/variants.client.js.map +1 -0
- package/dist/services/core/wishlists.client.d.ts +151 -0
- package/dist/services/core/wishlists.client.d.ts.map +1 -0
- package/dist/services/core/wishlists.client.js +125 -0
- package/dist/services/core/wishlists.client.js.map +1 -0
- package/dist/storefront/index.d.ts +152 -0
- package/dist/storefront/index.d.ts.map +1 -0
- package/dist/storefront/index.js +189 -0
- package/dist/storefront/index.js.map +1 -0
- package/package.json +66 -0
|
@@ -0,0 +1,277 @@
|
|
|
1
|
+
import { geoRegionQueryParams } from '../../core/types/geo.js';
|
|
2
|
+
import { ProductAssetsClient } from './assets.client.js';
|
|
3
|
+
import { BaseResourceClient } from './base-resource.js';
|
|
4
|
+
import { ProductOptionTypesClient } from './option-types.client.js';
|
|
5
|
+
import { ProductRelationsClient } from './product-relations.client.js';
|
|
6
|
+
/** Extended timeout for CSV import operations (120 seconds) */
|
|
7
|
+
const IMPORT_TIMEOUT = 120_000;
|
|
8
|
+
export class ProductsClient extends BaseResourceClient {
|
|
9
|
+
_optionTypes;
|
|
10
|
+
_assets;
|
|
11
|
+
_relations;
|
|
12
|
+
constructor(httpClient, baseUrl) {
|
|
13
|
+
super({ httpClient, baseUrl, resourcePath: 'products' });
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Assets client for managing product images and media.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* ```typescript
|
|
20
|
+
* // Generate presigned URL and upload
|
|
21
|
+
* const { url, key, publicUrl } = await sdk.products.assets.generateUploadUrl(
|
|
22
|
+
* 'product-uuid',
|
|
23
|
+
* { filename: 'hero.jpg', contentType: 'image/jpeg' }
|
|
24
|
+
* );
|
|
25
|
+
*
|
|
26
|
+
* // List product assets
|
|
27
|
+
* const assets = await sdk.products.assets.list('product-uuid');
|
|
28
|
+
*
|
|
29
|
+
* // Set primary image
|
|
30
|
+
* await sdk.products.assets.setPrimary('product-uuid', 'asset-uuid');
|
|
31
|
+
* ```
|
|
32
|
+
*/
|
|
33
|
+
get assets() {
|
|
34
|
+
if (!this._assets) {
|
|
35
|
+
this._assets = new ProductAssetsClient(this.http, this.baseUrl);
|
|
36
|
+
}
|
|
37
|
+
return this._assets;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Option types client for managing product options (e.g., Color, Size).
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```typescript
|
|
44
|
+
* // List option types for a product
|
|
45
|
+
* const optionTypes = await sdk.products.optionTypes.list('product-uuid');
|
|
46
|
+
*
|
|
47
|
+
* // Create an option type with values
|
|
48
|
+
* const colorOption = await sdk.products.optionTypes.create('product-uuid', {
|
|
49
|
+
* name: 'Color',
|
|
50
|
+
* values: [
|
|
51
|
+
* { value: 'Red', metadata: { hex: '#FF0000' } },
|
|
52
|
+
* { value: 'Blue', metadata: { hex: '#0000FF' } },
|
|
53
|
+
* ],
|
|
54
|
+
* });
|
|
55
|
+
* ```
|
|
56
|
+
*/
|
|
57
|
+
get optionTypes() {
|
|
58
|
+
if (!this._optionTypes) {
|
|
59
|
+
this._optionTypes = new ProductOptionTypesClient(this.http, this.baseUrl);
|
|
60
|
+
}
|
|
61
|
+
return this._optionTypes;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Product relations client for deterministic merchandising edges.
|
|
65
|
+
*
|
|
66
|
+
* Catalog facts only (cross-sell, accessory, compatible_with, etc.).
|
|
67
|
+
* Not AI recommendation scores.
|
|
68
|
+
*
|
|
69
|
+
* @example
|
|
70
|
+
* ```typescript
|
|
71
|
+
* const outbound = await sdk.products.relations.listOutbound('product-uuid');
|
|
72
|
+
* await sdk.products.relations.create('product-uuid', {
|
|
73
|
+
* targetProductId: 'other-uuid',
|
|
74
|
+
* type: 'cross_sell',
|
|
75
|
+
* });
|
|
76
|
+
* ```
|
|
77
|
+
*/
|
|
78
|
+
get relations() {
|
|
79
|
+
if (!this._relations) {
|
|
80
|
+
this._relations = new ProductRelationsClient(this.http, this.baseUrl);
|
|
81
|
+
}
|
|
82
|
+
return this._relations;
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* Get a single product by ID with optional field expansion.
|
|
86
|
+
*
|
|
87
|
+
* @param id - Product UUID
|
|
88
|
+
* @param options - Optional configuration including field expansion
|
|
89
|
+
* @returns Product with requested expanded fields
|
|
90
|
+
*
|
|
91
|
+
* @example
|
|
92
|
+
* ```typescript
|
|
93
|
+
* // Base product only
|
|
94
|
+
* const product = await sdk.products.get('uuid');
|
|
95
|
+
*
|
|
96
|
+
* // With variants and price range
|
|
97
|
+
* const expanded = await sdk.products.get('uuid', {
|
|
98
|
+
* include: ['variants', 'priceRange'],
|
|
99
|
+
* });
|
|
100
|
+
* console.log(expanded.priceRange?.min); // TypeScript knows this exists
|
|
101
|
+
* ```
|
|
102
|
+
*/
|
|
103
|
+
async get(id, options) {
|
|
104
|
+
const params = {
|
|
105
|
+
...this.buildIncludeParams(options?.include),
|
|
106
|
+
...geoRegionQueryParams(options),
|
|
107
|
+
};
|
|
108
|
+
return this.http.get(`${this.endpoint}/${id}`, { params });
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* List products with optional pagination, filters, and field expansion.
|
|
112
|
+
*
|
|
113
|
+
* @param options - Pagination, filters, and include options
|
|
114
|
+
* @returns Paginated response with products including expanded fields
|
|
115
|
+
*
|
|
116
|
+
* @example
|
|
117
|
+
* ```typescript
|
|
118
|
+
* // Base fields with pagination
|
|
119
|
+
* const products = await sdk.products.list({ page: 1, limit: 20 });
|
|
120
|
+
*
|
|
121
|
+
* // With filters and expanded fields
|
|
122
|
+
* const expanded = await sdk.products.list({
|
|
123
|
+
* filters: { isEnabled: true, productType: 'good' },
|
|
124
|
+
* include: ['priceRange', 'variantCount', 'categories'],
|
|
125
|
+
* });
|
|
126
|
+
* // Each product has: priceRange, variantCount, categories
|
|
127
|
+
* ```
|
|
128
|
+
*/
|
|
129
|
+
async list(options) {
|
|
130
|
+
const params = {
|
|
131
|
+
...this.buildQueryParams(options ?? {}),
|
|
132
|
+
...this.buildIncludeParams(options?.include),
|
|
133
|
+
...geoRegionQueryParams(options),
|
|
134
|
+
...priceRangeQueryParams(options),
|
|
135
|
+
};
|
|
136
|
+
return this.http.get(this.endpoint, { params });
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* Search products by query string with optional field expansion.
|
|
140
|
+
*
|
|
141
|
+
* @param query - Search query string
|
|
142
|
+
* @param options - Optional limit and include options
|
|
143
|
+
* @returns Paginated search results with expanded fields
|
|
144
|
+
*/
|
|
145
|
+
async search(query, options) {
|
|
146
|
+
const params = {
|
|
147
|
+
q: query,
|
|
148
|
+
...this.buildIncludeParams(options?.include),
|
|
149
|
+
...geoRegionQueryParams(options),
|
|
150
|
+
...priceRangeQueryParams(options),
|
|
151
|
+
};
|
|
152
|
+
if (options?.limit !== undefined) {
|
|
153
|
+
params.limit = String(options.limit);
|
|
154
|
+
}
|
|
155
|
+
return this.http.get(`${this.endpoint}/search`, {
|
|
156
|
+
params,
|
|
157
|
+
});
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
* Get a product by its slug with optional field expansion.
|
|
161
|
+
*
|
|
162
|
+
* @param slug - Product slug
|
|
163
|
+
* @param options - Optional include options
|
|
164
|
+
* @returns Product with requested expanded fields
|
|
165
|
+
*/
|
|
166
|
+
async getBySlug(slug, options) {
|
|
167
|
+
const params = {
|
|
168
|
+
...this.buildIncludeParams(options?.include),
|
|
169
|
+
...geoRegionQueryParams(options),
|
|
170
|
+
};
|
|
171
|
+
return this.http.get(`${this.endpoint}/slug/${slug}`, { params });
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* Bulk enable/disable products.
|
|
175
|
+
*
|
|
176
|
+
* @param productIds - Array of product UUIDs
|
|
177
|
+
* @param isEnabled - New enabled status
|
|
178
|
+
* @returns Updated products
|
|
179
|
+
*/
|
|
180
|
+
async bulkUpdateStatus(productIds, isEnabled) {
|
|
181
|
+
return this.http.patch(`${this.endpoint}/bulk-status`, {
|
|
182
|
+
productIds,
|
|
183
|
+
isEnabled,
|
|
184
|
+
});
|
|
185
|
+
}
|
|
186
|
+
/**
|
|
187
|
+
* Assign categories to a product.
|
|
188
|
+
* This replaces the product's existing category assignments.
|
|
189
|
+
*
|
|
190
|
+
* @param productId - Product UUID
|
|
191
|
+
* @param categoryIds - Array of category UUIDs to assign
|
|
192
|
+
* @returns Updated product
|
|
193
|
+
*
|
|
194
|
+
* @example
|
|
195
|
+
* ```typescript
|
|
196
|
+
* const product = await sdk.products.assignCategories('product-uuid', [
|
|
197
|
+
* 'category-1-uuid',
|
|
198
|
+
* 'category-2-uuid',
|
|
199
|
+
* ]);
|
|
200
|
+
* ```
|
|
201
|
+
*/
|
|
202
|
+
async assignCategories(productId, categoryIds) {
|
|
203
|
+
return this.http.post(`${this.endpoint}/${productId}/categories`, { categoryIds });
|
|
204
|
+
}
|
|
205
|
+
/**
|
|
206
|
+
* Remove categories from a product.
|
|
207
|
+
*
|
|
208
|
+
* @param productId - Product UUID
|
|
209
|
+
* @param categoryIds - Array of category UUIDs to remove
|
|
210
|
+
* @returns Updated product
|
|
211
|
+
*
|
|
212
|
+
* @example
|
|
213
|
+
* ```typescript
|
|
214
|
+
* const product = await sdk.products.removeCategories('product-uuid', [
|
|
215
|
+
* 'category-1-uuid',
|
|
216
|
+
* ]);
|
|
217
|
+
* ```
|
|
218
|
+
*/
|
|
219
|
+
async removeCategories(productId, categoryIds) {
|
|
220
|
+
return this.http.delete(`${this.endpoint}/${productId}/categories`, {
|
|
221
|
+
data: { categoryIds },
|
|
222
|
+
});
|
|
223
|
+
}
|
|
224
|
+
// ==================== CSV Import ====================
|
|
225
|
+
/**
|
|
226
|
+
* Download the CSV import template for products.
|
|
227
|
+
* Returns raw CSV content as a string.
|
|
228
|
+
*/
|
|
229
|
+
async getImportTemplate() {
|
|
230
|
+
return this.http.get(`${this.endpoint}/import/template`, {
|
|
231
|
+
responseType: 'text',
|
|
232
|
+
});
|
|
233
|
+
}
|
|
234
|
+
/**
|
|
235
|
+
* Preview a CSV import without making changes.
|
|
236
|
+
* @param file - CSV content as a string, File, or Blob
|
|
237
|
+
*/
|
|
238
|
+
async previewImport(file) {
|
|
239
|
+
const csvContent = typeof file === 'string' ? file : await file.text();
|
|
240
|
+
return this.http.post(`${this.endpoint}/import/preview`, { file: csvContent }, { timeout: IMPORT_TIMEOUT });
|
|
241
|
+
}
|
|
242
|
+
/**
|
|
243
|
+
* Import products from a CSV file.
|
|
244
|
+
* @param file - CSV content as a string, File, or Blob
|
|
245
|
+
* @param options.updateExisting - Update products/variants that already exist by slug/SKU
|
|
246
|
+
*/
|
|
247
|
+
async importFromCSV(file, options = {}) {
|
|
248
|
+
const csvContent = typeof file === 'string' ? file : await file.text();
|
|
249
|
+
const params = {};
|
|
250
|
+
if (options.updateExisting !== undefined)
|
|
251
|
+
params.updateExisting = String(options.updateExisting);
|
|
252
|
+
return this.http.post(`${this.endpoint}/import`, { file: csvContent }, { params, timeout: IMPORT_TIMEOUT });
|
|
253
|
+
}
|
|
254
|
+
/**
|
|
255
|
+
* Build include query params from array of include keys.
|
|
256
|
+
* Converts ['variants', 'priceRange'] to { include: 'variants,priceRange' }
|
|
257
|
+
*/
|
|
258
|
+
buildIncludeParams(include) {
|
|
259
|
+
if (!include || include.length === 0) {
|
|
260
|
+
return {};
|
|
261
|
+
}
|
|
262
|
+
return { include: include.join(',') };
|
|
263
|
+
}
|
|
264
|
+
}
|
|
265
|
+
function priceRangeQueryParams(options) {
|
|
266
|
+
if (!options)
|
|
267
|
+
return {};
|
|
268
|
+
const params = {};
|
|
269
|
+
if (options.marketId !== undefined) {
|
|
270
|
+
params.marketId = options.marketId;
|
|
271
|
+
}
|
|
272
|
+
if (options.currencyCode !== undefined) {
|
|
273
|
+
params.currencyCode = options.currencyCode;
|
|
274
|
+
}
|
|
275
|
+
return params;
|
|
276
|
+
}
|
|
277
|
+
//# sourceMappingURL=products.client.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"products.client.js","sourceRoot":"","sources":["../../../../../src/services/core/products.client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAwB,MAAM,yBAAyB,CAAC;AAErF,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAGxD,OAAO,EAAE,wBAAwB,EAA0B,MAAM,0BAA0B,CAAC;AAC5F,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAIvE,+DAA+D;AAC/D,MAAM,cAAc,GAAG,OAAO,CAAC;AAsb/B,MAAM,OAAO,cAAe,SAAQ,kBAKnC;IACS,YAAY,CAA4B;IACxC,OAAO,CAAuB;IAC9B,UAAU,CAA0B;IAE5C,YAAY,UAAsB,EAAE,OAAe;QACjD,KAAK,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,MAAM;QACR,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,OAAO,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAClE,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,WAAW;QACb,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,IAAI,CAAC,YAAY,GAAG,IAAI,wBAAwB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5E,CAAC;QACD,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,SAAS;QACX,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,IAAI,CAAC,UAAU,GAAG,IAAI,sBAAsB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,GAAG,CACP,EAAU,EACV,OAA8B;QAE9B,MAAM,MAAM,GAAG;YACb,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC;YAC5C,GAAG,oBAAoB,CAAC,OAAO,CAAC;SACjC,CAAC;QACF,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAqB,GAAG,IAAI,CAAC,QAAQ,IAAI,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,IAAI,CACR,OAA+B;QAE/B,MAAM,MAAM,GAAG;YACb,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,IAAI,EAAE,CAAC;YACvC,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC;YAC5C,GAAG,oBAAoB,CAAC,OAAO,CAAC;YAChC,GAAG,qBAAqB,CAAC,OAAO,CAAC;SAClC,CAAC;QACF,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAwC,IAAI,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,KAAa,EACb,OAAiC;QAEjC,MAAM,MAAM,GAA2B;YACrC,CAAC,EAAE,KAAK;YACR,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC;YAC5C,GAAG,oBAAoB,CAAC,OAAO,CAAC;YAChC,GAAG,qBAAqB,CAAC,OAAO,CAAC;SAClC,CAAC;QACF,IAAI,OAAO,EAAE,KAAK,KAAK,SAAS,EAAE,CAAC;YACjC,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAwC,GAAG,IAAI,CAAC,QAAQ,SAAS,EAAE;YACrF,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,CACb,IAAY,EACZ,OAA8B;QAE9B,MAAM,MAAM,GAAG;YACb,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC;YAC5C,GAAG,oBAAoB,CAAC,OAAO,CAAC;SACjC,CAAC;QACF,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAqB,GAAG,IAAI,CAAC,QAAQ,SAAS,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,gBAAgB,CAAC,UAAoB,EAAE,SAAkB;QAC7D,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAY,GAAG,IAAI,CAAC,QAAQ,cAAc,EAAE;YAChE,UAAU;YACV,SAAS;SACV,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,gBAAgB,CAAC,SAAiB,EAAE,WAAqB;QAC7D,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAU,GAAG,IAAI,CAAC,QAAQ,IAAI,SAAS,aAAa,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,gBAAgB,CAAC,SAAiB,EAAE,WAAqB;QAC7D,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAU,GAAG,IAAI,CAAC,QAAQ,IAAI,SAAS,aAAa,EAAE;YAC3E,IAAI,EAAE,EAAE,WAAW,EAAE;SACtB,CAAC,CAAC;IACL,CAAC;IAED,uDAAuD;IAEvD;;;OAGG;IACH,KAAK,CAAC,iBAAiB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAS,GAAG,IAAI,CAAC,QAAQ,kBAAkB,EAAE;YAC/D,YAAY,EAAE,MAAM;SACrB,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa,CAAC,IAA0B;QAC5C,MAAM,UAAU,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QACvE,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CACnB,GAAG,IAAI,CAAC,QAAQ,iBAAiB,EACjC,EAAE,IAAI,EAAE,UAAU,EAAE,EACpB,EAAE,OAAO,EAAE,cAAc,EAAE,CAC5B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CACjB,IAA0B,EAC1B,UAAwC,EAAE;QAE1C,MAAM,UAAU,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QACvE,MAAM,MAAM,GAA2B,EAAE,CAAC;QAC1C,IAAI,OAAO,CAAC,cAAc,KAAK,SAAS;YACtC,MAAM,CAAC,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CACnB,GAAG,IAAI,CAAC,QAAQ,SAAS,EACzB,EAAE,IAAI,EAAE,UAAU,EAAE,EACpB,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,CACpC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACK,kBAAkB,CAAC,OAA6B;QACtD,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrC,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;IACxC,CAAC;CACF;AAED,SAAS,qBAAqB,CAAC,OAG9B;IACC,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,CAAC;IACxB,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACnC,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IACrC,CAAC;IACD,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QACvC,MAAM,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IAC7C,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
import type { HttpClientTransport as HttpClient } from '../../core/http-client.js';
|
|
2
|
+
export type ReturnStatus = 'requested' | 'pendingApproval' | 'approved' | 'rejected' | 'shipped' | 'received' | 'inspecting' | 'processingRefund' | 'refunded' | 'completed' | 'cancelled';
|
|
3
|
+
export type ReturnReason = 'defective' | 'notAsDescribed' | 'wrongItem' | 'damaged' | 'noLongerNeeded' | 'arrivedLate' | 'other';
|
|
4
|
+
export type ResolutionType = 'refund' | 'exchange' | 'storeCredit';
|
|
5
|
+
/** Condition of a returned item recorded on creation / inspection. */
|
|
6
|
+
export type ReturnItemCondition = 'unopened' | 'opened' | 'damaged' | 'defective';
|
|
7
|
+
/** Status of a refund record processed for a return. */
|
|
8
|
+
export type RefundStatus = 'pending' | 'processing' | 'completed' | 'failed';
|
|
9
|
+
/**
|
|
10
|
+
* Line item supplied when creating a return request.
|
|
11
|
+
*/
|
|
12
|
+
export interface CreateReturnItemDto {
|
|
13
|
+
orderItemId: string;
|
|
14
|
+
quantity: number;
|
|
15
|
+
reason: ReturnReason;
|
|
16
|
+
condition?: ReturnItemCondition;
|
|
17
|
+
notes?: string;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Return line item as returned by GET /returns/:id.
|
|
21
|
+
*
|
|
22
|
+
* Monetary fields are decimal strings of cents. `sku` and `variantId` are sourced from the
|
|
23
|
+
* order-line snapshot and are only populated on the return detail endpoint (not on list).
|
|
24
|
+
*/
|
|
25
|
+
export interface ReturnLineItem {
|
|
26
|
+
id: string;
|
|
27
|
+
tenantId: string;
|
|
28
|
+
storeId: string;
|
|
29
|
+
returnId: string;
|
|
30
|
+
orderItemId: string;
|
|
31
|
+
quantity: number;
|
|
32
|
+
reason: ReturnReason;
|
|
33
|
+
condition: ReturnItemCondition | null;
|
|
34
|
+
inspectionNotes: string | null;
|
|
35
|
+
restockStatus: string;
|
|
36
|
+
/** Refund amount in cents (decimal string). */
|
|
37
|
+
refundAmount: string;
|
|
38
|
+
/** Product SKU from the order-line snapshot (detail endpoint only). */
|
|
39
|
+
sku?: string | null;
|
|
40
|
+
/** Product variant id from the order-line snapshot (detail endpoint only). */
|
|
41
|
+
variantId?: string | null;
|
|
42
|
+
createdAt: string;
|
|
43
|
+
updatedAt: string;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Refund record produced when processing a return refund.
|
|
47
|
+
*/
|
|
48
|
+
export interface Refund {
|
|
49
|
+
id: string;
|
|
50
|
+
tenantId: string;
|
|
51
|
+
storeId: string;
|
|
52
|
+
returnId: string;
|
|
53
|
+
idempotencyKey?: string | null;
|
|
54
|
+
transactionId?: string | null;
|
|
55
|
+
/** Refund amount in cents (decimal string). */
|
|
56
|
+
amount: string;
|
|
57
|
+
currency: string;
|
|
58
|
+
status: RefundStatus;
|
|
59
|
+
provider: string;
|
|
60
|
+
providerRef?: string | null;
|
|
61
|
+
errorMessage?: string | null;
|
|
62
|
+
retryCount: number;
|
|
63
|
+
lastRetryAt?: string | null;
|
|
64
|
+
metadata: Record<string, unknown>;
|
|
65
|
+
processedAt?: string | null;
|
|
66
|
+
createdAt: string;
|
|
67
|
+
updatedAt: string;
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* Return (RMA) as returned by the returns endpoints.
|
|
71
|
+
*
|
|
72
|
+
* Monetary fields (`totalAmount`, `refundAmount`, `restockingFee`) are decimal strings of
|
|
73
|
+
* cents. `returnItems` are enriched with `sku`/`variantId` only on GET /returns/:id.
|
|
74
|
+
*/
|
|
75
|
+
export interface Return {
|
|
76
|
+
id: string;
|
|
77
|
+
returnNumber: string;
|
|
78
|
+
orderId: string;
|
|
79
|
+
status: ReturnStatus;
|
|
80
|
+
reason: ReturnReason;
|
|
81
|
+
resolutionType: ResolutionType;
|
|
82
|
+
/** Total return amount in cents (decimal string). */
|
|
83
|
+
totalAmount: string;
|
|
84
|
+
/** Refund amount in cents (decimal string), or null. */
|
|
85
|
+
refundAmount: string | null;
|
|
86
|
+
/** Restocking fee in cents (decimal string), or null. */
|
|
87
|
+
restockingFee: string | null;
|
|
88
|
+
notes: string | null;
|
|
89
|
+
metadata: Record<string, unknown>;
|
|
90
|
+
trackingNumber: string | null;
|
|
91
|
+
shippingLabelUrl: string | null;
|
|
92
|
+
shippingCarrier: string | null;
|
|
93
|
+
shippingMethod: string | null;
|
|
94
|
+
tenantId: string;
|
|
95
|
+
storeId: string;
|
|
96
|
+
createdBy: string | null;
|
|
97
|
+
approvedBy: string | null;
|
|
98
|
+
returnItems: ReturnLineItem[];
|
|
99
|
+
createdAt: string;
|
|
100
|
+
updatedAt: string;
|
|
101
|
+
deletedAt: string | null;
|
|
102
|
+
}
|
|
103
|
+
export interface CreateReturnDto {
|
|
104
|
+
orderId: string;
|
|
105
|
+
items: CreateReturnItemDto[];
|
|
106
|
+
reason: ReturnReason;
|
|
107
|
+
resolutionType?: ResolutionType;
|
|
108
|
+
notes?: string;
|
|
109
|
+
}
|
|
110
|
+
export interface ReturnFilters {
|
|
111
|
+
status?: ReturnStatus;
|
|
112
|
+
customerId?: string;
|
|
113
|
+
orderId?: string;
|
|
114
|
+
limit?: number;
|
|
115
|
+
offset?: number;
|
|
116
|
+
}
|
|
117
|
+
export interface ReturnLabelResult {
|
|
118
|
+
return: Return;
|
|
119
|
+
labelUrl: string;
|
|
120
|
+
trackingNumber: string;
|
|
121
|
+
}
|
|
122
|
+
export interface ReturnListResponse {
|
|
123
|
+
returns: Return[];
|
|
124
|
+
total: number;
|
|
125
|
+
limit: number;
|
|
126
|
+
offset: number;
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
129
|
+
* ReturnsClient manages order returns and RMA (Return Merchandise Authorization).
|
|
130
|
+
*
|
|
131
|
+
* @example
|
|
132
|
+
* ```typescript
|
|
133
|
+
* // Create a return request
|
|
134
|
+
* const return_ = await sdk.returns.create({
|
|
135
|
+
* orderId: 'order-uuid',
|
|
136
|
+
* items: [{ orderItemId: 'item-uuid', quantity: 1, reason: 'defective' }],
|
|
137
|
+
* reason: 'defective',
|
|
138
|
+
* resolutionType: 'refund',
|
|
139
|
+
* });
|
|
140
|
+
*
|
|
141
|
+
* // Admin approves the return
|
|
142
|
+
* await sdk.returns.approve(return_.id);
|
|
143
|
+
*
|
|
144
|
+
* // Generate return label
|
|
145
|
+
* const { labelUrl, trackingNumber } = await sdk.returns.generateLabel(return_.id);
|
|
146
|
+
*
|
|
147
|
+
* // Process refund after receiving items
|
|
148
|
+
* await sdk.returns.markAsReceived(return_.id);
|
|
149
|
+
* await sdk.returns.processRefund(return_.id);
|
|
150
|
+
* ```
|
|
151
|
+
*/
|
|
152
|
+
export declare class ReturnsClient {
|
|
153
|
+
private readonly http;
|
|
154
|
+
private readonly baseUrl;
|
|
155
|
+
constructor(http: HttpClient, baseUrl: string);
|
|
156
|
+
/**
|
|
157
|
+
* List returns with filters
|
|
158
|
+
*/
|
|
159
|
+
list(filters?: ReturnFilters): Promise<ReturnListResponse>;
|
|
160
|
+
/**
|
|
161
|
+
* Get a specific return by ID
|
|
162
|
+
*/
|
|
163
|
+
get(id: string): Promise<Return>;
|
|
164
|
+
/**
|
|
165
|
+
* Create a new return request
|
|
166
|
+
*/
|
|
167
|
+
create(data: CreateReturnDto): Promise<Return>;
|
|
168
|
+
/**
|
|
169
|
+
* Cancel a return request
|
|
170
|
+
*/
|
|
171
|
+
cancel(id: string): Promise<Return>;
|
|
172
|
+
/**
|
|
173
|
+
* Mark a return as shipped by the customer
|
|
174
|
+
*/
|
|
175
|
+
markAsShipped(id: string, trackingNumber?: string): Promise<Return>;
|
|
176
|
+
/**
|
|
177
|
+
* Approve a return request (admin)
|
|
178
|
+
*/
|
|
179
|
+
approve(id: string): Promise<Return>;
|
|
180
|
+
/**
|
|
181
|
+
* Reject a return request (admin)
|
|
182
|
+
*/
|
|
183
|
+
reject(id: string, reason?: string): Promise<Return>;
|
|
184
|
+
/**
|
|
185
|
+
* Mark a return as received at the warehouse
|
|
186
|
+
*/
|
|
187
|
+
markAsReceived(id: string): Promise<Return>;
|
|
188
|
+
/**
|
|
189
|
+
* Generate a return shipping label
|
|
190
|
+
*/
|
|
191
|
+
generateLabel(id: string): Promise<ReturnLabelResult>;
|
|
192
|
+
/**
|
|
193
|
+
* Process refund for a return.
|
|
194
|
+
*
|
|
195
|
+
* Returns the created Refund record (not the Return).
|
|
196
|
+
*/
|
|
197
|
+
processRefund(id: string): Promise<Refund>;
|
|
198
|
+
}
|
|
199
|
+
//# sourceMappingURL=returns.client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"returns.client.d.ts","sourceRoot":"","sources":["../../../../../src/services/core/returns.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,IAAI,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAInF,MAAM,MAAM,YAAY,GACpB,WAAW,GACX,iBAAiB,GACjB,UAAU,GACV,UAAU,GACV,SAAS,GACT,UAAU,GACV,YAAY,GACZ,kBAAkB,GAClB,UAAU,GACV,WAAW,GACX,WAAW,CAAC;AAEhB,MAAM,MAAM,YAAY,GACpB,WAAW,GACX,gBAAgB,GAChB,WAAW,GACX,SAAS,GACT,gBAAgB,GAChB,aAAa,GACb,OAAO,CAAC;AAEZ,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,UAAU,GAAG,aAAa,CAAC;AAEnE,sEAAsE;AACtE,MAAM,MAAM,mBAAmB,GAAG,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,CAAC;AAElF,wDAAwD;AACxD,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;AAE7E;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IACrB,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IACrB,SAAS,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACtC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,+CAA+C;IAC/C,YAAY,EAAE,MAAM,CAAC;IACrB,uEAAuE;IACvE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,8EAA8E;IAC9E,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,EAAE,YAAY,CAAC;IACrB,cAAc,EAAE,cAAc,CAAC;IAC/B,qDAAqD;IACrD,WAAW,EAAE,MAAM,CAAC;IACpB,wDAAwD;IACxD,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,yDAAyD;IACzD,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,WAAW,EAAE,cAAc,EAAE,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,mBAAmB,EAAE,CAAC;IAC7B,MAAM,EAAE,YAAY,CAAC;IACrB,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,aAAa;IAEtB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO;gBADP,IAAI,EAAE,UAAU,EAChB,OAAO,EAAE,MAAM;IAGlC;;OAEG;IACG,IAAI,CAAC,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAUpE;;OAEG;IACG,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAItC;;OAEG;IACG,MAAM,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAIpD;;OAEG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIzC;;OAEG;IACG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIzE;;OAEG;IACG,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI1C;;OAEG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI1D;;OAEG;IACG,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIjD;;OAEG;IACG,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI3D;;;;OAIG;IACG,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAGjD"}
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* ReturnsClient manages order returns and RMA (Return Merchandise Authorization).
|
|
3
|
+
*
|
|
4
|
+
* @example
|
|
5
|
+
* ```typescript
|
|
6
|
+
* // Create a return request
|
|
7
|
+
* const return_ = await sdk.returns.create({
|
|
8
|
+
* orderId: 'order-uuid',
|
|
9
|
+
* items: [{ orderItemId: 'item-uuid', quantity: 1, reason: 'defective' }],
|
|
10
|
+
* reason: 'defective',
|
|
11
|
+
* resolutionType: 'refund',
|
|
12
|
+
* });
|
|
13
|
+
*
|
|
14
|
+
* // Admin approves the return
|
|
15
|
+
* await sdk.returns.approve(return_.id);
|
|
16
|
+
*
|
|
17
|
+
* // Generate return label
|
|
18
|
+
* const { labelUrl, trackingNumber } = await sdk.returns.generateLabel(return_.id);
|
|
19
|
+
*
|
|
20
|
+
* // Process refund after receiving items
|
|
21
|
+
* await sdk.returns.markAsReceived(return_.id);
|
|
22
|
+
* await sdk.returns.processRefund(return_.id);
|
|
23
|
+
* ```
|
|
24
|
+
*/
|
|
25
|
+
export class ReturnsClient {
|
|
26
|
+
http;
|
|
27
|
+
baseUrl;
|
|
28
|
+
constructor(http, baseUrl) {
|
|
29
|
+
this.http = http;
|
|
30
|
+
this.baseUrl = baseUrl;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* List returns with filters
|
|
34
|
+
*/
|
|
35
|
+
async list(filters = {}) {
|
|
36
|
+
const params = {};
|
|
37
|
+
if (filters.status)
|
|
38
|
+
params.status = filters.status;
|
|
39
|
+
if (filters.customerId)
|
|
40
|
+
params.customerId = filters.customerId;
|
|
41
|
+
if (filters.orderId)
|
|
42
|
+
params.orderId = filters.orderId;
|
|
43
|
+
if (filters.limit !== undefined)
|
|
44
|
+
params.limit = String(filters.limit);
|
|
45
|
+
if (filters.offset !== undefined)
|
|
46
|
+
params.offset = String(filters.offset);
|
|
47
|
+
return this.http.get(`${this.baseUrl}/v1/returns`, { params });
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Get a specific return by ID
|
|
51
|
+
*/
|
|
52
|
+
async get(id) {
|
|
53
|
+
return this.http.get(`${this.baseUrl}/v1/returns/${id}`);
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Create a new return request
|
|
57
|
+
*/
|
|
58
|
+
async create(data) {
|
|
59
|
+
return this.http.post(`${this.baseUrl}/v1/returns`, data);
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Cancel a return request
|
|
63
|
+
*/
|
|
64
|
+
async cancel(id) {
|
|
65
|
+
return this.http.put(`${this.baseUrl}/v1/returns/${id}/cancel`, {});
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Mark a return as shipped by the customer
|
|
69
|
+
*/
|
|
70
|
+
async markAsShipped(id, trackingNumber) {
|
|
71
|
+
return this.http.put(`${this.baseUrl}/v1/returns/${id}/ship`, { trackingNumber });
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* Approve a return request (admin)
|
|
75
|
+
*/
|
|
76
|
+
async approve(id) {
|
|
77
|
+
return this.http.put(`${this.baseUrl}/v1/returns/${id}/approve`, {});
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* Reject a return request (admin)
|
|
81
|
+
*/
|
|
82
|
+
async reject(id, reason) {
|
|
83
|
+
return this.http.put(`${this.baseUrl}/v1/returns/${id}/reject`, { reason });
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Mark a return as received at the warehouse
|
|
87
|
+
*/
|
|
88
|
+
async markAsReceived(id) {
|
|
89
|
+
return this.http.put(`${this.baseUrl}/v1/returns/${id}/receive`, {});
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* Generate a return shipping label
|
|
93
|
+
*/
|
|
94
|
+
async generateLabel(id) {
|
|
95
|
+
return this.http.post(`${this.baseUrl}/v1/returns/${id}/label`, {});
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* Process refund for a return.
|
|
99
|
+
*
|
|
100
|
+
* Returns the created Refund record (not the Return).
|
|
101
|
+
*/
|
|
102
|
+
async processRefund(id) {
|
|
103
|
+
return this.http.post(`${this.baseUrl}/v1/returns/${id}/refund`, {});
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
//# sourceMappingURL=returns.client.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"returns.client.js","sourceRoot":"","sources":["../../../../../src/services/core/returns.client.ts"],"names":[],"mappings":"AAiKA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,OAAO,aAAa;IAEL;IACA;IAFnB,YACmB,IAAgB,EAChB,OAAe;QADf,SAAI,GAAJ,IAAI,CAAY;QAChB,YAAO,GAAP,OAAO,CAAQ;IAC/B,CAAC;IAEJ;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,UAAyB,EAAE;QACpC,MAAM,MAAM,GAA2B,EAAE,CAAC;QAC1C,IAAI,OAAO,CAAC,MAAM;YAAE,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QACnD,IAAI,OAAO,CAAC,UAAU;YAAE,MAAM,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QAC/D,IAAI,OAAO,CAAC,OAAO;YAAE,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QACtD,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACtE,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS;YAAE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACzE,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAqB,GAAG,IAAI,CAAC,OAAO,aAAa,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CAAC,EAAU;QAClB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAS,GAAG,IAAI,CAAC,OAAO,eAAe,EAAE,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,IAAqB;QAChC,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAS,GAAG,IAAI,CAAC,OAAO,aAAa,EAAE,IAAI,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAS,GAAG,IAAI,CAAC,OAAO,eAAe,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa,CAAC,EAAU,EAAE,cAAuB;QACrD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAS,GAAG,IAAI,CAAC,OAAO,eAAe,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,EAAU;QACtB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAS,GAAG,IAAI,CAAC,OAAO,eAAe,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,MAAe;QACtC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAS,GAAG,IAAI,CAAC,OAAO,eAAe,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAC,EAAU;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAS,GAAG,IAAI,CAAC,OAAO,eAAe,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa,CAAC,EAAU;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAoB,GAAG,IAAI,CAAC,OAAO,eAAe,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAAC,EAAU;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAS,GAAG,IAAI,CAAC,OAAO,eAAe,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF"}
|