Skip to content

feat(api): api update #1587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
increase-releases wants to merge 1 commit into from
Closed

feat(api): api update #1587

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion .stats.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
configured_endpoints: 239
openapi_spec_hash: 0af65087719d3a94ec028dea0f1f79dc
openapi_spec_hash: e2ae142628582b94b93c4593adeb2053
config_hash: 1ca082e374ef7000e2a5971e8da740e0
2 changes: 1 addition & 1 deletion scripts/mock
View file
Open in desktop

Large diffs are not rendered by default.

140 changes: 70 additions & 70 deletions src/increase/resources/exports.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,18 +48,18 @@ def create(
self,
*,
category: Literal[
"account_statement_ofx",
"account_statement_bai2",
"transaction_csv",
"account_statement_ofx",
"account_verification_letter",
"balance_csv",
"bookkeeping_account_balance_csv",
"daily_account_balance_csv",
"entity_csv",
"vendor_csv",
"account_verification_letter",
"funding_instructions",
"fee_csv",
"funding_instructions",
"transaction_csv",
"vendor_csv",
"voided_check",
"daily_account_balance_csv",
],
account_statement_bai2: export_create_params.AccountStatementBai2 | Omit = omit,
account_statement_ofx: export_create_params.AccountStatementOfx | Omit = omit,
Expand All @@ -86,25 +86,25 @@ def create(
Args:
category: The type of Export to create.

- `account_statement_ofx` - Export an Open Financial Exchange (OFX) file of
transactions and balances for a given time range and Account.
- `account_statement_bai2` - Export a BAI2 file of transactions and balances for
a given date and optional Account.
- `transaction_csv` - Export a CSV of all transactions for a given time range.
- `account_statement_ofx` - Export an Open Financial Exchange (OFX) file of
transactions and balances for a given time range and Account.
- `account_verification_letter` - A PDF of an account verification letter.
- `balance_csv` - Export a CSV of account balances for the dates in a given
range. (deprecated, use `daily_account_balance_csv` instead)
- `bookkeeping_account_balance_csv` - Export a CSV of bookkeeping account
balances for the dates in a given range.
- `daily_account_balance_csv` - Export a CSV of daily account balances with
starting and ending balances for a given date range.
- `entity_csv` - Export a CSV of entities with a given status.
- `vendor_csv` - Export a CSV of vendors added to the third-party risk
management dashboard.
- `account_verification_letter` - A PDF of an account verification letter.
- `funding_instructions` - A PDF of funding instructions.
- `fee_csv` - Export a CSV of fees. The time range must not include any fees
that are part of an open fee statement.
- `funding_instructions` - A PDF of funding instructions.
- `transaction_csv` - Export a CSV of all transactions for a given time range.
- `vendor_csv` - Export a CSV of vendors added to the third-party risk
management dashboard.
- `voided_check` - A PDF of a voided check.
- `daily_account_balance_csv` - Export a CSV of daily account balances with
starting and ending balances for a given date range.

account_statement_bai2: Options for the created export. Required if `category` is equal to
`account_statement_bai2`.
Expand Down Expand Up @@ -214,21 +214,21 @@ def list(
self,
*,
category: Literal[
"account_statement_ofx",
"account_statement_bai2",
"transaction_csv",
"account_statement_ofx",
"account_verification_letter",
"balance_csv",
"bookkeeping_account_balance_csv",
"entity_csv",
"vendor_csv",
"daily_account_balance_csv",
"dashboard_table_csv",
"account_verification_letter",
"funding_instructions",
"entity_csv",
"fee_csv",
"form_1099_int",
"form_1099_misc",
"fee_csv",
"funding_instructions",
"transaction_csv",
"vendor_csv",
"voided_check",
"daily_account_balance_csv",
]
| Omit = omit,
created_at: export_list_params.CreatedAt | Omit = omit,
Expand All @@ -251,29 +251,29 @@ def list(
Args:
category: Filter Exports for those with the specified category.

- `account_statement_ofx` - Export an Open Financial Exchange (OFX) file of
transactions and balances for a given time range and Account.
- `account_statement_bai2` - Export a BAI2 file of transactions and balances for
a given date and optional Account.
- `transaction_csv` - Export a CSV of all transactions for a given time range.
- `account_statement_ofx` - Export an Open Financial Exchange (OFX) file of
transactions and balances for a given time range and Account.
- `account_verification_letter` - A PDF of an account verification letter.
- `balance_csv` - Export a CSV of account balances for the dates in a given
range. (deprecated, use `daily_account_balance_csv` instead)
- `bookkeeping_account_balance_csv` - Export a CSV of bookkeeping account
balances for the dates in a given range.
- `entity_csv` - Export a CSV of entities with a given status.
- `vendor_csv` - Export a CSV of vendors added to the third-party risk
management dashboard.
- `daily_account_balance_csv` - Export a CSV of daily account balances with
starting and ending balances for a given date range.
- `dashboard_table_csv` - Certain dashboard tables are available as CSV exports.
This export cannot be created via the API.
- `account_verification_letter` - A PDF of an account verification letter.
- `funding_instructions` - A PDF of funding instructions.
- `form_1099_int` - A PDF of an Internal Revenue Service Form 1099-INT.
- `form_1099_misc` - A PDF of an Internal Revenue Service Form 1099-MISC.
- `entity_csv` - Export a CSV of entities with a given status.
- `fee_csv` - Export a CSV of fees. The time range must not include any fees
that are part of an open fee statement.
- `form_1099_int` - A PDF of an Internal Revenue Service Form 1099-INT.
- `form_1099_misc` - A PDF of an Internal Revenue Service Form 1099-MISC.
- `funding_instructions` - A PDF of funding instructions.
- `transaction_csv` - Export a CSV of all transactions for a given time range.
- `vendor_csv` - Export a CSV of vendors added to the third-party risk
management dashboard.
- `voided_check` - A PDF of a voided check.
- `daily_account_balance_csv` - Export a CSV of daily account balances with
starting and ending balances for a given date range.

cursor: Return the page of entries after this one.

Expand Down Expand Up @@ -345,18 +345,18 @@ async def create(
self,
*,
category: Literal[
"account_statement_ofx",
"account_statement_bai2",
"transaction_csv",
"account_statement_ofx",
"account_verification_letter",
"balance_csv",
"bookkeeping_account_balance_csv",
"daily_account_balance_csv",
"entity_csv",
"vendor_csv",
"account_verification_letter",
"funding_instructions",
"fee_csv",
"funding_instructions",
"transaction_csv",
"vendor_csv",
"voided_check",
"daily_account_balance_csv",
],
account_statement_bai2: export_create_params.AccountStatementBai2 | Omit = omit,
account_statement_ofx: export_create_params.AccountStatementOfx | Omit = omit,
Expand All @@ -383,25 +383,25 @@ async def create(
Args:
category: The type of Export to create.

- `account_statement_ofx` - Export an Open Financial Exchange (OFX) file of
transactions and balances for a given time range and Account.
- `account_statement_bai2` - Export a BAI2 file of transactions and balances for
a given date and optional Account.
- `transaction_csv` - Export a CSV of all transactions for a given time range.
- `account_statement_ofx` - Export an Open Financial Exchange (OFX) file of
transactions and balances for a given time range and Account.
- `account_verification_letter` - A PDF of an account verification letter.
- `balance_csv` - Export a CSV of account balances for the dates in a given
range. (deprecated, use `daily_account_balance_csv` instead)
- `bookkeeping_account_balance_csv` - Export a CSV of bookkeeping account
balances for the dates in a given range.
- `daily_account_balance_csv` - Export a CSV of daily account balances with
starting and ending balances for a given date range.
- `entity_csv` - Export a CSV of entities with a given status.
- `vendor_csv` - Export a CSV of vendors added to the third-party risk
management dashboard.
- `account_verification_letter` - A PDF of an account verification letter.
- `funding_instructions` - A PDF of funding instructions.
- `fee_csv` - Export a CSV of fees. The time range must not include any fees
that are part of an open fee statement.
- `funding_instructions` - A PDF of funding instructions.
- `transaction_csv` - Export a CSV of all transactions for a given time range.
- `vendor_csv` - Export a CSV of vendors added to the third-party risk
management dashboard.
- `voided_check` - A PDF of a voided check.
- `daily_account_balance_csv` - Export a CSV of daily account balances with
starting and ending balances for a given date range.

account_statement_bai2: Options for the created export. Required if `category` is equal to
`account_statement_bai2`.
Expand Down Expand Up @@ -511,21 +511,21 @@ def list(
self,
*,
category: Literal[
"account_statement_ofx",
"account_statement_bai2",
"transaction_csv",
"account_statement_ofx",
"account_verification_letter",
"balance_csv",
"bookkeeping_account_balance_csv",
"entity_csv",
"vendor_csv",
"daily_account_balance_csv",
"dashboard_table_csv",
"account_verification_letter",
"funding_instructions",
"entity_csv",
"fee_csv",
"form_1099_int",
"form_1099_misc",
"fee_csv",
"funding_instructions",
"transaction_csv",
"vendor_csv",
"voided_check",
"daily_account_balance_csv",
]
| Omit = omit,
created_at: export_list_params.CreatedAt | Omit = omit,
Expand All @@ -548,29 +548,29 @@ def list(
Args:
category: Filter Exports for those with the specified category.

- `account_statement_ofx` - Export an Open Financial Exchange (OFX) file of
transactions and balances for a given time range and Account.
- `account_statement_bai2` - Export a BAI2 file of transactions and balances for
a given date and optional Account.
- `transaction_csv` - Export a CSV of all transactions for a given time range.
- `account_statement_ofx` - Export an Open Financial Exchange (OFX) file of
transactions and balances for a given time range and Account.
- `account_verification_letter` - A PDF of an account verification letter.
- `balance_csv` - Export a CSV of account balances for the dates in a given
range. (deprecated, use `daily_account_balance_csv` instead)
- `bookkeeping_account_balance_csv` - Export a CSV of bookkeeping account
balances for the dates in a given range.
- `entity_csv` - Export a CSV of entities with a given status.
- `vendor_csv` - Export a CSV of vendors added to the third-party risk
management dashboard.
- `daily_account_balance_csv` - Export a CSV of daily account balances with
starting and ending balances for a given date range.
- `dashboard_table_csv` - Certain dashboard tables are available as CSV exports.
This export cannot be created via the API.
- `account_verification_letter` - A PDF of an account verification letter.
- `funding_instructions` - A PDF of funding instructions.
- `form_1099_int` - A PDF of an Internal Revenue Service Form 1099-INT.
- `form_1099_misc` - A PDF of an Internal Revenue Service Form 1099-MISC.
- `entity_csv` - Export a CSV of entities with a given status.
- `fee_csv` - Export a CSV of fees. The time range must not include any fees
that are part of an open fee statement.
- `form_1099_int` - A PDF of an Internal Revenue Service Form 1099-INT.
- `form_1099_misc` - A PDF of an Internal Revenue Service Form 1099-MISC.
- `funding_instructions` - A PDF of funding instructions.
- `transaction_csv` - Export a CSV of all transactions for a given time range.
- `vendor_csv` - Export a CSV of vendors added to the third-party risk
management dashboard.
- `voided_check` - A PDF of a voided check.
- `daily_account_balance_csv` - Export a CSV of daily account balances with
starting and ending balances for a given date range.

cursor: Return the page of entries after this one.

Expand Down
2 changes: 1 addition & 1 deletion src/increase/types/ach_transfer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ class Acknowledgement(BaseModel):
After the transfer is acknowledged by FedACH, this will contain supplemental details. The Federal Reserve sends an acknowledgement message for each file that Increase submits.
"""

acknowledged_at: str
acknowledged_at: datetime.datetime
"""
When the Federal Reserve acknowledged the submitted file containing this
transfer.
Expand Down
3 changes: 3 additions & 0 deletions src/increase/types/card_payment.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3247,6 +3247,7 @@ class ElementCardDecline(BaseModel):
"exceeds_approval_limit",
"card_temporarily_disabled",
"suspected_fraud",
"additional_customer_authentication_required",
"other",
]
] = None
Expand All @@ -3264,6 +3265,8 @@ class ElementCardDecline(BaseModel):
yet activated. The merchant may attempt to process the transaction again.
- `suspected_fraud` - The transaction is suspected to be fraudulent. The
merchant may attempt to process the transaction again.
- `additional_customer_authentication_required` - Additional customer
authentication is required to complete the transaction, such as 3DS.
- `other` - The transaction was declined for another reason. The merchant may
attempt to process the transaction again. This should be used sparingly.
"""
Expand Down
3 changes: 3 additions & 0 deletions src/increase/types/declined_transaction.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -993,6 +993,7 @@ class SourceCardDecline(BaseModel):
"exceeds_approval_limit",
"card_temporarily_disabled",
"suspected_fraud",
"additional_customer_authentication_required",
"other",
]
] = None
Expand All @@ -1010,6 +1011,8 @@ class SourceCardDecline(BaseModel):
yet activated. The merchant may attempt to process the transaction again.
- `suspected_fraud` - The transaction is suspected to be fraudulent. The
merchant may attempt to process the transaction again.
- `additional_customer_authentication_required` - Additional customer
authentication is required to complete the transaction, such as 3DS.
- `other` - The transaction was declined for another reason. The merchant may
attempt to process the transaction again. This should be used sparingly.
"""
Expand Down
40 changes: 20 additions & 20 deletions src/increase/types/export.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,50 +340,50 @@ class Export(BaseModel):
"""

category: Literal[
"account_statement_ofx",
"account_statement_bai2",
"transaction_csv",
"account_statement_ofx",
"account_verification_letter",
"balance_csv",
"bookkeeping_account_balance_csv",
"entity_csv",
"vendor_csv",
"daily_account_balance_csv",
"dashboard_table_csv",
"account_verification_letter",
"funding_instructions",
"entity_csv",
"fee_csv",
"form_1099_int",
"form_1099_misc",
"fee_csv",
"funding_instructions",
"transaction_csv",
"vendor_csv",
"voided_check",
"daily_account_balance_csv",
]
"""The category of the Export.

We may add additional possible values for this enum over time; your application
should be able to handle that gracefully.

- `account_statement_ofx` - Export an Open Financial Exchange (OFX) file of
transactions and balances for a given time range and Account.
- `account_statement_bai2` - Export a BAI2 file of transactions and balances for
a given date and optional Account.
- `transaction_csv` - Export a CSV of all transactions for a given time range.
- `account_statement_ofx` - Export an Open Financial Exchange (OFX) file of
transactions and balances for a given time range and Account.
- `account_verification_letter` - A PDF of an account verification letter.
- `balance_csv` - Export a CSV of account balances for the dates in a given
range. (deprecated, use `daily_account_balance_csv` instead)
- `bookkeeping_account_balance_csv` - Export a CSV of bookkeeping account
balances for the dates in a given range.
- `entity_csv` - Export a CSV of entities with a given status.
- `vendor_csv` - Export a CSV of vendors added to the third-party risk
management dashboard.
- `daily_account_balance_csv` - Export a CSV of daily account balances with
starting and ending balances for a given date range.
- `dashboard_table_csv` - Certain dashboard tables are available as CSV exports.
This export cannot be created via the API.
- `account_verification_letter` - A PDF of an account verification letter.
- `funding_instructions` - A PDF of funding instructions.
- `form_1099_int` - A PDF of an Internal Revenue Service Form 1099-INT.
- `form_1099_misc` - A PDF of an Internal Revenue Service Form 1099-MISC.
- `entity_csv` - Export a CSV of entities with a given status.
- `fee_csv` - Export a CSV of fees. The time range must not include any fees
that are part of an open fee statement.
- `form_1099_int` - A PDF of an Internal Revenue Service Form 1099-INT.
- `form_1099_misc` - A PDF of an Internal Revenue Service Form 1099-MISC.
- `funding_instructions` - A PDF of funding instructions.
- `transaction_csv` - Export a CSV of all transactions for a given time range.
- `vendor_csv` - Export a CSV of vendors added to the third-party risk
management dashboard.
- `voided_check` - A PDF of a voided check.
- `daily_account_balance_csv` - Export a CSV of daily account balances with
starting and ending balances for a given date range.
"""

created_at: datetime
Expand Down
Loading
Loading