apimatic-plaid-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d8f562c30efd9b5a8e7c7fabb0e70a9c40bd77db596824076bfa72709b5c5979
+  data.tar.gz: b1658e147748c971aed67e6cd15658a1e1cad0db92a45e74dcca8bae6330e040
+SHA512:
+  metadata.gz: 5aaaca1a50151417bf4a0cd2800d7509ae1e2d896393e4c909040d5a4edc1832aa0b8dfb0513b60d088da26418ffbc2b0126d2e79bf918503a25f7f83bab5693
+  data.tar.gz: e82e919506d8147cd58fcce9bd7406e0cea4a751c3e0c4b30eef4f49a885c9e0fb7295553949ca30e662c7ce123cbc1ead17846ae88fc626d478a3337cc55ec2

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,192 @@
+
+# Getting Started with The Plaid API
+
+## Introduction
+
+The Plaid REST API. Please see https://plaid.com/docs/api for more details.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install apimatic-plaid-sdk -v 0.0.1
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'apimatic-plaid-sdk', '0.0.1'
+```
+
+For additional gem details, see the [RubyGems page for the apimatic-plaid-sdk gem](https://rubygems.org/gems/apimatic-plaid-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 'plaid'
+include Plaid
+```
+
+### 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/plaid
+```
+
+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-plaid-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-plaid-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: 60** |
+| 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-plaid-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-plaid-ruby-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| plaid_client_id_credentials | [`PlaidClientIdCredentials`](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
+| plaid_secret_credentials | [`PlaidSecretCredentials`](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/auth/custom-header-signature-1.md) | The credential object for Custom Header Signature |
+| plaid_version_credentials | [`PlaidVersionCredentials`](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/auth/custom-header-signature-2.md) | The credential object for Custom Header Signature |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'plaid'
+include Plaid
+
+client = Client.new(
+  plaid_client_id_credentials: PlaidClientIdCredentials.new(
+    plaid_client_id: 'PLAID-CLIENT-ID'
+  ),
+  plaid_secret_credentials: PlaidSecretCredentials.new(
+    plaid_secret: 'PLAID-SECRET'
+  ),
+  plaid_version_credentials: PlaidVersionCredentials.new(
+    plaid_version: 'Plaid-Version'
+  ),
+  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 'plaid'
+include Plaid
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/apimatic-plaid-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** Production |
+| ENVIRONMENT2 | Development |
+| ENVIRONMENT3 | Sandbox |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`PLAID-CLIENT-ID (Custom Header Signature)`](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/auth/custom-header-signature.md)
+* [`PLAID-SECRET (Custom Header Signature)`](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/auth/custom-header-signature-1.md)
+* [`Plaid-Version (Custom Header Signature)`](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/auth/custom-header-signature-2.md)
+
+## List of APIs
+
+* [Item](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/item.md)
+* [Asset Report](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/asset-report.md)
+* [Processor](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/processor.md)
+* [Payment Initiation](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/payment-initiation.md)
+* [Sandbox](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/sandbox.md)
+* [Investments](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/investments.md)
+* [Institutions](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/institutions.md)
+* [Application](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/application.md)
+* [Accounts](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/accounts.md)
+* [Identity](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/identity.md)
+* [Liabilities](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/liabilities.md)
+* [Auth](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/auth.md)
+* [Transactions](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/transactions.md)
+* [Categories](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/categories.md)
+* [Webhook Verification Key](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/webhook-verification-key.md)
+* [Deposit Switch](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/deposit-switch.md)
+* [Link](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/link.md)
+* [Transfer](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/transfer.md)
+* [Bank Transfer](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/bank-transfer.md)
+* [Employers](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/employers.md)
+* [Income](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/income.md)
+* [Signal](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/controllers/signal.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/apimatic-plaid-ruby-sdk/tree/0.0.1/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/apimatic-plaid-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 'plaid'
+
+puts 'Plaid SDK loaded!'
+puts 'You can now create a client with: client = Plaid::Client.new'
+puts 'Or use from_env: client = Plaid::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/plaid/api_helper.rb

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

data/lib/plaid/apis/accounts_api.rb

@@ -0,0 +1,70 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AccountsApi
+  class AccountsApi < BaseApi
+    # The `/accounts/get`  endpoint can be used to retrieve information for any
+    # linked Item. Note that some information is nullable. Plaid will only
+    # return active bank accounts, i.e. accounts that are not closed and are
+    # capable of carrying a balance.
+    # This endpoint retrieves cached information, rather than extracting fresh
+    # information from the institution. As a result, balances returned may not
+    # be up-to-date; for realtime balance information, use
+    # `/accounts/balance/get` instead.
+    # @param [AccountsGetRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def accounts_get(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/accounts/get',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountsGetResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response.',
+                                 ErrorErrorException))
+        .execute
+    end
+
+    # The `/accounts/balance/get` endpoint returns the real-time balance for
+    # each of an Item's accounts. While other endpoints may return a balance
+    # object, only `/accounts/balance/get` forces the available and current
+    # balance fields to be refreshed rather than cached. This endpoint can be
+    # used for existing Items that were added via any of Plaid’s other products.
+    # This endpoint can be used as long as Link has been initialized with any
+    # other product, `balance` itself is not a product that can be used to
+    # initialize Link.
+    # @param [AccountsBalanceGetRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def accounts_balance_get(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/accounts/balance/get',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountsGetResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/plaid/apis/application_api.rb

@@ -0,0 +1,35 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # ApplicationApi
+  class ApplicationApi < BaseApi
+    # Allows financial institutions to retrieve information about Plaid clients
+    # for the purpose of building control-tower experiences
+    # @param [ApplicationGetRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def application_get(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/application/get',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ApplicationGetResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response.',
+                                 ErrorErrorException))
+        .execute
+    end
+  end
+end