Generated API v20250224 SDK for version 3.0.0

CHANGELOG.md

@@ -5,6 +5,26 @@ 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).
 
+## [3.0.0] - 2026-01-29
+
+### ⚠️ BREAKING CHANGES
+
+This is a major version bump because it targets a new API version. If you are currently using `mx-platform-node@^2`, this is a new API version (`v20250224`) 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)
 
 ### Changed
@@ -50,4 +70,4 @@ These versions (v1.10.1 through v1.12.0) contain the breaking API restructure bu
 
 ---
 
-**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).

v20250224/.npmignore

@@ -0,0 +1 @@
+# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm

v20250224/.openapi-generator-ignore

@@ -0,0 +1,2 @@
+git_push.sh
+.gitignore

v20250224/.openapi-generator/FILES

@@ -0,0 +1,10 @@
+.npmignore
+README.md
+api.ts
+base.ts
+common.ts
+configuration.ts
+index.ts
+package.json
+tsconfig.esm.json
+tsconfig.json

v20250224/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.0.1

v20250224/CHANGELOG.md

@@ -0,0 +1,73 @@
+# Changelog
+
+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).
+
+## [3.0.0] - 2026-01-29
+
+### ⚠️ BREAKING CHANGES
+
+This is a major version bump because it targets a new API version. If you are currently using `mx-platform-node@^2`, this is a new API version (`v20250224`) 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)
+
+### Changed
+- **Versioning Correction:** Re-released as v2.0.0 to properly indicate breaking changes that were inadvertently introduced in v1.10.1
+- No code changes from v1.12.1 - this is a versioning correction to follow semantic versioning
+- Versions v1.10.1 through v1.12.1 are now deprecated on npm in favor of this properly versioned v2.0.0 release
+
+### ⚠️ BREAKING CHANGES (from v1.10.0)
+
+**API Class Restructure:** The unified `MxPlatformApi` class has been replaced with granular, domain-specific API classes (e.g., `UsersApi`, `MembersApi`, `AccountsApi`) to better align with the OpenAPI specification structure. This change improves code organization and maintainability but requires migration of existing code.
+
+**Note:** This breaking change was originally introduced in v1.10.1 but should have been released as v2.0.0. If you are currently using v1.10.1 through v1.12.1, the code is functionally identical to v2.0.0.
+
+**See [MIGRATION.md](MIGRATION.md) for detailed upgrade instructions.**
+
+### Changed
+- Restructured API classes from single `MxPlatformApi` to domain-specific classes
+
+## [1.12.1] - 2025-11-25 (v20111101 API)
+
+### Fixed
+- Updated package template (`package.mustache`) to fix recurring dependency regression
+  - axios: ^0.21.4 → ^1.6.8 (fixes CVE GHSA-wf5p-g6vw-rhxx)
+  - typescript: ^3.6.4 → ^5.4.5
+  - @types/node: ^12.11.5 → ^20.12.7
+- Added automated validation workflow to prevent template/package.json drift
+
+### ⚠️ DEPRECATED
+This version contains breaking API changes that should have been released as v2.0.0. Please upgrade to v2.0.0 (code is functionally identical, just properly versioned).
+
+## [1.12.0] and earlier (1.10.1 - 1.12.0) - Various dates
+
+### ⚠️ DEPRECATED
+These versions (v1.10.1 through v1.12.0) contain the breaking API restructure but were incorrectly published as minor/patch releases instead of a major version. They have been deprecated on npm in favor of v2.0.0.
+
+**If you are on any of these versions:** Please upgrade to v2.0.0.
+
+## [1.10.0] - 2025-11-05 (v20111101 API)
+
+### 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).

v20250224/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 MX Technologies Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

v20250224/MIGRATION.md

@@ -0,0 +1,114 @@
+# 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
+
+**Important:** Starting with version 2.0.0 (originally introduced in v1.10.1, now properly versioned), the unified `MxPlatformApi` class has been replaced with domain-specific API classes. If you're upgrading from v1.10.0 or earlier, you'll need to update your imports and API instantiation.
+
+**Note:** Versions v1.10.1 through v1.12.1 are deprecated. If you're on any of these versions, please upgrade to v2.0.0 (functionally identical to v1.12.1, just properly versioned).
+
+### What Changed
+
+The library now provides granular API classes organized by domain (Users, Members, Accounts, Transactions, etc.) instead of a single `MxPlatformApi` class. This aligns with the OpenAPI specification structure and provides better code organization.
+
+### How to Migrate
+
+**Before (v1.10.0 and earlier):**
+```javascript
+import { Configuration, MxPlatformApi } from 'mx-platform-node';
+
+const client = new MxPlatformApi(configuration);
+await client.createUser(requestBody);
+await client.listMembers(userGuid);
+await client.listAccounts(userGuid);
+```
+
+**After (v2.0.0+):**
+```javascript
+import { Configuration, UsersApi, MembersApi, AccountsApi } from 'mx-platform-node';
+
+const usersApi = new UsersApi(configuration);
+const membersApi = new MembersApi(configuration);
+const accountsApi = new AccountsApi(configuration);
+
+await usersApi.createUser(requestBody);
+await membersApi.listMembers(userGuid);
+await accountsApi.listAccounts(userGuid);
+```
+
+### Available API Classes
+
+The new structure includes the following API classes:
+
+- `AccountsApi` - Account operations
+- `AuthorizationApi` - Authorization operations
+- `BudgetsApi` - Budget operations
+- `CategoriesApi` - Category operations
+- `GoalsApi` - Goal operations
+- `InsightsApi` - Insight operations
+- `InstitutionsApi` - Institution operations
+- `InvestmentHoldingsApi` - Investment holding operations
+- `ManagedDataApi` - Managed data operations
+- `MembersApi` - Member operations
+- `MerchantsApi` - Merchant operations
+- `MicrodepositsApi` - Microdeposit operations
+- `MonthlyCashFlowProfileApi` - Monthly cash flow profile operations
+- `NotificationsApi` - Notification operations
+- `ProcessorTokenApi` - Processor token operations
+- `RewardsApi` - Rewards operations
+- `SpendingPlanApi` - Spending plan operations
+- `StatementsApi` - Statement operations
+- `TaggingsApi` - Tagging operations
+- `TagsApi` - Tag operations
+- `TransactionRulesApi` - Transaction rule operations
+- `TransactionsApi` - Transaction operations
+- `UsersApi` - User operations
+- `VerifiableCredentialsApi` - Verifiable credential operations
+- `WidgetsApi` - Widget operations
+
+For the complete list of available methods, please refer to the [API documentation](https://docs.mx.com/api).
+
+### Migration Checklist
+
+1. **Update your imports**: Replace `MxPlatformApi` with the specific API classes you need
+2. **Update instantiation**: Create separate instances for each API class instead of a single client
+3. **Update method calls**: Call methods on the appropriate API class instance
+4. **Test thoroughly**: Verify all API calls work as expected with the new structure
+5. **Update documentation**: If you have internal docs referencing the old API, update them
+
+### Need Help?
+
+If you encounter any issues during migration, please [open an issue](https://github.com/mxenabled/mx-platform-node/issues) on GitHub.

v20250224/README.md

@@ -0,0 +1,115 @@
+# MX Platform Node.js (v20250224 API)
+
+**SDK version:** 3.0.0  
+**API version:** v20250224
+
+You are using the **v20250224** API version of `mx-platform-node`. For other API versions, see [Available API Versions](#available-api-versions) below.
+
+### Checking Your Installed Version
+
+To verify which API version you have installed:
+
+**In package.json:**
+```json
+{
+  "dependencies": {
+    "mx-platform-node": "^3.0.0"
+  }
+}
+```
+
+**Programmatically in your code:**
+```javascript
+const pkg = require('mx-platform-node/package.json');
+console.log(pkg.apiVersion); // v20250224
+```
+
+**Via npm:**
+```shell
+npm view [email protected]
+```
+
+## Available API Versions
+
+- **[email protected]** - [v20111101 API](https://docs.mx.com/api-reference/platform-api/v20111101/reference/mx-platform-api/)
+- **[email protected]** - [v20250224 API](https://docs.mx.com/api-reference/platform-api/reference/mx-platform-api/)
+
+---
+
+## Overview
+
+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.
+
+## Documentation
+
+Examples for the API endpoints can be found [here.](https://docs.mx.com/api)
+
+## Requirements
+
+The generated Node module can be used in the following environments:
+
+Environment
+* Node.js
+* Webpack
+* Browserify
+
+Language level
+* ES5 - you must have a Promises/A+ library installed
+* ES6
+
+Module system
+* CommonJS
+* ES6 module system
+
+## Installation
+
+To build and compile the TypeScript sources to JavaScript use:
+
+```shell
+npm install mx-platform-node
+```
+
+## Getting Started
+
+In order to make requests, you will need to [sign up](https://dashboard.mx.com/sign_up) for the MX Platform API and get a `Client ID` and `API Key`.
+
+Please follow the [installation](#installation) procedure and then run the following code to create your first User:
+
+```javascript
+import { Configuration, UsersApi } from 'mx-platform-node';
+
+const configuration = new Configuration({
+  // Configure with your Client ID/API Key from https://dashboard.mx.com
+  username: 'Your Client ID',
+  password: 'Your API Key',
+
+  // Configure environment. https://int-api.mx.com for development, https://api.mx.com for production
+  basePath: 'https://int-api.mx.com',
+
+  baseOptions: {
+    headers: {
+      Accept: 'application/vnd.mx.api.v1+json'
+    }
+  }
+});
+
+const usersApi = new UsersApi(configuration);
+
+const requestBody = {
+  user: {
+    metadata: 'Creating a user!'
+  }
+};
+
+const response = await usersApi.createUser(requestBody);
+
+console.log(response.data);
+```
+
+## Upgrading from v1.x?
+
+> **⚠️ 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.
+
+## Contributing
+
+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)