Skip to content

Commit

Permalink
Update to Plaid v1.508.0
Browse files Browse the repository at this point in the history
  • Loading branch information
viceroypenguin committed Apr 17, 2024
1 parent ff43ae1 commit f863e43
Show file tree
Hide file tree
Showing 85 changed files with 681 additions and 103 deletions.
2 changes: 1 addition & 1 deletion plaid-openapi
Submodule plaid-openapi updated 2 files
+854 −69 2020-09-14.yml
+37 −0 CHANGELOG.md
83 changes: 83 additions & 0 deletions src/Plaid/Entity/AccountIdentityDocumentUpload.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
namespace Going.Plaid.Entity;

/// <summary>
/// <para>Identity information about an account</para>
/// </summary>
public record AccountIdentityDocumentUpload
{
/// <summary>
/// <para>Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new <c>account_id</c> will be assigned to the account.</para>
/// <para>The <c>account_id</c> can also change if the <c>access_token</c> is deleted and the same credentials that were used to generate that <c>access_token</c> are used to generate a new <c>access_token</c> on a later date. In that case, the new <c>account_id</c> will be different from the old <c>account_id</c>.</para>
/// <para>If an account with a specific <c>account_id</c> disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API.</para>
/// <para>Like all Plaid identifiers, the <c>account_id</c> is case sensitive.</para>
/// </summary>
[JsonPropertyName("account_id")]
public string? AccountId { get; init; } = default!;

/// <summary>
/// <para>A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by <c>/accounts/balance/get</c>.</para>
/// </summary>
[JsonPropertyName("balances")]
public Entity.AccountBalance? Balances { get; init; } = default!;

/// <summary>
/// <para>The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.</para>
/// </summary>
[JsonPropertyName("mask")]
public string? Mask { get; init; } = default!;

/// <summary>
/// <para>The name of the account, either assigned by the user or by the financial institution itself</para>
/// </summary>
[JsonPropertyName("name")]
public string? Name { get; init; } = default!;

/// <summary>
/// <para>The official name of the account as given by the financial institution</para>
/// </summary>
[JsonPropertyName("official_name")]
public string? OfficialName { get; init; } = default!;

/// <summary>
/// <para>See the <a href="https://plaid.com/docs/api/accounts#account-type-schema">Account type schema</a> for a full listing of account types and corresponding subtypes.</para>
/// </summary>
[JsonPropertyName("type")]
public Entity.AccountType? Type { get; init; } = default!;

/// <summary>
/// <para>See the [Account type schema](https://plaid.com/docs/api/accounts/#account-type-schema) for a full listing of account types and corresponding subtypes.</para>
/// </summary>
[JsonPropertyName("subtype")]
public Entity.AccountSubtype? Subtype { get; init; } = default!;

/// <summary>
/// <para>The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. Returned for Auth Items only.</para>
/// </summary>
[JsonPropertyName("verification_status")]
public Entity.AccountIdentityDocumentUploadVerificationStatusEnum? VerificationStatus { get; init; } = default!;

/// <summary>
/// <para>Insights from performing database verification for the account.</para>
/// </summary>
[JsonPropertyName("verification_insights")]
public Entity.VerificationInsights? VerificationInsights { get; init; } = default!;

/// <summary>
/// <para>A unique and persistent identifier for accounts that can be used to trace multiple instances of the same account across different Items for depository accounts. This is currently only supported for Chase Items. Because Chase accounts have a different account number each time they are linked, this field may be used instead of the account number to uniquely identify a Chase account across multiple Items for payments use cases, helping to reduce duplicate Items or attempted fraud. In Sandbox, this field may be populated for any account; in Production and Development, it will only be populated for Chase accounts.</para>
/// </summary>
[JsonPropertyName("persistent_account_id")]
public string? PersistentAccountId { get; init; } = default!;

/// <summary>
/// <para>Data returned by the financial institution about the account owner or owners. Only returned by Identity or Assets endpoints. For business accounts, the name reported may be either the name of the individual or the name of the business, depending on the institution; detecting whether the linked account is a business account is not currently supported. Multiple owners on a single account will be represented in the same <c>owner</c> object, not in multiple owner objects within the array. In API versions 2018-05-22 and earlier, the <c>owners</c> object is not returned, and instead identity information is returned in the top level <c>identity</c> object. For more details, see <a href="https://plaid.com/docs/api/versioning/#version-2019-05-29">Plaid API versioning</a></para>
/// </summary>
[JsonPropertyName("owners")]
public IReadOnlyList<Entity.Owner>? Owners { get; init; } = default!;

/// <summary>
/// <para>An array of document with which the Identity data is derived from.</para>
/// </summary>
[JsonPropertyName("documents")]
public IReadOnlyList<Entity.IdentityDocumentUpload>? Documents { get; init; } = default!;

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
namespace Going.Plaid.Entity;

/// <summary>
/// <para>The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. Returned for Auth Items only.</para>
/// </summary>
public enum AccountIdentityDocumentUploadVerificationStatusEnum
{
/// <summary>
/// <para>The Item has successfully been automatically verified</para>
/// </summary>
[EnumMember(Value = "automatically_verified")]
AutomaticallyVerified,

/// <summary>
/// <para>The Item is pending automatic verification</para>
/// </summary>
[EnumMember(Value = "pending_automatic_verification")]
PendingAutomaticVerification,

/// <summary>
/// <para>The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit.</para>
/// </summary>
[EnumMember(Value = "pending_manual_verification")]
PendingManualVerification,

/// <summary>
/// <para>The Item has successfully been manually verified</para>
/// </summary>
[EnumMember(Value = "manually_verified")]
ManuallyVerified,

/// <summary>
/// <para>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.</para>
/// </summary>
[EnumMember(Value = "verification_expired")]
VerificationExpired,

/// <summary>
/// <para>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.</para>
/// </summary>
[EnumMember(Value = "verification_failed")]
VerificationFailed,

/// <summary>
/// <para>The Item has successfully been verified using Plaid's data sources. Note: Database Match is currently a beta feature, please contact your account manager for more information.</para>
/// </summary>
[EnumMember(Value = "database_matched")]
DatabaseMatched,

/// <summary>
/// <para>The Item's ACH numbers have been verified using Plaid's data sources and have strong signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.</para>
/// </summary>
[EnumMember(Value = "database_insights_pass")]
DatabaseInsightsPass,

/// <summary>
/// <para>The Item's ACH numbers have been verified using Plaid's data sources and have some signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.</para>
/// </summary>
[EnumMember(Value = "database_insights_pass_with_caution")]
DatabaseInsightsPassWithCaution,

/// <summary>
/// <para>The Item's ACH numbers have been verified using Plaid's data sources and have signal for being invalid and/or have no signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.</para>
/// </summary>
[EnumMember(Value = "database_insights_fail")]
DatabaseInsightsFail,

/// <summary>
/// <para>Catch-all for unknown values returned by Plaid. If you encounter this, please check if there is a later version of the Going.Plaid library.</para>
/// </summary>
[EnumMember(Value = "undefined")]
Undefined,

}
8 changes: 4 additions & 4 deletions src/Plaid/Entity/AccountType.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,25 @@ namespace Going.Plaid.Entity;
public enum AccountType
{
/// <summary>
/// <para>An account type holding cash, in which funds are deposited. Supported products for <c>depository</c> accounts are: Auth (<c>checking</c> and <c>savings</c> types only), Balance, Transactions, Identity, Payment Initiation, Assets, and Investments (<c>cash management</c> type only).</para>
/// <para>An account type holding cash, in which funds are deposited. Supported products for <c>depository</c> accounts are: Auth (<c>checking</c> and <c>savings</c> types only), Transfer, Balance, Signal, Income, Transactions, Identity, Payment Initiation, Assets, and Investments (<c>cash management</c> type only).</para>
/// </summary>
[EnumMember(Value = "depository")]
Depository,

/// <summary>
/// <para>A credit card type account. Supported products for <c>credit</c> accounts are: Balance, Transactions, Identity, and Liabilities.</para>
/// <para>A credit card type account. Supported products for <c>credit</c> accounts are: Balance, Transactions, Identity, Assets, and Liabilities.</para>
/// </summary>
[EnumMember(Value = "credit")]
Credit,

/// <summary>
/// <para>A loan type account. Supported products for <c>loan</c> accounts are: Balance, Liabilities, and Transactions.</para>
/// <para>A loan type account. Supported products for <c>loan</c> accounts are: Balance, Liabilities, Assets, and Transactions.</para>
/// </summary>
[EnumMember(Value = "loan")]
Loan,

/// <summary>
/// <para>An investment account. Supported products for <c>investment</c> accounts are: Balance and Investments. In API versions 2018-05-22 and earlier, this type is called <c>brokerage</c>.</para>
/// <para>An investment account. Supported products for <c>investment</c> accounts are: Balance, Assets, and Investments. In API versions 2018-05-22 and earlier, this type is called <c>brokerage</c>.</para>
/// </summary>
[EnumMember(Value = "investment")]
Investment,
Expand Down
18 changes: 18 additions & 0 deletions src/Plaid/Entity/BaseReportTransaction.cs
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,22 @@ public record BaseReportTransaction
[JsonPropertyName("account_owner")]
public string? AccountOwner { get; init; } = default!;

/// <summary>
///
/// </summary>
[JsonPropertyName("transaction_type")]
public Entity.BaseReportTransactionType? TransactionType { get; init; } = default!;

/// <summary>
/// <para>A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see <a href="https://plaid.com/docs/api/products/transactions/#categoriesget"><c>/categories/get</c></a>.</para>
/// </summary>
[JsonPropertyName("category")]
public IReadOnlyList<string>? Category { get; init; } = default!;

/// <summary>
/// <para>The ID of the category to which this transaction belongs. For a full list of categories, see <a href="https://plaid.com/docs/api/products/transactions/#categoriesget"><c>/categories/get</c></a>.</para>
/// </summary>
[JsonPropertyName("category_id")]
public Entity.BaseReportTransactionCategoryIdObject? CategoryId { get; init; } = default!;

}
8 changes: 8 additions & 0 deletions src/Plaid/Entity/BaseReportTransactionCategoryIdObject.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
namespace Going.Plaid.Entity;

/// <summary>
/// <para>The ID of the category to which this transaction belongs. For a full list of categories, see <a href="https://plaid.com/docs/api/products/transactions/#categoriesget"><c>/categories/get</c></a>.</para>
/// </summary>
public record BaseReportTransactionCategoryIdObject
{
}
38 changes: 38 additions & 0 deletions src/Plaid/Entity/BaseReportTransactionType.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
namespace Going.Plaid.Entity;

/// <summary>
///
/// </summary>
public enum BaseReportTransactionType
{
/// <summary>
/// <para>transactions that took place online.</para>
/// </summary>
[EnumMember(Value = "digital")]
Digital,

/// <summary>
/// <para>transactions that were made at a physical location.</para>
/// </summary>
[EnumMember(Value = "place")]
Place,

/// <summary>
/// <para>transactions that relate to banks, e.g. fees or deposits.</para>
/// </summary>
[EnumMember(Value = "special")]
Special,

/// <summary>
/// <para>transactions that do not fit into the other types.</para>
/// </summary>
[EnumMember(Value = "unresolved")]
Unresolved,

/// <summary>
/// <para>Catch-all for unknown values returned by Plaid. If you encounter this, please check if there is a later version of the Going.Plaid library.</para>
/// </summary>
[EnumMember(Value = "undefined")]
Undefined,

}
12 changes: 6 additions & 6 deletions src/Plaid/Entity/BeaconAccountRiskEvaluateAccountAttributes.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,6 @@ public record BeaconAccountRiskEvaluateAccountAttributes
[JsonPropertyName("days_since_first_plaid_connection")]
public int? DaysSinceFirstPlaidConnection { get; init; } = default!;

/// <summary>
/// <para>The age of the account as reported by the FI, when available.</para>
/// </summary>
[JsonPropertyName("days_since_account_creation")]
public int? DaysSinceAccountCreation { get; init; } = default!;

/// <summary>
/// <para>Indicates if the account has been closed by the financial institution or the consumer, or is at risk of being closed</para>
/// </summary>
Expand Down Expand Up @@ -172,4 +166,10 @@ public record BeaconAccountRiskEvaluateAccountAttributes
[JsonPropertyName("phone_change_count_90d")]
public int? PhoneChangeCount90d { get; init; } = default!;

/// <summary>
/// <para>The number of days since the bank account was opened, as reported by the financial institution</para>
/// </summary>
[JsonPropertyName("days_since_account_opening")]
public int? DaysSinceAccountOpening { get; init; } = default!;

}
6 changes: 3 additions & 3 deletions src/Plaid/Entity/BeaconUserAddress.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ namespace Going.Plaid.Entity;
public record BeaconUserAddress
{
/// <summary>
/// <para>The primary street portion of an address. If an address is provided, this field will always be filled.</para>
/// <para>The primary street portion of an address. If an address is provided, this field will always be filled. A string with at least one non-whitespace alphabetical character, with a max length of 80 characters.</para>
/// </summary>
[JsonPropertyName("street")]
public string Street { get; init; } = default!;

/// <summary>
/// <para>Extra street information, like an apartment or suite number.</para>
/// <para>Extra street information, like an apartment or suite number. If provided, a string with at least one non-whitespace character, with a max length of 20 characters.</para>
/// </summary>
[JsonPropertyName("street2")]
public string? Street2 { get; init; } = default!;

/// <summary>
/// <para>City from the end user's address</para>
/// <para>City from the end user's address. A string with at least one non-whitespace alphabetical character, with a max length of 100 characters."</para>
/// </summary>
[JsonPropertyName("city")]
public string City { get; init; } = default!;
Expand Down
2 changes: 1 addition & 1 deletion src/Plaid/Entity/BeaconUserIDNumber.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace Going.Plaid.Entity;
public class BeaconUserIDNumber
{
/// <summary>
/// <para>Value of identity document value typed in by user. Alpha-numeric, with all formatting characters stripped.</para>
/// <para>Value of identity document value typed in by user. Alpha-numeric, with all formatting characters stripped. For specific format requirements by ID type, see <a href="https://plaid.com/docs/identity-verification/hybrid-input-validation/">Hybrid Input Validation</a>.</para>
/// </summary>
[JsonPropertyName("value")]
public string Value { get; set; } = default!;
Expand Down
6 changes: 3 additions & 3 deletions src/Plaid/Entity/BeaconUserRequestAddress.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ namespace Going.Plaid.Entity;
public class BeaconUserRequestAddress
{
/// <summary>
/// <para>The primary street portion of an address. If an address is provided, this field will always be filled.</para>
/// <para>The primary street portion of an address. If an address is provided, this field will always be filled. A string with at least one non-whitespace alphabetical character, with a max length of 80 characters.</para>
/// </summary>
[JsonPropertyName("street")]
public string Street { get; set; } = default!;

/// <summary>
/// <para>Extra street information, like an apartment or suite number.</para>
/// <para>Extra street information, like an apartment or suite number. If provided, a string with at least one non-whitespace character, with a max length of 20 characters.</para>
/// </summary>
[JsonPropertyName("street2")]
public string? Street2 { get; set; } = default!;

/// <summary>
/// <para>City from the end user's address</para>
/// <para>City from the end user's address. A string with at least one non-whitespace alphabetical character, with a max length of 100 characters."</para>
/// </summary>
[JsonPropertyName("city")]
public string City { get; set; } = default!;
Expand Down
18 changes: 18 additions & 0 deletions src/Plaid/Entity/CraBankIncomeSummary.cs
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,24 @@ public record CraBankIncomeSummary
[JsonPropertyName("forecasted_average_monthly_income")]
public IReadOnlyList<Entity.CreditAmountWithCurrency>? ForecastedAverageMonthlyIncome { get; init; } = default!;

/// <summary>
/// <para>An estimate of the annual gross income based on the historical net amount and income category for the income source(s).</para>
/// </summary>
[JsonPropertyName("historical_annual_gross_income")]
public IReadOnlyList<Entity.CreditAmountWithCurrency>? HistoricalAnnualGrossIncome { get; init; } = default!;

/// <summary>
/// <para>The annual income amount estimated based on the historical data for the income source(s).</para>
/// </summary>
[JsonPropertyName("historical_annual_income")]
public IReadOnlyList<Entity.CreditAmountWithCurrency>? HistoricalAnnualIncome { get; init; } = default!;

/// <summary>
/// <para>The predicted average annual income amount for the income source(s).</para>
/// </summary>
[JsonPropertyName("forecasted_annual_income")]
public IReadOnlyList<Entity.CreditAmountWithCurrency>? ForecastedAnnualIncome { get; init; } = default!;

/// <summary>
///
/// </summary>
Expand Down
26 changes: 26 additions & 0 deletions src/Plaid/Entity/IdentityDocumentUpload.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
namespace Going.Plaid.Entity;

/// <summary>
/// <para>Document object with metadata of the uploaded document</para>
/// </summary>
public record IdentityDocumentUpload
{
/// <summary>
///
/// </summary>
[JsonPropertyName("document_id")]
public string? DocumentId { get; init; } = default!;

/// <summary>
/// <para>In closed beta. Object representing metadata pertaining to the document.</para>
/// </summary>
[JsonPropertyName("metadata")]
public Entity.IdentityDocumentUploadMetadata? Metadata { get; init; } = default!;

/// <summary>
/// <para>In closed beta. Object representing fraud risk data of the document</para>
/// </summary>
[JsonPropertyName("risk_insights")]
public Entity.IdentityDocumentUploadRiskInsights? RiskInsights { get; init; } = default!;

}
Loading

0 comments on commit f863e43

Please sign in to comment.