feat(api): adds support for delegated KYB onboarding and more device details in 3DS Authentications

- adds support for KYB Delegated when creating an AccountHolder
- adds support for IS_EQUAL_TO, IS_NOT_EQUAL_TO, IS_GREATER_THAN_OR_EQUAL_TO and IS_LESS_THAN_OR_EQUAL_TO to Conditional Block Parameters
- moves wire details into debtor and creditor specific properties
- adds additional device related data fields to 3DS Authentications: https://docs.lithic.com/changelog/new-mobile-device-info-for-3ds-authentications

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 168
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-e16df7d65a6ababc8e0ca1f2a65070893d82d3b2b046394ab708d56fe717b3ad.yml
-openapi_spec_hash: ee82cf8fd5bb6b86abbae304f6c43934
-config_hash: c6d56596249e319c59d49d8e49a190b1
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-117e0ee9b030a2efc3b09e189e445fb1a26fd32f1c563f385b9d7071a959c550.yml
+openapi_spec_hash: e529a3fa8c3a79d3664db391683334c3
+config_hash: 22e4b128e110e2767daa9d95428ebf9d

api.md

@@ -772,7 +772,11 @@ Methods:
 Types:
 
 ```python
-from lithic.types import AccountActivityListResponse, AccountActivityRetrieveTransactionResponse
+from lithic.types import (
+    WirePartyDetails,
+    AccountActivityListResponse,
+    AccountActivityRetrieveTransactionResponse,
+)
 ```
 
 Methods:

src/lithic/resources/account_holders.py

@@ -140,6 +140,79 @@ def create(
         """
         ...
 
+    @overload
+    def create(
+        self,
+        *,
+        business_entity: account_holder_create_params.KYBDelegatedBusinessEntity,
+        beneficial_owner_individuals: Iterable[account_holder_create_params.KYBDelegatedBeneficialOwnerIndividual]
+        | NotGiven = NOT_GIVEN,
+        control_person: account_holder_create_params.KYBDelegatedControlPerson | NotGiven = NOT_GIVEN,
+        external_id: str | NotGiven = NOT_GIVEN,
+        nature_of_business: str | NotGiven = NOT_GIVEN,
+        tos_timestamp: str | NotGiven = NOT_GIVEN,
+        website_url: str | NotGiven = NOT_GIVEN,
+        workflow: Literal["KYB_DELEGATED"] | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> AccountHolderCreateResponse:
+        """
+        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 a synchronous response. The response time will depend on
+        the workflow. In some cases, the response may indicate the workflow is under
+        review or further action will be needed to complete the account creation
+        process. This endpoint can only be used on accounts that are part of the program
+        that the calling API key manages.
+
+        Args:
+          business_entity: Information for business for which the account is being opened.
+
+          beneficial_owner_individuals: You can submit a list of all direct and indirect individuals with 25% or more
+              ownership in the company. A maximum of 4 beneficial owners can be submitted. If
+              no individual owns 25% of the company you do not need to send beneficial owner
+              information. 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.
+
+          control_person: 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.
+
+          external_id: A user provided id that can be used to link an account holder with an external
+              system
+
+          nature_of_business: Short description of the company's line of business (i.e., what does the company
+              do?).
+
+          tos_timestamp: An RFC 3339 timestamp indicating when the account holder accepted the applicable
+              legal agreements (e.g., cardholder terms) as agreed upon during API customer's
+              implementation with Lithic.
+
+          website_url: Company website URL.
+
+          workflow: Specifies the type of KYB workflow to run.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        ...
+
     @overload
     def create(
         self,
@@ -266,6 +339,7 @@ def create(
             "tos_timestamp",
             "workflow",
         ],
+        ["business_entity"],
         ["individual", "tos_timestamp", "workflow"],
         ["address", "email", "first_name", "kyc_exemption_type", "last_name", "phone_number", "workflow"],
     )
@@ -278,7 +352,11 @@ def create(
         control_person: account_holder_create_params.KYBControlPerson | NotGiven = NOT_GIVEN,
         nature_of_business: str | NotGiven = NOT_GIVEN,
         tos_timestamp: str | NotGiven = NOT_GIVEN,
-        workflow: Literal["KYB_BASIC", "KYB_BYO"] | Literal["KYC_BASIC", "KYC_BYO"] | Literal["KYC_EXEMPT"],
+        workflow: Literal["KYB_BASIC", "KYB_BYO"]
+        | Literal["KYB_DELEGATED"]
+        | Literal["KYC_BASIC", "KYC_BYO"]
+        | Literal["KYC_EXEMPT"]
+        | NotGiven = NOT_GIVEN,
         beneficial_owner_entities: Iterable[account_holder_create_params.KYBBeneficialOwnerEntity]
         | NotGiven = NOT_GIVEN,
         external_id: str | NotGiven = NOT_GIVEN,
@@ -1129,6 +1207,79 @@ async def create(
         """
         ...
 
+    @overload
+    async def create(
+        self,
+        *,
+        business_entity: account_holder_create_params.KYBDelegatedBusinessEntity,
+        beneficial_owner_individuals: Iterable[account_holder_create_params.KYBDelegatedBeneficialOwnerIndividual]
+        | NotGiven = NOT_GIVEN,
+        control_person: account_holder_create_params.KYBDelegatedControlPerson | NotGiven = NOT_GIVEN,
+        external_id: str | NotGiven = NOT_GIVEN,
+        nature_of_business: str | NotGiven = NOT_GIVEN,
+        tos_timestamp: str | NotGiven = NOT_GIVEN,
+        website_url: str | NotGiven = NOT_GIVEN,
+        workflow: Literal["KYB_DELEGATED"] | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> AccountHolderCreateResponse:
+        """
+        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 a synchronous response. The response time will depend on
+        the workflow. In some cases, the response may indicate the workflow is under
+        review or further action will be needed to complete the account creation
+        process. This endpoint can only be used on accounts that are part of the program
+        that the calling API key manages.
+
+        Args:
+          business_entity: Information for business for which the account is being opened.
+
+          beneficial_owner_individuals: You can submit a list of all direct and indirect individuals with 25% or more
+              ownership in the company. A maximum of 4 beneficial owners can be submitted. If
+              no individual owns 25% of the company you do not need to send beneficial owner
+              information. 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.
+
+          control_person: 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.
+
+          external_id: A user provided id that can be used to link an account holder with an external
+              system
+
+          nature_of_business: Short description of the company's line of business (i.e., what does the company
+              do?).
+
+          tos_timestamp: An RFC 3339 timestamp indicating when the account holder accepted the applicable
+              legal agreements (e.g., cardholder terms) as agreed upon during API customer's
+              implementation with Lithic.
+
+          website_url: Company website URL.
+
+          workflow: Specifies the type of KYB workflow to run.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        ...
+
     @overload
     async def create(
         self,
@@ -1255,6 +1406,7 @@ async def create(
             "tos_timestamp",
             "workflow",
         ],
+        ["business_entity"],
         ["individual", "tos_timestamp", "workflow"],
         ["address", "email", "first_name", "kyc_exemption_type", "last_name", "phone_number", "workflow"],
     )
@@ -1267,7 +1419,11 @@ async def create(
         control_person: account_holder_create_params.KYBControlPerson | NotGiven = NOT_GIVEN,
         nature_of_business: str | NotGiven = NOT_GIVEN,
         tos_timestamp: str | NotGiven = NOT_GIVEN,
-        workflow: Literal["KYB_BASIC", "KYB_BYO"] | Literal["KYC_BASIC", "KYC_BYO"] | Literal["KYC_EXEMPT"],
+        workflow: Literal["KYB_BASIC", "KYB_BYO"]
+        | Literal["KYB_DELEGATED"]
+        | Literal["KYC_BASIC", "KYC_BYO"]
+        | Literal["KYC_EXEMPT"]
+        | NotGiven = NOT_GIVEN,
         beneficial_owner_entities: Iterable[account_holder_create_params.KYBBeneficialOwnerEntity]
         | NotGiven = NOT_GIVEN,
         external_id: str | NotGiven = NOT_GIVEN,

src/lithic/resources/book_transfers.py

@@ -84,6 +84,7 @@ def create(
             "DISPUTE_WON",
             "SERVICE",
             "TRANSFER",
+            "COLLECTION",
         ],
         token: str | NotGiven = NOT_GIVEN,
         external_id: str | NotGiven = NOT_GIVEN,
@@ -379,6 +380,7 @@ async def create(
             "DISPUTE_WON",
             "SERVICE",
             "TRANSFER",
+            "COLLECTION",
         ],
         token: str | NotGiven = NOT_GIVEN,
         external_id: str | NotGiven = NOT_GIVEN,

src/lithic/resources/reports/settlement/settlement.py

@@ -75,7 +75,7 @@ def list_details(
           ending_before: A cursor representing an item's token before which a page of results should end.
               Used to retrieve the previous page of results before this item.
 
-          page_size: Page size (for pagination).
+          page_size: Number of records per page.
 
           starting_after: A cursor representing an item's token after which a page of results should
               begin. Used to retrieve the next page of results after this item.
@@ -190,7 +190,7 @@ def list_details(
           ending_before: A cursor representing an item's token before which a page of results should end.
               Used to retrieve the previous page of results before this item.
 
-          page_size: Page size (for pagination).
+          page_size: Number of records per page.
 
           starting_after: A cursor representing an item's token after which a page of results should
               begin. Used to retrieve the next page of results after this item.

src/lithic/types/__init__.py

@@ -47,6 +47,7 @@
 from .card_create_params import CardCreateParams as CardCreateParams
 from .card_update_params import CardUpdateParams as CardUpdateParams
 from .event_subscription import EventSubscription as EventSubscription
+from .wire_party_details import WirePartyDetails as WirePartyDetails
 from .account_list_params import AccountListParams as AccountListParams
 from .balance_list_params import BalanceListParams as BalanceListParams
 from .card_embed_response import CardEmbedResponse as CardEmbedResponse

src/lithic/types/account_activity_list_response.py

@@ -8,6 +8,7 @@
 from .transaction import Transaction
 from .external_payment import ExternalPayment
 from .external_resource import ExternalResource
+from .wire_party_details import WirePartyDetails
 from .management_operation_transaction import ManagementOperationTransaction
 
 __all__ = [
@@ -235,6 +236,7 @@ class BookTransferTransactionEvent(BaseModel):
         "DISPUTE_WON",
         "SERVICE",
         "TRANSFER",
+        "COLLECTION",
     ]
     """Type of the book transfer"""
 
@@ -416,38 +418,24 @@ class PaymentTransactionMethodAttributesACHMethodAttributes(BaseModel):
 
 
 class PaymentTransactionMethodAttributesWireMethodAttributes(BaseModel):
-    wire_transfer_type: Literal["FEDWIRE", "SWIFT"]
+    wire_network: Literal["FEDWIRE", "SWIFT"]
     """Type of wire transfer"""
 
-    external_bank_name: Optional[str] = None
-    """External bank name"""
+    creditor: Optional[WirePartyDetails] = None
 
-    external_bank_routing_number: Optional[str] = None
-    """External bank routing number"""
+    debtor: Optional[WirePartyDetails] = None
 
-    external_individual_name: Optional[str] = None
-    """External individual name"""
-
-    imad: Optional[str] = None
-    """IMAD"""
-
-    lithic_bank_name: Optional[str] = None
-    """Lithic bank name"""
-
-    lithic_bank_routing_number: Optional[str] = None
-    """Lithic bank routing number"""
-
-    lithic_individual_name: Optional[str] = None
-    """Lithic individual name"""
-
-    omad: Optional[str] = None
-    """OMAD"""
+    message_id: Optional[str] = None
+    """
+    Point to point reference identifier, as assigned by the instructing party, used
+    for tracking the message through the Fedwire system
+    """
 
-    previous_transfer: Optional[str] = None
-    """UUID of previous transfer if this is a retry"""
+    remittance_information: Optional[str] = None
+    """Payment details or invoice reference"""
 
-    wire_token: Optional[str] = None
-    """Wire token"""
+    wire_message_type: Optional[str] = None
+    """Type of wire message"""
 
 
 PaymentTransactionMethodAttributes: TypeAlias = Union[
@@ -537,6 +525,19 @@ class PaymentTransaction(BaseModel):
     external_bank_account_token: Optional[str] = None
     """External bank account token"""
 
+    type: Optional[
+        Literal[
+            "ORIGINATION_CREDIT",
+            "ORIGINATION_DEBIT",
+            "RECEIPT_CREDIT",
+            "RECEIPT_DEBIT",
+            "WIRE_INBOUND_PAYMENT",
+            "WIRE_INBOUND_ADMIN",
+            "WIRE_OUTBOUND_PAYMENT",
+            "WIRE_OUTBOUND_ADMIN",
+        ]
+    ] = None
+
     user_defined_id: Optional[str] = None
     """User-defined identifier"""