From 4c8a1903b7caee3fa8edf285415e7e95b914a4a1 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 31 Jan 2025 16:57:46 +0000 Subject: [PATCH 1/2] feat(api): api update (#941) --- .stats.yml | 2 +- src/increase/types/card_payment.py | 30 ++++--- src/increase/types/pending_transaction.py | 11 ++- src/increase/types/transaction.py | 98 ++++++++++++++++------- 4 files changed, 101 insertions(+), 40 deletions(-) diff --git a/.stats.yml b/.stats.yml index f96c3c096..d901d3705 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,2 +1,2 @@ configured_endpoints: 201 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-b83233a82025949d61c863da86f7d5cb639e8868924719a83bda389714fbf568.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-8682653c46661e7abcd90fefb10194ac68a8caf701a5fbf7ae887fa50c12b0a6.yml diff --git a/src/increase/types/card_payment.py b/src/increase/types/card_payment.py index 0b6fc7b84..7d6898681 100644 --- a/src/increase/types/card_payment.py +++ b/src/increase/types/card_payment.py @@ -2827,21 +2827,24 @@ class Element(BaseModel): """A Card Authentication object. This field will be present in the JSON response if and only if `category` is - equal to `card_authentication`. + equal to `card_authentication`. Card Authentications are attempts to + authenticate a transaction or a card with 3DS. """ card_authorization: Optional[ElementCardAuthorization] = None """A Card Authorization object. This field will be present in the JSON response if and only if `category` is - equal to `card_authorization`. + equal to `card_authorization`. Card Authorizations are temporary holds placed on + a customers funds with the intent to later clear a transaction. """ card_authorization_expiration: Optional[ElementCardAuthorizationExpiration] = None """A Card Authorization Expiration object. This field will be present in the JSON response if and only if `category` is - equal to `card_authorization_expiration`. + equal to `card_authorization_expiration`. Card Authorization Expirations are + cancellations of authorizations that were never settled by the acquirer. """ card_decline: Optional[ElementCardDecline] = None @@ -2855,42 +2858,51 @@ class Element(BaseModel): """A Card Fuel Confirmation object. This field will be present in the JSON response if and only if `category` is - equal to `card_fuel_confirmation`. + equal to `card_fuel_confirmation`. Card Fuel Confirmations update the amount of + a Card Authorization after a fuel pump transaction is completed. """ card_increment: Optional[ElementCardIncrement] = None """A Card Increment object. This field will be present in the JSON response if and only if `category` is - equal to `card_increment`. + equal to `card_increment`. Card Increments increase the pending amount of an + authorized transaction. """ card_refund: Optional[ElementCardRefund] = None """A Card Refund object. This field will be present in the JSON response if and only if `category` is - equal to `card_refund`. + equal to `card_refund`. Card Refunds move money back to the cardholder. While + they are usually connected to a Card Settlement an acquirer can also refund + money directly to a card without relation to a transaction. """ card_reversal: Optional[ElementCardReversal] = None """A Card Reversal object. This field will be present in the JSON response if and only if `category` is - equal to `card_reversal`. + equal to `card_reversal`. Card Reversals cancel parts of or the entirety of an + existing Card Authorization. """ card_settlement: Optional[ElementCardSettlement] = None """A Card Settlement object. This field will be present in the JSON response if and only if `category` is - equal to `card_settlement`. + equal to `card_settlement`. Card Settlements are card transactions that have + cleared and settled. While a settlement is usually preceded by an authorization, + an acquirer can also directly clear a transaction without first authorizing it. """ card_validation: Optional[ElementCardValidation] = None """A Card Validation object. This field will be present in the JSON response if and only if `category` is - equal to `card_validation`. + equal to `card_validation`. Card Validations are requests from a merchant to + verify that a card number and optionally its address and/or Card Verification + Value are valid. """ category: Literal[ diff --git a/src/increase/types/pending_transaction.py b/src/increase/types/pending_transaction.py index 0bf113134..2a72048d3 100644 --- a/src/increase/types/pending_transaction.py +++ b/src/increase/types/pending_transaction.py @@ -604,7 +604,8 @@ class Source(BaseModel): """A Card Authorization object. This field will be present in the JSON response if and only if `category` is - equal to `card_authorization`. + equal to `card_authorization`. Card Authorizations are temporary holds placed on + a customers funds with the intent to later clear a transaction. """ category: Literal[ @@ -665,14 +666,18 @@ class Source(BaseModel): """An Inbound Funds Hold object. This field will be present in the JSON response if and only if `category` is - equal to `inbound_funds_hold`. + equal to `inbound_funds_hold`. We hold funds for certain transaction types to + account for return windows where funds might still be clawed back by the sending + institution. """ inbound_wire_transfer_reversal: Optional[SourceInboundWireTransferReversal] = None """An Inbound Wire Transfer Reversal object. This field will be present in the JSON response if and only if `category` is - equal to `inbound_wire_transfer_reversal`. + equal to `inbound_wire_transfer_reversal`. An Inbound Wire Transfer Reversal is + created when Increase has received a wire and the User requests that it be + reversed. """ other: Optional[object] = None diff --git a/src/increase/types/transaction.py b/src/increase/types/transaction.py index d1aecbc8e..d534ec078 100644 --- a/src/increase/types/transaction.py +++ b/src/increase/types/transaction.py @@ -2280,70 +2280,87 @@ class Source(BaseModel): """An Account Transfer Intention object. This field will be present in the JSON response if and only if `category` is - equal to `account_transfer_intention`. + equal to `account_transfer_intention`. Two Account Transfer Intentions are + created from each Account Transfer. One decrements the source account, and the + other increments the destination account. """ ach_transfer_intention: Optional[SourceACHTransferIntention] = None """An ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is - equal to `ach_transfer_intention`. + equal to `ach_transfer_intention`. An ACH Transfer Intention is created from an + ACH Transfer. It reflects the intention to move money into or out of an Increase + account via the ACH network. """ ach_transfer_rejection: Optional[SourceACHTransferRejection] = None """An ACH Transfer Rejection object. This field will be present in the JSON response if and only if `category` is - equal to `ach_transfer_rejection`. + equal to `ach_transfer_rejection`. An ACH Transfer Rejection is created when an + ACH Transfer is rejected by Increase. It offsets the ACH Transfer Intention. + These rejections are rare. """ ach_transfer_return: Optional[SourceACHTransferReturn] = None """An ACH Transfer Return object. This field will be present in the JSON response if and only if `category` is - equal to `ach_transfer_return`. + equal to `ach_transfer_return`. An ACH Transfer Return is created when an ACH + Transfer is returned by the receiving bank. It offsets the ACH Transfer + Intention. ACH Transfer Returns usually occur within the first two business days + after the transfer is initiated, but can occur much later. """ card_dispute_acceptance: Optional[SourceCardDisputeAcceptance] = None """A Card Dispute Acceptance object. This field will be present in the JSON response if and only if `category` is - equal to `card_dispute_acceptance`. + equal to `card_dispute_acceptance`. Contains the details of a successful Card + Dispute. """ card_dispute_loss: Optional[SourceCardDisputeLoss] = None """A Card Dispute Loss object. This field will be present in the JSON response if and only if `category` is - equal to `card_dispute_loss`. + equal to `card_dispute_loss`. Contains the details of a lost Card Dispute. """ card_refund: Optional[SourceCardRefund] = None """A Card Refund object. This field will be present in the JSON response if and only if `category` is - equal to `card_refund`. + equal to `card_refund`. Card Refunds move money back to the cardholder. While + they are usually connected to a Card Settlement an acquirer can also refund + money directly to a card without relation to a transaction. """ card_revenue_payment: Optional[SourceCardRevenuePayment] = None """A Card Revenue Payment object. This field will be present in the JSON response if and only if `category` is - equal to `card_revenue_payment`. + equal to `card_revenue_payment`. Card Revenue Payments reflect earnings from + fees on card transactions. """ card_settlement: Optional[SourceCardSettlement] = None """A Card Settlement object. This field will be present in the JSON response if and only if `category` is - equal to `card_settlement`. + equal to `card_settlement`. Card Settlements are card transactions that have + cleared and settled. While a settlement is usually preceded by an authorization, + an acquirer can also directly clear a transaction without first authorizing it. """ cashback_payment: Optional[SourceCashbackPayment] = None """A Cashback Payment object. This field will be present in the JSON response if and only if `category` is - equal to `cashback_payment`. + equal to `cashback_payment`. A Cashback Payment represents the cashback paid to + a cardholder for a given period. Cashback is usually paid monthly for the prior + month's transactions. """ category: Literal[ @@ -2448,63 +2465,79 @@ class Source(BaseModel): """A Check Deposit Acceptance object. This field will be present in the JSON response if and only if `category` is - equal to `check_deposit_acceptance`. + equal to `check_deposit_acceptance`. A Check Deposit Acceptance is created when + a Check Deposit is processed and its details confirmed. Check Deposits may be + returned by the receiving bank, which will appear as a Check Deposit Return. """ check_deposit_return: Optional[SourceCheckDepositReturn] = None """A Check Deposit Return object. This field will be present in the JSON response if and only if `category` is - equal to `check_deposit_return`. + equal to `check_deposit_return`. A Check Deposit Return is created when a Check + Deposit is returned by the bank holding the account it was drawn against. Check + Deposits may be returned for a variety of reasons, including insufficient funds + or a mismatched account number. Usually, checks are returned within the first 7 + days after the deposit is made. """ check_transfer_deposit: Optional[SourceCheckTransferDeposit] = None """A Check Transfer Deposit object. This field will be present in the JSON response if and only if `category` is - equal to `check_transfer_deposit`. + equal to `check_transfer_deposit`. An Inbound Check is a check drawn on an + Increase account that has been deposited by an external bank account. These + types of checks are not pre-registered. """ fee_payment: Optional[SourceFeePayment] = None """A Fee Payment object. This field will be present in the JSON response if and only if `category` is - equal to `fee_payment`. + equal to `fee_payment`. A Fee Payment represents a payment made to Increase. """ inbound_ach_transfer: Optional[SourceInboundACHTransfer] = None """An Inbound ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is - equal to `inbound_ach_transfer`. + equal to `inbound_ach_transfer`. An Inbound ACH Transfer Intention is created + when an ACH transfer is initiated at another bank and received by Increase. """ inbound_ach_transfer_return_intention: Optional[SourceInboundACHTransferReturnIntention] = None """An Inbound ACH Transfer Return Intention object. This field will be present in the JSON response if and only if `category` is - equal to `inbound_ach_transfer_return_intention`. + equal to `inbound_ach_transfer_return_intention`. An Inbound ACH Transfer Return + Intention is created when an ACH transfer is initiated at another bank and + returned by Increase. """ inbound_check_adjustment: Optional[SourceInboundCheckAdjustment] = None """An Inbound Check Adjustment object. This field will be present in the JSON response if and only if `category` is - equal to `inbound_check_adjustment`. + equal to `inbound_check_adjustment`. An Inbound Check Adjustment is created when + Increase receives an adjustment for a check or return deposited through Check21. """ inbound_check_deposit_return_intention: Optional[SourceInboundCheckDepositReturnIntention] = None """An Inbound Check Deposit Return Intention object. This field will be present in the JSON response if and only if `category` is - equal to `inbound_check_deposit_return_intention`. + equal to `inbound_check_deposit_return_intention`. An Inbound Check Deposit + Return Intention is created when Increase receives an Inbound Check and the User + requests that it be returned. """ inbound_real_time_payments_transfer_confirmation: Optional[SourceInboundRealTimePaymentsTransferConfirmation] = None """An Inbound Real-Time Payments Transfer Confirmation object. This field will be present in the JSON response if and only if `category` is - equal to `inbound_real_time_payments_transfer_confirmation`. + equal to `inbound_real_time_payments_transfer_confirmation`. An Inbound + Real-Time Payments Transfer Confirmation is created when a Real-Time Payments + transfer is initiated at another bank and received by Increase. """ inbound_real_time_payments_transfer_decline: Optional[SourceInboundRealTimePaymentsTransferDecline] = None @@ -2518,35 +2551,43 @@ class Source(BaseModel): """An Inbound Wire Reversal object. This field will be present in the JSON response if and only if `category` is - equal to `inbound_wire_reversal`. + equal to `inbound_wire_reversal`. An Inbound Wire Reversal represents a reversal + of a wire transfer that was initiated via Increase. The other bank is sending + the money back. This most often happens when the original destination account + details were incorrect. """ inbound_wire_transfer: Optional[SourceInboundWireTransfer] = None """An Inbound Wire Transfer Intention object. This field will be present in the JSON response if and only if `category` is - equal to `inbound_wire_transfer`. + equal to `inbound_wire_transfer`. An Inbound Wire Transfer Intention is created + when a wire transfer is initiated at another bank and received by Increase. """ inbound_wire_transfer_reversal: Optional[SourceInboundWireTransferReversal] = None """An Inbound Wire Transfer Reversal Intention object. This field will be present in the JSON response if and only if `category` is - equal to `inbound_wire_transfer_reversal`. + equal to `inbound_wire_transfer_reversal`. An Inbound Wire Transfer Reversal + Intention is created when Increase has received a wire and the User requests + that it be reversed. """ interest_payment: Optional[SourceInterestPayment] = None """An Interest Payment object. This field will be present in the JSON response if and only if `category` is - equal to `interest_payment`. + equal to `interest_payment`. An Interest Payment represents a payment of + interest on an account. Interest is usually paid monthly. """ internal_source: Optional[SourceInternalSource] = None """An Internal Source object. This field will be present in the JSON response if and only if `category` is - equal to `internal_source`. + equal to `internal_source`. A transaction between the user and Increase. See the + `reason` attribute for more information. """ other: Optional[object] = None @@ -2559,21 +2600,24 @@ class Source(BaseModel): """A Real-Time Payments Transfer Acknowledgement object. This field will be present in the JSON response if and only if `category` is - equal to `real_time_payments_transfer_acknowledgement`. + equal to `real_time_payments_transfer_acknowledgement`. A Real-Time Payments + Transfer Acknowledgement is created when a Real-Time Payments Transfer sent from + Increase is acknowledged by the receiving bank. """ sample_funds: Optional[SourceSampleFunds] = None """A Sample Funds object. This field will be present in the JSON response if and only if `category` is - equal to `sample_funds`. + equal to `sample_funds`. Sample funds for testing purposes. """ wire_transfer_intention: Optional[SourceWireTransferIntention] = None """A Wire Transfer Intention object. This field will be present in the JSON response if and only if `category` is - equal to `wire_transfer_intention`. + equal to `wire_transfer_intention`. A Wire Transfer initiated via Increase and + sent to a different bank. """ From fd37af43091e34b9dbe093dbda4f0e8f970a5813 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 31 Jan 2025 16:58:11 +0000 Subject: [PATCH 2/2] release: 0.185.0 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 8 ++++++++ pyproject.toml | 2 +- src/increase/_version.py | 2 +- 4 files changed, 11 insertions(+), 3 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 06ebae073..68019aa59 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.184.0" + ".": "0.185.0" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 6afa02d55..df93c2269 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 0.185.0 (2025-01-31) + +Full Changelog: [v0.184.0...v0.185.0](https://github.com/Increase/increase-python/compare/v0.184.0...v0.185.0) + +### Features + +* **api:** api update ([#941](https://github.com/Increase/increase-python/issues/941)) ([4c8a190](https://github.com/Increase/increase-python/commit/4c8a1903b7caee3fa8edf285415e7e95b914a4a1)) + ## 0.184.0 (2025-01-31) Full Changelog: [v0.183.0...v0.184.0](https://github.com/Increase/increase-python/compare/v0.183.0...v0.184.0) diff --git a/pyproject.toml b/pyproject.toml index 3a9ed9b06..bd2a1eb9c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "increase" -version = "0.184.0" +version = "0.185.0" description = "The official Python library for the increase API" dynamic = ["readme"] license = "Apache-2.0" diff --git a/src/increase/_version.py b/src/increase/_version.py index 2488e14d3..39f9c5038 100644 --- a/src/increase/_version.py +++ b/src/increase/_version.py @@ -1,4 +1,4 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. __title__ = "increase" -__version__ = "0.184.0" # x-release-please-version +__version__ = "0.185.0" # x-release-please-version