Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
92 changes: 92 additions & 0 deletions .openapi-generator/FILES

Large diffs are not rendered by default.

45 changes: 45 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,50 @@
See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).

# 44.1.0
- Updating to OAS 2020-09-14_1.670.0

## OpenAPI Schema Changes
### 2020-09-14_1.670.0
- Add support for investments to `/cra/check_report/verification/get`

### 2020-09-14_1.669.0
- Add `AccountInsights` to `/asset_report/get`

### 2020-09-14_1.668.3
- Update `identity_creation_result` to be `null` for V0 `/user/create` routes

### 2020-09-14_1.668.2
- (beta) use user_id in `/user/third_party_token/create`

### 2020-09-14_1.668.1
- Add `options` for `network_insights` in `link/token/create`, `cra/check_report/create`, and `cra/check_report/network_insights/get`

### 2020-09-14_1.668.0

- Add support for Cashflow Insights and LendScore, including adding `cra_cashflow_insights` and `cra_lend_score` to Products array and creating new `PlaidLendScoreVersion` schema object.
- Documentation-only changes to support a single, shared Signal Rules-based integration path for Balance and Signal Transaction Scores using `/signal/evaluate`.
- Documentation-only changes to support Transfer for Platforms.

### 2020-09-14_1.667.6
- (beta) new `/protect/report/create` endpoint

### 2020-09-14_1.667.5
- Publish `/transfer/platform/originator/create` to docs
- Publish `/transfer/platform/person/create` to docs
- Publish `/transfer/platform/requirement/submit` to docs

### 2020-09-14_1.667.4
- Fixed a broken documentation link

### 2020-09-14_1.667.3
- Add cra_partner_insights as possible add_ons for `cra/check_report/pdf/get`

### 2020-09-14_1.667.2
- (beta) updated street_1, city, region, and postal_code to no longer be required

### 2020-09-14_1.667.1
- (beta) Allow ClientUserIdentityName to be nullable

# 44.0.0
- Updating to OAS 2020-09-14_1.667.0

Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Note: This image is also built in CircleCI, so limit references to internal repositories.
# Keep this in sync with the image in plaid-ruby-release Jenkinsfile
FROM ruby:3.2.0
FROM 345594567237.dkr.ecr.us-east-1.amazonaws.com/docker-hub/library/ruby:3.2.0

# Create app directory
WORKDIR /usr/src/app
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Ruby embeds the version in the generator where as others don't so it's not possible to cat for it.
RUBY_PACKAGE_VERSION=44.0.0
RUBY_PACKAGE_VERSION=44.1.0

.PHONY: release
release:
Expand Down
48 changes: 47 additions & 1 deletion lib/plaid.rb

Large diffs are not rendered by default.

498 changes: 453 additions & 45 deletions lib/plaid/api/plaid_api.rb

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions lib/plaid/api_client.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

#The Plaid REST API. Please see https://plaid.com/docs/api for more details.

The version of the OpenAPI document: 2020-09-14_1.667.0
The version of the OpenAPI document: 2020-09-14_1.670.0

Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.3.0
Expand Down Expand Up @@ -41,7 +41,7 @@ class ApiConnectionFailedError < ApiError; end
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
def initialize(config = Configuration.default)
@config = config
@user_agent = "Plaid Ruby v44.0.0"
@user_agent = "Plaid Ruby v44.1.0"
@default_headers = {
'Content-Type' => 'application/json',
'User-Agent' => @user_agent,
Expand Down
2 changes: 1 addition & 1 deletion lib/plaid/api_error.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

#The Plaid REST API. Please see https://plaid.com/docs/api for more details.

The version of the OpenAPI document: 2020-09-14_1.667.0
The version of the OpenAPI document: 2020-09-14_1.670.0

Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.3.0
Expand Down
2 changes: 1 addition & 1 deletion lib/plaid/configuration.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

#The Plaid REST API. Please see https://plaid.com/docs/api for more details.

The version of the OpenAPI document: 2020-09-14_1.667.0
The version of the OpenAPI document: 2020-09-14_1.670.0

Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.3.0
Expand Down
2 changes: 1 addition & 1 deletion lib/plaid/models/aamva_analysis.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

#The Plaid REST API. Please see https://plaid.com/docs/api for more details.

The version of the OpenAPI document: 2020-09-14_1.667.0
The version of the OpenAPI document: 2020-09-14_1.670.0

Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.3.0
Expand Down
2 changes: 1 addition & 1 deletion lib/plaid/models/aamva_detailed_match_result.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

#The Plaid REST API. Please see https://plaid.com/docs/api for more details.

The version of the OpenAPI document: 2020-09-14_1.667.0
The version of the OpenAPI document: 2020-09-14_1.670.0

Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.3.0
Expand Down
2 changes: 1 addition & 1 deletion lib/plaid/models/aamva_match_result.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

#The Plaid REST API. Please see https://plaid.com/docs/api for more details.

The version of the OpenAPI document: 2020-09-14_1.667.0
The version of the OpenAPI document: 2020-09-14_1.670.0

Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.3.0
Expand Down
2 changes: 1 addition & 1 deletion lib/plaid/models/account_access.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

#The Plaid REST API. Please see https://plaid.com/docs/api for more details.

The version of the OpenAPI document: 2020-09-14_1.667.0
The version of the OpenAPI document: 2020-09-14_1.670.0

Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.3.0
Expand Down
20 changes: 15 additions & 5 deletions lib/plaid/models/account_assets.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

#The Plaid REST API. Please see https://plaid.com/docs/api for more details.

The version of the OpenAPI document: 2020-09-14_1.667.0
The version of the OpenAPI document: 2020-09-14_1.670.0

Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.3.0
Expand Down Expand Up @@ -56,6 +56,8 @@ class AccountAssets
# Calculated data about the historical balances on the account. Available for `credit` and `depository` type accounts.
attr_accessor :historical_balances

attr_accessor :account_insights

class EnumAttributeValidator
attr_reader :datatype
attr_reader :allowable_values
Expand Down Expand Up @@ -95,7 +97,8 @@ def self.attribute_map
:'investments' => :'investments',
:'owners' => :'owners',
:'ownership_type' => :'ownership_type',
:'historical_balances' => :'historical_balances'
:'historical_balances' => :'historical_balances',
:'account_insights' => :'account_insights'
}
end

Expand All @@ -121,7 +124,8 @@ def self.openapi_types
:'investments' => :'AssetReportInvestments',
:'owners' => :'Array<Owner>',
:'ownership_type' => :'OwnershipType',
:'historical_balances' => :'Array<HistoricalBalance>'
:'historical_balances' => :'Array<HistoricalBalance>',
:'account_insights' => :'AccountInsights'
}
end

Expand All @@ -132,6 +136,7 @@ def self.openapi_nullable
:'official_name',
:'subtype',
:'ownership_type',
:'account_insights'
])
end

Expand Down Expand Up @@ -215,6 +220,10 @@ def initialize(attributes = {})
self.historical_balances = value
end
end

if attributes.key?(:'account_insights')
self.account_insights = attributes[:'account_insights']
end
end

# Show invalid properties with the reasons. Usually used together with valid?
Expand Down Expand Up @@ -301,7 +310,8 @@ def ==(o)
investments == o.investments &&
owners == o.owners &&
ownership_type == o.ownership_type &&
historical_balances == o.historical_balances
historical_balances == o.historical_balances &&
account_insights == o.account_insights
end

# @see the `==` method
Expand All @@ -313,7 +323,7 @@ def eql?(o)
# Calculates hash code according to all attributes.
# @return [Integer] Hash code
def hash
[account_id, balances, mask, name, official_name, type, subtype, verification_status, persistent_account_id, days_available, transactions, investments, owners, ownership_type, historical_balances].hash
[account_id, balances, mask, name, official_name, type, subtype, verification_status, persistent_account_id, days_available, transactions, investments, owners, ownership_type, historical_balances, account_insights].hash
end

# Builds the object from hash
Expand Down
8 changes: 4 additions & 4 deletions lib/plaid/models/account_balance.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

#The Plaid REST API. Please see https://plaid.com/docs/api for more details.

The version of the OpenAPI document: 2020-09-14_1.667.0
The version of the OpenAPI document: 2020-09-14_1.670.0

Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.3.0
Expand All @@ -14,12 +14,12 @@
require 'time'

module Plaid
# A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by `/accounts/balance/get`.
# A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by `/accounts/balance/get` or `/signal/evaluate` (using a Balance-only ruleset).
class AccountBalance
# The amount of funds available to be withdrawn from the account, as determined by the financial institution. For `credit`-type accounts, the `available` balance typically equals the `limit` less the `current` balance, less any pending outflows plus any pending inflows. For `depository`-type accounts, the `available` balance typically equals the `current` balance less any pending outflows plus any pending inflows. For `depository`-type accounts, the `available` balance does not include the overdraft limit. For `investment`-type accounts (or `brokerage`-type accounts for API versions 2018-05-22 and earlier), the `available` balance is the total cash available to withdraw as presented by the institution. Note that not all institutions calculate the `available` balance. In the event that `available` balance is unavailable, Plaid will return an `available` balance value of `null`. Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by `/accounts/balance/get`. If `current` is `null` this field is guaranteed not to be `null`.
# The amount of funds available to be withdrawn from the account, as determined by the financial institution. For `credit`-type accounts, the `available` balance typically equals the `limit` less the `current` balance, less any pending outflows plus any pending inflows. For `depository`-type accounts, the `available` balance typically equals the `current` balance less any pending outflows plus any pending inflows. For `depository`-type accounts, the `available` balance does not include the overdraft limit. For `investment`-type accounts (or `brokerage`-type accounts for API versions 2018-05-22 and earlier), the `available` balance is the total cash available to withdraw as presented by the institution. Note that not all institutions calculate the `available` balance. In the event that `available` balance is unavailable, Plaid will return an `available` balance value of `null`. Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by `/accounts/balance/get`, or by `/signal/evaluate` with a Balance-only ruleset. If `current` is `null` this field is guaranteed not to be `null`.
attr_accessor :available

# The total amount of funds in or owed by the account. For `credit`-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder. For `loan`-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (`ins_116944`). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest. Similar to `credit`-type accounts, a positive balance is typically expected, while a negative amount indicates the lender owing the account holder. For `investment`-type accounts (or `brokerage`-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution. Note that balance information may be cached unless the value was returned by `/accounts/balance/get`; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the `available` balance as provided by `/accounts/balance/get`. When returned by `/accounts/balance/get`, this field may be `null`. When this happens, `available` is guaranteed not to be `null`.
# The total amount of funds in or owed by the account. For `credit`-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder. For `loan`-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (`ins_116944`). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest. Similar to `credit`-type accounts, a positive balance is typically expected, while a negative amount indicates the lender owing the account holder. For `investment`-type accounts (or `brokerage`-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution. Note that balance information may be cached unless the value was returned by `/accounts/balance/get` or by `/signal/evaluate` with a Balance-only ruleset; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the `available` balance as provided by `/accounts/balance/get` or `/signal/evaluate` called with a Balance-only `ruleset_key`. When returned by `/accounts/balance/get`, this field may be `null`. When this happens, `available` is guaranteed not to be `null`.
attr_accessor :current

# For `credit`-type accounts, this represents the credit limit. For `depository`-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe. In North America, this field is typically only available for `credit`-type accounts.
Expand Down
4 changes: 2 additions & 2 deletions lib/plaid/models/account_base.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

#The Plaid REST API. Please see https://plaid.com/docs/api for more details.

The version of the OpenAPI document: 2020-09-14_1.667.0
The version of the OpenAPI document: 2020-09-14_1.670.0

Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.3.0
Expand Down Expand Up @@ -34,7 +34,7 @@ class AccountBase

attr_accessor :subtype

# The current verification status of an Auth Item initiated through micro-deposits or database verification. Returned for Auth Items only. `pending_automatic_verification`: The Item is pending automatic verification `pending_manual_verification`: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit. `automatically_verified`: The Item has successfully been automatically verified `manually_verified`: The Item has successfully been manually verified `verification_expired`: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link. `verification_failed`: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link. `unsent`: The Item is pending micro-deposit verification, but Plaid has not yet sent the micro-deposit. `database_matched`: The Item has successfully been verified using Plaid's data sources. Only returned for Auth Items created via Database Match. `database_insights_pass`: The Item's numbers have been verified using Plaid's data sources: the routing and account number match a routing and account number of an account recognized on the Plaid network, and the account is not known by Plaid to be frozen or closed. Only returned for Auth Items created via Database Auth. `database_insights_pass_with_caution`:The Item's numbers have been verified using Plaid's data sources and have some signal for being valid: the routing and account number were not recognized on the Plaid network, but the routing number is valid and the account number is a potential valid account number for that routing number. Only returned for Auth Items created via Database Auth. `database_insights_fail`: The Item's numbers have been verified using Plaid's data sources and have signal for being invalid and/or have no signal for being valid. Typically this indicates that the routing number is invalid, the account number does not match the account number format associated with the routing number, or the account has been reported as closed or frozen. Only returned for Auth Items created via Database Auth.
# Indicates an Item's micro-deposit-based verification or database verification status. This field is only populated when using Auth and falling back to micro-deposit or database verification. Possible values are: `pending_automatic_verification`: The Item is pending automatic verification. `pending_manual_verification`: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the code. `automatically_verified`: The Item has successfully been automatically verified. `manually_verified`: The Item has successfully been manually verified. `verification_expired`: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link. `verification_failed`: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link. `unsent`: The Item is pending micro-deposit verification, but Plaid has not yet sent the micro-deposit. `database_insights_pending`: The Database Auth result is pending and will be available upon Auth request. `database_insights_fail`: The Item's numbers have been verified using Plaid's data sources and have signal for being invalid and/or have no signal for being valid. Typically this indicates that the routing number is invalid, the account number does not match the account number format associated with the routing number, or the account has been reported as closed or frozen. Only returned for Auth Items created via Database Auth. `database_insights_pass`: The Item's numbers have been verified using Plaid's data sources: the routing and account number match a routing and account number of an account recognized on the Plaid network, and the account is not known by Plaid to be frozen or closed. Only returned for Auth Items created via Database Auth. `database_insights_pass_with_caution`: The Item's numbers have been verified using Plaid's data sources and have some signal for being valid: the routing and account number were not recognized on the Plaid network, but the routing number is valid and the account number is a potential valid account number for that routing number. Only returned for Auth Items created via Database Auth. `database_matched`: (deprecated) The Item has successfully been verified using Plaid's data sources. Only returned for Auth Items created via Database Match. `null` or empty string: Neither micro-deposit-based verification nor database verification are being used for the Item.
attr_accessor :verification_status

# The account holder name that was used for micro-deposit and/or database verification. Only returned for Auth Items created via micro-deposit or database verification. This name was manually-entered by the user during Link, unless it was otherwise provided via the `user.legal_name` request field in `/link/token/create` for the Link session that created the Item.
Expand Down
Loading