feat(api): introduce TransactionSeries and update ShippingMethod fields (#732)

  - Add new `transaction_series` schema and fields for Transaction events
  - Add `expected_release_date` property to Payments
  - Deprecate various business entity fields and improve documentation
  - Add new `LOSS_WRITE_OFF` transaction type

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 156
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-179992b114ffada2cdd2d9d56a8a25e0683bec2297606d32d0f0006b9eb9f21d.yml
-openapi_spec_hash: a111418d378ea248892306c81b00f8c8
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-18973e063e9e9233433290bb4d641df8e17e1f21f5b1ec57e00182f0a48dbdec.yml
+openapi_spec_hash: ab503dc3772f962b603ade7b91b8534c
 config_hash: 6729d695e399d14fff4891b6b82ec86c

src/lithic/resources/account_holders.py

@@ -94,8 +94,8 @@ def create(
         accounts that are part of the program that the calling API key manages.
 
         Args:
-          beneficial_owner_individuals: List of all direct and indirect individuals with >25% ownership in the company.
-              If no individual owns >25% of the company, please identify the largest
+          beneficial_owner_individuals: List of all direct and indirect individuals with 25% or more ownership in the
+              company. If no individual owns 25% of the company, please identify the largest
               shareholder in this field. See
               [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
               (Section I) for more background on individuals that should be included.
@@ -404,21 +404,13 @@ def update(
         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
-              individual owns >25% of the company, and the largest shareholder is an entity,
-              please identify them in this field. See
-              [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)(Section
-              I) for more background. If no business owner is an entity, pass in an empty
-              list. However, either this parameter or `beneficial_owner_individuals` must be
-              populated. on entities that should be included.
-
-          beneficial_owner_individuals: List of all individuals with >25% ownership in the company. If no entity or
-              individual owns >25% of the company, and the largest shareholder is an
-              individual, please identify them in this field. See
-              [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)(Section
-              I) for more background on individuals that should be included. If no individual
-              is an entity, pass in an empty list. However, either this parameter or
-              `beneficial_owner_entities` must be populated.
+          beneficial_owner_entities: Deprecated.
+
+          beneficial_owner_individuals: List of all direct and indirect individuals with 25% or more ownership in the
+              company. If no individual owns 25% of the company, please identify the largest
+              shareholder in this field. See
+              [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+              (Section I) for more background on individuals that should be included.
 
           business_entity: Information for business for which the account is being opened and KYB is being
               run.
@@ -1083,8 +1075,8 @@ async def create(
         accounts that are part of the program that the calling API key manages.
 
         Args:
-          beneficial_owner_individuals: List of all direct and indirect individuals with >25% ownership in the company.
-              If no individual owns >25% of the company, please identify the largest
+          beneficial_owner_individuals: List of all direct and indirect individuals with 25% or more ownership in the
+              company. If no individual owns 25% of the company, please identify the largest
               shareholder in this field. See
               [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
               (Section I) for more background on individuals that should be included.
@@ -1393,21 +1385,13 @@ async def update(
         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
-              individual owns >25% of the company, and the largest shareholder is an entity,
-              please identify them in this field. See
-              [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)(Section
-              I) for more background. If no business owner is an entity, pass in an empty
-              list. However, either this parameter or `beneficial_owner_individuals` must be
-              populated. on entities that should be included.
-
-          beneficial_owner_individuals: List of all individuals with >25% ownership in the company. If no entity or
-              individual owns >25% of the company, and the largest shareholder is an
-              individual, please identify them in this field. See
-              [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)(Section
-              I) for more background on individuals that should be included. If no individual
-              is an entity, pass in an empty list. However, either this parameter or
-              `beneficial_owner_entities` must be populated.
+          beneficial_owner_entities: Deprecated.
+
+          beneficial_owner_individuals: List of all direct and indirect individuals with 25% or more ownership in the
+              company. If no individual owns 25% of the company, please identify the largest
+              shareholder in this field. See
+              [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+              (Section I) for more background on individuals that should be included.
 
           business_entity: Information for business for which the account is being opened and KYB is being
               run.

src/lithic/types/account_holder.py

@@ -206,12 +206,15 @@ class AccountHolder(BaseModel):
     """Globally unique identifier for the account."""
 
     beneficial_owner_entities: Optional[List[BeneficialOwnerEntity]] = None
-    """Deprecated. Only present when user_type == "BUSINESS"."""
+    """Deprecated."""
 
     beneficial_owner_individuals: Optional[List[BeneficialOwnerIndividual]] = None
-    """Only present when user_type == "BUSINESS".
-
-    List of all individuals with >25% ownership in the company.
+    """
+    Only present when user_type == "BUSINESS". List of all direct and indirect
+    individuals with 25% or more ownership in the company. If no individual owns 25%
+    of the company, please identify the largest shareholder in this field. See
+    [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+    (Section I) for more background on individuals that should be included.
     """
 
     business_account_token: Optional[str] = None
@@ -319,8 +322,8 @@ class AccountHolder(BaseModel):
 
     If the type is "INDIVIDUAL", the "individual" attribute will be present. If the
     type is "BUSINESS" then the "business_entity", "control_person",
-    "beneficial_owner_individuals", "beneficial_owner_entities",
-    "nature_of_business", and "website_url" attributes will be present.
+    "beneficial_owner_individuals", "nature_of_business", and "website_url"
+    attributes will be present.
     """
 
     verification_application: Optional[VerificationApplication] = None

src/lithic/types/account_holder_create_params.py

@@ -22,9 +22,9 @@
 
 class KYB(TypedDict, total=False):
     beneficial_owner_individuals: Required[Iterable[KYBBeneficialOwnerIndividual]]
-    """List of all direct and indirect individuals with >25% ownership in the company.
-
-    If no individual owns >25% of the company, please identify the largest
+    """
+    List of all direct and indirect individuals with 25% or more ownership in the
+    company. If no individual owns 25% of the company, please identify the largest
     shareholder in this field. See
     [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
     (Section I) for more background on individuals that should be included.

src/lithic/types/account_holder_simulate_enrollment_review_response.py

@@ -250,15 +250,16 @@ class AccountHolderSimulateEnrollmentReviewResponse(BaseModel):
     """Globally unique identifier for the account."""
 
     beneficial_owner_entities: Optional[List[KYBBusinessEntity]] = None
-    """Only present when user_type == "BUSINESS".
-
-    List of all entities with >25% ownership in the company.
-    """
+    """Deprecated."""
 
     beneficial_owner_individuals: Optional[List[BeneficialOwnerIndividual]] = None
     """Only present when user_type == "BUSINESS".
 
-    List of all individuals with >25% ownership in the company.
+    List of all direct and indirect individuals with 25% or more ownership in the
+    company. If no individual owns 25% of the company, please identify the largest
+    shareholder in this field. See
+    [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+    (Section I) for more background on individuals that should be included.
     """
 
     business_account_token: Optional[str] = None
@@ -389,9 +390,8 @@ class AccountHolderSimulateEnrollmentReviewResponse(BaseModel):
     If the type is "INDIVIDUAL", the "individual" attribute will be present.
 
     If the type is "BUSINESS" then the "business_entity", "control_person",
-    "beneficial_owner_individuals", "beneficial_owner_entities",
-
-    "nature_of_business", and "website_url" attributes will be present.
+    "beneficial_owner_individuals", "nature_of_business", and "website_url"
+    attributes will be present.
     """
 
     verification_application: Optional[VerificationApplication] = None

src/lithic/types/account_holder_update_params.py

@@ -22,25 +22,15 @@
 
 class KYBPatchRequest(TypedDict, total=False):
     beneficial_owner_entities: Iterable[KYBPatchRequestBeneficialOwnerEntity]
-    """List of all entities with >25% ownership in the company.
-
-    If no entity or individual owns >25% of the company, and the largest shareholder
-    is an entity, please identify them in this field. See
-    [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)(Section
-    I) for more background. If no business owner is an entity, pass in an empty
-    list. However, either this parameter or `beneficial_owner_individuals` must be
-    populated. on entities that should be included.
-    """
+    """Deprecated."""
 
     beneficial_owner_individuals: Iterable[KYBPatchRequestBeneficialOwnerIndividual]
-    """List of all individuals with >25% ownership in the company.
-
-    If no entity or individual owns >25% of the company, and the largest shareholder
-    is an individual, please identify them in this field. See
-    [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)(Section
-    I) for more background on individuals that should be included. If no individual
-    is an entity, pass in an empty list. However, either this parameter or
-    `beneficial_owner_entities` must be populated.
+    """
+    List of all direct and indirect individuals with 25% or more ownership in the
+    company. If no individual owns 25% of the company, please identify the largest
+    shareholder in this field. See
+    [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+    (Section I) for more background on individuals that should be included.
     """
 
     business_entity: KYBPatchRequestBusinessEntity

src/lithic/types/account_holder_update_response.py

@@ -253,15 +253,16 @@ class KYBKYCPatchResponse(BaseModel):
     """Globally unique identifier for the account."""
 
     beneficial_owner_entities: Optional[List[KYBBusinessEntity]] = None
-    """Only present when user_type == "BUSINESS".
-
-    List of all entities with >25% ownership in the company.
-    """
+    """Deprecated."""
 
     beneficial_owner_individuals: Optional[List[KybkycPatchResponseBeneficialOwnerIndividual]] = None
     """Only present when user_type == "BUSINESS".
 
-    List of all individuals with >25% ownership in the company.
+    List of all direct and indirect individuals with 25% or more ownership in the
+    company. If no individual owns 25% of the company, please identify the largest
+    shareholder in this field. See
+    [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+    (Section I) for more background on individuals that should be included.
     """
 
     business_account_token: Optional[str] = None
@@ -392,9 +393,8 @@ class KYBKYCPatchResponse(BaseModel):
     If the type is "INDIVIDUAL", the "individual" attribute will be present.
 
     If the type is "BUSINESS" then the "business_entity", "control_person",
-    "beneficial_owner_individuals", "beneficial_owner_entities",
-
-    "nature_of_business", and "website_url" attributes will be present.
+    "beneficial_owner_individuals", "nature_of_business", and "website_url"
+    attributes will be present.
     """
 
     verification_application: Optional[KYBKYCPatchResponseVerificationApplication] = None

src/lithic/types/financial_accounts/statements/statement_line_items.py

@@ -99,6 +99,7 @@ class Data(BaseModel):
         "INTERNAL_ADJUSTMENT",
         "LATE_PAYMENT",
         "LATE_PAYMENT_REVERSAL",
+        "LOSS_WRITE_OFF",
         "PROVISIONAL_CREDIT",
         "PROVISIONAL_CREDIT_REVERSAL",
         "RETURN",

src/lithic/types/financial_transaction.py

@@ -86,6 +86,7 @@ class Event(BaseModel):
             "INTERNAL_ADJUSTMENT",
             "LATE_PAYMENT",
             "LATE_PAYMENT_REVERSAL",
+            "LOSS_WRITE_OFF",
             "PROVISIONAL_CREDIT",
             "PROVISIONAL_CREDIT_REVERSAL",
             "RETURN",

src/lithic/types/kyb_param.py

@@ -146,9 +146,9 @@ class BeneficialOwnerEntity(TypedDict, total=False):
 
 class KYBParam(TypedDict, total=False):
     beneficial_owner_individuals: Required[Iterable[BeneficialOwnerIndividual]]
-    """List of all direct and indirect individuals with >25% ownership in the company.
-
-    If no individual owns >25% of the company, please identify the largest
+    """
+    List of all direct and indirect individuals with 25% or more ownership in the
+    company. If no individual owns 25% of the company, please identify the largest
     shareholder in this field. See
     [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
     (Section I) for more background on individuals that should be included.