Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,6 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [2.0.0] - 2026-01-29 (v20111101 API)

### Changed
- 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-01-29.

## [3.0.0] - 2026-01-29

### ⚠️ BREAKING CHANGES (from v2.x.x)
Expand Down
33 changes: 4 additions & 29 deletions v20111101/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,32 +5,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [2.0.0] - 2026-01-29 (v20111101 API)

### Changed
- 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-01-29.

## [3.0.0] - 2026-01-29

### ⚠️ BREAKING CHANGES (from v2.x.x)

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.**

### Added
- Initial support for MX Platform API `v20250224`
- Published as separate major version to support independent API versions

### Changed
- 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`

### Migration
For upgrading from `mx-platform-node@^2` (v20111101 API) to v3.x (v20250224 API):
```bash
npm install mx-platform-node@^3
```
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.

## [2.0.0] - 2026-01-07 (v20111101 API)
## [2.0.0] - 1/7/2026

### Changed
- **Versioning Correction:** Re-released as v2.0.0 to properly indicate breaking changes that were inadvertently introduced in v1.10.1
Expand All @@ -48,7 +23,7 @@ Consult the [MX Platform API Migration Guide](https://docs.mx.com/api-reference/
### Changed
- Restructured API classes from single `MxPlatformApi` to domain-specific classes

## [1.12.1] - 2025-11-25 (v20111101 API)
## [1.12.1] - 11/25/2025

### Fixed
- Updated package template (`package.mustache`) to fix recurring dependency regression
Expand All @@ -67,12 +42,12 @@ These versions (v1.10.1 through v1.12.0) contain the breaking API restructure bu

**If you are on any of these versions:** Please upgrade to v2.0.0.

## [1.10.0] - 2025-11-05 (v20111101 API)
## [1.10.0] - 11/5/2025

### Note
- Last stable version with unified `MxPlatformApi` class
- Upgrade from this version to v2.0.0 requires code changes (see [MIGRATION.md](MIGRATION.md))

---

**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).
**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).
32 changes: 0 additions & 32 deletions v20111101/MIGRATION.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,5 @@
# Migration Guide

## Upgrading from v20111101 (v2.x) to v20250224 (v3.x)

The v20250224 API is now available, and v3.0.0 of this SDK provides support as an independent major version.

### Installation

The two API versions are published as separate major versions of the same npm package:

**For v20111101 API:**
```bash
npm install mx-platform-node@^2
```

**For v20250224 API:**
```bash
npm install mx-platform-node@^3
```

### Migration Path

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
2. **Update Package**: Update your `package.json` to use `mx-platform-node@^3`
3. **Update Imports**: Both APIs have similar structure, but review type definitions for any breaking changes
4. **Run Tests**: Validate your code works with the new SDK version
5. **Deploy**: Update production once validated

### Benefits of TypeScript

Since this is a TypeScript SDK, the compiler will help catch most compatibility issues at compile time when you update to v3.x.

---

## Upgrading to v2.0.0 from v1.10.0 or earlier

### Breaking Change: API Class Restructure
Expand Down
115 changes: 0 additions & 115 deletions v20111101/generated-v20111101/README.md

This file was deleted.

Loading