Skip to content

Commit

Permalink
Update to Plaid v1.419.0
Browse files Browse the repository at this point in the history
  • Loading branch information
viceroypenguin committed Aug 22, 2023
1 parent d8726f3 commit de23bf1
Show file tree
Hide file tree
Showing 10 changed files with 139 additions and 73 deletions.
2 changes: 1 addition & 1 deletion plaid-openapi
Submodule plaid-openapi updated 2 files
+46 −37 2020-09-14.yml
+296 −14 CHANGELOG.md
2 changes: 1 addition & 1 deletion src/Plaid/Entity/AssetReportTransaction.cs
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public record AssetReportTransaction
public string? CategoryId { get; init; } = default!;

/// <summary>
/// <para>Information describing the intent of the transaction. Most relevant for credit use cases, but not limited to such use cases. Please reach out to your account manager or sales representative if you would like to receive this field.</para>
/// <para>Information describing the intent of the transaction. Most relevant for credit use cases, but not limited to such use cases.</para>
/// <para>See the <a href="https://plaid.com/documents/credit-category-taxonomy.csv"><c>taxonomy csv file</c></a> for a full list of credit categories.</para>
/// </summary>
[JsonPropertyName("credit_category")]
Expand Down
33 changes: 1 addition & 32 deletions src/Plaid/Entity/BaseReportTransaction.cs
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,7 @@ public record BaseReportTransaction
public string? OriginalDescription { 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 string? CategoryId { get; init; } = default!;

/// <summary>
/// <para>Information describing the intent of the transaction. Most relevant for credit use cases, but not limited to such use cases. Please reach out to your account manager or sales representative if you would like to receive this field.</para>
/// <para>Information describing the intent of the transaction. Most relevant for credit use cases, but not limited to such use cases.</para>
/// <para>See the <a href="https://plaid.com/documents/credit-category-taxonomy.csv"><c>taxonomy csv file</c></a> for a full list of credit categories.</para>
/// </summary>
[JsonPropertyName("credit_category")]
Expand Down Expand Up @@ -73,25 +61,12 @@ public record BaseReportTransaction
[JsonPropertyName("location")]
public Entity.Location? Location { get; init; } = default!;

/// <summary>
/// <para>The merchant name or transaction description.</para>
/// </summary>
[JsonPropertyName("name")]
public string? Name { get; init; } = default!;

/// <summary>
/// <para>The merchant name, as enriched by Plaid from the <c>name</c> field. This is typically a more human-readable version of the merchant counterparty in the transaction. For some bank transactions (such as checks or account transfers) where there is no meaningful merchant name, this value will be <c>null</c>.</para>
/// </summary>
[JsonPropertyName("merchant_name")]
public string? MerchantName { get; init; } = default!;

/// <summary>
/// <para>Transaction information specific to inter-bank transfers. If the transaction was not an inter-bank transfer, all fields will be <c>null</c>.</para>
/// <para>If the <c>transactions</c> object was returned by a Transactions endpoint such as <c>/transactions/sync</c> or <c>/transactions/get</c>, the <c>payment_meta</c> key will always appear, but no data elements are guaranteed. If the <c>transactions</c> object was returned by an Assets endpoint such as <c>/asset_report/get/</c> or <c>/asset_report/pdf/get</c>, this field will only appear in an Asset Report with Insights.</para>
/// </summary>
[JsonPropertyName("payment_meta")]
public Entity.PaymentMeta? PaymentMeta { get; init; } = default!;

/// <summary>
/// <para>When <c>true</c>, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.</para>
/// </summary>
Expand All @@ -103,10 +78,4 @@ public record BaseReportTransaction
/// </summary>
[JsonPropertyName("account_owner")]
public string? AccountOwner { get; init; } = default!;

/// <summary>
///
/// </summary>
[JsonPropertyName("transaction_type")]
public Entity.BaseReportTransactionType? TransactionType { get; init; } = default!;
}
37 changes: 0 additions & 37 deletions src/Plaid/Entity/BaseReportTransactionType.cs

This file was deleted.

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

/// <summary>
/// <para>This enum describes the reason a consumer report is created for</para>
/// </summary>
public enum ConsumerReportPermissiblePurpose
{
/// <summary>
/// <para>In connection with a consumer credit transaction for the review or collection of an account pursuant to FCRA Section 604(a)(3)(A).</para>
/// </summary>
[EnumMember(Value = "ACCOUNT_REVIEW_CREDIT")]
AccountReviewCredit,

/// <summary>
/// <para>For a legitimate business need of the information to review a non-credit account provided primarily for personal, family, or household purposes to determine whether the consumer continues to meet the terms of the account pursuant to FCRA Section 604(a)(3)(F)(2).</para>
/// </summary>
[EnumMember(Value = "ACCOUNT_REVIEW_NON_CREDIT")]
AccountReviewNonCredit,

/// <summary>
/// <para>For employment purposes pursuant to FCRA 604(a)(3)(B), including hiring, retention and promotion purposes.</para>
/// </summary>
[EnumMember(Value = "EMPLOYMENT")]
Employment,

/// <summary>
/// <para>In connection with a credit transaction initiated by and involving the consumer pursuant to FCRA Section 604(a)(3)(A).</para>
/// </summary>
[EnumMember(Value = "EXTENSION_OF_CREDIT")]
ExtensionOfCredit,

/// <summary>
/// <para>For a legitimate business need in connection with a business transaction initiated by the consumer primarily for personal, family, or household purposes in connection with a property rental assessment pursuant to FCRA Section 604(a)(3)(F)(i).</para>
/// </summary>
[EnumMember(Value = "LEGITIMATE_BUSINESS_NEED_TENANT_SCREENING")]
LegitimateBusinessNeedTenantScreening,

/// <summary>
/// <para>For a legitimate business need in connection with a business transaction made primarily for personal, family, or household initiated by the consumer pursuant to FCRA Section 604(a)(3)(F)(i).</para>
/// </summary>
[EnumMember(Value = "LEGITIMATE_BUSINESS_NEED_TENANT_OTHER")]
LegitimateBusinessNeedTenantOther,

/// <summary>
/// <para>In accordance with the written instructions of the consumer pursuant to FCRA Section 604(a)(2), to evaluate an application’s profile to make an offer to the consumer.</para>
/// </summary>
[EnumMember(Value = "WRITTEN_INSTRUCTION_PREQUALIFICATION")]
WrittenInstructionPrequalification,

/// <summary>
/// <para>In accordance with the written instructions of the consumer pursuant to FCRA Section 604(a)(2), such as when an individual agrees to act as a guarantor or assumes personal liability for a consumer, business, or commercial loan.</para>
/// </summary>
[EnumMember(Value = "WRITTEN_INSTRUCTION_OTHER")]
WrittenInstructionOther,

/// <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,
}
2 changes: 1 addition & 1 deletion src/Plaid/Entity/CreditCategory.cs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
namespace Going.Plaid.Entity;

/// <summary>
/// <para>Information describing the intent of the transaction. Most relevant for credit use cases, but not limited to such use cases. Please reach out to your account manager or sales representative if you would like to receive this field.</para>
/// <para>Information describing the intent of the transaction. Most relevant for credit use cases, but not limited to such use cases.</para>
/// <para>See the <a href="https://plaid.com/documents/credit-category-taxonomy.csv"><c>taxonomy csv file</c></a> for a full list of credit categories.</para>
/// </summary>
public record CreditCategory
Expand Down
6 changes: 6 additions & 0 deletions src/Plaid/Entity/Recurrence.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,10 @@ public record Recurrence
/// </summary>
[JsonPropertyName("is_recurring")]
public bool? IsRecurring { get; init; } = default!;

/// <summary>
/// <para>Describes the frequency of the transaction stream.</para>
/// </summary>
[JsonPropertyName("frequency")]
public Entity.RecurringFrequency? Frequency { get; init; } = default!;
}
61 changes: 61 additions & 0 deletions src/Plaid/Entity/RecurringFrequency.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
namespace Going.Plaid.Entity;

/// <summary>
/// <para>Describes the frequency of the transaction stream.</para>
/// </summary>
public enum RecurringFrequency
{
/// <summary>
/// <para>Assigned to a transaction stream that isn't recurring in nature.</para>
/// </summary>
[EnumMember(Value = "UNKNOWN")]
Unknown,

/// <summary>
/// <para>Assigned to a transaction stream that occurs approximately every week.</para>
/// </summary>
[EnumMember(Value = "WEEKLY")]
Weekly,

/// <summary>
/// <para>Assigned to a transaction stream that occurs approximately every 2 weeks.</para>
/// </summary>
[EnumMember(Value = "BIWEEKLY")]
Biweekly,

/// <summary>
/// <para>Assigned to a transaction stream that occurs approximately twice per month. This frequency is typically seen for inflow transaction streams.</para>
/// </summary>
[EnumMember(Value = "SEMI_MONTHLY")]
SemiMonthly,

/// <summary>
/// <para>Assigned to a transaction stream that occurs approximately every month.</para>
/// </summary>
[EnumMember(Value = "MONTHLY")]
Monthly,

/// <summary>
/// <para>Assigned to a transaction stream that occurs approximately every year.</para>
/// </summary>
[EnumMember(Value = "ANNUALLY")]
Annually,

/// <summary>
/// <para>Assigned to a transaction stream that occurs approximately every day.</para>
/// </summary>
[EnumMember(Value = "DAILY")]
Daily,

/// <summary>
/// <para>Assigned to a transaction stream that varies in recurrence frequency. This frequency is typically seen for inflow streams in the gig economy.</para>
/// </summary>
[EnumMember(Value = "DYNAMIC")]
Dynamic,

/// <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,
}
6 changes: 6 additions & 0 deletions src/Plaid/Link/LinkTokenCreateRequest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,12 @@ public partial class LinkTokenCreateRequest : RequestBase
[JsonPropertyName("base_report")]
public Entity.LinkTokenCreateRequestBaseReport? BaseReport { get; set; } = default!;

/// <summary>
/// <para>This enum describes the reason a consumer report is created for</para>
/// </summary>
[JsonPropertyName("consumer_report_permissible_purpose")]
public Entity.ConsumerReportPermissiblePurpose? ConsumerReportPermissiblePurpose { get; set; } = default!;

/// <summary>
/// <para>Specifies options for initializing Link for use with the Auth product. This field can be used to enable or disable extended Auth flows for the resulting Link session. Omitting any field will result in a default that can be configured by your account manager.</para>
/// </summary>
Expand Down
2 changes: 1 addition & 1 deletion src/Plaid/Processor/PlaidClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public sealed partial class PlaidClient
.ParseResponseAsync<Processor.ProcessorSignalEvaluateResponse>();

/// <summary>
/// <para>After calling <c>/processor/signal/evaluate</c>, call <c>/processor/signal/decision/report</c> to report whether the transaction was initiated. This endpoint will return an <a href="https://plaid.com/docs/errors/invalid-request/#invalid_field"><c>INVALID_FIELD</c></a> error if called a second time with a different value for <c>initiated</c>.</para>
/// <para>After calling <c>/processor/signal/evaluate</c>, call <c>/processor/signal/decision/report</c> to report whether the transaction was initiated.</para>
/// </summary>
/// <remarks><see href="https://plaid.com/docs/api/processors/#processorsignaldecisionreport" /></remarks>
public Task<Processor.ProcessorSignalDecisionReportResponse> ProcessorSignalDecisionReportAsync(Processor.ProcessorSignalDecisionReportRequest request) =>
Expand Down

0 comments on commit de23bf1

Please sign in to comment.