feat(client): update currency data type (#709)

stainless-app[bot] · stainless-app[bot] · commit 2f9b36d8652f · 2025-03-12T12:30:31.000-04:00
docs: update some descriptions
chore(client): deprecate some fields
diff --git a/src/lithic/resources/external_bank_accounts/external_bank_accounts.py b/src/lithic/resources/external_bank_accounts/external_bank_accounts.py
@@ -111,7 +111,7 @@ def create(
           country: The country that the bank account is located in using ISO 3166-1. We will only
               accept USA bank accounts e.g., USA
 
-          currency: currency of the external account 3-digit alphabetic ISO 4217 code
+          currency: currency of the external account 3-character alphabetic ISO 4217 code
 
           financial_account_token: The financial account token of the operating account to fund the micro deposits
 
@@ -240,7 +240,7 @@ def create(
           country: The country that the bank account is located in using ISO 3166-1. We will only
               accept USA bank accounts e.g., USA
 
-          currency: currency of the external account 3-digit alphabetic ISO 4217 code
+          currency: currency of the external account 3-character alphabetic ISO 4217 code
 
           owner: Legal Name of the business or individual who owns the external account. This
               will appear in statements
@@ -680,7 +680,7 @@ async def create(
           country: The country that the bank account is located in using ISO 3166-1. We will only
               accept USA bank accounts e.g., USA
 
-          currency: currency of the external account 3-digit alphabetic ISO 4217 code
+          currency: currency of the external account 3-character alphabetic ISO 4217 code
 
           financial_account_token: The financial account token of the operating account to fund the micro deposits
 
@@ -809,7 +809,7 @@ async def create(
           country: The country that the bank account is located in using ISO 3166-1. We will only
               accept USA bank accounts e.g., USA
 
-          currency: currency of the external account 3-digit alphabetic ISO 4217 code
+          currency: currency of the external account 3-character alphabetic ISO 4217 code
 
           owner: Legal Name of the business or individual who owns the external account. This
               will appear in statements
diff --git a/src/lithic/resources/transactions/transactions.py b/src/lithic/resources/transactions/transactions.py
@@ -259,7 +259,7 @@ def simulate_authorization(
           merchant_amount: Amount of the transaction to be simulated in currency specified in
               merchant_currency, including any acquirer fees.
 
-          merchant_currency: 3-digit alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,
+          merchant_currency: 3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,
               GBP, EUR and defaults to GBP if another ISO 4217 code is provided
 
           partial_approval_capable: Set to true if the terminal is capable of partial approval otherwise false.
@@ -828,7 +828,7 @@ async def simulate_authorization(
           merchant_amount: Amount of the transaction to be simulated in currency specified in
               merchant_currency, including any acquirer fees.
 
-          merchant_currency: 3-digit alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,
+          merchant_currency: 3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,
               GBP, EUR and defaults to GBP if another ISO 4217 code is provided
 
           partial_approval_capable: Set to true if the terminal is capable of partial approval otherwise false.
diff --git a/src/lithic/types/account.py b/src/lithic/types/account.py
@@ -115,6 +115,6 @@ class Account(BaseModel):
     """
 
     cardholder_currency: Optional[str] = None
-    """3-digit alphabetic ISO 4217 code for the currency of the cardholder."""
+    """3-character alphabetic ISO 4217 code for the currency of the cardholder."""
 
     verification_address: Optional[VerificationAddress] = None
diff --git a/src/lithic/types/aggregate_balance.py b/src/lithic/types/aggregate_balance.py
@@ -16,7 +16,7 @@ class AggregateBalance(BaseModel):
     """Date and time for when the balance was first created."""
 
     currency: str
-    """3-digit alphabetic ISO 4217 code for the local currency of the balance."""
+    """3-character alphabetic ISO 4217 code for the local currency of the balance."""
 
     financial_account_type: Literal["ISSUING", "OPERATING", "RESERVE"]
     """Type of financial account"""
diff --git a/src/lithic/types/auth_rules/auth_rule_condition.py b/src/lithic/types/auth_rules/auth_rule_condition.py
@@ -20,8 +20,8 @@ class AuthRuleCondition(BaseModel):
     - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
       ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
       Netherlands Antilles.
-    - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
-      transaction.
+    - `CURRENCY`: 3-character alphabetic ISO 4217 code for the merchant currency of
+      the transaction.
     - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
       (merchant).
     - `DESCRIPTOR`: Short description of card acceptor.
diff --git a/src/lithic/types/auth_rules/auth_rule_condition_param.py b/src/lithic/types/auth_rules/auth_rule_condition_param.py
@@ -21,8 +21,8 @@ class AuthRuleConditionParam(TypedDict, total=False):
     - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
       ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
       Netherlands Antilles.
-    - `CURRENCY`: 3-digit alphabetic ISO 4217 code for the merchant currency of the
-      transaction.
+    - `CURRENCY`: 3-character alphabetic ISO 4217 code for the merchant currency of
+      the transaction.
     - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
       (merchant).
     - `DESCRIPTOR`: Short description of card acceptor.
diff --git a/src/lithic/types/balance.py b/src/lithic/types/balance.py
@@ -16,7 +16,7 @@ class Balance(BaseModel):
     """Date and time for when the balance was first created."""
 
     currency: str
-    """3-digit alphabetic ISO 4217 code for the local currency of the balance."""
+    """3-character alphabetic ISO 4217 code for the local currency of the balance."""
 
     financial_account_token: str
     """Globally unique identifier for the financial account that holds this balance."""
diff --git a/src/lithic/types/book_transfer_response.py b/src/lithic/types/book_transfer_response.py
@@ -55,7 +55,10 @@ class BookTransferResponse(BaseModel):
     """Date and time when the transfer occurred. UTC time zone."""
 
     currency: str
-    """3-digit alphabetic ISO 4217 code for the settling currency of the transaction."""
+    """
+    3-character alphabetic ISO 4217 code for the settling currency of the
+    transaction.
+    """
 
     events: List[Event]
     """A list of all financial events that have modified this transfer."""
diff --git a/src/lithic/types/card.py b/src/lithic/types/card.py
@@ -151,7 +151,7 @@ class Card(BaseModel):
     """
 
     cardholder_currency: Optional[str] = None
-    """3-digit alphabetic ISO 4217 code for the currency of the cardholder."""
+    """3-character alphabetic ISO 4217 code for the currency of the cardholder."""
 
     cvv: Optional[str] = None
     """Three digit cvv printed on the back of the card."""
diff --git a/src/lithic/types/card_program.py b/src/lithic/types/card_program.py
@@ -25,10 +25,10 @@ class CardProgram(BaseModel):
     """The first digits of the card number that this card program starts with."""
 
     cardholder_currency: Optional[str] = None
-    """3-digit alphabetic ISO 4217 code for the currency of the cardholder."""
+    """3-character alphabetic ISO 4217 code for the currency of the cardholder."""
 
     settlement_currencies: Optional[List[str]] = None
     """
-    List of 3-digit alphabetic ISO 4217 codes for the currencies that the card
+    List of 3-character alphabetic ISO 4217 codes for the currencies that the card
     program supports for settlement.
     """
diff --git a/src/lithic/types/cards/aggregate_balance_list_response.py b/src/lithic/types/cards/aggregate_balance_list_response.py
@@ -15,7 +15,7 @@ class AggregateBalanceListResponse(BaseModel):
     """Date and time for when the balance was first created."""
 
     currency: str
-    """3-digit alphabetic ISO 4217 code for the local currency of the balance."""
+    """3-character alphabetic ISO 4217 code for the local currency of the balance."""
 
     last_card_token: str
     """
diff --git a/src/lithic/types/cards/balance_list_response.py b/src/lithic/types/cards/balance_list_response.py
@@ -19,7 +19,7 @@ class BalanceListResponse(BaseModel):
     """Date and time for when the balance was first created."""
 
     currency: str
-    """3-digit alphabetic ISO 4217 code for the local currency of the balance."""
+    """3-character alphabetic ISO 4217 code for the local currency of the balance."""
 
     last_transaction_event_token: str
     """
diff --git a/src/lithic/types/external_bank_account_create_params.py b/src/lithic/types/external_bank_account_create_params.py
@@ -30,7 +30,7 @@ class BankVerifiedCreateBankAccountAPIRequest(TypedDict, total=False):
     """
 
     currency: Required[str]
-    """currency of the external account 3-digit alphabetic ISO 4217 code"""
+    """currency of the external account 3-character alphabetic ISO 4217 code"""
 
     financial_account_token: Required[str]
     """The financial account token of the operating account to fund the micro deposits"""
@@ -131,7 +131,7 @@ class ExternallyVerifiedCreateBankAccountAPIRequest(TypedDict, total=False):
     """
 
     currency: Required[str]
-    """currency of the external account 3-digit alphabetic ISO 4217 code"""
+    """currency of the external account 3-character alphabetic ISO 4217 code"""
 
     owner: Required[str]
     """Legal Name of the business or individual who owns the external account.
diff --git a/src/lithic/types/external_bank_account_create_response.py b/src/lithic/types/external_bank_account_create_response.py
@@ -32,7 +32,7 @@ class ExternalBankAccountCreateResponse(BaseModel):
     """
 
     currency: str
-    """currency of the external account 3-digit alphabetic ISO 4217 code"""
+    """currency of the external account 3-character alphabetic ISO 4217 code"""
 
     last_four: str
     """The last 4 digits of the bank account.
diff --git a/src/lithic/types/external_bank_account_list_response.py b/src/lithic/types/external_bank_account_list_response.py
@@ -32,7 +32,7 @@ class ExternalBankAccountListResponse(BaseModel):
     """
 
     currency: str
-    """currency of the external account 3-digit alphabetic ISO 4217 code"""
+    """currency of the external account 3-character alphabetic ISO 4217 code"""
 
     last_four: str
     """The last 4 digits of the bank account.
diff --git a/src/lithic/types/external_bank_account_retrieve_response.py b/src/lithic/types/external_bank_account_retrieve_response.py
@@ -32,7 +32,7 @@ class ExternalBankAccountRetrieveResponse(BaseModel):
     """
 
     currency: str
-    """currency of the external account 3-digit alphabetic ISO 4217 code"""
+    """currency of the external account 3-character alphabetic ISO 4217 code"""
 
     last_four: str
     """The last 4 digits of the bank account.
diff --git a/src/lithic/types/external_bank_account_retry_micro_deposits_response.py b/src/lithic/types/external_bank_account_retry_micro_deposits_response.py
@@ -32,7 +32,7 @@ class ExternalBankAccountRetryMicroDepositsResponse(BaseModel):
     """
 
     currency: str
-    """currency of the external account 3-digit alphabetic ISO 4217 code"""
+    """currency of the external account 3-character alphabetic ISO 4217 code"""
 
     last_four: str
     """The last 4 digits of the bank account.
diff --git a/src/lithic/types/external_bank_account_retry_prenote_response.py b/src/lithic/types/external_bank_account_retry_prenote_response.py
@@ -34,7 +34,7 @@ class ExternalBankAccountRetryPrenoteResponse(BaseModel):
     """
 
     currency: str
-    """currency of the external account 3-digit alphabetic ISO 4217 code"""
+    """currency of the external account 3-character alphabetic ISO 4217 code"""
 
     last_four: str
     """The last 4 digits of the bank account.
diff --git a/src/lithic/types/external_bank_account_update_response.py b/src/lithic/types/external_bank_account_update_response.py
@@ -32,7 +32,7 @@ class ExternalBankAccountUpdateResponse(BaseModel):
     """
 
     currency: str
-    """currency of the external account 3-digit alphabetic ISO 4217 code"""
+    """currency of the external account 3-character alphabetic ISO 4217 code"""
 
     last_four: str
     """The last 4 digits of the bank account.
diff --git a/src/lithic/types/external_bank_accounts/micro_deposit_create_response.py b/src/lithic/types/external_bank_accounts/micro_deposit_create_response.py
@@ -32,7 +32,7 @@ class MicroDepositCreateResponse(BaseModel):
     """
 
     currency: str
-    """currency of the external account 3-digit alphabetic ISO 4217 code"""
+    """currency of the external account 3-character alphabetic ISO 4217 code"""
 
     last_four: str
     """The last 4 digits of the bank account.
diff --git a/src/lithic/types/financial_accounts/balance_list_response.py b/src/lithic/types/financial_accounts/balance_list_response.py
@@ -19,7 +19,7 @@ class BalanceListResponse(BaseModel):
     """Date and time for when the balance was first created."""
 
     currency: str
-    """3-digit alphabetic ISO 4217 code for the local currency of the balance."""
+    """3-character alphabetic ISO 4217 code for the local currency of the balance."""
 
     last_transaction_event_token: str
     """
diff --git a/src/lithic/types/financial_accounts/statements/statement_line_items.py b/src/lithic/types/financial_accounts/statements/statement_line_items.py
@@ -34,7 +34,10 @@ class Data(BaseModel):
     """Timestamp of when the line item was generated"""
 
     currency: str
-    """3-digit alphabetic ISO 4217 code for the settling currency of the transaction"""
+    """
+    3-character alphabetic ISO 4217 code for the settling currency of the
+    transaction
+    """
 
     effective_date: date
     """Date that the transaction effected the account balance"""
diff --git a/src/lithic/types/financial_transaction.py b/src/lithic/types/financial_transaction.py
@@ -116,7 +116,10 @@ class FinancialTransaction(BaseModel):
     """Date and time when the financial transaction first occurred. UTC time zone."""
 
     currency: str
-    """3-digit alphabetic ISO 4217 code for the settling currency of the transaction."""
+    """
+    3-character alphabetic ISO 4217 code for the settling currency of the
+    transaction.
+    """
 
     descriptor: str
     """
diff --git a/src/lithic/types/payment.py b/src/lithic/types/payment.py
@@ -103,7 +103,7 @@ class Payment(BaseModel):
     """Date and time when the payment first occurred. UTC time zone."""
 
     currency: str
-    """3-digit alphabetic ISO 4217 code for the settling currency of the payment."""
+    """3-character alphabetic ISO 4217 code for the settling currency of the payment."""
 
     descriptor: str
     """
diff --git a/src/lithic/types/reports/settlement/network_total_list_response.py b/src/lithic/types/reports/settlement/network_total_list_response.py
@@ -36,7 +36,7 @@ class NetworkTotalListResponse(BaseModel):
     """RFC 3339 timestamp for when the record was created. UTC time zone."""
 
     currency: str
-    """Three-digit alphabetic ISO 4217 code."""
+    """3-character alphabetic ISO 4217 code."""
 
     institution_id: str
     """The institution that activity occurred on.
diff --git a/src/lithic/types/reports/settlement/network_total_retrieve_response.py b/src/lithic/types/reports/settlement/network_total_retrieve_response.py
@@ -36,7 +36,7 @@ class NetworkTotalRetrieveResponse(BaseModel):
     """RFC 3339 timestamp for when the record was created. UTC time zone."""
 
     currency: str
-    """Three-digit alphabetic ISO 4217 code."""
+    """3-character alphabetic ISO 4217 code."""
 
     institution_id: str
     """The institution that activity occurred on.
diff --git a/src/lithic/types/settlement_detail.py b/src/lithic/types/settlement_detail.py
@@ -41,7 +41,7 @@ class SettlementDetail(BaseModel):
     """Date and time when the transaction first occurred. UTC time zone."""
 
     currency: str
-    """Three-digit alphabetic ISO 4217 code."""
+    """Three-character alphabetic ISO 4217 code."""
 
     disputes_gross_amount: int
     """The total gross amount of disputes settlements."""
diff --git a/src/lithic/types/settlement_report.py b/src/lithic/types/settlement_report.py
@@ -14,7 +14,7 @@ class SettlementReport(BaseModel):
     """Date and time when the transaction first occurred. UTC time zone."""
 
     currency: str
-    """Three-digit alphabetic ISO 4217 code.
+    """3-character alphabetic ISO 4217 code.
 
     (This field is deprecated and will be removed in a future version of the API.)
     """
diff --git a/src/lithic/types/settlement_summary_details.py b/src/lithic/types/settlement_summary_details.py
@@ -10,7 +10,7 @@
 
 class SettlementSummaryDetails(BaseModel):
     currency: Optional[str] = None
-    """ISO 4217 alpha 3 code."""
+    """3-character alphabetic ISO 4217 code."""
 
     disputes_gross_amount: Optional[int] = None
     """The total gross amount of disputes settlements."""
diff --git a/src/lithic/types/shared/currency.py b/src/lithic/types/shared/currency.py
diff --git a/src/lithic/types/three_ds/authentication_simulate_params.py b/src/lithic/types/three_ds/authentication_simulate_params.py
diff --git a/src/lithic/types/transaction.py b/src/lithic/types/transaction.py
diff --git a/src/lithic/types/transaction_simulate_authorization_params.py b/src/lithic/types/transaction_simulate_authorization_params.py
