feat(api): api update

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 239
-openapi_spec_hash: f8d2bbed3081c9ffc1547d28f89a8a34
+openapi_spec_hash: d329987a4086757fa42ed578ac6395a9
 config_hash: 1ca082e374ef7000e2a5971e8da740e0

src/increase/resources/ach_prenotifications.py

@@ -107,7 +107,7 @@ def create(
 
  individual_id: Your identifier for the recipient.
 
- individual_name: The name of therecipient. This value is informational and not verified by the
+ individual_name: The name of the recipient. This value is informational and not verified by the
  recipient's bank.
 
  standard_entry_class_code: The
@@ -346,7 +346,7 @@ async def create(
 
  individual_id: Your identifier for the recipient.
 
- individual_name: The name of therecipient. This value is informational and not verified by the
+ individual_name: The name of the recipient. This value is informational and not verified by the
  recipient's bank.
 
  standard_entry_class_code: The

src/increase/resources/ach_transfers.py

@@ -71,7 +71,6 @@ def create(
  "internet_initiated",
  ]
  | Omit = omit,
- transaction_timing: Literal["synchronous", "asynchronous"] | Omit = omit,
  # 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,
@@ -173,12 +172,6 @@ def create(
  non-consumers to debit a consumer’s account. Credits can only be used for
  consumer to consumer transactions.
 
- transaction_timing: The timing of the transaction.
-
- - `synchronous` - A Transaction will be created immediately.
- - `asynchronous` - A Transaction will be created when the funds settle at the
- Federal Reserve.
-
  extra_headers: Send extra headers
 
  extra_query: Add additional query parameters to the request
@@ -211,7 +204,6 @@ def create(
  "require_approval": require_approval,
  "routing_number": routing_number,
  "standard_entry_class_code": standard_entry_class_code,
- "transaction_timing": transaction_timing,
  },
  ach_transfer_create_params.ACHTransferCreateParams,
  ),
@@ -461,7 +453,6 @@ async def create(
  "internet_initiated",
  ]
  | Omit = omit,
- transaction_timing: Literal["synchronous", "asynchronous"] | Omit = omit,
  # 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,
@@ -563,12 +554,6 @@ async def create(
  non-consumers to debit a consumer’s account. Credits can only be used for
  consumer to consumer transactions.
 
- transaction_timing: The timing of the transaction.
-
- - `synchronous` - A Transaction will be created immediately.
- - `asynchronous` - A Transaction will be created when the funds settle at the
- Federal Reserve.
-
  extra_headers: Send extra headers
 
  extra_query: Add additional query parameters to the request
@@ -601,7 +586,6 @@ async def create(
  "require_approval": require_approval,
  "routing_number": routing_number,
  "standard_entry_class_code": standard_entry_class_code,
- "transaction_timing": transaction_timing,
  },
  ach_transfer_create_params.ACHTransferCreateParams,
  ),

src/increase/resources/cards.py

@@ -58,6 +58,7 @@ def create(
  account_id: str,
  authorization_controls: card_create_params.AuthorizationControls | Omit = omit,
  billing_address: card_create_params.BillingAddress | Omit = omit,
+ cardholder_name: card_create_params.CardholderName | Omit = omit,
  description: str | Omit = omit,
  digital_wallet: card_create_params.DigitalWallet | Omit = omit,
  entity_id: str | Omit = omit,
@@ -79,6 +80,9 @@ def create(
 
  billing_address: The card's billing address.
 
+ cardholder_name: The name of the cardholder. Used to respond to Account Name Inquiry requests
+ from acquirers in Card Validations.
+
  description: The description you choose to give the card.
 
  digital_wallet: The contact information used in the two-factor steps for digital wallet card
@@ -107,6 +111,7 @@ def create(
  "account_id": account_id,
  "authorization_controls": authorization_controls,
  "billing_address": billing_address,
+ "cardholder_name": cardholder_name,
  "description": description,
  "digital_wallet": digital_wallet,
  "entity_id": entity_id,
@@ -462,6 +467,7 @@ async def create(
  account_id: str,
  authorization_controls: card_create_params.AuthorizationControls | Omit = omit,
  billing_address: card_create_params.BillingAddress | Omit = omit,
+ cardholder_name: card_create_params.CardholderName | Omit = omit,
  description: str | Omit = omit,
  digital_wallet: card_create_params.DigitalWallet | Omit = omit,
  entity_id: str | Omit = omit,
@@ -483,6 +489,9 @@ async def create(
 
  billing_address: The card's billing address.
 
+ cardholder_name: The name of the cardholder. Used to respond to Account Name Inquiry requests
+ from acquirers in Card Validations.
+
  description: The description you choose to give the card.
 
  digital_wallet: The contact information used in the two-factor steps for digital wallet card
@@ -511,6 +520,7 @@ async def create(
  "account_id": account_id,
  "authorization_controls": authorization_controls,
  "billing_address": billing_address,
+ "cardholder_name": cardholder_name,
  "description": description,
  "digital_wallet": digital_wallet,
  "entity_id": entity_id,

src/increase/types/ach_prenotification_create_params.py

@@ -56,7 +56,7 @@ class ACHPrenotificationCreateParams(TypedDict, total=False):
  """Your identifier for the recipient."""
 
  individual_name: str
- """The name of therecipient.
+ """The name of the recipient.
 
  This value is informational and not verified by the recipient's bank.
  """

src/increase/types/ach_transfer.py

@@ -686,7 +686,7 @@ class Submission(BaseModel):
  """The timestamp by which any administrative returns are expected to be received
  by.
 
- This follows the NACHA guidelines for return windows, which are: "In general,
+ This follows the Nacha guidelines for return windows, which are: "In general,
  return entries must be received by the RDFI’s ACH Operator by its deposit
  deadline for the return entry to be made available to the ODFI no later than the
  opening of business on the second banking day following the Settlement Date of

src/increase/types/ach_transfer_create_params.py

@@ -168,14 +168,6 @@ class ACHTransferCreateParams(TypedDict, total=False):
  consumer to consumer transactions.
  """
 
- transaction_timing: Literal["synchronous", "asynchronous"]
- """The timing of the transaction.
-
- - `synchronous` - A Transaction will be created immediately.
- - `asynchronous` - A Transaction will be created when the funds settle at the
- Federal Reserve.
- """
-
 
 class AddendaFreeformEntry(TypedDict, total=False):
  payment_related_information: Required[str]

src/increase/types/card.py

@@ -27,6 +27,7 @@
  "AuthorizationControlsUsageSingleUse",
  "AuthorizationControlsUsageSingleUseSettlementAmount",
  "BillingAddress",
+ "CardholderName",
  "DigitalWallet",
 ]
 
@@ -231,6 +232,22 @@ class BillingAddress(BaseModel):
  """The US state of the billing address."""
 
 
+class CardholderName(BaseModel):
+ """The name of the cardholder.
+
+ Used to respond to Account Name Inquiry requests from acquirers in Card Validations.
+ """
+
+ first: str
+ """The cardholder's first name."""
+
+ last: str
+ """The cardholder's last name."""
+
+ middle: Optional[str] = None
+ """The cardholder's middle name."""
+
+
 class DigitalWallet(BaseModel):
  """
  The contact information used in the two-factor steps for digital wallet card creation. At least one field must be present to complete the digital wallet steps.
@@ -276,6 +293,13 @@ class Card(BaseModel):
  bin: str
  """The Bank Identification Number (BIN) of the Card."""
 
+ cardholder_name: Optional[CardholderName] = None
+ """The name of the cardholder.
+
+ Used to respond to Account Name Inquiry requests from acquirers in Card
+ Validations.
+ """
+
  created_at: datetime
  """
  The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which

src/increase/types/card_create_params.py

@@ -24,6 +24,7 @@
  "AuthorizationControlsUsageSingleUse",
  "AuthorizationControlsUsageSingleUseSettlementAmount",
  "BillingAddress",
+ "CardholderName",
  "DigitalWallet",
 ]
 
@@ -38,6 +39,13 @@ class CardCreateParams(TypedDict, total=False):
  billing_address: BillingAddress
  """The card's billing address."""
 
+ cardholder_name: CardholderName
+ """The name of the cardholder.
+
+ Used to respond to Account Name Inquiry requests from acquirers in Card
+ Validations.
+ """
+
  description: str
  """The description you choose to give the card."""
 
@@ -276,6 +284,22 @@ class BillingAddress(TypedDict, total=False):
  """The second line of the billing address."""
 
 
+class CardholderName(TypedDict, total=False):
+ """The name of the cardholder.
+
+ Used to respond to Account Name Inquiry requests from acquirers in Card Validations.
+ """
+
+ first: Required[str]
+ """The cardholder's first name."""
+
+ last: Required[str]
+ """The cardholder's last name."""
+
+ middle: str
+ """The cardholder's middle name."""
+
+
 class DigitalWallet(TypedDict, total=False):
  """
  The contact information used in the two-factor steps for digital wallet card creation. To add the card to a digital wallet, you may supply an email or phone number with this request. Otherwise, subscribe and then action a Real Time Decision with the category `digital_wallet_token_requested` or `digital_wallet_authentication_requested`.

src/increase/types/card_dispute.py

@@ -2727,8 +2727,9 @@ class CardDispute(BaseModel):
  - `lost` - The Card Dispute has been lost and funds previously credited from the
  acceptance have been debited.
  - `won` - The Card Dispute has been won and no further action can be taken.
- - `rejected` - The Card Dispute has been reviewed and rejected, please review
- the explanation for more details.
+ - `rejected` - The Card Dispute was rejected before it was submitted to the
+ network, either by Increase or because the user withdrew it. Please review the
+ explanation for more details.
  """
 
  type: Literal["card_dispute"]

src/increase/types/card_payment.py

@@ -1453,6 +1453,15 @@ class ElementCardAuthorization(BaseModel):
  riskiest.
  """
 
+ original_card_payment_id: Optional[str] = None
+ """
+ The ID of the Card Payment containing the original authorization or card
+ validation this transaction references. For a merchant-initiated transaction,
+ this is the Card Payment from when the card was first stored, which is typically
+ where the CVV2 was verified. The reference this is derived from is supplied by
+ the merchant or their acquirer, so it is not guaranteed to be present.
+ """
+
  pending_transaction_id: Optional[str] = None
  """The identifier of the Pending Transaction associated with this Transaction."""
 

src/increase/types/check_transfer.py

@@ -275,6 +275,9 @@ class PhysicalCheck(BaseModel):
  return address if unspecified.
  """
 
+ physical_check_batch_id: Optional[str] = None
+ """The identifier of the Physical Check Batch that this check is a part of."""
+
  recipient_name: str
  """The name that will be printed on the check."""
 
@@ -556,6 +559,7 @@ class CheckTransfer(BaseModel):
  status: Literal[
  "pending_approval",
  "canceled",
+ "pending_batch_completing",
  "pending_submission",
  "pending_reviewing",
  "requires_attention",
@@ -570,6 +574,8 @@ class CheckTransfer(BaseModel):
 
  - `pending_approval` - The transfer is awaiting approval.
  - `canceled` - The transfer has been canceled.
+ - `pending_batch_completing` - The transfer is waiting for its Physical Check
+ Batch to be completed.
  - `pending_submission` - The transfer is pending submission.
  - `pending_reviewing` - The transfer is pending review by Increase.
  - `requires_attention` - The transfer requires attention from an Increase

src/increase/types/check_transfer_create_params.py

@@ -89,7 +89,10 @@ class CheckTransferCreateParams(TypedDict, total=False):
 
 
 class PhysicalCheckMailingAddress(TypedDict, total=False):
- """Details for where Increase will mail the check."""
+ """Details for where Increase will mail the check.
+
+ When `physical_check_batch_id` is set, the address must match the Physical Check Batch.
+ """
 
  city: Required[str]
  """The city component of the check's destination address."""
@@ -126,9 +129,8 @@ class PhysicalCheckPayer(TypedDict, total=False):
 
 
 class PhysicalCheckReturnAddress(TypedDict, total=False):
- """The return address to be printed on the check.
-
- If omitted this will default to an Increase-owned address that will mark checks as delivery failed and shred them.
+ """
+ Details for where the courier will return the check to if it is unable to be delivered. Defaults to an Increase-owned address that will mark checks as delivery failed and shred them.
  """
 
  city: Required[str]
@@ -180,7 +182,11 @@ class PhysicalCheck(TypedDict, total=False, extra_items=object): # type: ignore
  """
 
  mailing_address: Required[PhysicalCheckMailingAddress]
- """Details for where Increase will mail the check."""
+ """Details for where Increase will mail the check.
+
+ When `physical_check_batch_id` is set, the address must match the Physical Check
+ Batch.
+ """
 
  memo: Required[str]
  """The descriptor that will be printed on the memo field on the check."""
@@ -214,11 +220,14 @@ class PhysicalCheck(TypedDict, total=False, extra_items=object): # type: ignore
  note: str
  """The descriptor that will be printed on the letter included with the check."""
 
-return_address: PhysicalCheckReturnAddress
- """The return address to be printed on the check.
+physical_check_batch_id: str
+ """The identifier of the Physical Check Batch to mail this check as a part of."""
 
- If omitted this will default to an Increase-owned address that will mark checks
- as delivery failed and shred them.
+ return_address: PhysicalCheckReturnAddress
+ """
+ Details for where the courier will return the check to if it is unable to be
+ delivered. Defaults to an Increase-owned address that will mark checks as
+ delivery failed and shred them.
  """
 
  return_address_name: str