You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
5
5
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
8
+
## [2.1.0] - 2026-02-18 (v20111101 API)
9
+
10
+
### Changed
11
+
- Updated v20111101 API specification to most current version. Please check full [API changelog](https://docs.mx.com/resources/changelog/platform) for any changes made between 2026-01-07 and 2026-02-18.
Copy file name to clipboardExpand all lines: v20111101/CHANGELOG.md
+29-4Lines changed: 29 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,32 @@ All notable changes to this project will be documented in this file.
5
5
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
8
-
## [2.0.0] - 1/7/2026
8
+
## [2.1.0] - 2026-02-18 (v20111101 API)
9
+
10
+
### Changed
11
+
- Updated v20111101 API specification to most current version. Please check full [API changelog](https://docs.mx.com/resources/changelog/platform) for any changes made between 2026-01-07 and 2026-02-18.
12
+
13
+
## [3.0.0] - 2026-01-29
14
+
15
+
### ⚠️ BREAKING CHANGES (from v2.x.x)
16
+
17
+
This is a major version bump because it targets a new API version `v20250224`. If you are currently using `mx-platform-node@^2`, this is a new API version with potentially significant changes. **See the [MX Platform API Migration Guide](https://docs.mx.com/api-reference/platform-api/overview/migration) for detailed API breaking changes and migration instructions.**
18
+
19
+
### Added
20
+
- Initial support for MX Platform API `v20250224`
21
+
- Published as separate major version to support independent API versions
22
+
23
+
### Changed
24
+
- This is a completely new API version (`v20250224`). Refer to the [MX Platform API changelog](https://docs.mx.com/resources/changelog/platform) for detailed API specification changes from `v20111101`
25
+
26
+
### Migration
27
+
For upgrading from `mx-platform-node@^2` (v20111101 API) to v3.x (v20250224 API):
28
+
```bash
29
+
npm install mx-platform-node@^3
30
+
```
31
+
Consult the [MX Platform API Migration Guide](https://docs.mx.com/api-reference/platform-api/overview/migration) for API-level changes, deprecations and migration steps.
32
+
33
+
## [2.0.0] - 2026-01-07 (v20111101 API)
9
34
10
35
### Changed
11
36
-**Versioning Correction:** Re-released as v2.0.0 to properly indicate breaking changes that were inadvertently introduced in v1.10.1
@@ -23,7 +48,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
23
48
### Changed
24
49
- Restructured API classes from single `MxPlatformApi` to domain-specific classes
25
50
26
-
## [1.12.1] - 11/25/2025
51
+
## [1.12.1] - 2025-11-25 (v20111101 API)
27
52
28
53
### Fixed
29
54
- Updated package template (`package.mustache`) to fix recurring dependency regression
@@ -42,12 +67,12 @@ These versions (v1.10.1 through v1.12.0) contain the breaking API restructure bu
42
67
43
68
**If you are on any of these versions:** Please upgrade to v2.0.0.
44
69
45
-
## [1.10.0] - 11/5/2025
70
+
## [1.10.0] - 2025-11-05 (v20111101 API)
46
71
47
72
### Note
48
73
- Last stable version with unified `MxPlatformApi` class
49
74
- Upgrade from this version to v2.0.0 requires code changes (see [MIGRATION.md](MIGRATION.md))
50
75
51
76
---
52
77
53
-
**Note:** This CHANGELOG was created retroactively. For detailed version history prior to v2.0.0, please refer to the [commit history](https://github.com/mxenabled/mx-platform-node/commits/master).
78
+
**Note:** This CHANGELOG was created retroactively. For detailed version history prior to v2.0.0, please refer to the [commit history](https://github.com/mxenabled/mx-platform-node/commits/master).
Copy file name to clipboardExpand all lines: v20111101/MIGRATION.md
+32Lines changed: 32 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,37 @@
1
1
# Migration Guide
2
2
3
+
## Upgrading from v20111101 (v2.x) to v20250224 (v3.x)
4
+
5
+
The v20250224 API is now available, and v3.0.0 of this SDK provides support as an independent major version.
6
+
7
+
### Installation
8
+
9
+
The two API versions are published as separate major versions of the same npm package:
10
+
11
+
**For v20111101 API:**
12
+
```bash
13
+
npm install mx-platform-node@^2
14
+
```
15
+
16
+
**For v20250224 API:**
17
+
```bash
18
+
npm install mx-platform-node@^3
19
+
```
20
+
21
+
### Migration Path
22
+
23
+
1.**Review API Changes**: Consult the [MX Platform API Migration Guide](https://docs.mx.com/api-reference/platform-api/overview/migration) for breaking changes and new features
24
+
2.**Update Package**: Update your `package.json` to use `mx-platform-node@^3`
25
+
3.**Update Imports**: Both APIs have similar structure, but review type definitions for any breaking changes
26
+
4.**Run Tests**: Validate your code works with the new SDK version
27
+
5.**Deploy**: Update production once validated
28
+
29
+
### Benefits of TypeScript
30
+
31
+
Since this is a TypeScript SDK, the compiler will help catch most compatibility issues at compile time when you update to v3.x.
Copy file name to clipboardExpand all lines: v20111101/README.md
+38-15Lines changed: 38 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,42 @@
1
-
*This project is currently in **Beta**. Please open up an issue [here](https://github.com/mxenabled/mx-platform-node/issues) to report issues using the MX Platform Node.js library.*
1
+
# MX Platform Node.js (v20111101 API)
2
2
3
-
# MX Platform Node.js
3
+
**SDK version:** 2.1.0
4
+
**API version:** v20111101
5
+
6
+
You are using the **v20111101** API version of `mx-platform-node`. For other API versions, see [Available API Versions](#available-api-versions) below.
The [MX Platform API](https://www.mx.com/products/platform-api) is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.
6
42
@@ -74,19 +110,6 @@ console.log(response.data);
74
110
75
111
> **⚠️ Breaking Changes in v2.0.0:** If you're upgrading from v1.10.0 or earlier, the API structure has changed significantly. See the [Migration Guide](MIGRATION.md) for detailed instructions on updating your code.
76
112
77
-
## Development
78
-
79
-
This project was generated by the [OpenAPI Generator](https://openapi-generator.tech). To generate this library, verify you have the latest version of the `openapi-generator-cli` found [here.](https://github.com/OpenAPITools/openapi-generator#17---npm)
80
-
81
-
Running the following command in this repo's directory will generate this library using the [MX Platform API OpenAPI spec](https://github.com/mxenabled/openapi/blob/master/openapi/mx_platform_api.yml) with our [configuration and templates.](https://github.com/mxenabled/mx-platform-ruby/tree/master/openapi)
Please [open an issue](https://github.com/mxenabled/mx-platform-node/issues) or [submit a pull request.](https://github.com/mxenabled/mx-platform-node/pulls)
0 commit comments