Skip to content
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

docs(api): update limits docstrings #57

Merged
merged 1 commit into from
Jun 23, 2023
Merged

docs(api): update limits docstrings #57

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
38 changes: 14 additions & 24 deletions src/lithic/resources/accounts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,24 +74,19 @@ def update(
new cards.

Args:
daily_spend_limit: Amount (in cents) for the account's new daily spend limit. Note that a spend
limit of 0 is effectively no limit, and should only be used to reset or remove a
prior limit. Only a limit of 1 or above will result in declined transactions due
to checks against the account limit. By default the daily spend limit is set to
$1,250.00.
daily_spend_limit: Amount (in cents) for the account's daily spend limit. By default the daily
spend limit is set to $1,250.

lifetime_spend_limit: Amount (in cents) for the account's new lifetime limit. Once this limit is
lifetime_spend_limit: Amount (in cents) for the account's lifetime spend limit. Once this limit is
reached, no transactions will be accepted on any card created for this account
until the limit is updated. Note that a spend limit of 0 is effectively no
limit, and should only be used to reset or remove a prior limit. Only a limit of
1 or above will result in declined transactions due to checks against the
account limit.
account limit. This behavior differs from the daily spend limit and the monthly
spend limit.

monthly_spend_limit: Amount (in cents) for the account's new monthly spend limit. Note that a spend
limit of 0 is effectively no limit, and should only be used to reset or remove a
prior limit. Only a limit of 1 or above will result in declined transactions due
to checks against the account limit. By default the monthly spend limit is set
to $5,000.00.
monthly_spend_limit: Amount (in cents) for the account's monthly spend limit. By default the monthly
spend limit is set to $5,000.

state: Account states.

Expand Down Expand Up @@ -247,24 +242,19 @@ async def update(
new cards.

Args:
daily_spend_limit: Amount (in cents) for the account's new daily spend limit. Note that a spend
limit of 0 is effectively no limit, and should only be used to reset or remove a
prior limit. Only a limit of 1 or above will result in declined transactions due
to checks against the account limit. By default the daily spend limit is set to
$1,250.00.
daily_spend_limit: Amount (in cents) for the account's daily spend limit. By default the daily
spend limit is set to $1,250.

lifetime_spend_limit: Amount (in cents) for the account's new lifetime limit. Once this limit is
lifetime_spend_limit: Amount (in cents) for the account's lifetime spend limit. Once this limit is
reached, no transactions will be accepted on any card created for this account
until the limit is updated. Note that a spend limit of 0 is effectively no
limit, and should only be used to reset or remove a prior limit. Only a limit of
1 or above will result in declined transactions due to checks against the
account limit.
account limit. This behavior differs from the daily spend limit and the monthly
spend limit.

monthly_spend_limit: Amount (in cents) for the account's new monthly spend limit. Note that a spend
limit of 0 is effectively no limit, and should only be used to reset or remove a
prior limit. Only a limit of 1 or above will result in declined transactions due
to checks against the account limit. By default the monthly spend limit is set
to $5,000.00.
monthly_spend_limit: Amount (in cents) for the account's monthly spend limit. By default the monthly
spend limit is set to $5,000.

state: Account states.

Expand Down
23 changes: 9 additions & 14 deletions src/lithic/types/account_update_params.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,31 +9,26 @@

class AccountUpdateParams(TypedDict, total=False):
daily_spend_limit: int
"""Amount (in cents) for the account's new daily spend limit.

Note that a spend limit of 0 is effectively no limit, and should only be used to
reset or remove a prior limit. Only a limit of 1 or above will result in
declined transactions due to checks against the account limit. By default the
daily spend limit is set to $1,250.00.
"""
Amount (in cents) for the account's daily spend limit. By default the daily
spend limit is set to $1,250.
"""

lifetime_spend_limit: int
"""Amount (in cents) for the account's new lifetime limit.
"""Amount (in cents) for the account's lifetime spend limit.

Once this limit is reached, no transactions will be accepted on any card created
for this account until the limit is updated. Note that a spend limit of 0 is
effectively no limit, and should only be used to reset or remove a prior limit.
Only a limit of 1 or above will result in declined transactions due to checks
against the account limit.
against the account limit. This behavior differs from the daily spend limit and
the monthly spend limit.
"""

monthly_spend_limit: int
"""Amount (in cents) for the account's new monthly spend limit.

Note that a spend limit of 0 is effectively no limit, and should only be used to
reset or remove a prior limit. Only a limit of 1 or above will result in
declined transactions due to checks against the account limit. By default the
monthly spend limit is set to $5,000.00.
"""
Amount (in cents) for the account's monthly spend limit. By default the monthly
spend limit is set to $5,000.
"""

state: Literal["ACTIVE", "PAUSED"]
Expand Down