diff --git a/packages/medusa-js/src/resources/admin/sales-channels.ts b/packages/medusa-js/src/resources/admin/sales-channels.ts index 4b8457e37c..0318812db9 100644 --- a/packages/medusa-js/src/resources/admin/sales-channels.ts +++ b/packages/medusa-js/src/resources/admin/sales-channels.ts @@ -6,7 +6,9 @@ import { ResponsePromise } from "../../typings" import BaseResource from "../base" class AdminSalesChannelsResource extends BaseResource { - /** + /** retrieve a sales channel + * @experimental This feature is under development and may change in the future. + * To use this feature please enable featureflag `sales_channels` in your medusa backend project. * @description gets a sales channel * @returns a medusa sales channel */ @@ -23,7 +25,10 @@ class AdminSalesChannelsResource extends BaseResource { customHeaders: Record = {} ): ResponsePromise {}*/ - /** @description updates a sales channel + /** update a sales channel + * @experimental This feature is under development and may change in the future. + * To use this feature please enable featureflag `sales_channels` in your medusa backend project. + * @description updates a sales channel * @returns the updated medusa sales channel */ update( diff --git a/packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts b/packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts index 47a8353e9d..7649001df4 100644 --- a/packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts @@ -8,6 +8,12 @@ import { useMedusa } from "../../../contexts" import { buildOptions } from "../../utils/buildOptions" import { adminSalesChannelsKeys } from "./queries" +/** update a sales channel + * @experimental This feature is under development and may change in the future. + * To use this feature please enable featureflag `sales_channels` in your medusa backend project. + * @description updates a sales channel + * @returns the updated medusa sales channel + */ export const useAdminUpdateSalesChannel = ( id: string, options?: UseMutationOptions< diff --git a/packages/medusa-react/src/hooks/admin/sales-channels/queries.ts b/packages/medusa-react/src/hooks/admin/sales-channels/queries.ts index e909a88bd1..0384fd76d8 100644 --- a/packages/medusa-react/src/hooks/admin/sales-channels/queries.ts +++ b/packages/medusa-react/src/hooks/admin/sales-channels/queries.ts @@ -13,6 +13,12 @@ export const adminSalesChannelsKeys = queryKeysFactory( type SalesChannelsQueryKeys = typeof adminSalesChannelsKeys +/** retrieve a sales channel + * @experimental This feature is under development and may change in the future. + * To use this feature please enable featureflag `sales_channels` in your medusa backend project. + * @description gets a sales channel + * @returns a medusa sales channel + */ export const useAdminSalesChannel = ( id: string, options?: UseQueryOptionsWrapper<