Skip to content

docs(api): change description of various fields #76

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

Merged
stainless-bot merged 1 commit into from
Aug 10, 2023
Merged

docs(api): change description of various fields #76

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
34 changes: 16 additions & 18 deletions src/increase/types/declined_transaction.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,7 @@ class SourceWireDecline(BaseModel):

class Source(BaseModel):
ach_decline: Optional[SourceACHDecline]
"""A ACH Decline object.
"""An ACH Decline object.

This field will be present in the JSON response if and only if `category` is
equal to `ach_decline`.
Expand All @@ -511,25 +511,23 @@ class Source(BaseModel):
"wire_decline",
"other",
]
"""The type of decline that took place.
"""The type of the resource.

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

- `ach_decline` - The Declined Transaction was created by a ACH Decline object.
Details will be under the `ach_decline` object.
- `card_decline` - The Declined Transaction was created by a Card Decline
object. Details will be under the `card_decline` object.
- `check_decline` - The Declined Transaction was created by a Check Decline
object. Details will be under the `check_decline` object.
- `inbound_real_time_payments_transfer_decline` - The Declined Transaction was
created by a Inbound Real Time Payments Transfer Decline object. Details will
be under the `inbound_real_time_payments_transfer_decline` object.
- `international_ach_decline` - The Declined Transaction was created by a
International ACH Decline object. Details will be under the
`international_ach_decline` object.
- `wire_decline` - The Declined Transaction was created by a Wire Decline
object. Details will be under the `wire_decline` object.
- `ach_decline` - ACH Decline: details will be under the `ach_decline` object.
- `card_decline` - Card Decline: details will be under the `card_decline`
object.
- `check_decline` - Check Decline: details will be under the `check_decline`
object.
- `inbound_real_time_payments_transfer_decline` - Inbound Real Time Payments
Transfer Decline: details will be under the
`inbound_real_time_payments_transfer_decline` object.
- `international_ach_decline` - International ACH Decline: details will be under
the `international_ach_decline` object.
- `wire_decline` - Wire Decline: details will be under the `wire_decline`
object.
- `other` - The Declined Transaction was made for an undocumented or deprecated
reason.
"""
Expand All @@ -542,14 +540,14 @@ class Source(BaseModel):
"""

inbound_real_time_payments_transfer_decline: Optional[SourceInboundRealTimePaymentsTransferDecline]
"""A Inbound Real Time Payments Transfer Decline object.
"""An Inbound Real Time Payments Transfer Decline object.

This field will be present in the JSON response if and only if `category` is
equal to `inbound_real_time_payments_transfer_decline`.
"""

international_ach_decline: Optional[SourceInternationalACHDecline]
"""A International ACH Decline object.
"""An International ACH Decline object.

This field will be present in the JSON response if and only if `category` is
equal to `international_ach_decline`.
Expand Down
47 changes: 21 additions & 26 deletions src/increase/types/pending_transaction.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,14 +356,14 @@ class SourceWireTransferInstruction(BaseModel):

class Source(BaseModel):
account_transfer_instruction: Optional[SourceAccountTransferInstruction]
"""A Account Transfer Instruction object.
"""An Account Transfer Instruction object.

This field will be present in the JSON response if and only if `category` is
equal to `account_transfer_instruction`.
"""

ach_transfer_instruction: Optional[SourceACHTransferInstruction]
"""A ACH Transfer Instruction object.
"""An ACH Transfer Instruction object.

This field will be present in the JSON response if and only if `category` is
equal to `ach_transfer_instruction`.
Expand All @@ -387,33 +387,28 @@ class Source(BaseModel):
"wire_transfer_instruction",
"other",
]
"""The type of transaction that took place.
"""The type of the resource.

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

- `account_transfer_instruction` - The Pending Transaction was created by a
Account Transfer Instruction object. Details will be under the
`account_transfer_instruction` object.
- `ach_transfer_instruction` - The Pending Transaction was created by a ACH
Transfer Instruction object. Details will be under the
`ach_transfer_instruction` object.
- `card_authorization` - The Pending Transaction was created by a Card
Authorization object. Details will be under the `card_authorization` object.
- `check_deposit_instruction` - The Pending Transaction was created by a Check
Deposit Instruction object. Details will be under the
`check_deposit_instruction` object.
- `check_transfer_instruction` - The Pending Transaction was created by a Check
Transfer Instruction object. Details will be under the
`check_transfer_instruction` object.
- `inbound_funds_hold` - The Pending Transaction was created by a Inbound Funds
Hold object. Details will be under the `inbound_funds_hold` object.
- `real_time_payments_transfer_instruction` - The Pending Transaction was
created by a Real Time Payments Transfer Instruction object. Details will be
under the `real_time_payments_transfer_instruction` object.
- `wire_transfer_instruction` - The Pending Transaction was created by a Wire
Transfer Instruction object. Details will be under the
`wire_transfer_instruction` object.
- `account_transfer_instruction` - Account Transfer Instruction: details will be
under the `account_transfer_instruction` object.
- `ach_transfer_instruction` - ACH Transfer Instruction: details will be under
the `ach_transfer_instruction` object.
- `card_authorization` - Card Authorization: details will be under the
`card_authorization` object.
- `check_deposit_instruction` - Check Deposit Instruction: details will be under
the `check_deposit_instruction` object.
- `check_transfer_instruction` - Check Transfer Instruction: details will be
under the `check_transfer_instruction` object.
- `inbound_funds_hold` - Inbound Funds Hold: details will be under the
`inbound_funds_hold` object.
- `real_time_payments_transfer_instruction` - Real Time Payments Transfer
Instruction: details will be under the
`real_time_payments_transfer_instruction` object.
- `wire_transfer_instruction` - Wire Transfer Instruction: details will be under
the `wire_transfer_instruction` object.
- `other` - The Pending Transaction was made for an undocumented or deprecated
reason.
"""
Expand All @@ -433,7 +428,7 @@ class Source(BaseModel):
"""

inbound_funds_hold: Optional[SourceInboundFundsHold]
"""A Inbound Funds Hold object.
"""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`.
Expand Down
Loading