feat(api): api update

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 239
-openapi_spec_hash: f8d2bbed3081c9ffc1547d28f89a8a34
+openapi_spec_hash: ae7b960626bb899180349619e8f6035e
 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/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/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/entity.py

@@ -520,7 +520,7 @@ class TermsAgreement(BaseModel):
  agreed_at: datetime
  """The timestamp of when the Entity agreed to the terms."""
 
- ip_address: str
+ ip_address: Optional[str] = None
  """The IP address the Entity accessed reviewed the terms from."""
 
  terms_url: str

src/increase/types/file.py

@@ -14,7 +14,7 @@
 class File(BaseModel):
  """Files are objects that represent a file hosted on Increase's servers.
 
-The file may have been uploaded by you (for example, when uploading a check image) or it may have been created by Increase (for example, an autogenerated statement PDF). If you need to download a File, use the `/files/{file_id}/contents` endpoint. If you need to share a File with someone who doesn't have access to your API key, create a File Link.
+Each File has a `purpose` that determines how Increase will use it. You upload a File so it can be attached to another object in the API (for example, when uploading a check image), or Increase creates one for you to download (for example, an autogenerated statement PDF). If you need to download a File, use the `/files/{file_id}/contents` endpoint. If you need to share a File with someone who doesn't have access to your API key, create a File Link.
  """
 
  id: str

src/increase/types/inbound_ach_transfer.py

@@ -233,7 +233,7 @@ class InternationalAddenda(BaseModel):
  originating_depository_financial_institution_id: str
  """An identifier for the originating bank.
 
- One of an International Bank Account Number (IBAN) bank identifier, SWIFT Bank
+ One of an International Bank Account Number (IBAN) bank identifier, Swift Bank
  Identification Code (BIC), or a domestic identifier like a US Routing Number.
  """
 
@@ -247,7 +247,7 @@ class InternationalAddenda(BaseModel):
  - `national_clearing_system_number` - A domestic clearing system number. In the
  US, for example, this is the American Banking Association (ABA) routing
  number.
- - `bic_code` - The SWIFT Bank Identifier Code (BIC) of the bank.
+ - `bic_code` - The Swift Bank Identifier Code (BIC) of the bank.
  - `iban` - An International Bank Account Number.
  """
 
@@ -326,7 +326,7 @@ class InternationalAddenda(BaseModel):
  receiving_depository_financial_institution_id: str
  """An identifier for the receiving bank.
 
- One of an International Bank Account Number (IBAN) bank identifier, SWIFT Bank
+ One of an International Bank Account Number (IBAN) bank identifier, Swift Bank
  Identification Code (BIC), or a domestic identifier like a US Routing Number.
  """
 
@@ -340,7 +340,7 @@ class InternationalAddenda(BaseModel):
  - `national_clearing_system_number` - A domestic clearing system number. In the
  US, for example, this is the American Banking Association (ABA) routing
  number.
- - `bic_code` - The SWIFT Bank Identifier Code (BIC) of the bank.
+ - `bic_code` - The Swift Bank Identifier Code (BIC) of the bank.
  - `iban` - An International Bank Account Number.
  """
 

src/increase/types/simulations/card_dispute_action_params.py

@@ -11,6 +11,7 @@
  "VisaAcceptUserSubmission",
  "VisaDeclineUserPrearbitration",
  "VisaReceiveMerchantPrearbitration",
+ "VisaReject",
  "VisaRepresent",
  "VisaRequestFurtherInformation",
  "VisaTimeOutChargeback",
@@ -73,6 +74,16 @@ class VisaReceiveMerchantPrearbitration(TypedDict, total=False):
  pass
 
 
+class VisaReject(TypedDict, total=False):
+ """The parameters for rejecting the dispute.
+
+ Required if and only if `action` is `reject`.
+ """
+
+ explanation: Required[str]
+ """The explanation for rejecting the dispute."""
+
+
 class VisaRepresent(TypedDict, total=False):
  """The parameters for re-presenting the dispute.
 
@@ -140,6 +151,7 @@ class Visa(TypedDict, total=False):
  "accept_user_submission",
  "decline_user_prearbitration",
  "receive_merchant_prearbitration",
+ "reject",
  "represent",
  "request_further_information",
  "time_out_chargeback",
@@ -162,6 +174,8 @@ class Visa(TypedDict, total=False):
  - `receive_merchant_prearbitration` - Simulate the merchant issuing
  pre-arbitration. This will move the dispute to a `user_submission_required`
  state.
+ - `reject` - Simulate the dispute being rejected before it is submitted to the
+ network. This will move the dispute to a `rejected` state.
  - `represent` - Simulate the merchant re-presenting the dispute. This will move
  the dispute to a `user_submission_required` state.
  - `request_further_information` - Simulate further information being requested
@@ -201,6 +215,12 @@ class Visa(TypedDict, total=False):
  Required if and only if `action` is `receive_merchant_prearbitration`.
  """
 
+ reject: VisaReject
+ """The parameters for rejecting the dispute.
+
+ Required if and only if `action` is `reject`.
+ """
+
  represent: VisaRepresent
  """The parameters for re-presenting the dispute.
 

tests/api_resources/simulations/test_card_disputes.py

@@ -36,6 +36,7 @@ def test_method_action_with_all_params(self, client: Increase) -> None:
  "accept_user_submission": {},
  "decline_user_prearbitration": {},
  "receive_merchant_prearbitration": {},
+ "reject": {"explanation": "x"},
  "represent": {},
  "request_further_information": {"reason": "x"},
  "time_out_chargeback": {},
@@ -103,6 +104,7 @@ async def test_method_action_with_all_params(self, async_client: AsyncIncrease)
  "accept_user_submission": {},
  "decline_user_prearbitration": {},
  "receive_merchant_prearbitration": {},
+ "reject": {"explanation": "x"},
  "represent": {},
  "request_further_information": {"reason": "x"},
  "time_out_chargeback": {},

tests/api_resources/test_cards.py

@@ -73,6 +73,11 @@ def test_method_create_with_all_params(self, client: Increase) -> None:
  "state": "x",
  "line2": "x",
  },
+ cardholder_name={
+ "first": "x",
+ "last": "x",
+ "middle": "x",
+ },
  description="Card for Ian Crease",
  digital_wallet={
  "digital_card_profile_id": "digital_card_profile_id",
@@ -447,6 +452,11 @@ async def test_method_create_with_all_params(self, async_client: AsyncIncrease)
  "state": "x",
  "line2": "x",
  },
+ cardholder_name={
+ "first": "x",
+ "last": "x",
+ "middle": "x",
+ },
  description="Card for Ian Crease",
  digital_wallet={
  "digital_card_profile_id": "digital_card_profile_id",