Skip to content

Latest commit

 

History

History
114 lines (83 loc) · 4.42 KB

MIGRATION.md

File metadata and controls

114 lines (83 loc) · 4.42 KB

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:

npm install mx-platform-node@^2

For v20250224 API:

npm install mx-platform-node@^3

Migration Path

  1. Review API Changes: Consult the MX Platform API Migration Guide 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):

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+):

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.

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 on GitHub.