chore: add missing docstrings

Author: stainless-app[bot]

src/lithic/types/account.py

@@ -10,6 +10,10 @@
 
 
 class SpendLimit(BaseModel):
+    """
+    Spend limit information for the user containing the daily, monthly, and lifetime spend limit of the account. Any charges to a card owned by this account will be declined once their transaction volume has surpassed the value in the applicable time limit (rolling). A lifetime limit of 0 indicates that the lifetime limit feature is disabled.
+    """
+
     daily: int
     """Daily spend limit (in cents)."""
 

src/lithic/types/account_activity_list_response.py

@@ -17,6 +17,8 @@
 
 
 class FinancialTransaction(BaseModel):
+    """Financial transaction with inheritance from unified base transaction"""
+
     token: str
     """Unique identifier for the transaction"""
 
@@ -79,6 +81,8 @@ class FinancialTransaction(BaseModel):
 
 
 class CardTransaction(Transaction):
+    """Card transaction with ledger base properties"""
+
     token: str  # type: ignore
     """Unique identifier for the transaction"""
 

src/lithic/types/account_activity_retrieve_transaction_response.py

@@ -17,6 +17,8 @@
 
 
 class FinancialTransaction(BaseModel):
+    """Financial transaction with inheritance from unified base transaction"""
+
     token: str
     """Unique identifier for the transaction"""
 
@@ -79,6 +81,8 @@ class FinancialTransaction(BaseModel):
 
 
 class CardTransaction(Transaction):
+    """Card transaction with ledger base properties"""
+
     token: str  # type: ignore
     """Unique identifier for the transaction"""
 

src/lithic/types/account_holder.py

@@ -56,6 +56,11 @@ class BeneficialOwnerEntity(BaseModel):
 
 
 class BeneficialOwnerIndividual(BaseModel):
+    """Information about an individual associated with an account holder.
+
+    A subset of the information provided via KYC. For example, we do not return the government id.
+    """
+
     address: Address
     """Individual's current address"""
 
@@ -79,6 +84,11 @@ class BeneficialOwnerIndividual(BaseModel):
 
 
 class BusinessEntity(BaseModel):
+    """Only present when user_type == "BUSINESS".
+
+    Information about the business for which the account is being opened and KYB is being run.
+    """
+
     address: Address
     """
     Business's physical address - PO boxes, UPS drops, and FedEx drops are not
@@ -115,6 +125,13 @@ class BusinessEntity(BaseModel):
 
 
 class ControlPerson(BaseModel):
+    """
+    Only present when user_type == "BUSINESS".
+    An individual with significant responsibility for managing the legal entity (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating Officer,
+    Managing Member, General Partner, President, Vice President, or Treasurer). This can be an executive, or someone who will have program-wide access
+    to the cards that Lithic will provide. In some cases, this individual could also be a beneficial owner listed above.
+    """
+
     address: Address
     """Individual's current address"""
 
@@ -138,6 +155,11 @@ class ControlPerson(BaseModel):
 
 
 class Individual(BaseModel):
+    """Only present when user_type == "INDIVIDUAL".
+
+    Information about the individual for which the account is being opened and KYC is being run.
+    """
+
     address: Address
     """Individual's current address"""
 
@@ -161,6 +183,8 @@ class Individual(BaseModel):
 
 
 class VerificationApplication(BaseModel):
+    """Information about the most recent identity verification attempt"""
+
     created: Optional[datetime] = None
     """Timestamp of when the application was created."""
 

src/lithic/types/account_holder_create_params.py

@@ -92,6 +92,8 @@ class KYB(TypedDict, total=False):
 
 
 class KYBBeneficialOwnerIndividual(TypedDict, total=False):
+    """Individuals associated with a KYB application. Phone number is optional."""
+
     address: Required[Address]
     """
     Individual's current address - PO boxes, UPS drops, and FedEx drops are not
@@ -126,6 +128,10 @@ class KYBBeneficialOwnerIndividual(TypedDict, total=False):
 
 
 class KYBBusinessEntity(TypedDict, total=False):
+    """
+    Information for business for which the account is being opened and KYB is being run.
+    """
+
     address: Required[Address]
     """
     Business's physical address - PO boxes, UPS drops, and FedEx drops are not
@@ -159,6 +165,13 @@ class KYBBusinessEntity(TypedDict, total=False):
 
 
 class KYBControlPerson(TypedDict, total=False):
+    """
+    An individual with significant responsibility for managing the legal entity (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating Officer,
+    Managing Member, General Partner, President, Vice President, or Treasurer). This can be an executive, or someone who will have program-wide access
+    to the cards that Lithic will provide. In some cases, this individual could also be a beneficial owner listed above.
+    See [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf) (Section II) for more background.
+    """
+
     address: Required[Address]
     """
     Individual's current address - PO boxes, UPS drops, and FedEx drops are not
@@ -278,6 +291,8 @@ class KYBDelegated(TypedDict, total=False):
 
 
 class KYBDelegatedBusinessEntity(TypedDict, total=False):
+    """Information for business for which the account is being opened."""
+
     address: Required[Address]
     """
     Business's physical address - PO boxes, UPS drops, and FedEx drops are not
@@ -311,6 +326,8 @@ class KYBDelegatedBusinessEntity(TypedDict, total=False):
 
 
 class KYBDelegatedBeneficialOwnerIndividual(TypedDict, total=False):
+    """Individuals associated with a KYB application. Phone number is optional."""
+
     address: Required[Address]
     """
     Individual's current address - PO boxes, UPS drops, and FedEx drops are not
@@ -345,6 +362,13 @@ class KYBDelegatedBeneficialOwnerIndividual(TypedDict, total=False):
 
 
 class KYBDelegatedControlPerson(TypedDict, total=False):
+    """
+    An individual with significant responsibility for managing the legal entity (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating Officer,
+    Managing Member, General Partner, President, Vice President, or Treasurer). This can be an executive, or someone who will have program-wide access
+    to the cards that Lithic will provide. In some cases, this individual could also be a beneficial owner listed above.
+    See [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf) (Section II) for more background.
+    """
+
     address: Required[Address]
     """
     Individual's current address - PO boxes, UPS drops, and FedEx drops are not
@@ -411,6 +435,10 @@ class KYC(TypedDict, total=False):
 
 
 class KYCIndividual(TypedDict, total=False):
+    """
+    Information on individual for whom the account is being opened and KYC is being run.
+    """
+
     address: Required[Address]
     """
     Individual's current address - PO boxes, UPS drops, and FedEx drops are not

src/lithic/types/account_holder_simulate_enrollment_review_response.py

@@ -21,6 +21,10 @@
 
 
 class BeneficialOwnerIndividualAddress(BaseModel):
+    """
+    Individual's current address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+    """
+
     address1: str
     """Valid deliverable address (no PO boxes)."""
 
@@ -80,6 +84,10 @@ class BeneficialOwnerIndividual(BaseModel):
 
 
 class ControlPersonAddress(BaseModel):
+    """
+    Individual's current address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+    """
+
     address1: str
     """Valid deliverable address (no PO boxes)."""
 
@@ -112,6 +120,15 @@ class ControlPersonAddress(BaseModel):
 
 
 class ControlPerson(BaseModel):
+    """Only present when user_type == "BUSINESS".
+
+    An individual with significant responsibility for managing the legal entity (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating Officer,
+
+    Managing Member, General Partner, President, Vice President, or Treasurer). This can be an executive, or someone who will have program-wide access
+
+    to the cards that Lithic will provide. In some cases, this individual could also be a beneficial owner listed above.
+    """
+
     address: Optional[ControlPersonAddress] = None
     """
     Individual's current address - PO boxes, UPS drops, and FedEx drops are not
@@ -139,6 +156,10 @@ class ControlPerson(BaseModel):
 
 
 class IndividualAddress(BaseModel):
+    """
+    Individual's current address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+    """
+
     address1: str
     """Valid deliverable address (no PO boxes)."""
 
@@ -171,6 +192,11 @@ class IndividualAddress(BaseModel):
 
 
 class Individual(BaseModel):
+    """Only present when user_type == "INDIVIDUAL".
+
+    Information about the individual for which the account is being opened and KYC is being run.
+    """
+
     address: Optional[IndividualAddress] = None
     """
     Individual's current address - PO boxes, UPS drops, and FedEx drops are not
@@ -198,6 +224,8 @@ class Individual(BaseModel):
 
 
 class VerificationApplication(BaseModel):
+    """Information about the most recent identity verification attempt"""
+
     created: datetime
     """Timestamp of when the application was created."""
 

src/lithic/types/account_holder_update_params.py

@@ -106,6 +106,8 @@ class KYBPatchRequestBeneficialOwnerEntity(TypedDict, total=False):
 
 
 class KYBPatchRequestBeneficialOwnerIndividual(TypedDict, total=False):
+    """Individuals associated with a KYB application. Phone number is optional."""
+
     entity_token: Required[str]
     """Globally unique identifier for an entity."""
 
@@ -144,6 +146,10 @@ class KYBPatchRequestBeneficialOwnerIndividual(TypedDict, total=False):
 
 
 class KYBPatchRequestBusinessEntity(TypedDict, total=False):
+    """
+    Information for business for which the account is being opened and KYB is being run.
+    """
+
     entity_token: Required[str]
     """Globally unique identifier for an entity."""
 
@@ -180,6 +186,10 @@ class KYBPatchRequestBusinessEntity(TypedDict, total=False):
 
 
 class KYBPatchRequestControlPerson(TypedDict, total=False):
+    """
+    An individual with significant responsibility for managing the legal entity (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating Officer, Managing Member, General Partner, President, Vice President, or Treasurer). This can be an executive, or someone who will have program-wide access to the cards that Lithic will provide. In some cases, this individual could also be a beneficial owner listed above. See [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf) (Section II) for more background.
+    """
+
     entity_token: Required[str]
     """Globally unique identifier for an entity."""
 
@@ -232,6 +242,10 @@ class KYCPatchRequest(TypedDict, total=False):
 
 
 class KYCPatchRequestIndividual(TypedDict, total=False):
+    """
+    Information on the individual for whom the account is being opened and KYC is being run.
+    """
+
     entity_token: Required[str]
     """Globally unique identifier for an entity."""
 

src/lithic/types/account_holder_update_response.py

@@ -24,6 +24,10 @@
 
 
 class KybkycPatchResponseBeneficialOwnerIndividualAddress(BaseModel):
+    """
+    Individual's current address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+    """
+
     address1: str
     """Valid deliverable address (no PO boxes)."""
 
@@ -83,6 +87,10 @@ class KybkycPatchResponseBeneficialOwnerIndividual(BaseModel):
 
 
 class KYBKYCPatchResponseControlPersonAddress(BaseModel):
+    """
+    Individual's current address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+    """
+
     address1: str
     """Valid deliverable address (no PO boxes)."""
 
@@ -115,6 +123,15 @@ class KYBKYCPatchResponseControlPersonAddress(BaseModel):
 
 
 class KYBKYCPatchResponseControlPerson(BaseModel):
+    """Only present when user_type == "BUSINESS".
+
+    An individual with significant responsibility for managing the legal entity (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating Officer,
+
+    Managing Member, General Partner, President, Vice President, or Treasurer). This can be an executive, or someone who will have program-wide access
+
+    to the cards that Lithic will provide. In some cases, this individual could also be a beneficial owner listed above.
+    """
+
     address: Optional[KYBKYCPatchResponseControlPersonAddress] = None
     """
     Individual's current address - PO boxes, UPS drops, and FedEx drops are not
@@ -142,6 +159,10 @@ class KYBKYCPatchResponseControlPerson(BaseModel):
 
 
 class KYBKYCPatchResponseIndividualAddress(BaseModel):
+    """
+    Individual's current address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+    """
+
     address1: str
     """Valid deliverable address (no PO boxes)."""
 
@@ -174,6 +195,11 @@ class KYBKYCPatchResponseIndividualAddress(BaseModel):
 
 
 class KYBKYCPatchResponseIndividual(BaseModel):
+    """Only present when user_type == "INDIVIDUAL".
+
+    Information about the individual for which the account is being opened and KYC is being run.
+    """
+
     address: Optional[KYBKYCPatchResponseIndividualAddress] = None
     """
     Individual's current address - PO boxes, UPS drops, and FedEx drops are not
@@ -201,6 +227,8 @@ class KYBKYCPatchResponseIndividual(BaseModel):
 
 
 class KYBKYCPatchResponseVerificationApplication(BaseModel):
+    """Information about the most recent identity verification attempt"""
+
     created: datetime
     """Timestamp of when the application was created."""
 
@@ -412,6 +440,8 @@ class KYBKYCPatchResponse(BaseModel):
 
 
 class PatchResponseAddress(BaseModel):
+    """The address for the account holder"""
+
     address1: str
     """Valid deliverable address (no PO boxes)."""
 

src/lithic/types/account_update_params.py

@@ -88,6 +88,10 @@ class AccountUpdateParams(TypedDict, total=False):
 
 
 class VerificationAddress(TypedDict, total=False):
+    """
+    Address used during Address Verification Service (AVS) checks during transactions if enabled via Auth Rules. This field is deprecated as AVS checks are no longer supported by Auth Rules. The field will be removed from the schema in a future release.
+    """
+
     address1: str
 
     address2: str

src/lithic/types/aggregate_balance.py

@@ -9,6 +9,8 @@
 
 
 class AggregateBalance(BaseModel):
+    """Aggregate Balance across all end-user accounts"""
+
     available_amount: int
     """Funds available for spend in the currency's smallest unit (e.g., cents for USD)"""