Skip to content

Commit 8d9cbce

Browse files
devexperienceGenevieve Nuebel
devexperience
authored and
Genevieve Nuebel
committed
TEST: Generated SDK versions: v20111101
This commit was automatically created by the test-auto-generate workflow. Payload: {version:minor,commit_sha:c82b864da52b5d6215bbae79ce4772ba99e8abe8}
1 parent b6fd03d commit 8d9cbce

14 files changed

Lines changed: 25264 additions & 3 deletions

‎TEST-CHANGELOG.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [2.0.0] - 2026-02-17 (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.
12+
813
## [99.0.0] - 2026-02-16
914

1015
### Added
@@ -13,4 +18,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1318
## [98.0.0] - 2026-02-16
1419

1520
### Added
16-
- Test placeholder for v20111101 sandbox testing
21+
- Test placeholder for v20111101 sandbox testing

‎test-v20111101/.gitkeep‎

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎test-v20111101/CHANGELOG.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Test Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [2.0.0] - 2026-02-17 (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.
12+
13+
## [99.0.0] - 2026-02-16
14+
15+
### Added
16+
- Test placeholder for v20250224 sandbox testing
17+
18+
## [98.0.0] - 2026-02-16
19+
20+
### Added
21+
- Test placeholder for v20111101 sandbox testing

‎test-v20111101/LICENSE‎

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

‎test-v20111101/MIGRATION.md‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# Migration Guide
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.
32+
33+
---
34+
35+
## Upgrading to v2.0.0 from v1.10.0 or earlier
36+
37+
### Breaking Change: API Class Restructure
38+
39+
**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.
40+
41+
**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).
42+
43+
### What Changed
44+
45+
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.
46+
47+
### How to Migrate
48+
49+
**Before (v1.10.0 and earlier):**
50+
```javascript
51+
import { Configuration, MxPlatformApi } from 'mx-platform-node';
52+
53+
const client = new MxPlatformApi(configuration);
54+
await client.createUser(requestBody);
55+
await client.listMembers(userGuid);
56+
await client.listAccounts(userGuid);
57+
```
58+
59+
**After (v2.0.0+):**
60+
```javascript
61+
import { Configuration, UsersApi, MembersApi, AccountsApi } from 'mx-platform-node';
62+
63+
const usersApi = new UsersApi(configuration);
64+
const membersApi = new MembersApi(configuration);
65+
const accountsApi = new AccountsApi(configuration);
66+
67+
await usersApi.createUser(requestBody);
68+
await membersApi.listMembers(userGuid);
69+
await accountsApi.listAccounts(userGuid);
70+
```
71+
72+
### Available API Classes
73+
74+
The new structure includes the following API classes:
75+
76+
- `AccountsApi` - Account operations
77+
- `AuthorizationApi` - Authorization operations
78+
- `BudgetsApi` - Budget operations
79+
- `CategoriesApi` - Category operations
80+
- `GoalsApi` - Goal operations
81+
- `InsightsApi` - Insight operations
82+
- `InstitutionsApi` - Institution operations
83+
- `InvestmentHoldingsApi` - Investment holding operations
84+
- `ManagedDataApi` - Managed data operations
85+
- `MembersApi` - Member operations
86+
- `MerchantsApi` - Merchant operations
87+
- `MicrodepositsApi` - Microdeposit operations
88+
- `MonthlyCashFlowProfileApi` - Monthly cash flow profile operations
89+
- `NotificationsApi` - Notification operations
90+
- `ProcessorTokenApi` - Processor token operations
91+
- `RewardsApi` - Rewards operations
92+
- `SpendingPlanApi` - Spending plan operations
93+
- `StatementsApi` - Statement operations
94+
- `TaggingsApi` - Tagging operations
95+
- `TagsApi` - Tag operations
96+
- `TransactionRulesApi` - Transaction rule operations
97+
- `TransactionsApi` - Transaction operations
98+
- `UsersApi` - User operations
99+
- `VerifiableCredentialsApi` - Verifiable credential operations
100+
- `WidgetsApi` - Widget operations
101+
102+
For the complete list of available methods, please refer to the [API documentation](https://docs.mx.com/api).
103+
104+
### Migration Checklist
105+
106+
1. **Update your imports**: Replace `MxPlatformApi` with the specific API classes you need
107+
2. **Update instantiation**: Create separate instances for each API class instead of a single client
108+
3. **Update method calls**: Call methods on the appropriate API class instance
109+
4. **Test thoroughly**: Verify all API calls work as expected with the new structure
110+
5. **Update documentation**: If you have internal docs referencing the old API, update them
111+
112+
### Need Help?
113+
114+
If you encounter any issues during migration, please [open an issue](https://github.com/mxenabled/mx-platform-node/issues) on GitHub.

‎test-v20111101/README.md‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# MX Platform Node.js (v20111101 API)
2+
3+
**SDK version:** 98.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.
7+
8+
### Checking Your Installed Version
9+
10+
To verify which API version you have installed:
11+
12+
**In package.json:**
13+
```json
14+
{
15+
"dependencies": {
16+
"mx-platform-node": "^98.1.0"
17+
}
18+
}
19+
```
20+
21+
**Programmatically in your code:**
22+
```javascript
23+
const pkg = require('mx-platform-node/package.json');
24+
console.log(pkg.apiVersion); // v20111101
25+
```
26+
27+
**Via npm:**
28+
```shell
29+
npm view mx-platform-node@98.1.0
30+
```
31+
32+
## Available API Versions
33+
34+
- **mx-platform-node@2.x.x** - [v20111101 API](https://docs.mx.com/api-reference/platform-api/v20111101/reference/mx-platform-api/)
35+
- **mx-platform-node@3.x.x** - [v20250224 API](https://docs.mx.com/api-reference/platform-api/reference/mx-platform-api/)
36+
37+
---
38+
39+
## Overview
40+
41+
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.
42+
43+
## Documentation
44+
45+
Examples for the API endpoints can be found [here.](https://docs.mx.com/api)
46+
47+
## Requirements
48+
49+
The generated Node module can be used in the following environments:
50+
51+
Environment
52+
* Node.js
53+
* Webpack
54+
* Browserify
55+
56+
Language level
57+
* ES5 - you must have a Promises/A+ library installed
58+
* ES6
59+
60+
Module system
61+
* CommonJS
62+
* ES6 module system
63+
64+
## Installation
65+
66+
To build and compile the TypeScript sources to JavaScript use:
67+
68+
```shell
69+
npm install mx-platform-node
70+
```
71+
72+
## Getting Started
73+
74+
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`.
75+
76+
Please follow the [installation](#installation) procedure and then run the following code to create your first User:
77+
78+
```javascript
79+
import { Configuration, UsersApi } from 'mx-platform-node';
80+
81+
const configuration = new Configuration({
82+
// Configure with your Client ID/API Key from https://dashboard.mx.com
83+
username: 'Your Client ID',
84+
password: 'Your API Key',
85+
86+
// Configure environment. https://int-api.mx.com for development, https://api.mx.com for production
87+
basePath: 'https://int-api.mx.com',
88+
89+
baseOptions: {
90+
headers: {
91+
Accept: 'application/vnd.mx.api.v1+json'
92+
}
93+
}
94+
});
95+
96+
const usersApi = new UsersApi(configuration);
97+
98+
const requestBody = {
99+
user: {
100+
metadata: 'Creating a user!'
101+
}
102+
};
103+
104+
const response = await usersApi.createUser(requestBody);
105+
106+
console.log(response.data);
107+
```
108+
109+
## Upgrading from v1.x?
110+
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.
112+
113+
## Contributing
114+
115+
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

Comments
 (0)