Skip to content
Merged
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).

# 45.0.0
- Updating to OAS 2020-09-14_1.708.0

## OpenAPI Schema Changes
### 2020-09-14_1.708.0
- [Breaking] Preserve arbitrary JSON value types in `/cra/report/get` product `metadata` and `attributes` maps and scalar values in `/cra/credit_profile/report/get` cash flow and network insight attribute maps generated by client libraries.

### 2020-09-14_1.707.1
- Add `increase` to the `processor` enum on `/processor/token/create`, for creating processor tokens for the Increase integration.

### 2020-09-14_1.707.0
- Add hidden `user_id` request fields to `/credit/sessions/get` and `/credit/bank_statements/uploads/get`.

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

Expand Down
43 changes: 29 additions & 14 deletions api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* The Plaid API
* The Plaid REST API. Please see https://plaid.com/docs/api for more details.
*
* The version of the OpenAPI document: 2020-09-14_1.706.1
* The version of the OpenAPI document: 2020-09-14_1.708.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down Expand Up @@ -13689,7 +13689,7 @@ export interface CraCashflowInsightsReport {
*/
generated_time: string;
/**
* A map of cash flow attributes, where the key is a string, and the value is a float, int, or boolean. The specific list of attributes will depend on the cash flow attributes version used. For a full list of attributes, contact your account manager.
* A map of cash flow attributes, where the key is a string, and the value is a string, float, int, or boolean. The specific list of attributes will depend on the cash flow attributes version used. For a full list of attributes, contact your account manager.
* @type {object}
* @memberof CraCashflowInsightsReport
*/
Expand Down Expand Up @@ -14982,17 +14982,17 @@ export interface CraCreditProfileReport {
*/
lend_scores: Array<CraCreditProfileLendScore>;
/**
* A map of cash flow attributes, where the key is a string, and the value is a float, int, or boolean. The specific list of attributes will depend on the cash flow attributes version used. For a full list of attributes, contact your account manager.
* @type {{ [key: string]: object; }}
* A map of cash flow attributes, where the key is a string, and the value is a string, float, int, or boolean. The specific list of attributes will depend on the cash flow attributes version used. For a full list of attributes, contact your account manager.
* @type {{ [key: string]: any; }}
* @memberof CraCreditProfileReport
*/
cashflow_insights_attributes: { [key: string]: object; } | null;
cashflow_insights_attributes: { [key: string]: any; } | null;
/**
* A map of network attributes, where the key is a string, and the value is a float, int, or boolean. For a full list of attributes, contact your account manager.
* @type {{ [key: string]: object; }}
* @type {{ [key: string]: any; }}
* @memberof CraCreditProfileReport
*/
network_insights_attributes: { [key: string]: object; } | null;
network_insights_attributes: { [key: string]: any; } | null;
/**
*
* @type {CraCreditProfileReportMetadata}
Expand Down Expand Up @@ -17366,16 +17366,16 @@ export interface CraReportGetResponseProduct {
version: string;
/**
* A map of product report metadata, where the key is a string and the value varies by product. For a full list of metadata fields per product, see the data dictionary. May be `null` if metadata was not available.
* @type {{ [key: string]: object; }}
* @type {{ [key: string]: any; }}
* @memberof CraReportGetResponseProduct
*/
metadata: { [key: string]: object; } | null;
metadata: { [key: string]: any; } | null;
/**
* A map of product attributes, where the key is a string and the value is a float, int, or boolean. The specific list of attributes depends on the product and version. For a full list, see the data dictionary. May be `null` if attributes were not available.
* @type {{ [key: string]: object; }}
* A map of product attributes, where the key is a string and the value can be any JSON value. The specific list of attributes depends on the product and version. For a full list, see the data dictionary. May be `null` if attributes were not available.
* @type {{ [key: string]: any; }}
* @memberof CraReportGetResponseProduct
*/
attributes: { [key: string]: object; } | null;
attributes: { [key: string]: any; } | null;
/**
* Product-level errors. Non-empty when this product failed to generate; empty on success.
* @type {Array<PlaidError>}
Expand Down Expand Up @@ -20134,6 +20134,12 @@ export interface CreditBankStatementsUploadsGetRequest {
* @memberof CreditBankStatementsUploadsGetRequest
*/
user_token: string;
/**
*
* @type {string}
* @memberof CreditBankStatementsUploadsGetRequest
*/
user_id?: string;
/**
*
* @type {CreditBankStatementsUploadsGetRequestOptions}
Expand Down Expand Up @@ -22076,6 +22082,12 @@ export interface CreditSessionsGetRequest {
* @memberof CreditSessionsGetRequest
*/
user_token: string;
/**
*
* @type {string}
* @memberof CreditSessionsGetRequest
*/
user_id?: string;
}
/**
* CreditSessionsGetResponse defines the response schema for `/credit/sessions/get`
Expand Down Expand Up @@ -45026,7 +45038,8 @@ export enum ProcessorTokenCreateRequestProcessorEnum {
Pay = 'pay',
Natural = 'natural',
Kanmon = 'kanmon',
Kick = 'kick'
Kick = 'kick',
Increase = 'increase'
}

/**
Expand Down Expand Up @@ -56223,7 +56236,7 @@ export interface TransferAuthorizationDecisionRationale {
description: string;
}
/**
* A code representing the rationale for approving or declining the proposed transfer. If the `rationale_code` is `null`, the transfer passed the authorization check. Any non-`null` value for an `approved` transfer indicates that the authorization check could not be run and that you should perform your own risk assessment on the transfer. The code will indicate why the check could not be run. Possible values for an `approved` transfer are: `MANUALLY_VERIFIED_ITEM` - Item created via a manual entry flow (i.e. Same-Day Micro-deposit, Instant Micro-deposit, or database-based verification), limited information available. `ITEM_LOGIN_REQUIRED` - Unable to collect the account information due to Item staleness. Can be resolved by using Link and setting [`transfer.authorization_id`](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) in the request to `/link/token/create`. `PAYMENT_PROFILE_LOGIN_REQUIRED` - The Payment Profile associated with the call to `/transfer/authorization/create` is in a state that requires the end user to re-authenticate. Can be resolved by using Link to refresh the Payment Profile. `MIGRATED_ACCOUNT_ITEM` - Item created via `/transfer/migrate_account` endpoint, limited information available. `ERROR` - Unable to collect the account information due to an unspecified error. The following codes indicate that the authorization decision was `declined`: `NSF` - Transaction likely to result in a return due to insufficient funds. `RISK` - Transaction is high-risk. `TRANSFER_LIMIT_REACHED` - One or several transfer limits are reached, e.g. monthly transfer limit. Check the accompanying `description` field to understand which limit has been reached.
* A code representing the rationale for approving or declining the proposed transfer. If the `rationale_code` is `null`, the transfer passed the authorization check. Any non-`null` value for an `approved` transfer indicates that the authorization check could not be run and that you should perform your own risk assessment on the transfer. The code will indicate why the check could not be run. Possible values for an `approved` transfer are: `MANUALLY_VERIFIED_ITEM` - Item created via a manual entry flow (i.e. Same-Day Micro-deposit, Instant Micro-deposit, or database-based verification), limited information available. `ITEM_LOGIN_REQUIRED` - Unable to collect the account information due to Item staleness. Can be resolved by using Link and setting [`transfer.authorization_id`](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) in the request to `/link/token/create`. `PAYMENT_PROFILE_LOGIN_REQUIRED` - The Payment Profile associated with the call to `/transfer/authorization/create` is in a state that requires the end user to re-authenticate. Can be resolved by using Link to refresh the Payment Profile. `MIGRATED_ACCOUNT_ITEM` - Item created via `/transfer/migrate_account` endpoint, limited information available. `ERROR` - Unable to collect the account information due to an unspecified error. The following codes indicate that the authorization decision was `declined`: `NSF` - Transaction has an elevated probability of resulting in a return due to insufficient funds. `RISK` - Transaction is high-risk. `TRANSFER_LIMIT_REACHED` - One or several transfer limits are reached, e.g. monthly transfer limit. Check the accompanying `description` field to understand which limit has been reached. `ADMIN` - Transaction has an elevated probability of resulting in an administrative return (for example a closed, invalid, or unauthorized account). `FRAUD` - Transaction has an elevated probability of being fraudulent.
* @export
* @enum {string}
*/
Expand All @@ -56236,6 +56249,8 @@ export enum TransferAuthorizationDecisionRationaleCode {
PaymentProfileLoginRequired = 'PAYMENT_PROFILE_LOGIN_REQUIRED',
Error = 'ERROR',
MigratedAccountItem = 'MIGRATED_ACCOUNT_ITEM',
Admin = 'ADMIN',
Fraud = 'FRAUD',
Null = 'null'
}

Expand Down
2 changes: 1 addition & 1 deletion base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* The Plaid API
* The Plaid REST API. Please see https://plaid.com/docs/api for more details.
*
* The version of the OpenAPI document: 2020-09-14_1.706.1
* The version of the OpenAPI document: 2020-09-14_1.708.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* The Plaid API
* The Plaid REST API. Please see https://plaid.com/docs/api for more details.
*
* The version of the OpenAPI document: 2020-09-14_1.706.1
* The version of the OpenAPI document: 2020-09-14_1.708.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
4 changes: 2 additions & 2 deletions configuration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* The Plaid API
* The Plaid REST API. Please see https://plaid.com/docs/api for more details.
*
* The version of the OpenAPI document: 2020-09-14_1.706.1
* The version of the OpenAPI document: 2020-09-14_1.708.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down Expand Up @@ -96,7 +96,7 @@ export class Configuration {
if(!this.baseOptions) this.baseOptions = {};
if(!this.baseOptions.headers) this.baseOptions.headers = {};
this.baseOptions.headers = {
['User-Agent']: `Plaid Node v44.0.0`,
['User-Agent']: `Plaid Node v45.0.0`,
['Plaid-Version']: '2020-09-14',
...this.baseOptions.headers,
}
Expand Down
43 changes: 29 additions & 14 deletions dist/api.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* The Plaid API
* The Plaid REST API. Please see https://plaid.com/docs/api for more details.
*
* The version of the OpenAPI document: 2020-09-14_1.706.1
* The version of the OpenAPI document: 2020-09-14_1.708.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down Expand Up @@ -13616,7 +13616,7 @@ export interface CraCashflowInsightsReport {
*/
generated_time: string;
/**
* A map of cash flow attributes, where the key is a string, and the value is a float, int, or boolean. The specific list of attributes will depend on the cash flow attributes version used. For a full list of attributes, contact your account manager.
* A map of cash flow attributes, where the key is a string, and the value is a string, float, int, or boolean. The specific list of attributes will depend on the cash flow attributes version used. For a full list of attributes, contact your account manager.
* @type {object}
* @memberof CraCashflowInsightsReport
*/
Expand Down Expand Up @@ -14905,20 +14905,20 @@ export interface CraCreditProfileReport {
*/
lend_scores: Array<CraCreditProfileLendScore>;
/**
* A map of cash flow attributes, where the key is a string, and the value is a float, int, or boolean. The specific list of attributes will depend on the cash flow attributes version used. For a full list of attributes, contact your account manager.
* @type {{ [key: string]: object; }}
* A map of cash flow attributes, where the key is a string, and the value is a string, float, int, or boolean. The specific list of attributes will depend on the cash flow attributes version used. For a full list of attributes, contact your account manager.
* @type {{ [key: string]: any; }}
* @memberof CraCreditProfileReport
*/
cashflow_insights_attributes: {
[key: string]: object;
[key: string]: any;
} | null;
/**
* A map of network attributes, where the key is a string, and the value is a float, int, or boolean. For a full list of attributes, contact your account manager.
* @type {{ [key: string]: object; }}
* @type {{ [key: string]: any; }}
* @memberof CraCreditProfileReport
*/
network_insights_attributes: {
[key: string]: object;
[key: string]: any;
} | null;
/**
*
Expand Down Expand Up @@ -17282,19 +17282,19 @@ export interface CraReportGetResponseProduct {
version: string;
/**
* A map of product report metadata, where the key is a string and the value varies by product. For a full list of metadata fields per product, see the data dictionary. May be `null` if metadata was not available.
* @type {{ [key: string]: object; }}
* @type {{ [key: string]: any; }}
* @memberof CraReportGetResponseProduct
*/
metadata: {
[key: string]: object;
[key: string]: any;
} | null;
/**
* A map of product attributes, where the key is a string and the value is a float, int, or boolean. The specific list of attributes depends on the product and version. For a full list, see the data dictionary. May be `null` if attributes were not available.
* @type {{ [key: string]: object; }}
* A map of product attributes, where the key is a string and the value can be any JSON value. The specific list of attributes depends on the product and version. For a full list, see the data dictionary. May be `null` if attributes were not available.
* @type {{ [key: string]: any; }}
* @memberof CraReportGetResponseProduct
*/
attributes: {
[key: string]: object;
[key: string]: any;
} | null;
/**
* Product-level errors. Non-empty when this product failed to generate; empty on success.
Expand Down Expand Up @@ -20041,6 +20041,12 @@ export interface CreditBankStatementsUploadsGetRequest {
* @memberof CreditBankStatementsUploadsGetRequest
*/
user_token: string;
/**
*
* @type {string}
* @memberof CreditBankStatementsUploadsGetRequest
*/
user_id?: string;
/**
*
* @type {CreditBankStatementsUploadsGetRequestOptions}
Expand Down Expand Up @@ -21980,6 +21986,12 @@ export interface CreditSessionsGetRequest {
* @memberof CreditSessionsGetRequest
*/
user_token: string;
/**
*
* @type {string}
* @memberof CreditSessionsGetRequest
*/
user_id?: string;
}
/**
* CreditSessionsGetResponse defines the response schema for `/credit/sessions/get`
Expand Down Expand Up @@ -44803,7 +44815,8 @@ export declare enum ProcessorTokenCreateRequestProcessorEnum {
Pay = "pay",
Natural = "natural",
Kanmon = "kanmon",
Kick = "kick"
Kick = "kick",
Increase = "increase"
}
/**
* ProcessorTokenCreateResponse defines the response schema for `/processor/token/create` and `/processor/apex/processor_token/create`
Expand Down Expand Up @@ -55937,7 +55950,7 @@ export interface TransferAuthorizationDecisionRationale {
description: string;
}
/**
* A code representing the rationale for approving or declining the proposed transfer. If the `rationale_code` is `null`, the transfer passed the authorization check. Any non-`null` value for an `approved` transfer indicates that the authorization check could not be run and that you should perform your own risk assessment on the transfer. The code will indicate why the check could not be run. Possible values for an `approved` transfer are: `MANUALLY_VERIFIED_ITEM` - Item created via a manual entry flow (i.e. Same-Day Micro-deposit, Instant Micro-deposit, or database-based verification), limited information available. `ITEM_LOGIN_REQUIRED` - Unable to collect the account information due to Item staleness. Can be resolved by using Link and setting [`transfer.authorization_id`](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) in the request to `/link/token/create`. `PAYMENT_PROFILE_LOGIN_REQUIRED` - The Payment Profile associated with the call to `/transfer/authorization/create` is in a state that requires the end user to re-authenticate. Can be resolved by using Link to refresh the Payment Profile. `MIGRATED_ACCOUNT_ITEM` - Item created via `/transfer/migrate_account` endpoint, limited information available. `ERROR` - Unable to collect the account information due to an unspecified error. The following codes indicate that the authorization decision was `declined`: `NSF` - Transaction likely to result in a return due to insufficient funds. `RISK` - Transaction is high-risk. `TRANSFER_LIMIT_REACHED` - One or several transfer limits are reached, e.g. monthly transfer limit. Check the accompanying `description` field to understand which limit has been reached.
* A code representing the rationale for approving or declining the proposed transfer. If the `rationale_code` is `null`, the transfer passed the authorization check. Any non-`null` value for an `approved` transfer indicates that the authorization check could not be run and that you should perform your own risk assessment on the transfer. The code will indicate why the check could not be run. Possible values for an `approved` transfer are: `MANUALLY_VERIFIED_ITEM` - Item created via a manual entry flow (i.e. Same-Day Micro-deposit, Instant Micro-deposit, or database-based verification), limited information available. `ITEM_LOGIN_REQUIRED` - Unable to collect the account information due to Item staleness. Can be resolved by using Link and setting [`transfer.authorization_id`](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) in the request to `/link/token/create`. `PAYMENT_PROFILE_LOGIN_REQUIRED` - The Payment Profile associated with the call to `/transfer/authorization/create` is in a state that requires the end user to re-authenticate. Can be resolved by using Link to refresh the Payment Profile. `MIGRATED_ACCOUNT_ITEM` - Item created via `/transfer/migrate_account` endpoint, limited information available. `ERROR` - Unable to collect the account information due to an unspecified error. The following codes indicate that the authorization decision was `declined`: `NSF` - Transaction has an elevated probability of resulting in a return due to insufficient funds. `RISK` - Transaction is high-risk. `TRANSFER_LIMIT_REACHED` - One or several transfer limits are reached, e.g. monthly transfer limit. Check the accompanying `description` field to understand which limit has been reached. `ADMIN` - Transaction has an elevated probability of resulting in an administrative return (for example a closed, invalid, or unauthorized account). `FRAUD` - Transaction has an elevated probability of being fraudulent.
* @export
* @enum {string}
*/
Expand All @@ -55950,6 +55963,8 @@ export declare enum TransferAuthorizationDecisionRationaleCode {
PaymentProfileLoginRequired = "PAYMENT_PROFILE_LOGIN_REQUIRED",
Error = "ERROR",
MigratedAccountItem = "MIGRATED_ACCOUNT_ITEM",
Admin = "ADMIN",
Fraud = "FRAUD",
Null = "null"
}
/**
Expand Down
Loading