apimatic-mx-apis-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db5d2ff996987458ef1919b2d415e0f0fca8a0516f8d8fe9fab984b7fd158747
+  data.tar.gz: 9383fb6dfcfeaa68cf5dc3ab81f53720a81238d62855db8419cec23bd64f8ab0
+SHA512:
+  metadata.gz: abf7be39ee4401926c6324214b8e2ae1fbb3dad0ae2341b6f7bd2d44d838ac4776cf7c99cba535475f46ca6cc2a40b548e5573b5edf9fdc7ecd40ea8b9e4edc6
+  data.tar.gz: e9092d15c7d6d3b4b38974ba3291998b8f2612f399ae75f668123219fe3e74901b2f8955aca6888eb4e85022247ce670b4a8007a2129c3d653ee4831c1fe190b

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2026 APIMATIC Limited
+
+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.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,207 @@
+
+# Getting Started with MX Platform API
+
+## Introduction
+
+The MX 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.
+
+### What's Changed?
+
+Several endpoints, headers, and fields changed in `v20250224`. For more on breaking changes, refer to our [versioning](/api-reference/platform-api/overview/versioning#v20250224) and [migration](/api-reference/platform-api/overview/migration) guides.
+
+### Version Header
+
+Versions are set in the `Accept-Version` header of API requests. Version numbers correspond with the date associated with that version.  The example below uses the version `v20250224`.
+
+```
+-H 'Accept: application/json'
+-H 'Accept-Version: v20250224'
+```
+
+---
+
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install apimatic-mx-apis-sdk -v 0.0.1
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'apimatic-mx-apis-sdk', '0.0.1'
+```
+
+For additional gem details, see the [RubyGems page for the apimatic-mx-apis-sdk gem](https://rubygems.org/gems/apimatic-mx-apis-sdk/versions/0.0.1).
+
+## IRB Console Usage
+
+You can explore the SDK interactively using IRB in two ways
+
+### 1. Use IRB with Installed Gem
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
+
+```bash
+irb
+```
+
+Now you can load the SDK in the IRB
+
+```ruby
+require 'mx_platform_api'
+include MxPlatformApi
+```
+
+### 2. Use IRB within SDK
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
+
+```
+cd path/to/mx_platform_api
+```
+
+Now you can start the preconfigured irb console by running the following command
+
+```bash
+ruby bin/console
+```
+
+**_Note:_** This automatically loads the SDK from lib/
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| environment | [`Environment`](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION`** |
+| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| timeout | `Float` | The value to use for connection timeout. <br> **Default: 30** |
+| max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
+| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| basic_auth_credentials | [`BasicAuthCredentials`](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
+| bearer_auth_credentials | [`BearerAuthCredentials`](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'mx_platform_api'
+include MxPlatformApi
+
+client = Client.new(
+  basic_auth_credentials: BasicAuthCredentials.new(
+    username: 'Username',
+    password: 'Password'
+  ),
+  bearer_auth_credentials: BearerAuthCredentials.new(
+    access_token: 'AccessToken'
+  ),
+  environment: Environment::PRODUCTION,
+  logging_configuration: LoggingConfiguration.new(
+    log_level: Logger::INFO,
+    request_logging_config: RequestLoggingConfiguration.new(
+      log_body: true
+    ),
+    response_logging_config: ResponseLoggingConfiguration.new(
+      log_headers: true
+    )
+  )
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'mx_platform_api'
+include MxPlatformApi
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md) section for details.
+
+## Environments
+
+The SDK can be configured to use a different environment for making API calls. Available environments are:
+
+### Fields
+
+| Name | Description |
+|  --- | --- |
+| PRODUCTION | **Default** |
+| ENVIRONMENT2 | - |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`basicAuth (Basic Authentication)`](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/auth/basic-authentication.md)
+* [`bearerAuth (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md)
+
+## List of APIs
+
+* [Achreturn](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/achreturn.md)
+* [Investmentholdings](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/investmentholdings.md)
+* [Monthlycashflowprofile](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/monthlycashflowprofile.md)
+* [Processortoken](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/processortoken.md)
+* [Spendingplan](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/spendingplan.md)
+* [Transactionrules](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/transactionrules.md)
+* [Verifiablecredentials](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/verifiablecredentials.md)
+* [Manageddata Deprecated](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/manageddata-deprecated.md)
+* [Accounts](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/accounts.md)
+* [Budgets](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/budgets.md)
+* [Categories](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/categories.md)
+* [Goals](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/goals.md)
+* [Insights](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/insights.md)
+* [Institutions](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/institutions.md)
+* [Members](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/members.md)
+* [Merchants](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/merchants.md)
+* [Microdeposits](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/microdeposits.md)
+* [Notifications](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/notifications.md)
+* [Rewards](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/rewards.md)
+* [Statements](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/statements.md)
+* [Taggings](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/taggings.md)
+* [Tags](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/tags.md)
+* [Transactions](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/transactions.md)
+* [Users](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/users.md)
+* [Widgets](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/widgets.md)
+* [Jobs](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/controllers/jobs.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/apimatic-mx-apis-ruby-sdk/tree/0.0.1/doc/date-time-helper.md)
+

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# Load the lib folder into Ruby's load path
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+# Require the gem
+require 'mx_platform_api'
+
+puts 'MxPlatformApi SDK loaded!'
+puts 'You can now create a client with: client = MxPlatformApi::Client.new'
+puts 'Or use from_env: client = MxPlatformApi::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/mx_platform_api/api_helper.rb

@@ -0,0 +1,10 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # API utility class
+  class APIHelper < CoreLibrary::ApiHelper
+  end
+end