docs: added an upgrade guide for 1.7.0 (#2750)
This commit is contained in:
35
docs/content/advanced/backend/upgrade-guides/1-7-0.md
Normal file
35
docs/content/advanced/backend/upgrade-guides/1-7-0.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
description: 'Actions Required for v.1.7.0'
|
||||
---
|
||||
|
||||
# v1.7.0
|
||||
|
||||
Version `1.7.0` of Medusa introduces a breaking change in the [CustomerService](../../../references/services/classes/CustomerService.md).
|
||||
|
||||
## Overview
|
||||
|
||||
In this new version, the method [`retrieveByEmail` in the Customer Service](../../../references/services/classes/CustomerService.md#retrievebyemail) has been deprecated in favor of other methods. Read the actions required below to learn which methods to use instead.
|
||||
|
||||
## Actions Required
|
||||
|
||||
Instead of using `customerService.retrieveByEmail`, you should now use the methods `customerService.retrieveRegisteredByEmail` or `customerService.retrieveUnRegisteredByEmail`.
|
||||
|
||||
The `customerService.retrieveRegisteredByEmail` method allows you to retrieve a registered customer by email:
|
||||
|
||||
```tsx
|
||||
customerService.retrieveRegisteredByEmail("example@gmail.com");
|
||||
```
|
||||
|
||||
On the other hand, the `retrieveUnregisteredByEmail` method allows to retrieve guest customers by email:
|
||||
|
||||
```jsx
|
||||
customerService.retrieveUnRegisteredByEmail("example@gmail.com");
|
||||
```
|
||||
|
||||
To retrieve a customer by email regardless of whether they are registered or not, you can use the `customerService.list` method instead:
|
||||
|
||||
```tsx
|
||||
customerService.list({
|
||||
email: "example@gmail.com"
|
||||
})
|
||||
```
|
||||
@@ -194,6 +194,11 @@ module.exports = {
|
||||
id: "advanced/backend/upgrade-guides/1-6-1",
|
||||
label: "v1.6.1"
|
||||
},
|
||||
{
|
||||
type: "doc",
|
||||
id: "advanced/backend/upgrade-guides/1-7-0",
|
||||
label: "v1.7.0"
|
||||
},
|
||||
]
|
||||
},
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user