Skip to content

Commit d42dc78

Browse files
Update MIGRATION_GUIDE.md
Includes breaking changes from 5x => 6x and 6x => 7x
1 parent b7ec536 commit d42dc78

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

MIGRATION_GUIDE.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,32 @@
22

33
The objective of this guide is to document the breaking changes and updates required to migrate from one major version to the next.
44

5+
## version 6.x.x to version 7.x.x
6+
* The method names for the `EntitySynchronization` service have been streamlined for improved clarity. The previous naming convention included the suffix `EntitySyncConfig`, which has now been removed
7+
8+
Before:
9+
```typescript
10+
EntitySynchronization.GetInventoryRecordEntitySyncConfig(...)
11+
```
12+
13+
After:
14+
```typescript
15+
EntitySynchronization.GetInventoryRecords(...)
16+
```
17+
18+
## version 5.x.x to version 6.x.x
19+
* `ForgottenPassword` service renamed to `ForgottenCredentials`
20+
21+
Before:
22+
```typescript
23+
ForgottenPassword.SendVerificationCode(...)
24+
```
25+
26+
After:
27+
```typescript
28+
ForgottenCredentials.SendVerificationCode(...)
29+
```
30+
531
## version 4.x.x to version 5.x.x
632
* [Axios](https://www.npmjs.com/package/axios) less than version 1.0.0 is no longer supported
733
* The type for the `errors` property on the class `OrderCloudError` has changed

0 commit comments

Comments
 (0)