chore(api): updates to documentation and additional filter for status on Transactions (#669)

- updates to documentation for Accounts & AccountHolders
- adds status filter to Transactions

Author: stainless-app[bot]

src/lithic/resources/account_holders.py

@@ -83,12 +83,13 @@ def create(
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AccountHolderCreateResponse:
         """
-        Run an individual or business's information through the Customer Identification
-        Program (CIP). All calls to this endpoint will return an immediate response -
-        though in some cases, the response may indicate the enrollment is under review
-        or further action will be needed to complete the account enrollment process.
-        This endpoint can only be used on accounts that are part of the program that the
-        calling API key manages.
+        Create an account holder and initiate the appropriate onboarding workflow.
+        Account holders and accounts have a 1:1 relationship. When an account holder is
+        successfully created an associated account is also created. All calls to this
+        endpoint will return an immediate response - though in some cases, the response
+        may indicate the enrollment is under review or further action will be needed to
+        complete the account enrollment process. This endpoint can only be used on
+        accounts that are part of the program that the calling API key manages.
 
         Args:
           beneficial_owner_entities: List of all entities with >25% ownership in the company. If no entity or
@@ -165,12 +166,13 @@ def create(
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AccountHolderCreateResponse:
         """
-        Run an individual or business's information through the Customer Identification
-        Program (CIP). All calls to this endpoint will return an immediate response -
-        though in some cases, the response may indicate the enrollment is under review
-        or further action will be needed to complete the account enrollment process.
-        This endpoint can only be used on accounts that are part of the program that the
-        calling API key manages.
+        Create an account holder and initiate the appropriate onboarding workflow.
+        Account holders and accounts have a 1:1 relationship. When an account holder is
+        successfully created an associated account is also created. All calls to this
+        endpoint will return an immediate response - though in some cases, the response
+        may indicate the enrollment is under review or further action will be needed to
+        complete the account enrollment process. This endpoint can only be used on
+        accounts that are part of the program that the calling API key manages.
 
         Args:
           individual: Information on individual for whom the account is being opened and KYC is being
@@ -221,12 +223,13 @@ def create(
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AccountHolderCreateResponse:
         """
-        Run an individual or business's information through the Customer Identification
-        Program (CIP). All calls to this endpoint will return an immediate response -
-        though in some cases, the response may indicate the enrollment is under review
-        or further action will be needed to complete the account enrollment process.
-        This endpoint can only be used on accounts that are part of the program that the
-        calling API key manages.
+        Create an account holder and initiate the appropriate onboarding workflow.
+        Account holders and accounts have a 1:1 relationship. When an account holder is
+        successfully created an associated account is also created. All calls to this
+        endpoint will return an immediate response - though in some cases, the response
+        may indicate the enrollment is under review or further action will be needed to
+        complete the account enrollment process. This endpoint can only be used on
+        accounts that are part of the program that the calling API key manages.
 
         Args:
           address: KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not
@@ -240,7 +243,7 @@ def create(
 
           last_name: The KYC Exempt user's last name
 
-          phone_number: The KYC Exempt user's phone number
+          phone_number: The KYC Exempt user's phone number, entered in E.164 format.
 
           workflow: Specifies the workflow type. This must be 'KYC_EXEMPT'
 
@@ -784,6 +787,7 @@ def upload_document(
             "UTILITY_BILL_STATEMENT",
             "SSN_CARD",
             "ITIN_LETTER",
+            "FINCEN_BOI_REPORT",
         ],
         entity_token: str,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -888,12 +892,13 @@ async def create(
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AccountHolderCreateResponse:
         """
-        Run an individual or business's information through the Customer Identification
-        Program (CIP). All calls to this endpoint will return an immediate response -
-        though in some cases, the response may indicate the enrollment is under review
-        or further action will be needed to complete the account enrollment process.
-        This endpoint can only be used on accounts that are part of the program that the
-        calling API key manages.
+        Create an account holder and initiate the appropriate onboarding workflow.
+        Account holders and accounts have a 1:1 relationship. When an account holder is
+        successfully created an associated account is also created. All calls to this
+        endpoint will return an immediate response - though in some cases, the response
+        may indicate the enrollment is under review or further action will be needed to
+        complete the account enrollment process. This endpoint can only be used on
+        accounts that are part of the program that the calling API key manages.
 
         Args:
           beneficial_owner_entities: List of all entities with >25% ownership in the company. If no entity or
@@ -970,12 +975,13 @@ async def create(
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AccountHolderCreateResponse:
         """
-        Run an individual or business's information through the Customer Identification
-        Program (CIP). All calls to this endpoint will return an immediate response -
-        though in some cases, the response may indicate the enrollment is under review
-        or further action will be needed to complete the account enrollment process.
-        This endpoint can only be used on accounts that are part of the program that the
-        calling API key manages.
+        Create an account holder and initiate the appropriate onboarding workflow.
+        Account holders and accounts have a 1:1 relationship. When an account holder is
+        successfully created an associated account is also created. All calls to this
+        endpoint will return an immediate response - though in some cases, the response
+        may indicate the enrollment is under review or further action will be needed to
+        complete the account enrollment process. This endpoint can only be used on
+        accounts that are part of the program that the calling API key manages.
 
         Args:
           individual: Information on individual for whom the account is being opened and KYC is being
@@ -1026,12 +1032,13 @@ async def create(
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AccountHolderCreateResponse:
         """
-        Run an individual or business's information through the Customer Identification
-        Program (CIP). All calls to this endpoint will return an immediate response -
-        though in some cases, the response may indicate the enrollment is under review
-        or further action will be needed to complete the account enrollment process.
-        This endpoint can only be used on accounts that are part of the program that the
-        calling API key manages.
+        Create an account holder and initiate the appropriate onboarding workflow.
+        Account holders and accounts have a 1:1 relationship. When an account holder is
+        successfully created an associated account is also created. All calls to this
+        endpoint will return an immediate response - though in some cases, the response
+        may indicate the enrollment is under review or further action will be needed to
+        complete the account enrollment process. This endpoint can only be used on
+        accounts that are part of the program that the calling API key manages.
 
         Args:
           address: KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not
@@ -1045,7 +1052,7 @@ async def create(
 
           last_name: The KYC Exempt user's last name
 
-          phone_number: The KYC Exempt user's phone number
+          phone_number: The KYC Exempt user's phone number, entered in E.164 format.
 
           workflow: Specifies the workflow type. This must be 'KYC_EXEMPT'
 
@@ -1589,6 +1596,7 @@ async def upload_document(
             "UTILITY_BILL_STATEMENT",
             "SSN_CARD",
             "ITIN_LETTER",
+            "FINCEN_BOI_REPORT",
         ],
         entity_token: str,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.

src/lithic/resources/accounts.py

@@ -102,19 +102,19 @@ def update(
         in the `PAUSED` state will not be able to transact or create new cards.
 
         Args:
-          daily_spend_limit: Amount (in cents) for the account's daily spend limit. By default the daily
-              spend limit is set to $1,250.
+          daily_spend_limit: Amount (in cents) for the account's daily spend limit (e.g. 100000 would be a
+              $1,000 limit). By default the daily spend limit is set to $1,250.
 
-          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. This behavior differs from the daily spend limit and the monthly
-              spend limit.
+          lifetime_spend_limit: Amount (in cents) for the account's lifetime spend limit (e.g. 100000 would be a
+              $1,000 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. This behavior differs from the daily spend
+              limit and the monthly spend limit.
 
-          monthly_spend_limit: Amount (in cents) for the account's monthly spend limit. By default the monthly
-              spend limit is set to $5,000.
+          monthly_spend_limit: Amount (in cents) for the account's monthly spend limit (e.g. 100000 would be a
+              $1,000 limit). By default the monthly spend limit is set to $5,000.
 
           state: Account states.
 
@@ -329,19 +329,19 @@ async def update(
         in the `PAUSED` state will not be able to transact or create new cards.
 
         Args:
-          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 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. This behavior differs from the daily spend limit and the monthly
-              spend limit.
-
-          monthly_spend_limit: Amount (in cents) for the account's monthly spend limit. By default the monthly
-              spend limit is set to $5,000.
+          daily_spend_limit: Amount (in cents) for the account's daily spend limit (e.g. 100000 would be a
+              $1,000 limit). By default the daily spend limit is set to $1,250.
+
+          lifetime_spend_limit: Amount (in cents) for the account's lifetime spend limit (e.g. 100000 would be a
+              $1,000 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. This behavior differs from the daily spend
+              limit and the monthly spend limit.
+
+          monthly_spend_limit: Amount (in cents) for the account's monthly spend limit (e.g. 100000 would be a
+              $1,000 limit). By default the monthly spend limit is set to $5,000.
 
           state: Account states.
 

src/lithic/resources/cards/cards.py

@@ -219,11 +219,11 @@ def create(
               - `EXPEDITED` - FedEx Standard Overnight or similar international option, with
                 tracking
 
-          spend_limit: Amount (in cents) to limit approved authorizations. Transaction requests above
-              the spend limit will be declined. 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 card
-              limit.
+          spend_limit: Amount (in cents) to limit approved authorizations (e.g. 100000 would be a
+              $1,000 limit). Transaction requests above the spend limit will be declined. 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 card limit.
 
           spend_limit_duration:
               Spend limit duration values:
@@ -359,11 +359,11 @@ def update(
           pin_status: Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
               attempts). Can only be set to `OK` to unblock a card.
 
-          spend_limit: Amount (in cents) to limit approved authorizations. Transaction requests above
-              the spend limit will be declined. 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 card
-              limit.
+          spend_limit: Amount (in cents) to limit approved authorizations (e.g. 100000 would be a
+              $1,000 limit). Transaction requests above the spend limit will be declined. 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 card limit.
 
           spend_limit_duration:
               Spend limit duration values:
@@ -515,9 +515,9 @@ def convert_physical(
         to state `PENDING_FULFILLMENT` and fulfilled at next fulfillment cycle. Virtual
         cards created on card programs which do not support physical cards cannot be
         converted. The card program cannot be changed as part of the conversion. Cards
-        must be in a state of either `OPEN` or `PAUSED` to be converted. Only applies to
-        cards of type `VIRTUAL` (or existing cards with deprecated types of
-        `DIGITAL_WALLET` and `UNLOCKED`).
+        must be in an `OPEN` state to be converted. Only applies to cards of type
+        `VIRTUAL` (or existing cards with deprecated types of `DIGITAL_WALLET` and
+        `UNLOCKED`).
 
         Args:
           shipping_address: The shipping address this card will be sent to.
@@ -1202,11 +1202,11 @@ async def create(
               - `EXPEDITED` - FedEx Standard Overnight or similar international option, with
                 tracking
 
-          spend_limit: Amount (in cents) to limit approved authorizations. Transaction requests above
-              the spend limit will be declined. 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 card
-              limit.
+          spend_limit: Amount (in cents) to limit approved authorizations (e.g. 100000 would be a
+              $1,000 limit). Transaction requests above the spend limit will be declined. 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 card limit.
 
           spend_limit_duration:
               Spend limit duration values:
@@ -1342,11 +1342,11 @@ async def update(
           pin_status: Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
               attempts). Can only be set to `OK` to unblock a card.
 
-          spend_limit: Amount (in cents) to limit approved authorizations. Transaction requests above
-              the spend limit will be declined. 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 card
-              limit.
+          spend_limit: Amount (in cents) to limit approved authorizations (e.g. 100000 would be a
+              $1,000 limit). Transaction requests above the spend limit will be declined. 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 card limit.
 
           spend_limit_duration:
               Spend limit duration values:
@@ -1498,9 +1498,9 @@ async def convert_physical(
         to state `PENDING_FULFILLMENT` and fulfilled at next fulfillment cycle. Virtual
         cards created on card programs which do not support physical cards cannot be
         converted. The card program cannot be changed as part of the conversion. Cards
-        must be in a state of either `OPEN` or `PAUSED` to be converted. Only applies to
-        cards of type `VIRTUAL` (or existing cards with deprecated types of
-        `DIGITAL_WALLET` and `UNLOCKED`).
+        must be in an `OPEN` state to be converted. Only applies to cards of type
+        `VIRTUAL` (or existing cards with deprecated types of `DIGITAL_WALLET` and
+        `UNLOCKED`).
 
         Args:
           shipping_address: The shipping address this card will be sent to.