Skip to content

Commit 9d3de85

Browse files
author
Genevieve Nuebel
committed
Regenerated v2.0.0-rc.1 in latest directory
1 parent f50a755 commit 9d3de85

21 files changed

Lines changed: 350 additions & 6 deletions

.github/clean.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"CHANGELOG.md",
1010
"LICENSE",
1111
"MIGRATION.md",
12-
"latest",
12+
"README.md",
1313
"node_modules",
1414
"openapi",
1515
"openapitools.json",

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ This version contains breaking API changes that should have been released as v2.
4040
### ⚠️ DEPRECATED
4141
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.
4242

43-
**If you are on any of these versions:** Please upgrade to v2.0.0 (code is identical to v1.12.1, just properly versioned).
43+
**If you are on any of these versions:** Please upgrade to v2.0.0.
4444

4545
## [1.10.0] - 11/5/2025
4646

@@ -50,4 +50,4 @@ These versions (v1.10.1 through v1.12.0) contain the breaking API restructure bu
5050

5151
---
5252

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) and [releases page](https://github.com/mxenabled/mx-platform-node/releases).
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).

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ In order to make requests, you will need to [sign up](https://dashboard.mx.com/s
4040
Please follow the [installation](#installation) procedure and then run the following code to create your first User:
4141

4242
```javascript
43-
import { Configuration, MxPlatformApi } from 'mx-platform-node';
43+
import { Configuration, UsersApi } from 'mx-platform-node';
4444

4545
const configuration = new Configuration({
4646
// Configure with your Client ID/API Key from https://dashboard.mx.com
@@ -57,19 +57,23 @@ const configuration = new Configuration({
5757
}
5858
});
5959

60-
const client = new MxPlatformApi(configuration);
60+
const usersApi = new UsersApi(configuration);
6161

6262
const requestBody = {
6363
user: {
6464
metadata: 'Creating a user!'
6565
}
6666
};
6767

68-
const response = await client.createUser(requestBody);
68+
const response = await usersApi.createUser(requestBody);
6969

7070
console.log(response.data);
7171
```
7272

73+
## Upgrading from v1.x?
74+
75+
> **⚠️ 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+
7377
## Development
7478

7579
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)

latest/.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
wwwroot/*.js
2+
node_modules
3+
typings
4+
dist
File renamed without changes.

latest/.openapi-generator-ignore

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# OpenAPI Generator Ignore
2+
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
3+
4+
# Use this file to prevent files from being overwritten by the generator.
5+
# The patterns follow closely to .gitignore or .dockerignore.
6+
7+
# As an example, the C# client generator defines ApiClient.cs.
8+
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
9+
#ApiClient.cs
10+
11+
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
12+
#foo/*/qux
13+
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14+
15+
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16+
#foo/**/qux
17+
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18+
19+
# You can also negate patterns with an exclamation (!).
20+
# For example, you can ignore all files in a docs folder with the file extension .md:
21+
#docs/*.md
22+
# Then explicitly reverse the ignore rule for a single file:
23+
#!docs/README.md
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
.gitignore
22
.npmignore
3+
.openapi-generator-ignore
34
README.md
45
api.ts
56
base.ts
67
common.ts
78
configuration.ts
9+
git_push.sh
810
index.ts
911
package.json
1012
tsconfig.esm.json

latest/CHANGELOG.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# 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] - 1/7/2026
9+
10+
### Changed
11+
- **Versioning Correction:** Re-released as v2.0.0 to properly indicate breaking changes that were inadvertently introduced in v1.10.1
12+
- No code changes from v1.12.1 - this is a versioning correction to follow semantic versioning
13+
- Versions v1.10.1 through v1.12.1 are now deprecated on npm in favor of this properly versioned v2.0.0 release
14+
15+
### ⚠️ BREAKING CHANGES (from v1.10.0)
16+
17+
**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.
18+
19+
**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.
20+
21+
**See [MIGRATION.md](MIGRATION.md) for detailed upgrade instructions.**
22+
23+
### Changed
24+
- Restructured API classes from single `MxPlatformApi` to domain-specific classes
25+
26+
## [1.12.1] - 11/25/2025
27+
28+
### Fixed
29+
- Updated package template (`package.mustache`) to fix recurring dependency regression
30+
- axios: ^0.21.4 → ^1.6.8 (fixes CVE GHSA-wf5p-g6vw-rhxx)
31+
- typescript: ^3.6.4 → ^5.4.5
32+
- @types/node: ^12.11.5 → ^20.12.7
33+
- Added automated validation workflow to prevent template/package.json drift
34+
35+
### ⚠️ DEPRECATED
36+
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).
37+
38+
## [1.12.0] and earlier (1.10.1 - 1.12.0) - Various dates
39+
40+
### ⚠️ DEPRECATED
41+
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.
42+
43+
**If you are on any of these versions:** Please upgrade to v2.0.0.
44+
45+
## [1.10.0] - 11/5/2025
46+
47+
### Note
48+
- Last stable version with unified `MxPlatformApi` class
49+
- Upgrade from this version to v2.0.0 requires code changes (see [MIGRATION.md](MIGRATION.md))
50+
51+
---
52+
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).

latest/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.

0 commit comments

Comments
 (0)